Class: FlatApi::ScoreCreationBuilderDataAllOfBuilderDataLayoutData
- Inherits:
-
Object
- Object
- FlatApi::ScoreCreationBuilderDataAllOfBuilderDataLayoutData
- Defined in:
- lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb
Overview
Control the appearance of the score. If missing, default values are used.
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#length_unit ⇒ Object
The unit to use for layout customizations.
-
#notes_spacing_coeff ⇒ Object
A float value >= 1 that controls the spacing between notes.
-
#page_height ⇒ Object
The height of the page in chosen unit (‘lengthUnit`).
-
#page_margin_bottom ⇒ Object
The bottom margin of the page in chosen unit (‘lengthUnit`).
-
#page_margin_left ⇒ Object
The left margin of the page in chosen unit (‘lengthUnit`).
-
#page_margin_right ⇒ Object
The right margin of the page in chosen unit (‘lengthUnit`).
-
#page_margin_top ⇒ Object
The top margin of the page in chosen unit (‘lengthUnit`).
-
#page_width ⇒ Object
The width of the page in chosen unit (‘lengthUnit`).
Class Method Summary collapse
-
._deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ ScoreCreationBuilderDataAllOfBuilderDataLayoutData
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ ScoreCreationBuilderDataAllOfBuilderDataLayoutData
Initializes the object
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 |
# File 'lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb', line 106 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `FlatApi::ScoreCreationBuilderDataAllOfBuilderDataLayoutData` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::ScoreCreationBuilderDataAllOfBuilderDataLayoutData`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'notes_spacing_coeff') self.notes_spacing_coeff = attributes[:'notes_spacing_coeff'] end if attributes.key?(:'length_unit') self.length_unit = attributes[:'length_unit'] else self.length_unit = 'cm' end if attributes.key?(:'page_height') self.page_height = attributes[:'page_height'] end if attributes.key?(:'page_width') self.page_width = attributes[:'page_width'] end if attributes.key?(:'page_margin_top') self.page_margin_top = attributes[:'page_margin_top'] end if attributes.key?(:'page_margin_bottom') self.page_margin_bottom = attributes[:'page_margin_bottom'] end if attributes.key?(:'page_margin_left') self.page_margin_left = attributes[:'page_margin_left'] end if attributes.key?(:'page_margin_right') self.page_margin_right = attributes[:'page_margin_right'] end end |
Instance Attribute Details
#length_unit ⇒ Object
The unit to use for layout customizations
23 24 25 |
# File 'lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb', line 23 def length_unit @length_unit end |
#notes_spacing_coeff ⇒ Object
A float value >= 1 that controls the spacing between notes.
20 21 22 |
# File 'lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb', line 20 def notes_spacing_coeff @notes_spacing_coeff end |
#page_height ⇒ Object
The height of the page in chosen unit (‘lengthUnit`).
26 27 28 |
# File 'lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb', line 26 def page_height @page_height end |
#page_margin_bottom ⇒ Object
The bottom margin of the page in chosen unit (‘lengthUnit`).
35 36 37 |
# File 'lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb', line 35 def page_margin_bottom @page_margin_bottom end |
#page_margin_left ⇒ Object
The left margin of the page in chosen unit (‘lengthUnit`).
38 39 40 |
# File 'lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb', line 38 def page_margin_left @page_margin_left end |
#page_margin_right ⇒ Object
The right margin of the page in chosen unit (‘lengthUnit`).
41 42 43 |
# File 'lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb', line 41 def page_margin_right @page_margin_right end |
#page_margin_top ⇒ Object
The top margin of the page in chosen unit (‘lengthUnit`).
32 33 34 |
# File 'lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb', line 32 def page_margin_top @page_margin_top end |
#page_width ⇒ Object
The width of the page in chosen unit (‘lengthUnit`).
29 30 31 |
# File 'lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb', line 29 def page_width @page_width end |
Class Method Details
._deserialize(type, value) ⇒ Object
Deserializes the data based on type
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 |
# File 'lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb', line 235 def self._deserialize(type, value) case type.to_sym when :Time Time.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :Boolean if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model # models (e.g. Pet) or oneOf klass = FlatApi.const_get(type) klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end |
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
80 81 82 |
# File 'lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb', line 80 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
66 67 68 69 70 71 72 73 74 75 76 77 |
# File 'lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb', line 66 def self.attribute_map { :'notes_spacing_coeff' => :'notesSpacingCoeff', :'length_unit' => :'lengthUnit', :'page_height' => :'pageHeight', :'page_width' => :'pageWidth', :'page_margin_top' => :'pageMarginTop', :'page_margin_bottom' => :'pageMarginBottom', :'page_margin_left' => :'pageMarginLeft', :'page_margin_right' => :'pageMarginRight' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 |
# File 'lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb', line 211 def self.build_from_hash(attributes) return nil unless attributes.is_a?(Hash) attributes = attributes.transform_keys(&:to_sym) transformed_hash = {} openapi_types.each_pair do |key, type| if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil? transformed_hash["#{key}"] = nil elsif type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the attribute # is documented as an array but the input is not if attributes[attribute_map[key]].is_a?(Array) transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) } end elsif !attributes[attribute_map[key]].nil? transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]]) end end new(transformed_hash) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
99 100 101 102 |
# File 'lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb', line 99 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
85 86 87 88 89 90 91 92 93 94 95 96 |
# File 'lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb', line 85 def self.openapi_types { :'notes_spacing_coeff' => :'Float', :'length_unit' => :'String', :'page_height' => :'Float', :'page_width' => :'Float', :'page_margin_top' => :'Float', :'page_margin_bottom' => :'Float', :'page_margin_left' => :'Float', :'page_margin_right' => :'Float' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
183 184 185 186 187 188 189 190 191 192 193 194 |
# File 'lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb', line 183 def ==(o) return true if self.equal?(o) self.class == o.class && notes_spacing_coeff == o.notes_spacing_coeff && length_unit == o.length_unit && page_height == o.page_height && page_width == o.page_width && page_margin_top == o.page_margin_top && page_margin_bottom == o.page_margin_bottom && page_margin_left == o.page_margin_left && page_margin_right == o.page_margin_right end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
306 307 308 309 310 311 312 313 314 315 316 317 318 |
# File 'lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb', line 306 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end |
#eql?(o) ⇒ Boolean
198 199 200 |
# File 'lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb', line 198 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
204 205 206 |
# File 'lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb', line 204 def hash [notes_spacing_coeff, length_unit, page_height, page_width, page_margin_top, page_margin_bottom, page_margin_left, page_margin_right].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
156 157 158 159 160 |
# File 'lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb', line 156 def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
282 283 284 |
# File 'lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb', line 282 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
288 289 290 291 292 293 294 295 296 297 298 299 300 |
# File 'lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb', line 288 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
276 277 278 |
# File 'lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb', line 276 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
164 165 166 167 168 169 |
# File 'lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb', line 164 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' length_unit_validator = EnumAttributeValidator.new('String', ["cm", "inch"]) return false unless length_unit_validator.valid?(@length_unit) true end |