Class: ProtonApi::BacktestRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BacktestRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

  if attributes.has_key?(:'trades')
    self.trades = attributes[:'trades']
  else
    self.trades = true
  end

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

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

  if attributes.has_key?(:'stats')
    self.stats = attributes[:'stats']
  else
    self.stats = true
  end

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

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

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

  if attributes.has_key?(:'asset_sizes')
    self.asset_sizes = attributes[:'asset_sizes']
  else
    self.asset_sizes = true
  end

  if attributes.has_key?(:'holdings')
    self.holdings = attributes[:'holdings']
  else
    self.holdings = true
  end
end

Instance Attribute Details

#asset_size ⇒ Object

Returns the value of attribute asset_size.



31
32
33
 
# File 'lib/proton_api/models/backtest_request.rb', line 31

def asset_size
  @asset_size
end

#asset_sizes ⇒ Object

Returns the value of attribute asset_sizes.



33
34
35
 
# File 'lib/proton_api/models/backtest_request.rb', line 33

def asset_sizes
  @asset_sizes
end

#end_date ⇒ Object

Returns the value of attribute end_date.



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

def end_date
  @end_date
end

#holdings ⇒ Object

Returns the value of attribute holdings.



35
36
37
 
# File 'lib/proton_api/models/backtest_request.rb', line 35

def holdings
  @holdings
end

#initial_weights ⇒ Object

Returns the value of attribute initial_weights.



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

def initial_weights
  @initial_weights
end

#model_id ⇒ Object

Returns the value of attribute model_id.



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

def model_id
  @model_id
end

#settings ⇒ Object

Returns the value of attribute settings.



29
30
31
 
# File 'lib/proton_api/models/backtest_request.rb', line 29

def settings
  @settings
end

#start_date ⇒ Object

Returns the value of attribute start_date.



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

def start_date
  @start_date
end

#stats ⇒ Object

Returns the value of attribute stats.



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

def stats
  @stats
end

#trades ⇒ Object

Returns the value of attribute trades.



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

def trades
  @trades
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/proton_api/models/backtest_request.rb', line 38

def self.attribute_map
  {
    :'end_date' => :'end_date',
    :'trades' => :'trades',
    :'model_id' => :'model_id',
    :'start_date' => :'start_date',
    :'stats' => :'stats',
    :'initial_weights' => :'initial_weights',
    :'settings' => :'settings',
    :'asset_size' => :'asset_size',
    :'asset_sizes' => :'asset_sizes',
    :'holdings' => :'holdings'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/proton_api/models/backtest_request.rb', line 54

def self.swagger_types
  {
    :'end_date' => :'Date',
    :'trades' => :'BOOLEAN',
    :'model_id' => :'String',
    :'start_date' => :'Date',
    :'stats' => :'BOOLEAN',
    :'initial_weights' => :'Object',
    :'settings' => :'Settings',
    :'asset_size' => :'Float',
    :'asset_sizes' => :'BOOLEAN',
    :'holdings' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/proton_api/models/backtest_request.rb', line 166

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      end_date == o.end_date &&
      trades == o.trades &&
      model_id == o.model_id &&
      start_date == o.start_date &&
      stats == o.stats &&
      initial_weights == o.initial_weights &&
      settings == o.settings &&
      asset_size == o.asset_size &&
      asset_sizes == o.asset_sizes &&
      holdings == o.holdings
end

#_deserialize(type, value) ⇒ Object

Returns Deserialized data.

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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

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



280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/proton_api/models/backtest_request.rb', line 280

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



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

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


183
184
185
 
# File 'lib/proton_api/models/backtest_request.rb', line 183

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



189
190
191
 
# File 'lib/proton_api/models/backtest_request.rb', line 189

def hash
  [end_date, trades, model_id, start_date, stats, initial_weights, settings, asset_size, asset_sizes, holdings].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



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/proton_api/models/backtest_request.rb', line 128

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

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

  if !@asset_size.nil? && @asset_size < 0
    invalid_properties.push('invalid value for "asset_size", 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



261
262
263
 
# File 'lib/proton_api/models/backtest_request.rb', line 261

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



267
268
269
270
271
272
273
274
275
 
# File 'lib/proton_api/models/backtest_request.rb', line 267

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



255
256
257
 
# File 'lib/proton_api/models/backtest_request.rb', line 255

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



147
148
149
150
151
152
 
# File 'lib/proton_api/models/backtest_request.rb', line 147

def valid?
  return false if @end_date.nil?
  return false if @start_date.nil?
  return false if !@asset_size.nil? && @asset_size < 0
  true
end