Class: EsiClient::GetCharactersCharacterIdBlueprints200Ok

Inherits:
Object
  • Object
show all
Defined in:
lib/esi-ruby/models/get_characters_character_id_blueprints_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 = {}) ⇒ GetCharactersCharacterIdBlueprints200Ok

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#item_id ⇒ Object

Unique ID for this item. The ID of an item is stable if that item is not repackaged, stacked, detached from a stack, assembled, or otherwise altered. If an item is changed in one of these ways, then the ID will also change (see notes below).



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

def item_id
  @item_id
end

#location_flag ⇒ Object

Indicates something about this item’s storage location. The flag is used to differentiate between hangar divisions, drone bay, fitting location, and similar.



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

def location_flag
  @location_flag
end

#location_id ⇒ Object

References a solar system, station or itemID if this blueprint is located within a container. If an itemID the Character - AssetList API must be queried to find the container using the itemID, from which the correct location of the Blueprint can be derived.



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

def location_id
  @location_id
end

#material_efficiency ⇒ Object

Material Efficiency Level of the blueprint, can be any integer between 0 and 10.



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

def material_efficiency
  @material_efficiency
end

#quantity ⇒ Object

Typically will be -1 or -2 designating a singleton item, where -1 is an original and -2 is a copy. It can be a positive integer if it is a stack of blueprint originals fresh from the market (no activities performed on them yet).



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

def quantity
  @quantity
end

#runs ⇒ Object

Number of runs remaining if the blueprint is a copy, -1 if it is an original.



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

def runs
  @runs
end

#time_efficiency ⇒ Object

Time Efficiency Level of the blueprint, can be any even integer between 0 and 20.



36
37
38
 
# File 'lib/esi-ruby/models/get_characters_character_id_blueprints_200_ok.rb', line 36

def time_efficiency
  @time_efficiency
end

#type_id ⇒ Object

type_id integer



39
40
41
 
# File 'lib/esi-ruby/models/get_characters_character_id_blueprints_200_ok.rb', line 39

def type_id
  @type_id
end

Class Method Details

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/esi-ruby/models/get_characters_character_id_blueprints_200_ok.rb', line 64

def self.attribute_map
  {
    :'item_id' => :'item_id',
    :'location_flag' => :'location_flag',
    :'location_id' => :'location_id',
    :'material_efficiency' => :'material_efficiency',
    :'quantity' => :'quantity',
    :'runs' => :'runs',
    :'time_efficiency' => :'time_efficiency',
    :'type_id' => :'type_id'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/esi-ruby/models/get_characters_character_id_blueprints_200_ok.rb', line 78

def self.swagger_types
  {
    :'item_id' => :'Integer',
    :'location_flag' => :'String',
    :'location_id' => :'Integer',
    :'material_efficiency' => :'Integer',
    :'quantity' => :'Integer',
    :'runs' => :'Integer',
    :'time_efficiency' => :'Integer',
    :'type_id' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/esi-ruby/models/get_characters_character_id_blueprints_200_ok.rb', line 200

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      item_id == o.item_id &&
      location_flag == o.location_flag &&
      location_id == o.location_id &&
      material_efficiency == o.material_efficiency &&
      quantity == o.quantity &&
      runs == o.runs &&
      time_efficiency == o.time_efficiency &&
      type_id == o.type_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



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
277
278
279
280
281
282
283
284
285
 
# File 'lib/esi-ruby/models/get_characters_character_id_blueprints_200_ok.rb', line 249

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



315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/esi-ruby/models/get_characters_character_id_blueprints_200_ok.rb', line 315

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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/esi-ruby/models/get_characters_character_id_blueprints_200_ok.rb', line 228

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


215
216
217
 
# File 'lib/esi-ruby/models/get_characters_character_id_blueprints_200_ok.rb', line 215

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



221
222
223
 
# File 'lib/esi-ruby/models/get_characters_character_id_blueprints_200_ok.rb', line 221

def hash
  [item_id, location_flag, location_id, material_efficiency, quantity, runs, time_efficiency, type_id].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



135
136
137
138
139
140
141
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/esi-ruby/models/get_characters_character_id_blueprints_200_ok.rb', line 135

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

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

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

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

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

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

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

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

  return 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



295
296
297
 
# File 'lib/esi-ruby/models/get_characters_character_id_blueprints_200_ok.rb', line 295

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



301
302
303
304
305
306
307
308
309
 
# File 'lib/esi-ruby/models/get_characters_character_id_blueprints_200_ok.rb', line 301

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

Returns:

  • (String) —

    String presentation of the object



289
290
291
 
# File 'lib/esi-ruby/models/get_characters_character_id_blueprints_200_ok.rb', line 289

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



174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/esi-ruby/models/get_characters_character_id_blueprints_200_ok.rb', line 174

def valid?
  return false if @item_id.nil?
  return false if @location_flag.nil?
  location_flag_validator = EnumAttributeValidator.new('String', ["AutoFit", "Cargo", "CorpseBay", "DroneBay", "FleetHangar", "Deliveries", "HiddenModifiers", "Hangar", "HangarAll", "LoSlot0", "LoSlot1", "LoSlot2", "LoSlot3", "LoSlot4", "LoSlot5", "LoSlot6", "LoSlot7", "MedSlot0", "MedSlot1", "MedSlot2", "MedSlot3", "MedSlot4", "MedSlot5", "MedSlot6", "MedSlot7", "HiSlot0", "HiSlot1", "HiSlot2", "HiSlot3", "HiSlot4", "HiSlot5", "HiSlot6", "HiSlot7", "AssetSafety", "Locked", "Unlocked", "Implant", "QuafeBay", "RigSlot0", "RigSlot1", "RigSlot2", "RigSlot3", "RigSlot4", "RigSlot5", "RigSlot6", "RigSlot7", "ShipHangar", "SpecializedFuelBay", "SpecializedOreHold", "SpecializedGasHold", "SpecializedMineralHold", "SpecializedSalvageHold", "SpecializedShipHold", "SpecializedSmallShipHold", "SpecializedMediumShipHold", "SpecializedLargeShipHold", "SpecializedIndustrialShipHold", "SpecializedAmmoHold", "SpecializedCommandCenterHold", "SpecializedPlanetaryCommoditiesHold", "SpecializedMaterialBay", "SubSystemSlot0", "SubSystemSlot1", "SubSystemSlot2", "SubSystemSlot3", "SubSystemSlot4", "SubSystemSlot5", "SubSystemSlot6", "SubSystemSlot7", "FighterBay", "FighterTube0", "FighterTube1", "FighterTube2", "FighterTube3", "FighterTube4", "Module"])
  return false unless location_flag_validator.valid?(@location_flag)
  return false if @location_id.nil?
  return false if @material_efficiency.nil?
  return false if @quantity.nil?
  return false if @runs.nil?
  return false if @time_efficiency.nil?
  return false if @type_id.nil?
  return true
end