Class: ESI::GetDogmaEffectsEffectIdOk

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

Overview

200 ok object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetDogmaEffectsEffectIdOk

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
220
221
222
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
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 154

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `ESI::GetDogmaEffectsEffectIdOk` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `ESI::GetDogmaEffectsEffectIdOk`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

  if attributes.key?(:'effect_id')
    self.effect_id = attributes[:'effect_id']
  else
    self.effect_id = nil
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#description ⇒ Object

description string



20
21
22
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 20

def description
  @description
end

#disallow_auto_repeat ⇒ Object

disallow_auto_repeat boolean



23
24
25
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 23

def disallow_auto_repeat
  @disallow_auto_repeat
end

#discharge_attribute_id ⇒ Object

discharge_attribute_id integer



26
27
28
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 26

def discharge_attribute_id
  @discharge_attribute_id
end

#display_name ⇒ Object

display_name string



29
30
31
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 29

def display_name
  @display_name
end

#duration_attribute_id ⇒ Object

duration_attribute_id integer



32
33
34
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 32

def duration_attribute_id
  @duration_attribute_id
end

#effect_category ⇒ Object

effect_category integer



35
36
37
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 35

def effect_category
  @effect_category
end

#effect_id ⇒ Object

effect_id integer



38
39
40
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 38

def effect_id
  @effect_id
end

#electronic_chance ⇒ Object

electronic_chance boolean



41
42
43
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 41

def electronic_chance
  @electronic_chance
end

#falloff_attribute_id ⇒ Object

falloff_attribute_id integer



44
45
46
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 44

def falloff_attribute_id
  @falloff_attribute_id
end

#icon_id ⇒ Object

icon_id integer



47
48
49
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 47

def icon_id
  @icon_id
end

#is_assistance ⇒ Object

is_assistance boolean



50
51
52
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 50

def is_assistance
  @is_assistance
end

#is_offensive ⇒ Object

is_offensive boolean



53
54
55
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 53

def is_offensive
  @is_offensive
end

#is_warp_safe ⇒ Object

is_warp_safe boolean



56
57
58
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 56

def is_warp_safe
  @is_warp_safe
end

#modifiers ⇒ Object

modifiers array



59
60
61
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 59

def modifiers
  @modifiers
end

#name ⇒ Object

name string



62
63
64
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 62

def name
  @name
end

#post_expression ⇒ Object

post_expression integer



65
66
67
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 65

def post_expression
  @post_expression
end

#pre_expression ⇒ Object

pre_expression integer



68
69
70
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 68

def pre_expression
  @pre_expression
end

#published ⇒ Object

published boolean



71
72
73
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 71

def published
  @published
end

#range_attribute_id ⇒ Object

range_attribute_id integer



74
75
76
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 74

def range_attribute_id
  @range_attribute_id
end

#range_chance ⇒ Object

range_chance boolean



77
78
79
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 77

def range_chance
  @range_chance
end

#tracking_speed_attribute_id ⇒ Object

tracking_speed_attribute_id integer



80
81
82
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 80

def tracking_speed_attribute_id
  @tracking_speed_attribute_id
end

Class Method Details

._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



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 373

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = ESI.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



110
111
112
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 110

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



115
116
117
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 115

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 83

def self.attribute_map
  {
    :'description' => :'description',
    :'disallow_auto_repeat' => :'disallow_auto_repeat',
    :'discharge_attribute_id' => :'discharge_attribute_id',
    :'display_name' => :'display_name',
    :'duration_attribute_id' => :'duration_attribute_id',
    :'effect_category' => :'effect_category',
    :'effect_id' => :'effect_id',
    :'electronic_chance' => :'electronic_chance',
    :'falloff_attribute_id' => :'falloff_attribute_id',
    :'icon_id' => :'icon_id',
    :'is_assistance' => :'is_assistance',
    :'is_offensive' => :'is_offensive',
    :'is_warp_safe' => :'is_warp_safe',
    :'modifiers' => :'modifiers',
    :'name' => :'name',
    :'post_expression' => :'post_expression',
    :'pre_expression' => :'pre_expression',
    :'published' => :'published',
    :'range_attribute_id' => :'range_attribute_id',
    :'range_chance' => :'range_chance',
    :'tracking_speed_attribute_id' => :'tracking_speed_attribute_id'
  }
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



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 349

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



147
148
149
150
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 147

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 120

def self.openapi_types
  {
    :'description' => :'String',
    :'disallow_auto_repeat' => :'Boolean',
    :'discharge_attribute_id' => :'Integer',
    :'display_name' => :'String',
    :'duration_attribute_id' => :'Integer',
    :'effect_category' => :'Integer',
    :'effect_id' => :'Integer',
    :'electronic_chance' => :'Boolean',
    :'falloff_attribute_id' => :'Integer',
    :'icon_id' => :'Integer',
    :'is_assistance' => :'Boolean',
    :'is_offensive' => :'Boolean',
    :'is_warp_safe' => :'Boolean',
    :'modifiers' => :'Array<GetDogmaEffectsEffectIdModifier>',
    :'name' => :'String',
    :'post_expression' => :'Integer',
    :'pre_expression' => :'Integer',
    :'published' => :'Boolean',
    :'range_attribute_id' => :'Integer',
    :'range_chance' => :'Boolean',
    :'tracking_speed_attribute_id' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 308

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      description == o.description &&
      disallow_auto_repeat == o.disallow_auto_repeat &&
      discharge_attribute_id == o.discharge_attribute_id &&
      display_name == o.display_name &&
      duration_attribute_id == o.duration_attribute_id &&
      effect_category == o.effect_category &&
      effect_id == o.effect_id &&
      electronic_chance == o.electronic_chance &&
      falloff_attribute_id == o.falloff_attribute_id &&
      icon_id == o.icon_id &&
      is_assistance == o.is_assistance &&
      is_offensive == o.is_offensive &&
      is_warp_safe == o.is_warp_safe &&
      modifiers == o.modifiers &&
      name == o.name &&
      post_expression == o.post_expression &&
      pre_expression == o.pre_expression &&
      published == o.published &&
      range_attribute_id == o.range_attribute_id &&
      range_chance == o.range_chance &&
      tracking_speed_attribute_id == o.tracking_speed_attribute_id
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



444
445
446
447
448
449
450
451
452
453
454
455
456
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 444

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


336
337
338
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 336

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



342
343
344
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 342

def hash
  [description, disallow_auto_repeat, discharge_attribute_id, display_name, duration_attribute_id, effect_category, effect_id, electronic_chance, falloff_attribute_id, icon_id, is_assistance, is_offensive, is_warp_safe, modifiers, name, post_expression, pre_expression, published, range_attribute_id, range_chance, tracking_speed_attribute_id].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



259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 259

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @effect_id.nil?
    invalid_properties.push('invalid value for "effect_id", effect_id cannot be nil.')
  end

  if !@modifiers.nil? && @modifiers.length > 100
    invalid_properties.push('invalid value for "modifiers", number of items must be less than or equal to 100.')
  end

  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



420
421
422
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 420

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



426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 426

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



414
415
416
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 414

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



275
276
277
278
279
280
 
# File 'lib/ruby-esi/models/get_dogma_effects_effect_id_ok.rb', line 275

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @effect_id.nil?
  return false if !@modifiers.nil? && @modifiers.length > 100
  true
end