Class: FtcEventsClient::Envelope

Inherits:
Object
  • Object
show all
Defined in:
lib/ftc_events_client/models/envelope.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Envelope

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
139
140
141
142
143
144
 
# File 'lib/ftc_events_client/models/envelope.rb', line 84

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `FtcEventsClient::Envelope` 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 `FtcEventsClient::Envelope`. 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?(:'is_null')
    self.is_null = attributes[:'is_null']
  end

  if attributes.key?(:'width')
    self.width = attributes[:'width']
  end

  if attributes.key?(:'height')
    self.height = attributes[:'height']
  end

  if attributes.key?(:'diameter')
    self.diameter = attributes[:'diameter']
  end

  if attributes.key?(:'min_x')
    self.min_x = attributes[:'min_x']
  end

  if attributes.key?(:'max_x')
    self.max_x = attributes[:'max_x']
  end

  if attributes.key?(:'min_y')
    self.min_y = attributes[:'min_y']
  end

  if attributes.key?(:'max_y')
    self.max_y = attributes[:'max_y']
  end

  if attributes.key?(:'area')
    self.area = attributes[:'area']
  end

  if attributes.key?(:'min_extent')
    self.min_extent = attributes[:'min_extent']
  end

  if attributes.key?(:'max_extent')
    self.max_extent = attributes[:'max_extent']
  end

  if attributes.key?(:'centre')
    self.centre = attributes[:'centre']
  end
end

Instance Attribute Details

#area ⇒ Object

Returns the value of attribute area.



32
33
34
 
# File 'lib/ftc_events_client/models/envelope.rb', line 32

def area
  @area
end

#centre ⇒ Object

Returns the value of attribute centre.



38
39
40
 
# File 'lib/ftc_events_client/models/envelope.rb', line 38

def centre
  @centre
end

#diameter ⇒ Object

Returns the value of attribute diameter.



22
23
24
 
# File 'lib/ftc_events_client/models/envelope.rb', line 22

def diameter
  @diameter
end

#height ⇒ Object

Returns the value of attribute height.



20
21
22
 
# File 'lib/ftc_events_client/models/envelope.rb', line 20

def height
  @height
end

#is_null ⇒ Object

Returns the value of attribute is_null.



16
17
18
 
# File 'lib/ftc_events_client/models/envelope.rb', line 16

def is_null
  @is_null
end

#max_extent ⇒ Object

Returns the value of attribute max_extent.



36
37
38
 
# File 'lib/ftc_events_client/models/envelope.rb', line 36

def max_extent
  @max_extent
end

#max_x ⇒ Object

Returns the value of attribute max_x.



26
27
28
 
# File 'lib/ftc_events_client/models/envelope.rb', line 26

def max_x
  @max_x
end

#max_y ⇒ Object

Returns the value of attribute max_y.



30
31
32
 
# File 'lib/ftc_events_client/models/envelope.rb', line 30

def max_y
  @max_y
end

#min_extent ⇒ Object

Returns the value of attribute min_extent.



34
35
36
 
# File 'lib/ftc_events_client/models/envelope.rb', line 34

def min_extent
  @min_extent
end

#min_x ⇒ Object

Returns the value of attribute min_x.



24
25
26
 
# File 'lib/ftc_events_client/models/envelope.rb', line 24

def min_x
  @min_x
end

#min_y ⇒ Object

Returns the value of attribute min_y.



28
29
30
 
# File 'lib/ftc_events_client/models/envelope.rb', line 28

def min_y
  @min_y
end

#width ⇒ Object

Returns the value of attribute width.



18
19
20
 
# File 'lib/ftc_events_client/models/envelope.rb', line 18

def width
  @width
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/ftc_events_client/models/envelope.rb', line 41

def self.attribute_map
  {
    :'is_null' => :'isNull',
    :'width' => :'width',
    :'height' => :'height',
    :'diameter' => :'diameter',
    :'min_x' => :'minX',
    :'max_x' => :'maxX',
    :'min_y' => :'minY',
    :'max_y' => :'maxY',
    :'area' => :'area',
    :'min_extent' => :'minExtent',
    :'max_extent' => :'maxExtent',
    :'centre' => :'centre'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



193
194
195
 
# File 'lib/ftc_events_client/models/envelope.rb', line 193

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



77
78
79
80
 
# File 'lib/ftc_events_client/models/envelope.rb', line 77

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
71
72
73
74
 
# File 'lib/ftc_events_client/models/envelope.rb', line 59

def self.openapi_types
  {
    :'is_null' => :'Object',
    :'width' => :'Object',
    :'height' => :'Object',
    :'diameter' => :'Object',
    :'min_x' => :'Object',
    :'max_x' => :'Object',
    :'min_y' => :'Object',
    :'max_y' => :'Object',
    :'area' => :'Object',
    :'min_extent' => :'Object',
    :'max_extent' => :'Object',
    :'centre' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/ftc_events_client/models/envelope.rb', line 161

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      is_null == o.is_null &&
      width == o.width &&
      height == o.height &&
      diameter == o.diameter &&
      min_x == o.min_x &&
      max_x == o.max_x &&
      min_y == o.min_y &&
      max_y == o.max_y &&
      area == o.area &&
      min_extent == o.min_extent &&
      max_extent == o.max_extent &&
      centre == o.centre
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/ftc_events_client/models/envelope.rb', line 223

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
    FtcEventsClient.const_get(type).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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/ftc_events_client/models/envelope.rb', line 292

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/ftc_events_client/models/envelope.rb', line 200

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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[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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


180
181
182
 
# File 'lib/ftc_events_client/models/envelope.rb', line 180

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



186
187
188
 
# File 'lib/ftc_events_client/models/envelope.rb', line 186

def hash
  [is_null, width, height, diameter, min_x, max_x, min_y, max_y, area, min_extent, max_extent, centre].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



148
149
150
151
 
# File 'lib/ftc_events_client/models/envelope.rb', line 148

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



268
269
270
 
# File 'lib/ftc_events_client/models/envelope.rb', line 268

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/ftc_events_client/models/envelope.rb', line 274

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

Returns:

  • (String) —

    String presentation of the object



262
263
264
 
# File 'lib/ftc_events_client/models/envelope.rb', line 262

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



155
156
157
 
# File 'lib/ftc_events_client/models/envelope.rb', line 155

def valid?
  true
end