Class: ESIClient::GetFleetsFleetIdMembers200Ok

Inherits:
Object
  • Object
show all
Defined in:
lib/esi_client/models/get_fleets_fleet_id_members_200_ok.rb

Overview

200 ok object

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetFleetsFleetIdMembers200Ok

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
145
146
147
148
149
# File 'lib/esi_client/models/get_fleets_fleet_id_members_200_ok.rb', line 104

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#character_idObject

character_id integer



19
20
21
# File 'lib/esi_client/models/get_fleets_fleet_id_members_200_ok.rb', line 19

def character_id
  @character_id
end

#join_timeObject

join_time string



37
38
39
# File 'lib/esi_client/models/get_fleets_fleet_id_members_200_ok.rb', line 37

def join_time
  @join_time
end

#roleObject

Member’s role in fleet



31
32
33
# File 'lib/esi_client/models/get_fleets_fleet_id_members_200_ok.rb', line 31

def role
  @role
end

#role_nameObject

Localized role names



34
35
36
# File 'lib/esi_client/models/get_fleets_fleet_id_members_200_ok.rb', line 34

def role_name
  @role_name
end

#ship_type_idObject

ship_type_id integer



22
23
24
# File 'lib/esi_client/models/get_fleets_fleet_id_members_200_ok.rb', line 22

def ship_type_id
  @ship_type_id
end

#solar_system_idObject

Solar system the member is located in



43
44
45
# File 'lib/esi_client/models/get_fleets_fleet_id_members_200_ok.rb', line 43

def solar_system_id
  @solar_system_id
end

#squad_idObject

ID of the squad the member is in. If not applicable, will be set to -1



28
29
30
# File 'lib/esi_client/models/get_fleets_fleet_id_members_200_ok.rb', line 28

def squad_id
  @squad_id
end

#station_idObject

Station in which the member is docked in, if applicable



46
47
48
# File 'lib/esi_client/models/get_fleets_fleet_id_members_200_ok.rb', line 46

def station_id
  @station_id
end

#takes_fleet_warpObject

Whether the member take fleet warps



40
41
42
# File 'lib/esi_client/models/get_fleets_fleet_id_members_200_ok.rb', line 40

def takes_fleet_warp
  @takes_fleet_warp
end

#wing_idObject

ID of the wing the member is in. If not applicable, will be set to -1



25
26
27
# File 'lib/esi_client/models/get_fleets_fleet_id_members_200_ok.rb', line 25

def wing_id
  @wing_id
end

Class Method Details

.attribute_mapObject

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
# File 'lib/esi_client/models/get_fleets_fleet_id_members_200_ok.rb', line 71

def self.attribute_map
  {
    :'character_id' => :'character_id',
    :'ship_type_id' => :'ship_type_id',
    :'wing_id' => :'wing_id',
    :'squad_id' => :'squad_id',
    :'role' => :'role',
    :'role_name' => :'role_name',
    :'join_time' => :'join_time',
    :'takes_fleet_warp' => :'takes_fleet_warp',
    :'solar_system_id' => :'solar_system_id',
    :'station_id' => :'station_id'
  }
end

.swagger_typesObject

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
# File 'lib/esi_client/models/get_fleets_fleet_id_members_200_ok.rb', line 87

def self.swagger_types
  {
    :'character_id' => :'Integer',
    :'ship_type_id' => :'Integer',
    :'wing_id' => :'Integer',
    :'squad_id' => :'Integer',
    :'role' => :'String',
    :'role_name' => :'String',
    :'join_time' => :'DateTime',
    :'takes_fleet_warp' => :'BOOLEAN',
    :'solar_system_id' => :'Integer',
    :'station_id' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



223
224
225
226
227
228
229
230
231
232
233
234
235
236
# File 'lib/esi_client/models/get_fleets_fleet_id_members_200_ok.rb', line 223

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      character_id == o.character_id &&
      ship_type_id == o.ship_type_id &&
      wing_id == o.wing_id &&
      squad_id == o.squad_id &&
      role == o.role &&
      role_name == o.role_name &&
      join_time == o.join_time &&
      takes_fleet_warp == o.takes_fleet_warp &&
      solar_system_id == o.solar_system_id &&
      station_id == o.station_id
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



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
# File 'lib/esi_client/models/get_fleets_fleet_id_members_200_ok.rb', line 274

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



340
341
342
343
344
345
346
347
348
349
350
351
352
# File 'lib/esi_client/models/get_fleets_fleet_id_members_200_ok.rb', line 340

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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
# File 'lib/esi_client/models/get_fleets_fleet_id_members_200_ok.rb', line 253

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


240
241
242
# File 'lib/esi_client/models/get_fleets_fleet_id_members_200_ok.rb', line 240

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



246
247
248
# File 'lib/esi_client/models/get_fleets_fleet_id_members_200_ok.rb', line 246

def hash
  [character_id, ship_type_id, wing_id, squad_id, role, role_name, join_time, takes_fleet_warp, solar_system_id, station_id].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
# File 'lib/esi_client/models/get_fleets_fleet_id_members_200_ok.rb', line 153

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

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

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

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

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

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

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

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

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

  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



320
321
322
# File 'lib/esi_client/models/get_fleets_fleet_id_members_200_ok.rb', line 320

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



326
327
328
329
330
331
332
333
334
# File 'lib/esi_client/models/get_fleets_fleet_id_members_200_ok.rb', line 326

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



314
315
316
# File 'lib/esi_client/models/get_fleets_fleet_id_members_200_ok.rb', line 314

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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
# File 'lib/esi_client/models/get_fleets_fleet_id_members_200_ok.rb', line 196

def valid?
  return false if @character_id.nil?
  return false if @ship_type_id.nil?
  return false if @wing_id.nil?
  return false if @squad_id.nil?
  return false if @role.nil?
  role_validator = EnumAttributeValidator.new('String', ['fleet_commander', 'wing_commander', 'squad_commander', 'squad_member'])
  return false unless role_validator.valid?(@role)
  return false if @role_name.nil?
  return false if @join_time.nil?
  return false if @takes_fleet_warp.nil?
  return false if @solar_system_id.nil?
  true
end