Struct amfnengine::engine::calc_utility::CalcUtility

pub struct CalcUtility {}

The AmFn utility methods.

Implementations

impl CalcUtility

The AmFn utility methods implementation.

pub fn convert_currency_event(
    calc_mgr: &Ref<'_, CalcManager>,
    cashflow_currency_code: &str,
    event_currency_code: &str,
    value: Decimal
) -> Decimal

Convert a value from the cashflow code to the event code. Cross rates are used if the exchange rate is unavailable and the cross rate international currency code is not empty.

Arguments

• calc_mgr - Calculation manager reference.
• cashflow_currency_code - Cashflow currency code.
• event_currency_code - Event currency code.
• value - The value to convert.

Return

• See description.

pub fn create_event_type_list_parameter(
    calc_manager: &Rc<RefCell<CalcManager>>,
    elem_type: ExtensionType,
    elem_extension: &ElemExtension
) -> ListParameter

Create the event type parameter list.

Arguments

• calc_manager - Calculation manager.
• elem_type - Type of the event.
• elem_extension - A ElemPrincipalChange, ElemCurrentValue, ElemInterestChange, or ElemStatisticValue element.

Return

• See description.

pub fn evaluate_descriptors(
    calc_manager: &Rc<RefCell<CalcManager>>,
    expression: &RefCell<CalcExpression>,
    list_parameter: &ListParameter,
    list_descriptor: &ListDescriptor
)

Evaluate all of the descriptors in the list. For each descriptor that specifies an expression, execute the expression using the list of parameters.

Arguments

• calc_manager - Calculation manager.
• expression - CalcExpression element.
• list_parameter - List of parameters used with evaluation.
• list_descriptor - List of descriptors to evaluate.

pub fn evaluate_expression(
    calc_manager: &Rc<RefCell<CalcManager>>,
    list_parameter: Option<&ListParameter>,
    expression_str: &str,
    cashflow: bool
) -> ElemSymbol

Evaluate the expression.

Arguments

• calc_manager - Calculation manager.
• list_parameter - List of parameters used with evaluation.
• expression_str - The expression to evaluate.
• cashflow - Search the cashflow preferences.

Return

• Resulting symbol if successful, otherwise an error message in the symbol.

pub fn get_event_value(
    calc_manager: &Rc<RefCell<CalcManager>>,
    elem_column: &ElemColumn
) -> String

Get the appropriate event list value as a string.

Arguments

• calc_manager - Calculation manager.
• elem_column - Column element.

Return

• See description.

pub fn get_am_value(
    calc_manager: &Rc<RefCell<CalcManager>>,
    elem_column: &ElemColumn,
    list_am: &ListAmortization
) -> String

Get the appropriate amortization list value as a string.

Arguments

• calc_manager - Calculation manager.
• elem_column - Column element.
• list_am_opt - Amortization list.

Return

• See description.

pub fn normalize_expression(
    calc_manager: &Rc<RefCell<CalcManager>>,
    expression: &str,
    new_line: bool
) -> String

Normalize the expression.

Arguments

• calc_manager - Calculation manager.
• expression - The expression to normalize.
• new_line - If true, format with a newline character between expressions.

Return

• Normalized expression.

pub fn parse_columns(
    calc_manager: &Rc<RefCell<CalcManager>>,
    elem_type: TableType,
    cashflow: bool
) -> ListColumn

Create and return a column list object.

Arguments

• calc_manager - Calculation manager.
• elem_type - The type of table.
• cashflow - Search the cashflow preferences.

Return

• See description.

pub fn parse_summary(calc_manager: &Rc<RefCell<CalcManager>>) -> ListSummary

Create and return a summary list object.

Arguments

• calc_manager - Calculation manager.

Return

• See description.

pub fn set_event_value(
    calc_manager: &Rc<RefCell<CalcManager>>,
    col_name_index: usize,
    col_type: &str,
    col_code: &str,
    index: usize,
    value_param: &str
) -> String

Set the appropriate event list value and return it as a string.

Arguments

• calc_manager - Calculation manager.
• col_name_index - Column name index.
• col_type - Column type.
• col_code - Column code.
• index - Event row index.
• value_param - Value to set as a string.

Return

• See description.

pub fn set_extension_values(
    calc_manager: &Rc<RefCell<CalcManager>>,
    index: usize,
    ext_param: &ElemExtension
) -> bool

Set the appropriate event list extension values.

Arguments

• calc_manager - Calculation manager.
• index - Event row index.
• ext_param - Extension values to set.

Return

• True if successful, otherwise false.

pub fn set_parameter_values(
    calc_manager: &Rc<RefCell<CalcManager>>,
    index_param: usize,
    parameters: Vec<String>
) -> bool

Set the appropriate event list parameter values.

Arguments

• calc_manager - Calculation manager.
• index_param - Event row index.
• parameters - Parameters to set.

Return

• True if successful, otherwise false.