class ProtonApi::EducationCalculatorAnnualCostRequest
Attributes
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/proton_api/models/education_calculator_annual_cost_request.rb, line 40 def self.attribute_map { :'education_inflation_rate' => :'education_inflation_rate', :'decumulation_horizon' => :'decumulation_horizon', :'accumulation_horizon' => :'accumulation_horizon', :'account_ids' => :'account_ids', :'tax_rate' => :'tax_rate', :'general_inflation_rate' => :'general_inflation_rate', :'portfolio_return' => :'portfolio_return', :'deposit_schedule' => :'deposit_schedule', :'initial_balance' => :'initial_balance', :'percent_of_costs_covered' => :'percent_of_costs_covered', :'aggregation_account_ids' => :'aggregation_account_ids' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/proton_api/models/education_calculator_annual_cost_request.rb, line 75 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?(:'education_inflation_rate') self.education_inflation_rate = attributes[:'education_inflation_rate'] else self.education_inflation_rate = 0.05 end if attributes.has_key?(:'decumulation_horizon') self.decumulation_horizon = attributes[:'decumulation_horizon'] end if attributes.has_key?(:'accumulation_horizon') self.accumulation_horizon = attributes[:'accumulation_horizon'] end if attributes.has_key?(:'account_ids') if (value = attributes[:'account_ids']).is_a?(Array) self.account_ids = value end end if attributes.has_key?(:'tax_rate') self.tax_rate = attributes[:'tax_rate'] else self.tax_rate = 0.0 end if attributes.has_key?(:'general_inflation_rate') self.general_inflation_rate = attributes[:'general_inflation_rate'] else self.general_inflation_rate = 0.0 end if attributes.has_key?(:'portfolio_return') self.portfolio_return = attributes[:'portfolio_return'] end if attributes.has_key?(:'deposit_schedule') self.deposit_schedule = attributes[:'deposit_schedule'] end if attributes.has_key?(:'initial_balance') self.initial_balance = attributes[:'initial_balance'] else self.initial_balance = 0.0 end if attributes.has_key?(:'percent_of_costs_covered') self.percent_of_costs_covered = attributes[:'percent_of_costs_covered'] else self.percent_of_costs_covered = 1.0 end if attributes.has_key?(:'aggregation_account_ids') if (value = attributes[:'aggregation_account_ids']).is_a?(Array) self.aggregation_account_ids = value end end end
Attribute type mapping.
# File lib/proton_api/models/education_calculator_annual_cost_request.rb, line 57 def self.swagger_types { :'education_inflation_rate' => :'Float', :'decumulation_horizon' => :'Integer', :'accumulation_horizon' => :'Integer', :'account_ids' => :'Array<String>', :'tax_rate' => :'Float', :'general_inflation_rate' => :'Float', :'portfolio_return' => :'Float', :'deposit_schedule' => :'CalculatorDepositSchedule1', :'initial_balance' => :'Float', :'percent_of_costs_covered' => :'Float', :'aggregation_account_ids' => :'Array<String>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/proton_api/models/education_calculator_annual_cost_request.rb, line 320 def ==(o) return true if self.equal?(o) self.class == o.class && education_inflation_rate == o.education_inflation_rate && decumulation_horizon == o.decumulation_horizon && accumulation_horizon == o.accumulation_horizon && account_ids == o.account_ids && tax_rate == o.tax_rate && general_inflation_rate == o.general_inflation_rate && portfolio_return == o.portfolio_return && deposit_schedule == o.deposit_schedule && initial_balance == o.initial_balance && percent_of_costs_covered == o.percent_of_costs_covered && aggregation_account_ids == o.aggregation_account_ids end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/proton_api/models/education_calculator_annual_cost_request.rb, line 371 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/proton_api/models/education_calculator_annual_cost_request.rb, line 435 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
Custom attribute writer method with validation @param [Object] accumulation_horizon
Value to be assigned
# File lib/proton_api/models/education_calculator_annual_cost_request.rb, line 244 def accumulation_horizon=(accumulation_horizon) if accumulation_horizon.nil? fail ArgumentError, 'accumulation_horizon cannot be nil' end if accumulation_horizon < 0 fail ArgumentError, 'invalid value for "accumulation_horizon", must be greater than or equal to 0.' end @accumulation_horizon = accumulation_horizon end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/proton_api/models/education_calculator_annual_cost_request.rb, line 351 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
Custom attribute writer method with validation @param [Object] decumulation_horizon
Value to be assigned
# File lib/proton_api/models/education_calculator_annual_cost_request.rb, line 230 def decumulation_horizon=(decumulation_horizon) if decumulation_horizon.nil? fail ArgumentError, 'decumulation_horizon cannot be nil' end if decumulation_horizon < 0 fail ArgumentError, 'invalid value for "decumulation_horizon", must be greater than or equal to 0.' end @decumulation_horizon = decumulation_horizon end
Custom attribute writer method with validation @param [Object] education_inflation_rate
Value to be assigned
# File lib/proton_api/models/education_calculator_annual_cost_request.rb, line 220 def education_inflation_rate=(education_inflation_rate) if !education_inflation_rate.nil? && education_inflation_rate < -1 fail ArgumentError, 'invalid value for "education_inflation_rate", must be greater than or equal to -1.' end @education_inflation_rate = education_inflation_rate end
@see the `==` method @param [Object] Object to be compared
# File lib/proton_api/models/education_calculator_annual_cost_request.rb, line 338 def eql?(o) self == o end
Custom attribute writer method with validation @param [Object] general_inflation_rate
Value to be assigned
# File lib/proton_api/models/education_calculator_annual_cost_request.rb, line 272 def general_inflation_rate=(general_inflation_rate) if !general_inflation_rate.nil? && general_inflation_rate < -1 fail ArgumentError, 'invalid value for "general_inflation_rate", must be greater than or equal to -1.' end @general_inflation_rate = general_inflation_rate end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/proton_api/models/education_calculator_annual_cost_request.rb, line 344 def hash [education_inflation_rate, decumulation_horizon, accumulation_horizon, account_ids, tax_rate, general_inflation_rate, portfolio_return, deposit_schedule, initial_balance, percent_of_costs_covered, aggregation_account_ids].hash end
Custom attribute writer method with validation @param [Object] initial_balance
Value to be assigned
# File lib/proton_api/models/education_calculator_annual_cost_request.rb, line 296 def initial_balance=(initial_balance) if !initial_balance.nil? && initial_balance < 0 fail ArgumentError, 'invalid value for "initial_balance", must be greater than or equal to 0.' end @initial_balance = initial_balance end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/proton_api/models/education_calculator_annual_cost_request.rb, line 142 def list_invalid_properties invalid_properties = Array.new if !@education_inflation_rate.nil? && @education_inflation_rate < -1 invalid_properties.push('invalid value for "education_inflation_rate", must be greater than or equal to -1.') end if @decumulation_horizon.nil? invalid_properties.push('invalid value for "decumulation_horizon", decumulation_horizon cannot be nil.') end if @decumulation_horizon < 0 invalid_properties.push('invalid value for "decumulation_horizon", must be greater than or equal to 0.') end if @accumulation_horizon.nil? invalid_properties.push('invalid value for "accumulation_horizon", accumulation_horizon cannot be nil.') end if @accumulation_horizon < 0 invalid_properties.push('invalid value for "accumulation_horizon", must be greater than or equal to 0.') end if !@tax_rate.nil? && @tax_rate > 1 invalid_properties.push('invalid value for "tax_rate", must be smaller than or equal to 1.') end if !@tax_rate.nil? && @tax_rate < 0 invalid_properties.push('invalid value for "tax_rate", must be greater than or equal to 0.') end if !@general_inflation_rate.nil? && @general_inflation_rate < -1 invalid_properties.push('invalid value for "general_inflation_rate", must be greater than or equal to -1.') end if @portfolio_return.nil? invalid_properties.push('invalid value for "portfolio_return", portfolio_return cannot be nil.') end if @portfolio_return < -1 invalid_properties.push('invalid value for "portfolio_return", must be greater than or equal to -1.') end if !@initial_balance.nil? && @initial_balance < 0 invalid_properties.push('invalid value for "initial_balance", must be greater than or equal to 0.') end if !@percent_of_costs_covered.nil? && @percent_of_costs_covered > 1 invalid_properties.push('invalid value for "percent_of_costs_covered", must be smaller than or equal to 1.') end if !@percent_of_costs_covered.nil? && @percent_of_costs_covered < 0 invalid_properties.push('invalid value for "percent_of_costs_covered", must be greater than or equal to 0.') end invalid_properties end
Custom attribute writer method with validation @param [Object] percent_of_costs_covered
Value to be assigned
# File lib/proton_api/models/education_calculator_annual_cost_request.rb, line 306 def percent_of_costs_covered=(percent_of_costs_covered) if !percent_of_costs_covered.nil? && percent_of_costs_covered > 1 fail ArgumentError, 'invalid value for "percent_of_costs_covered", must be smaller than or equal to 1.' end if !percent_of_costs_covered.nil? && percent_of_costs_covered < 0 fail ArgumentError, 'invalid value for "percent_of_costs_covered", must be greater than or equal to 0.' end @percent_of_costs_covered = percent_of_costs_covered end
Custom attribute writer method with validation @param [Object] portfolio_return
Value to be assigned
# File lib/proton_api/models/education_calculator_annual_cost_request.rb, line 282 def portfolio_return=(portfolio_return) if portfolio_return.nil? fail ArgumentError, 'portfolio_return cannot be nil' end if portfolio_return < -1 fail ArgumentError, 'invalid value for "portfolio_return", must be greater than or equal to -1.' end @portfolio_return = portfolio_return end
Custom attribute writer method with validation @param [Object] tax_rate
Value to be assigned
# File lib/proton_api/models/education_calculator_annual_cost_request.rb, line 258 def tax_rate=(tax_rate) if !tax_rate.nil? && tax_rate > 1 fail ArgumentError, 'invalid value for "tax_rate", must be smaller than or equal to 1.' end if !tax_rate.nil? && tax_rate < 0 fail ArgumentError, 'invalid value for "tax_rate", must be greater than or equal to 0.' end @tax_rate = tax_rate end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/proton_api/models/education_calculator_annual_cost_request.rb, line 422 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/proton_api/models/education_calculator_annual_cost_request.rb, line 410 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/proton_api/models/education_calculator_annual_cost_request.rb, line 201 def valid? return false if !@education_inflation_rate.nil? && @education_inflation_rate < -1 return false if @decumulation_horizon.nil? return false if @decumulation_horizon < 0 return false if @accumulation_horizon.nil? return false if @accumulation_horizon < 0 return false if !@tax_rate.nil? && @tax_rate > 1 return false if !@tax_rate.nil? && @tax_rate < 0 return false if !@general_inflation_rate.nil? && @general_inflation_rate < -1 return false if @portfolio_return.nil? return false if @portfolio_return < -1 return false if !@initial_balance.nil? && @initial_balance < 0 return false if !@percent_of_costs_covered.nil? && @percent_of_costs_covered > 1 return false if !@percent_of_costs_covered.nil? && @percent_of_costs_covered < 0 true end