Struct amfnengine::engine::calc_manager::CalcManager

pub struct CalcManager { /* private fields */ }

Implementations

impl CalcManager

The manager implementation of the AmFn engine component.

pub fn new(core_manager_param: CoreManager) -> CalcManager

Create and return a new calc manager element.

Arguments

• core_manager_param - CoreManager element.

Return

• See description.

pub fn init_calc_manager(&mut self, calc_manager: &Rc<RefCell<CalcManager>>)

Initialize the calc manager element.

Arguments

• calc_manager - Calculation manager.

pub fn core_manager(&self) -> &CoreManager

Get the core manager.

Return

• See description.

pub fn clear(&mut self)

Clear all engine elements and lists.

pub fn copy_template_events(
    &self,
    calc_manager: &Rc<RefCell<CalcManager>>,
    date_param: usize,
    end_date_param: usize,
    new_date_param: usize,
    frequency_param: FrequencyType
) -> Result<ListEvent, ErrorType>

Copies the event list from the currently selected template event into a new event list.

Arguments

• calc_manager - Calculation manager.
• date_param - Base starting date for the new event(s).
• end_date_param - Base ending date for the new event(s).
• new_date_param - Next date for the new event(s) (i.e., normally end_date_param plus one period).
• frequency_param - Next frequency for the new event(s).

Return

• The new event list, otherwise an error code.

pub fn combine_principal(&self, cashflow: bool) -> bool

Get the combine principal change events. The cashflow and user preferences are searched in that order.

Arguments

• cashflow - Search the cashflow preferences.

Return

• See description.

pub fn compress_descriptor(&self, cashflow: bool) -> bool

Get the After balancing and during compression. The cashflow and user preferences are searched in that order.

Arguments

• cashflow - Search the cashflow preferences.

Return

• See description.

pub fn cross_rate_code(&self, cashflow: bool) -> &str

Get the resolved cross rate code. The cashflow and user preferences are searched in that order.

Arguments

• cashflow - Search the cashflow preferences.

Return

• See description.

pub fn fiscal_year_start(&self, cashflow: bool) -> usize

Get the resolved start of fiscal year. The cashflow and user preferences are searched in that order.

Arguments

• cashflow - Search the cashflow preferences.

Return

• See description.

pub fn decimal_digits(&self, cashflow: bool) -> usize

Get the resolved number of significant decimal digits. The cashflow and user preferences are searched in that order.

Arguments

• cashflow - Search the cashflow preferences.

Return

• See description.

pub fn default_encoding(&self, cashflow: bool) -> &str

Get the resolved default encoding. The cashflow and user preferences are searched in that order.

Arguments

• cashflow - Search the cashflow preferences.

Return

• See description.

pub fn target(&self) -> Decimal

Get the resolved target value. The cashflow and user preferences are searched in that order.

Return

• See description.

pub fn descriptor_value(
    &self,
    group: &str,
    name: &str,
    desc_type: &str,
    code: &str,
    cashflow: bool,
    is_event: bool
) -> String

Searches the various descriptor lists, from lowest to highest, and returns the constant value for a group, name, type, and code.

Arguments

• group - The group name of the descriptor.
• name - The name of the descriptor.
• desc_type - The type of the descriptor.
• code - The code of the descriptor.
• cashflow - Search the cashflow descriptor list.
• is_event - Search the event descriptor list.

Return

• See description.

pub fn group(&self, cashflow: bool) -> &str

Get the resolved template group name. The cashflow and user preferences are searched in that order.

Arguments

• cashflow - Search the cashflow preferences.

Return

• See description.

pub fn list_locale(&self) -> &ListLocale

Get the locale list.

Return

• See description.

pub fn list_locale_mut(&mut self) -> &mut ListLocale

Get the mutable locale list.

Return

• See description.

pub fn preferences(&self) -> &ElemPreferences

Get the user preferences element.

Return

• See description.

pub fn preferences_mut(&mut self) -> &mut ElemPreferences

Get the mutable user preferences element.

Return

• See description.

pub fn list_cashflow(&self) -> &ListCashflow

Get the list of cashflows.

Return

• See description.

pub fn list_cashflow_mut(&mut self) -> &mut ListCashflow

Get the mutable list of cashflows.

Return

• See description.

pub fn list_template_group(&self) -> &ListTemplateGroup

Get the list of template groups.

Return

• See description.

pub fn list_template_group_mut(&mut self) -> &mut ListTemplateGroup

Get the mutable list of template groups.

Return

• See description.

pub fn list_exchange_rate(&self) -> &ListExchangeRate

Get the list of exchange rates.

Return

• See description.

pub fn list_exchange_rate_mut(&mut self) -> &mut ListExchangeRate

Get the mutable list of exchange rates.

Return

• See description.

pub fn get_error_string(&self, error: ErrorType) -> String

Get the error text corresponding to an error value.

Arguments

• error - The value of the error.

Return

• See description.

pub fn locale(&self, cashflow: bool) -> String

Get the resolved locale. The cashflow and user preferences are searched in that order.

Arguments

• cashflow - Search the cashflow preferences.

Return

• ISO language code (ISO 639)_ISO country code (ISO 3166).

pub fn statistic_events(&self, cashflow: bool) -> bool

Get the statistic events from the compressed event list. The cashflow and user preferences are searched in that order.

Arguments

• cashflow - Search the cashflow preferences.

Return

• See description.

pub fn updating_json(&self) -> bool

Get the updating json.

Return

• See description.

pub fn set_list_locale(&mut self, list_locale: ListLocale)

Set the list locale.

Arguments

• list_locale - See description.

pub fn set_preferences(&mut self, preferences: ElemPreferences)

Set the preferences.

Arguments

• preferences - See description.

pub fn set_list_cashflow(&mut self, list_cashflow: ListCashflow)

Set the list cashflow.

Arguments

• list_cashflow - See description.

pub fn set_list_template_group(
    &mut self,
    list_template_group: ListTemplateGroup
)

Set the list template group.

Arguments

• list_template_group - See description.

pub fn set_list_exchange_rate(&mut self, list_exchange_rate: ListExchangeRate)

Set the list exchange rate.

Arguments

• list_exchange_rate - See description.

pub fn set_updating_json(&self, value_param: bool)

Set the updating json.

Arguments

• value_param - See description.

pub fn col_name_resource_key(column_value: ColumnType) -> String

Get the column name resource key.

Arguments

• column_value - Column name value.

Return

• See description.

pub fn util_date_diff(
    date1: usize,
    date2: usize,
    frequency: FrequencyType,
    intervals: usize,
    eom: bool
) -> i32

Calculates number of intervals between two dates. If intDate2 is greater than or equal to intDate1, the result will be positive, otherwise the result will be negative.

Arguments

• date1 - First date in YYYYMMDD format.
• date2 - Second date in YYYYMMDD format.
• frequency - Date frequency.
• intervals - Number of intervals of frequency.
• eom - Adjust successive dates to end of month.

Return

• Number of intervals (positive or negative).

pub fn util_date_newi(
    event_date: usize,
    periods: usize,
    frequency: FrequencyType,
    intervals: i32,
    eom: bool
) -> usize

Calculates a new date based upon a given date and number of intervals. If intervals is positive, the resulting date will be greater than event_date, otherwise the resulting date will be less than event_date.

Arguments

• event_date - Date in YYYYMMDD format.
• periods - Number of periods.
• frequency - Date frequency.
• intervals - Number of intervals of frequency.
• eom - Adjust successive dates to end of month.

Return

• New date in YYYYMMDD format.

pub fn util_date_new(
    event_date: usize,
    periods: usize,
    frequency: FrequencyType,
    intervals: usize,
    eom: bool
) -> usize

Calculates a new date based upon a given date and number of intervals.

Arguments

• event_date - Date in YYYYMMDD format.
• periods - Number of periods.
• frequency - Date frequency.
• intervals - Number of intervals of frequency.
• eom - Adjust successive dates to end of month.

Return

• New date in YYYYMMDD format.

pub fn util_date_now() -> usize

Returns the current date in YYYYMMDD format.

Return

• Current date in YYYYMMDD format.

pub fn util_intervals_in_year(frequency: FrequencyType) -> usize

Return the number of intervals in a year for a frequency.

Arguments

• frequency - Frequency value.

Return

• See description.

pub fn util_intervals_in_year_by_name(frequency: &str) -> usize

Return the number of intervals in a year for a frequency mnemonic.

Arguments

• frequency - The frequency mnemonic.

Return

• See description.

pub fn util_rate_dr_to_nar(dr: Decimal, days_in_year: usize) -> Decimal

Converts a Daily Rate (DR) into a Nominal Annual Rate (NAR).

Arguments

• dr - The daily interest rate expressed as a percentage.
• days_in_year - Number of days in the year.

Return

• The nominal annual rate as a percentage.

pub fn util_rate_ear_to_nar(
    ear: Decimal,
    compound_frequency: FrequencyType,
    days_in_year: usize
) -> Decimal

Convert an Effective Annual Rate (EAR) into a Nominal Annual Rate (NAR).

Arguments

• ear - The effective annual interest rate expressed as a percentage.
• compound_frequency - Actual compounding frequency.
• days_in_year - Number of days in the year.

Return

• The nominal annual rate as a percentage.

pub fn util_rate_nar_to_dr(nar: Decimal, days_in_year: usize) -> Decimal

Converts a Nominal Annual Rate (NAR) into a Daily Rate (DR).

Arguments

• nar - The nominal annual interest rate expressed as a percentage.
• days_in_year - Number of days in the year.

Return

• The daily rate as a percentage.

pub fn util_rate_nar_to_ear(
    nar: Decimal,
    compound_frequency: FrequencyType,
    days_in_year: usize
) -> Decimal

Convert a Nominal Annual Rate (NAR) into an Effective Annual Rate (EAR).

Arguments

• nar - The nominal annual interest rate expressed as a percentage.
• compound_frequency - Actual compounding frequency.
• days_in_year - Number of days in the year.

Return

• The effective annual rate as a percentage.

pub fn util_rate_nar_to_pr(
    nar: Decimal,
    frequency: FrequencyType,
    days_in_year: usize
) -> Decimal

Convert a Nominal Annual Rate (NAR) into a Periodic Rate (PR).

Arguments

• nar - The nominal annual interest rate expressed as a percentage.
• frequency - Frequency value.
• days_in_year - Number of days in the year.

Return

• The periodic rate as a percentage.

pub fn util_rate_pr_to_nar(
    pr: Decimal,
    frequency: FrequencyType,
    days_in_year: usize
) -> Decimal

Convert a Periodic Rate (PR) into a Nominal Annual Rate (NAR).

Arguments

• pr - The periodic interest rate expressed as a percentage.
• frequency - Frequency value.
• days_in_year - Number of days in the year.

Return

• The nominal annual rate as a percentage.