Class: FlatApi::ScoreCommentContext
- Inherits:
-
Object
- Object
- FlatApi::ScoreCommentContext
- Defined in:
- lib/flat_api/models/score_comment_context.rb
Overview
The context of the comment (for inline/contextualized comments). A context will include all the information related to the location of the comment (i.e. score parts, range of measure, time position).
Instance Attribute Summary collapse
-
#measure_uuids ⇒ Object
The list of measure UUIds.
-
#part_uuid ⇒ Object
The unique identifier (UUID) of the score part.
-
#staff_idx ⇒ Object
(Deprecated, use ‘staffUuid`) The identififer of the staff.
-
#staff_uuid ⇒ Object
The unique identififer (UUID) of the staff.
-
#start_dpq ⇒ Object
Returns the value of attribute start_dpq.
-
#start_time_pos ⇒ Object
Returns the value of attribute start_time_pos.
-
#stop_dpq ⇒ Object
Returns the value of attribute stop_dpq.
-
#stop_time_pos ⇒ Object
Returns the value of attribute stop_time_pos.
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 = {}) ⇒ ScoreCommentContext
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 = {}) ⇒ ScoreCommentContext
Initializes the object
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 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 |
# File 'lib/flat_api/models/score_comment_context.rb', line 80 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `FlatApi::ScoreCommentContext` 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::ScoreCommentContext`. 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?(:'part_uuid') self.part_uuid = attributes[:'part_uuid'] else self.part_uuid = nil end if attributes.key?(:'staff_idx') self.staff_idx = attributes[:'staff_idx'] end if attributes.key?(:'staff_uuid') self.staff_uuid = attributes[:'staff_uuid'] end if attributes.key?(:'measure_uuids') if (value = attributes[:'measure_uuids']).is_a?(Array) self.measure_uuids = value end else self.measure_uuids = nil end if attributes.key?(:'start_time_pos') self.start_time_pos = attributes[:'start_time_pos'] else self.start_time_pos = nil end if attributes.key?(:'stop_time_pos') self.stop_time_pos = attributes[:'stop_time_pos'] else self.stop_time_pos = nil end if attributes.key?(:'start_dpq') self.start_dpq = attributes[:'start_dpq'] else self.start_dpq = nil end if attributes.key?(:'stop_dpq') self.stop_dpq = attributes[:'stop_dpq'] else self.stop_dpq = nil end end |
Instance Attribute Details
#measure_uuids ⇒ Object
The list of measure UUIds
29 30 31 |
# File 'lib/flat_api/models/score_comment_context.rb', line 29 def measure_uuids @measure_uuids end |
#part_uuid ⇒ Object
The unique identifier (UUID) of the score part
20 21 22 |
# File 'lib/flat_api/models/score_comment_context.rb', line 20 def part_uuid @part_uuid end |
#staff_idx ⇒ Object
(Deprecated, use ‘staffUuid`) The identififer of the staff
23 24 25 |
# File 'lib/flat_api/models/score_comment_context.rb', line 23 def staff_idx @staff_idx end |
#staff_uuid ⇒ Object
The unique identififer (UUID) of the staff
26 27 28 |
# File 'lib/flat_api/models/score_comment_context.rb', line 26 def staff_uuid @staff_uuid end |
#start_dpq ⇒ Object
Returns the value of attribute start_dpq.
35 36 37 |
# File 'lib/flat_api/models/score_comment_context.rb', line 35 def start_dpq @start_dpq end |
#start_time_pos ⇒ Object
Returns the value of attribute start_time_pos.
31 32 33 |
# File 'lib/flat_api/models/score_comment_context.rb', line 31 def start_time_pos @start_time_pos end |
#stop_dpq ⇒ Object
Returns the value of attribute stop_dpq.
37 38 39 |
# File 'lib/flat_api/models/score_comment_context.rb', line 37 def stop_dpq @stop_dpq end |
#stop_time_pos ⇒ Object
Returns the value of attribute stop_time_pos.
33 34 35 |
# File 'lib/flat_api/models/score_comment_context.rb', line 33 def stop_time_pos @stop_time_pos end |
Class Method Details
._deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 273 274 275 276 |
# File 'lib/flat_api/models/score_comment_context.rb', line 239 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
54 55 56 |
# File 'lib/flat_api/models/score_comment_context.rb', line 54 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
40 41 42 43 44 45 46 47 48 49 50 51 |
# File 'lib/flat_api/models/score_comment_context.rb', line 40 def self.attribute_map { :'part_uuid' => :'partUuid', :'staff_idx' => :'staffIdx', :'staff_uuid' => :'staffUuid', :'measure_uuids' => :'measureUuids', :'start_time_pos' => :'startTimePos', :'stop_time_pos' => :'stopTimePos', :'start_dpq' => :'startDpq', :'stop_dpq' => :'stopDpq' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 |
# File 'lib/flat_api/models/score_comment_context.rb', line 215 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
73 74 75 76 |
# File 'lib/flat_api/models/score_comment_context.rb', line 73 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
59 60 61 62 63 64 65 66 67 68 69 70 |
# File 'lib/flat_api/models/score_comment_context.rb', line 59 def self.openapi_types { :'part_uuid' => :'String', :'staff_idx' => :'Float', :'staff_uuid' => :'String', :'measure_uuids' => :'Array<String>', :'start_time_pos' => :'Float', :'stop_time_pos' => :'Float', :'start_dpq' => :'Float', :'stop_dpq' => :'Float' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
187 188 189 190 191 192 193 194 195 196 197 198 |
# File 'lib/flat_api/models/score_comment_context.rb', line 187 def ==(o) return true if self.equal?(o) self.class == o.class && part_uuid == o.part_uuid && staff_idx == o.staff_idx && staff_uuid == o.staff_uuid && measure_uuids == o.measure_uuids && start_time_pos == o.start_time_pos && stop_time_pos == o.stop_time_pos && start_dpq == o.start_dpq && stop_dpq == o.stop_dpq end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
310 311 312 313 314 315 316 317 318 319 320 321 322 |
# File 'lib/flat_api/models/score_comment_context.rb', line 310 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
202 203 204 |
# File 'lib/flat_api/models/score_comment_context.rb', line 202 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
208 209 210 |
# File 'lib/flat_api/models/score_comment_context.rb', line 208 def hash [part_uuid, staff_idx, staff_uuid, measure_uuids, start_time_pos, stop_time_pos, start_dpq, stop_dpq].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 |
# File 'lib/flat_api/models/score_comment_context.rb', line 142 def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new if @part_uuid.nil? invalid_properties.push('invalid value for "part_uuid", part_uuid cannot be nil.') end if @measure_uuids.nil? invalid_properties.push('invalid value for "measure_uuids", measure_uuids cannot be nil.') end if @start_time_pos.nil? invalid_properties.push('invalid value for "start_time_pos", start_time_pos cannot be nil.') end if @stop_time_pos.nil? invalid_properties.push('invalid value for "stop_time_pos", stop_time_pos cannot be nil.') end if @start_dpq.nil? invalid_properties.push('invalid value for "start_dpq", start_dpq cannot be nil.') end if @stop_dpq.nil? invalid_properties.push('invalid value for "stop_dpq", stop_dpq cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
286 287 288 |
# File 'lib/flat_api/models/score_comment_context.rb', line 286 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
292 293 294 295 296 297 298 299 300 301 302 303 304 |
# File 'lib/flat_api/models/score_comment_context.rb', line 292 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
280 281 282 |
# File 'lib/flat_api/models/score_comment_context.rb', line 280 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
174 175 176 177 178 179 180 181 182 183 |
# File 'lib/flat_api/models/score_comment_context.rb', line 174 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' return false if @part_uuid.nil? return false if @measure_uuids.nil? return false if @start_time_pos.nil? return false if @stop_time_pos.nil? return false if @start_dpq.nil? return false if @stop_dpq.nil? true end |