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
The identififer 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
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
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
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 |
# File 'lib/flat_api/models/score_comment_context.rb', line 64 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} if attributes.has_key?(:'partUuid') self.part_uuid = attributes[:'partUuid'] end if attributes.has_key?(:'staffIdx') self.staff_idx = attributes[:'staffIdx'] end if attributes.has_key?(:'measureUuids') if (value = attributes[:'measureUuids']).is_a?(Array) self.measure_uuids = value end end if attributes.has_key?(:'startTimePos') self.start_time_pos = attributes[:'startTimePos'] end if attributes.has_key?(:'stopTimePos') self.stop_time_pos = attributes[:'stopTimePos'] end if attributes.has_key?(:'startDpq') self.start_dpq = attributes[:'startDpq'] end if attributes.has_key?(:'stopDpq') self.stop_dpq = attributes[:'stopDpq'] end end |
Instance Attribute Details
#measure_uuids ⇒ Object
The list of measure UUIds
25 26 27 |
# File 'lib/flat_api/models/score_comment_context.rb', line 25 def measure_uuids @measure_uuids end |
#part_uuid ⇒ Object
The unique identifier (UUID) of the score part
19 20 21 |
# File 'lib/flat_api/models/score_comment_context.rb', line 19 def part_uuid @part_uuid end |
#staff_idx ⇒ Object
The identififer of the staff
22 23 24 |
# File 'lib/flat_api/models/score_comment_context.rb', line 22 def staff_idx @staff_idx end |
#start_dpq ⇒ Object
Returns the value of attribute start_dpq.
31 32 33 |
# File 'lib/flat_api/models/score_comment_context.rb', line 31 def start_dpq @start_dpq end |
#start_time_pos ⇒ Object
Returns the value of attribute start_time_pos.
27 28 29 |
# File 'lib/flat_api/models/score_comment_context.rb', line 27 def start_time_pos @start_time_pos end |
#stop_dpq ⇒ Object
Returns the value of attribute stop_dpq.
33 34 35 |
# File 'lib/flat_api/models/score_comment_context.rb', line 33 def stop_dpq @stop_dpq end |
#stop_time_pos ⇒ Object
Returns the value of attribute stop_time_pos.
29 30 31 |
# File 'lib/flat_api/models/score_comment_context.rb', line 29 def stop_time_pos @stop_time_pos end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
37 38 39 40 41 42 43 44 45 46 47 |
# File 'lib/flat_api/models/score_comment_context.rb', line 37 def self.attribute_map { :'part_uuid' => :'partUuid', :'staff_idx' => :'staffIdx', :'measure_uuids' => :'measureUuids', :'start_time_pos' => :'startTimePos', :'stop_time_pos' => :'stopTimePos', :'start_dpq' => :'startDpq', :'stop_dpq' => :'stopDpq' } end |
.swagger_types ⇒ Object
Attribute type mapping.
50 51 52 53 54 55 56 57 58 59 60 |
# File 'lib/flat_api/models/score_comment_context.rb', line 50 def self.swagger_types { :'part_uuid' => :'String', :'staff_idx' => :'Float', :'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.
152 153 154 155 156 157 158 159 160 161 162 |
# File 'lib/flat_api/models/score_comment_context.rb', line 152 def ==(o) return true if self.equal?(o) self.class == o.class && part_uuid == o.part_uuid && staff_idx == o.staff_idx && 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 |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 |
# File 'lib/flat_api/models/score_comment_context.rb', line 200 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.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 temp_model = FlatApi.const_get(type).new temp_model.build_from_hash(value) end end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
266 267 268 269 270 271 272 273 274 275 276 277 278 |
# File 'lib/flat_api/models/score_comment_context.rb', line 266 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 |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 |
# File 'lib/flat_api/models/score_comment_context.rb', line 179 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(o) ⇒ Boolean
166 167 168 |
# File 'lib/flat_api/models/score_comment_context.rb', line 166 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
172 173 174 |
# File 'lib/flat_api/models/score_comment_context.rb', line 172 def hash [part_uuid, staff_idx, 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?
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 |
# File 'lib/flat_api/models/score_comment_context.rb', line 104 def list_invalid_properties invalid_properties = Array.new if @part_uuid.nil? invalid_properties.push("invalid value for 'part_uuid', part_uuid cannot be nil.") end if @staff_idx.nil? invalid_properties.push("invalid value for 'staff_idx', staff_idx 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 return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
246 247 248 |
# File 'lib/flat_api/models/score_comment_context.rb', line 246 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
252 253 254 255 256 257 258 259 260 |
# File 'lib/flat_api/models/score_comment_context.rb', line 252 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
240 241 242 |
# File 'lib/flat_api/models/score_comment_context.rb', line 240 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
139 140 141 142 143 144 145 146 147 148 |
# File 'lib/flat_api/models/score_comment_context.rb', line 139 def valid? return false if @part_uuid.nil? return false if @staff_idx.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? return true end |