Class: EsiClient::GetCharactersCharacterIdPlanetsPlanetIdRoute

Inherits:
Object
  • Object
show all
Defined in:
lib/esi-ruby/models/get_characters_character_id_planets_planet_id_route.rb

Overview

route object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetCharactersCharacterIdPlanetsPlanetIdRoute

Initializes the object

Parameters:

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

    Model attributes in the form of hash



62
63
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
# File 'lib/esi-ruby/models/get_characters_character_id_planets_planet_id_route.rb', line 62

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?(:'content_type_id')
    self.content_type_id = attributes[:'content_type_id']
  end

  if attributes.has_key?(:'destination_pin_id')
    self.destination_pin_id = attributes[:'destination_pin_id']
  end

  if attributes.has_key?(:'quantity')
    self.quantity = attributes[:'quantity']
  end

  if attributes.has_key?(:'route_id')
    self.route_id = attributes[:'route_id']
  end

  if attributes.has_key?(:'source_pin_id')
    self.source_pin_id = attributes[:'source_pin_id']
  end

  if attributes.has_key?(:'waypoints')
    if (value = attributes[:'waypoints']).is_a?(Array)
      self.waypoints = value
    end
  end

end

Instance Attribute Details

#content_type_idObject

content_type_id integer



18
19
20
# File 'lib/esi-ruby/models/get_characters_character_id_planets_planet_id_route.rb', line 18

def content_type_id
  @content_type_id
end

#destination_pin_idObject

destination_pin_id integer



21
22
23
# File 'lib/esi-ruby/models/get_characters_character_id_planets_planet_id_route.rb', line 21

def destination_pin_id
  @destination_pin_id
end

#quantityObject

quantity number



24
25
26
# File 'lib/esi-ruby/models/get_characters_character_id_planets_planet_id_route.rb', line 24

def quantity
  @quantity
end

#route_idObject

route_id integer



27
28
29
# File 'lib/esi-ruby/models/get_characters_character_id_planets_planet_id_route.rb', line 27

def route_id
  @route_id
end

#source_pin_idObject

source_pin_id integer



30
31
32
# File 'lib/esi-ruby/models/get_characters_character_id_planets_planet_id_route.rb', line 30

def source_pin_id
  @source_pin_id
end

#waypointsObject

waypoints array



33
34
35
# File 'lib/esi-ruby/models/get_characters_character_id_planets_planet_id_route.rb', line 33

def waypoints
  @waypoints
end

Class Method Details

.attribute_mapObject

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



37
38
39
40
41
42
43
44
45
46
# File 'lib/esi-ruby/models/get_characters_character_id_planets_planet_id_route.rb', line 37

def self.attribute_map
  {
    :'content_type_id' => :'content_type_id',
    :'destination_pin_id' => :'destination_pin_id',
    :'quantity' => :'quantity',
    :'route_id' => :'route_id',
    :'source_pin_id' => :'source_pin_id',
    :'waypoints' => :'waypoints'
  }
end

.swagger_typesObject

Attribute type mapping.



49
50
51
52
53
54
55
56
57
58
# File 'lib/esi-ruby/models/get_characters_character_id_planets_planet_id_route.rb', line 49

def self.swagger_types
  {
    :'content_type_id' => :'Integer',
    :'destination_pin_id' => :'Integer',
    :'quantity' => :'Float',
    :'route_id' => :'Integer',
    :'source_pin_id' => :'Integer',
    :'waypoints' => :'Array<GetCharactersCharacterIdPlanetsPlanetIdWaypoint>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



136
137
138
139
140
141
142
143
144
145
# File 'lib/esi-ruby/models/get_characters_character_id_planets_planet_id_route.rb', line 136

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      content_type_id == o.content_type_id &&
      destination_pin_id == o.destination_pin_id &&
      quantity == o.quantity &&
      route_id == o.route_id &&
      source_pin_id == o.source_pin_id &&
      waypoints == o.waypoints
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



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
# File 'lib/esi-ruby/models/get_characters_character_id_planets_planet_id_route.rb', line 183

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 = EsiClient.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

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash



249
250
251
252
253
254
255
256
257
258
259
260
261
# File 'lib/esi-ruby/models/get_characters_character_id_planets_planet_id_route.rb', line 249

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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
# File 'lib/esi-ruby/models/get_characters_character_id_planets_planet_id_route.rb', line 162

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

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


149
150
151
# File 'lib/esi-ruby/models/get_characters_character_id_planets_planet_id_route.rb', line 149

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



155
156
157
# File 'lib/esi-ruby/models/get_characters_character_id_planets_planet_id_route.rb', line 155

def hash
  [content_type_id, destination_pin_id, quantity, route_id, source_pin_id, waypoints].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properies with the reasons



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# File 'lib/esi-ruby/models/get_characters_character_id_planets_planet_id_route.rb', line 98

def list_invalid_properties
  invalid_properties = Array.new
  if @content_type_id.nil?
    invalid_properties.push("invalid value for 'content_type_id', content_type_id cannot be nil.")
  end

  if @destination_pin_id.nil?
    invalid_properties.push("invalid value for 'destination_pin_id', destination_pin_id cannot be nil.")
  end

  if @quantity.nil?
    invalid_properties.push("invalid value for 'quantity', quantity cannot be nil.")
  end

  if @route_id.nil?
    invalid_properties.push("invalid value for 'route_id', route_id cannot be nil.")
  end

  if @source_pin_id.nil?
    invalid_properties.push("invalid value for 'source_pin_id', source_pin_id cannot be nil.")
  end

  return invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



229
230
231
# File 'lib/esi-ruby/models/get_characters_character_id_planets_planet_id_route.rb', line 229

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



235
236
237
238
239
240
241
242
243
# File 'lib/esi-ruby/models/get_characters_character_id_planets_planet_id_route.rb', line 235

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



223
224
225
# File 'lib/esi-ruby/models/get_characters_character_id_planets_planet_id_route.rb', line 223

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



125
126
127
128
129
130
131
132
# File 'lib/esi-ruby/models/get_characters_character_id_planets_planet_id_route.rb', line 125

def valid?
  return false if @content_type_id.nil?
  return false if @destination_pin_id.nil?
  return false if @quantity.nil?
  return false if @route_id.nil?
  return false if @source_pin_id.nil?
  return true
end