—

              
HideShow 24 lines of Pod
=begin comment
Copyright (c) 2025 Aspose.Cells Cloud
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
=end comment
=cut
package AsposeCellsCloud::Object::FormulaSettings;
require 5.6.0;
use strict;
use warnings;
use utf8;
use JSON qw(decode_json);
use Data::Dumper;
use Module::Runtime qw(use_module);
use Log::Any qw($log);
use Date::Parse;
use DateTime;
  
use base ("Class::Accessor", "Class::Data::Inheritable");
__PACKAGE__->mk_classdata('attribute_map' => {});
__PACKAGE__->mk_classdata('swagger_types' => {});
__PACKAGE__->mk_classdata('method_documentation' => {}); 
__PACKAGE__->mk_classdata('class_documentation' => {});
# new object
sub new { 
    my ($class, %args) = @_; 
        my $self = bless {}, $class;
        foreach my $attribute (keys %{$class->attribute_map}) {
                my $args_key = $class->attribute_map->{$attribute};
                $self->$attribute( $args{ $args_key } );
        }
        return $self;
}  
# return perl hash
sub to_hash {
    return decode_json(JSON->new->convert_blessed->encode( shift ));
}
# used by JSON for serialization
sub TO_JSON { 
    my $self = shift;
    my $_data = {};
    foreach my $_key (keys %{$self->attribute_map}) {
        if (defined $self->{$_key}) {
            $_data->{$self->attribute_map->{$_key}} = $self->{$_key};
        }
    }
    return $_data;
}
# from Perl hashref
sub from_hash {
    my ($self, $hash) = @_;
    # loop through attributes and use swagger_types to deserialize the data
    while ( my ($_key, $_type) = each %{$self->swagger_types} ) {
        my $_json_attribute = $self->attribute_map->{$_key}; 
        if ($_type =~ /^array\[/i) { # array
            my $_subclass = substr($_type, 6, -1);
            my @_array = ();
            foreach my $_element (@{$hash->{$_json_attribute}}) {
                push @_array, $self->_deserialize($_subclass, $_element);
            }
            $self->{$_key} = \@_array;
        } elsif (exists $hash->{$_json_attribute}) { #hash(model), primitive, datetime
            $self->{$_key} = $self->_deserialize($_type, $hash->{$_json_attribute});
        } else {
                $log->debugf("Warning: %s (%s) does not exist in input hash\n", $_key, $_json_attribute);
        }
    }
    return $self;
}
# deserialize non-array data
sub _deserialize {
    my ($self, $type, $data) = @_;
    $log->debugf("deserializing %s with %s",Dumper($data), $type);
    if ($type eq 'DateTime') {
        return DateTime->from_epoch(epoch => str2time($data));
    } elsif ( grep( /^$type$/, ('int', 'double', 'string', 'boolean'))) {
        return $data;
    } else { # hash(model)
        my $_instance = eval "AsposeCellsCloud::Object::$type->new()";
        return $_instance->from_hash($data);
    }
}
__PACKAGE__->class_documentation({description => 'Settings of formulas and calculation. ',
                                  class => 'FormulaSettings',
                                  required => [], # TODO
}                                 );
__PACKAGE__->method_documentation({
     'calculate_on_open' => {
        datatype => 'boolean',
        base_name => 'CalculateOnOpen',
        description => 'Indicates whether the application is required to perform a full calculation when the workbook is opened. ',
        format => '',
        read_only => '',
                },
     'calculate_on_save' => {
        datatype => 'boolean',
        base_name => 'CalculateOnSave',
        description => 'Indicates whether recalculate the workbook before saving the document, when in manual calculation mode. ',
        format => '',
        read_only => '',
                },
     'force_full_calculation' => {
        datatype => 'boolean',
        base_name => 'ForceFullCalculation',
        description => 'Indicates whether calculates all formulas every time when a calculation is triggered. ',
        format => '',
        read_only => '',
                },
     'calculation_mode' => {
        datatype => 'string',
        base_name => 'CalculationMode',
        description => 'Gets or sets the mode for workbook calculation in ms excel. ',
        format => '',
        read_only => '',
                },
     'calculation_id' => {
        datatype => 'string',
        base_name => 'CalculationId',
        description => 'Specifies the version of the calculation engine used to calculate values in the workbook. ',
        format => '',
        read_only => '',
                },
     'enable_iterative_calculation' => {
        datatype => 'boolean',
        base_name => 'EnableIterativeCalculation',
        description => 'Indicates whether enable iterative calculation to resolve circular references. ',
        format => '',
        read_only => '',
                },
     'max_iteration' => {
        datatype => 'int',
        base_name => 'MaxIteration',
        description => 'The maximum iterations to resolve a circular reference. ',
        format => '',
        read_only => '',
                },
     'max_change' => {
        datatype => 'double',
        base_name => 'MaxChange',
        description => 'The maximum change to resolve a circular reference. ',
        format => '',
        read_only => '',
                },
     'precision_as_displayed' => {
        datatype => 'boolean',
        base_name => 'PrecisionAsDisplayed',
        description => 'Whether the precision of calculated result be set as they are displayed while calculating formulas ',
        format => '',
        read_only => '',
                },
     'enable_calculation_chain' => {
        datatype => 'boolean',
        base_name => 'EnableCalculationChain',
        description => 'Whether enable calculation chain for formulas. Default is false. ',
        format => '',
        read_only => '',
                },
     'preserve_padding_spaces' => {
        datatype => 'boolean',
        base_name => 'PreservePaddingSpaces',
        description => 'Indicates whether preserve those spaces and line breaks that are padded between formula tokens            while getting and setting formulas.            Default value is false. ',
        format => '',
        read_only => '',
                },    
});
__PACKAGE__->swagger_types( {
    'calculate_on_open' => 'boolean',
    'calculate_on_save' => 'boolean',
    'force_full_calculation' => 'boolean',
    'calculation_mode' => 'string',
    'calculation_id' => 'string',
    'enable_iterative_calculation' => 'boolean',
    'max_iteration' => 'int',
    'max_change' => 'double',
    'precision_as_displayed' => 'boolean',
    'enable_calculation_chain' => 'boolean',
    'preserve_padding_spaces' => 'boolean' 
} );
__PACKAGE__->attribute_map( {
    'calculate_on_open' => 'CalculateOnOpen',
    'calculate_on_save' => 'CalculateOnSave',
    'force_full_calculation' => 'ForceFullCalculation',
    'calculation_mode' => 'CalculationMode',
    'calculation_id' => 'CalculationId',
    'enable_iterative_calculation' => 'EnableIterativeCalculation',
    'max_iteration' => 'MaxIteration',
    'max_change' => 'MaxChange',
    'precision_as_displayed' => 'PrecisionAsDisplayed',
    'enable_calculation_chain' => 'EnableCalculationChain',
    'preserve_padding_spaces' => 'PreservePaddingSpaces' 
} );
__PACKAGE__->mk_accessors(keys %{__PACKAGE__->attribute_map});
1;