Struct amfnengine::engine::elem_cashflow::ElemCashflow

pub struct ElemCashflow { /* fields omitted */ }

Implementations

impl ElemCashflow

The cashflow element definition implementation.

pub fn new(
    name_param: &str,
    preferences_param: ElemPreferences,
    list_event_param: Option<ListEvent>,
    calculate_param: CalcCalculate
) -> ElemCashflow

Create and return a new cashflow element.

Arguments

• name_param - Name of cashflow.
• preferences_param - Cashflow preferences.
• list_event_param - Event list.
• calculate_param - Calculate element.

Return

• See description.

pub fn name(&self) -> &str

Get the name.

Return

• See description.

pub fn preferences(&self) -> &ElemPreferences

Get the preferences.

Return

• See description.

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

Get the mut preferences.

Return

• See description.

pub fn list_event(&self) -> &ListEvent

Get the list event.

Return

• See description.

pub fn list_event_mut(&mut self) -> &mut ListEvent

Get the list event mutable.

Return

• See description.

pub fn list_amortization(&self) -> &ListAmortization

Get the list amortization.

Return

• See description.

pub fn list_amortization_mut(&mut self) -> &mut ListAmortization

Get the list amortization mutable.

Return

• See description.

pub fn cashflow_valid(&self) -> bool

Get the cashflow valid.

Return

• See description.

pub fn updated(&self) -> bool

Get the updated value.

Return

• See description.

pub fn calculate(&self) -> &CalcCalculate

Get the calculate object.

Return

• See description.

pub fn list_statistic_helper(&self) -> &ListStatisticHelper

Get the statistic helper.

Return

• See description.

pub fn elem_balance_result(&self) -> &ElemBalanceResult

Get the balance result.

Return

• See description.

pub fn last_amortization_index(&self) -> usize

Get the last amortization index.

Return

• See description.

pub fn set_name(&mut self, name_param: &str)

Set the name.

Arguments

• name_param - See description.

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

Set the preferences.

Arguments

• preferences_param - See description.

pub fn set_list_event(&mut self, list_event_param: ListEvent)

Set the list event.

Arguments

• list_event_param - See description.

pub fn set_list_amortization(&mut self, list_am_param: ListAmortization)

Set the list amortization.

Arguments

• list_am_param - See description.

pub fn set_cashflow_valid(&mut self, cashflow_valid_param: bool)

Set the cashflow valid.

Arguments

• cashflow_valid_param - See description.

pub fn set_updated(&mut self, updated_param: bool)

Set the updated value.

Arguments

• updated_param - See description.

pub fn set_calculate(&mut self, calculate_param: CalcCalculate)

Set the calculate object.

Arguments

• calculate_param - See description.

pub fn set_list_statistic_helper(
    &mut self,
    statistic_helper_param: ListStatisticHelper
)

Set the statistic helper.

Arguments

• list_statistic_helper_param - See description.

pub fn set_elem_balance_result(
    &mut self,
    elem_balance_result_param: ElemBalanceResult
)

Set the balance result.

Arguments

• elem_balance_result_param - See description.

pub fn set_last_amortization_index(
    &mut self,
    last_amortization_index_param: usize
)

Set the last amortization index.

Arguments

• last_am_index_param - See description.