class AsposeCellsCloud::CalculationOptions

Attributes

calc_stack_size[RW]

Specifies the stack size for calculating cells recursively.

calculation_monitor[RW]

The monitor for user to track the progress of formula calculation.

custom_engine[RW]

The custom formula calculation engine to extend the default calculation engine of Aspose.Cells.

ignore_error[RW]

Indicates whether errors encountered while calculating formulas should be ignored. The error may be unsupported function, external links, etc. The default value is true.

linked_data_sources[RW]

Specifies the data sources for external links used in formulas.

precision_strategy[RW]

Specifies the strategy for processing precision of calculation.

recursive[RW]

Indicates whether calculate the dependent cells recursively when calculating one cell and it depends on other cells. The default value is true.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/aspose_cells_cloud/models/calculation_options.rb, line 50
def self.attribute_map
  {
    :'calc_stack_size' => :'CalcStackSize',
    :'ignore_error' => :'IgnoreError',
    :'precision_strategy' => :'PrecisionStrategy',
    :'recursive' => :'Recursive',
    :'custom_engine' => :'CustomEngine',
    :'calculation_monitor' => :'CalculationMonitor',
    :'linked_data_sources' => :'LinkedDataSources'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/aspose_cells_cloud/models/calculation_options.rb, line 77
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?(:'CalcStackSize')
      self.calc_stack_size = attributes[:'CalcStackSize']
  end
  if attributes.has_key?(:'IgnoreError')
      self.ignore_error = attributes[:'IgnoreError']
  end
  if attributes.has_key?(:'PrecisionStrategy')
      self.precision_strategy = attributes[:'PrecisionStrategy']
  end
  if attributes.has_key?(:'Recursive')
      self.recursive = attributes[:'Recursive']
  end
  if attributes.has_key?(:'CustomEngine')
      self.custom_engine = attributes[:'CustomEngine']
  end
  if attributes.has_key?(:'CalculationMonitor')
      self.calculation_monitor = attributes[:'CalculationMonitor']
  end
  if attributes.has_key?(:'LinkedDataSources')
      self.linked_data_sources = attributes[:'LinkedDataSources']
  end

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/aspose_cells_cloud/models/calculation_options.rb, line 63
def self.swagger_types
  {
    :'calc_stack_size' => :'Integer',
    :'ignore_error' => :'BOOLEAN',
    :'precision_strategy' => :'String',
    :'recursive' => :'BOOLEAN',
    :'custom_engine' => :'AbstractCalculationEngine',
    :'calculation_monitor' => :'AbstractCalculationMonitor',
    :'linked_data_sources' => :'Array<Workbook>'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/aspose_cells_cloud/models/calculation_options.rb, line 151
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      calc_stack_size == o.calc_stack_size &&
      ignore_error == o.ignore_error &&
      precision_strategy == o.precision_strategy &&
      recursive == o.recursive &&
      custom_engine == o.custom_engine &&
      calculation_monitor == o.calculation_monitor &&
      linked_data_sources == o.linked_data_sources 
      std_dev == o.std_dev
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/aspose_cells_cloud/models/calculation_options.rb, line 200
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = AsposeCellsCloud.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

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/aspose_cells_cloud/models/calculation_options.rb, line 266
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/aspose_cells_cloud/models/calculation_options.rb, line 179
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 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) click to toggle source

@see the ‘==` method @param [Object] Object to be compared

# File lib/aspose_cells_cloud/models/calculation_options.rb, line 166
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/aspose_cells_cloud/models/calculation_options.rb, line 172
def hash
  [ calc_stack_size , ignore_error , precision_strategy , recursive , custom_engine , calculation_monitor , linked_data_sources ].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# File lib/aspose_cells_cloud/models/calculation_options.rb, line 109
def list_invalid_properties
  invalid_properties = Array.new
  if @calc_stack_size.nil?
      invalid_properties.push("invalid value for 'calc_stack_size', calc_stack_size cannot be nil.")
  end
  if @ignore_error.nil?
      invalid_properties.push("invalid value for 'ignore_error', ignore_error cannot be nil.")
  end
  if @precision_strategy.nil?
      invalid_properties.push("invalid value for 'precision_strategy', precision_strategy cannot be nil.")
  end
  if @recursive.nil?
      invalid_properties.push("invalid value for 'recursive', recursive cannot be nil.")
  end
  if @custom_engine.nil?
      invalid_properties.push("invalid value for 'custom_engine', custom_engine cannot be nil.")
  end
  if @calculation_monitor.nil?
      invalid_properties.push("invalid value for 'calculation_monitor', calculation_monitor cannot be nil.")
  end
  if @linked_data_sources.nil?
      invalid_properties.push("invalid value for 'linked_data_sources', linked_data_sources cannot be nil.")
  end

  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/aspose_cells_cloud/models/calculation_options.rb, line 246
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/aspose_cells_cloud/models/calculation_options.rb, line 252
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/aspose_cells_cloud/models/calculation_options.rb, line 240
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/aspose_cells_cloud/models/calculation_options.rb, line 138
def valid?
  return false if @calc_stack_size.nil?
  return false if @ignore_error.nil?
  return false if @precision_strategy.nil?
  return false if @recursive.nil?
  return false if @custom_engine.nil?
  return false if @calculation_monitor.nil?
  return false if @linked_data_sources.nil?
  return true
end