Class: ProtonApi::RatioTargets1

Inherits:
Object
  • Object
show all
Defined in:
lib/proton_api/models/ratio_targets1.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RatioTargets1

Initializes the object

Parameters:

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

    Model attributes in the form of hash



55
56
57
58
59
60
61
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
95
96
 
# File 'lib/proton_api/models/ratio_targets1.rb', line 55

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

  if attributes.has_key?(:'return_on_assets')
    self.return_on_assets = attributes[:'return_on_assets']
  else
    self.return_on_assets = 0.05
  end

  if attributes.has_key?(:'debt_to_equity')
    self.debt_to_equity = attributes[:'debt_to_equity']
  else
    self.debt_to_equity = 1.5
  end

  if attributes.has_key?(:'profit_margin')
    self.profit_margin = attributes[:'profit_margin']
  else
    self.profit_margin = 0.1
  end

  if attributes.has_key?(:'debt_ratio')
    self.debt_ratio = attributes[:'debt_ratio']
  else
    self.debt_ratio = 0.5
  end

  if attributes.has_key?(:'asset_turnover')
    self.asset_turnover = attributes[:'asset_turnover']
  else
    self.asset_turnover = 1.0
  end
end

Instance Attribute Details

#asset_turnover ⇒ Object

Returns the value of attribute asset_turnover.



27
28
29
 
# File 'lib/proton_api/models/ratio_targets1.rb', line 27

def asset_turnover
  @asset_turnover
end

#debt_ratio ⇒ Object

Returns the value of attribute debt_ratio.



25
26
27
 
# File 'lib/proton_api/models/ratio_targets1.rb', line 25

def debt_ratio
  @debt_ratio
end

#debt_to_equity ⇒ Object

Returns the value of attribute debt_to_equity.



21
22
23
 
# File 'lib/proton_api/models/ratio_targets1.rb', line 21

def debt_to_equity
  @debt_to_equity
end

#profit_margin ⇒ Object

Returns the value of attribute profit_margin.



23
24
25
 
# File 'lib/proton_api/models/ratio_targets1.rb', line 23

def profit_margin
  @profit_margin
end

#return_on_assets ⇒ Object

Returns the value of attribute return_on_assets.



19
20
21
 
# File 'lib/proton_api/models/ratio_targets1.rb', line 19

def return_on_assets
  @return_on_assets
end

#return_on_equity ⇒ Object

Returns the value of attribute return_on_equity.



17
18
19
 
# File 'lib/proton_api/models/ratio_targets1.rb', line 17

def return_on_equity
  @return_on_equity
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
38
39
 
# File 'lib/proton_api/models/ratio_targets1.rb', line 30

def self.attribute_map
  {
    :'return_on_equity' => :'return_on_equity',
    :'return_on_assets' => :'return_on_assets',
    :'debt_to_equity' => :'debt_to_equity',
    :'profit_margin' => :'profit_margin',
    :'debt_ratio' => :'debt_ratio',
    :'asset_turnover' => :'asset_turnover'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



42
43
44
45
46
47
48
49
50
51
 
# File 'lib/proton_api/models/ratio_targets1.rb', line 42

def self.swagger_types
  {
    :'return_on_equity' => :'Float',
    :'return_on_assets' => :'Float',
    :'debt_to_equity' => :'Float',
    :'profit_margin' => :'Float',
    :'debt_ratio' => :'Float',
    :'asset_turnover' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



203
204
205
206
207
208
209
210
211
212
 
# File 'lib/proton_api/models/ratio_targets1.rb', line 203

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      return_on_equity == o.return_on_equity &&
      return_on_assets == o.return_on_assets &&
      debt_to_equity == o.debt_to_equity &&
      profit_margin == o.profit_margin &&
      debt_ratio == o.debt_ratio &&
      asset_turnover == o.asset_turnover
end

#_deserialize(type, value) ⇒ Object

Returns Deserialized data.

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/proton_api/models/ratio_targets1.rb', line 249

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 = ProtonApi.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ 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



313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/proton_api/models/ratio_targets1.rb', line 313

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



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/proton_api/models/ratio_targets1.rb', line 229

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


216
217
218
 
# File 'lib/proton_api/models/ratio_targets1.rb', line 216

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



222
223
224
 
# File 'lib/proton_api/models/ratio_targets1.rb', line 222

def hash
  [return_on_equity, return_on_assets, debt_to_equity, profit_margin, debt_ratio, asset_turnover].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



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
 
# File 'lib/proton_api/models/ratio_targets1.rb', line 100

def list_invalid_properties
  invalid_properties = Array.new
  if !@return_on_equity.nil? && @return_on_equity < 0
    invalid_properties.push('invalid value for "return_on_equity", must be greater than or equal to 0.')
  end

  if !@return_on_assets.nil? && @return_on_assets < 0
    invalid_properties.push('invalid value for "return_on_assets", must be greater than or equal to 0.')
  end

  if !@debt_to_equity.nil? && @debt_to_equity < 0
    invalid_properties.push('invalid value for "debt_to_equity", must be greater than or equal to 0.')
  end

  if !@profit_margin.nil? && @profit_margin < 0
    invalid_properties.push('invalid value for "profit_margin", must be greater than or equal to 0.')
  end

  if !@debt_ratio.nil? && @debt_ratio < 0
    invalid_properties.push('invalid value for "debt_ratio", must be greater than or equal to 0.')
  end

  if !@asset_turnover.nil? && @asset_turnover < 0
    invalid_properties.push('invalid value for "asset_turnover", must be greater than or equal to 0.')
  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



294
295
296
 
# File 'lib/proton_api/models/ratio_targets1.rb', line 294

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



300
301
302
303
304
305
306
307
308
 
# File 'lib/proton_api/models/ratio_targets1.rb', line 300

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 String presentation of the object.

Returns:

  • (String) —

    String presentation of the object



288
289
290
 
# File 'lib/proton_api/models/ratio_targets1.rb', line 288

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



131
132
133
134
135
136
137
138
139
 
# File 'lib/proton_api/models/ratio_targets1.rb', line 131

def valid?
  return false if !@return_on_equity.nil? && @return_on_equity < 0
  return false if !@return_on_assets.nil? && @return_on_assets < 0
  return false if !@debt_to_equity.nil? && @debt_to_equity < 0
  return false if !@profit_margin.nil? && @profit_margin < 0
  return false if !@debt_ratio.nil? && @debt_ratio < 0
  return false if !@asset_turnover.nil? && @asset_turnover < 0
  true
end