Class: NucleusApi::ModelHolding

Inherits:
Object
  • Object
show all
Defined in:
lib/nucleus_api/models/model_holding.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ModelHolding

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
150
151
152
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
 
# File 'lib/nucleus_api/models/model_holding.rb', line 112

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#create_date ⇒ Object

Returns the value of attribute create_date.



17
18
19
 
# File 'lib/nucleus_api/models/model_holding.rb', line 17

def create_date
  @create_date
end

#current_weight ⇒ Object

Model Holding current weight



20
21
22
 
# File 'lib/nucleus_api/models/model_holding.rb', line 20

def current_weight
  @current_weight
end

#date ⇒ Object

Model Holding date



23
24
25
 
# File 'lib/nucleus_api/models/model_holding.rb', line 23

def date
  @date
end

#drift_factor ⇒ Object

driftFactor



26
27
28
 
# File 'lib/nucleus_api/models/model_holding.rb', line 26

def drift_factor
  @drift_factor
end

#id ⇒ Object

Returns the value of attribute id.



28
29
30
 
# File 'lib/nucleus_api/models/model_holding.rb', line 28

def id
  @id
end

#is_cash ⇒ Object

isCash



31
32
33
 
# File 'lib/nucleus_api/models/model_holding.rb', line 31

def is_cash
  @is_cash
end

#is_initial_holding ⇒ Object

isInitialHolding



34
35
36
 
# File 'lib/nucleus_api/models/model_holding.rb', line 34

def is_initial_holding
  @is_initial_holding
end

#is_safe_security ⇒ Object

isSafeSecurity



37
38
39
 
# File 'lib/nucleus_api/models/model_holding.rb', line 37

def is_safe_security
  @is_safe_security
end

#metadata ⇒ Object

Returns the value of attribute metadata.



39
40
41
 
# File 'lib/nucleus_api/models/model_holding.rb', line 39

def metadata
  @metadata
end

#model_description ⇒ Object

Returns the value of attribute model_description.



41
42
43
 
# File 'lib/nucleus_api/models/model_holding.rb', line 41

def model_description
  @model_description
end

#model_id ⇒ Object

modelId



44
45
46
 
# File 'lib/nucleus_api/models/model_holding.rb', line 44

def model_id
  @model_id
end

#model_name ⇒ Object

Returns the value of attribute model_name.



46
47
48
 
# File 'lib/nucleus_api/models/model_holding.rb', line 46

def model_name
  @model_name
end

#model_weight ⇒ Object

Returns the value of attribute model_weight.



48
49
50
 
# File 'lib/nucleus_api/models/model_holding.rb', line 48

def model_weight
  @model_weight
end

#sec_price ⇒ Object

Returns the value of attribute sec_price.



50
51
52
 
# File 'lib/nucleus_api/models/model_holding.rb', line 50

def sec_price
  @sec_price
end

#secondary_id ⇒ Object

Returns the value of attribute secondary_id.



52
53
54
 
# File 'lib/nucleus_api/models/model_holding.rb', line 52

def secondary_id
  @secondary_id
end

#security_id ⇒ Object

securityId



55
56
57
 
# File 'lib/nucleus_api/models/model_holding.rb', line 55

def security_id
  @security_id
end

#strategic_weight ⇒ Object

Model Holding strategicWeight



58
59
60
 
# File 'lib/nucleus_api/models/model_holding.rb', line 58

def strategic_weight
  @strategic_weight
end

#update_date ⇒ Object

Returns the value of attribute update_date.



60
61
62
 
# File 'lib/nucleus_api/models/model_holding.rb', line 60

def update_date
  @update_date
end

Class Method Details

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/nucleus_api/models/model_holding.rb', line 63

def self.attribute_map
  {
    :'create_date' => :'create_date',
    :'current_weight' => :'current_weight',
    :'date' => :'date',
    :'drift_factor' => :'drift_factor',
    :'id' => :'id',
    :'is_cash' => :'is_cash',
    :'is_initial_holding' => :'is_initial_holding',
    :'is_safe_security' => :'is_safe_security',
    :'metadata' => :'metadata',
    :'model_description' => :'model_description',
    :'model_id' => :'model_id',
    :'model_name' => :'model_name',
    :'model_weight' => :'model_weight',
    :'sec_price' => :'sec_price',
    :'secondary_id' => :'secondary_id',
    :'security_id' => :'security_id',
    :'strategic_weight' => :'strategic_weight',
    :'update_date' => :'update_date'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/nucleus_api/models/model_holding.rb', line 87

def self.swagger_types
  {
    :'create_date' => :'DateTime',
    :'current_weight' => :'Float',
    :'date' => :'Date',
    :'drift_factor' => :'Float',
    :'id' => :'String',
    :'is_cash' => :'BOOLEAN',
    :'is_initial_holding' => :'BOOLEAN',
    :'is_safe_security' => :'BOOLEAN',
    :'metadata' => :'Hash<String, String>',
    :'model_description' => :'String',
    :'model_id' => :'String',
    :'model_name' => :'String',
    :'model_weight' => :'Float',
    :'sec_price' => :'Float',
    :'secondary_id' => :'String',
    :'security_id' => :'String',
    :'strategic_weight' => :'Float',
    :'update_date' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/nucleus_api/models/model_holding.rb', line 233

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      create_date == o.create_date &&
      current_weight == o.current_weight &&
      date == o.date &&
      drift_factor == o.drift_factor &&
      id == o.id &&
      is_cash == o.is_cash &&
      is_initial_holding == o.is_initial_holding &&
      is_safe_security == o.is_safe_security &&
      metadata == o.metadata &&
      model_description == o.model_description &&
      model_id == o.model_id &&
      model_name == o.model_name &&
      model_weight == o.model_weight &&
      sec_price == o.sec_price &&
      secondary_id == o.secondary_id &&
      security_id == o.security_id &&
      strategic_weight == o.strategic_weight &&
      update_date == o.update_date
end

#_deserialize(type, value) ⇒ Object

Returns Deserialized data.

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/nucleus_api/models/model_holding.rb', line 290

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    (value)
  when :Date
    (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 = NucleusApi.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



356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/nucleus_api/models/model_holding.rb', line 356

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



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/nucleus_api/models/model_holding.rb', line 271

def build_from_hash(attributes)
  self.class.swagger_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]]))
    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


258
259
260
 
# File 'lib/nucleus_api/models/model_holding.rb', line 258

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



264
265
266
 
# File 'lib/nucleus_api/models/model_holding.rb', line 264

def hash
  [create_date, current_weight, date, drift_factor, id, is_cash, is_initial_holding, is_safe_security, metadata, model_description, model_id, model_name, model_weight, sec_price, secondary_id, security_id, strategic_weight, update_date].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



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/nucleus_api/models/model_holding.rb', line 195

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

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

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

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

  if @strategic_weight.nil?
    invalid_properties.push('invalid value for "strategic_weight", strategic_weight cannot be nil.')
  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



337
338
339
 
# File 'lib/nucleus_api/models/model_holding.rb', line 337

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



343
344
345
346
347
348
349
350
 
# File 'lib/nucleus_api/models/model_holding.rb', line 343

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    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



331
332
333
 
# File 'lib/nucleus_api/models/model_holding.rb', line 331

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



222
223
224
225
226
227
228
229
 
# File 'lib/nucleus_api/models/model_holding.rb', line 222

def valid?
  return false if @current_weight.nil?
  return false if @date.nil?
  return false if @model_id.nil?
  return false if @security_id.nil?
  return false if @strategic_weight.nil?
  true
end