Struct amfnengine::core::elem_extension::ElemExtension

pub struct ElemExtension { /* private fields */ }

The extension element of an event.

Implementations

impl ElemExtension

The extension implementation.

pub fn new_current_value(current_value_param: ElemCurrentValue) -> ElemExtension

Return a new current value event.

Arguments

• current_value_param - Principal change to add.

Return

• See description.

pub fn new_interest_change(
    interest_change_param: ElemInterestChange
) -> ElemExtension

Return a new interest change event.

Arguments

• interest_change_param - Principal change to add.

Return

• See description.

pub fn new_principal_change(
    principal_change_param: ElemPrincipalChange
) -> ElemExtension

Return a new principal change event.

Arguments

• principal_change_param - Principal change to add.

Return

• See description.

pub fn new_statistic_value(
    statistic_value_param: ElemStatisticValue
) -> ElemExtension

Return a new statistic value event.

Arguments

• statistic_value_param - Principal change to add.

Return

• See description.

pub fn copy(&self) -> ElemExtension

Copy this extension element as a new extension element.

Return

• See description.

pub fn equal(&self, elem: &ElemExtension) -> bool

Compare this extension to the extension parameter.

Arguments

• elem - Extension to compare.

Return

• True if equal, otherwise false.

pub fn extension_type(&self) -> ExtensionType

Get the extension type.

Return

• See description.

pub fn extension_value(&self) -> &ExtensionValue

Get the principal change.

Return

• See description.

pub fn extension_eom(&self) -> bool

Get the end-of-month.

Return

• See description.

pub fn pc_type(&self) -> PrincipalType

Get the principal change type.

Return

• See description.

pub fn pc_eom(&self) -> bool

Get the value of adjust successive dates to end of month.

Return

• See description.

pub fn pc_principal_first(&self) -> bool

Get the value of apply change to principal balance first for simple interest.

Return

• See description.

pub fn pc_balance_statistics(&self) -> bool

Get the value of include with balance result statistics.

Return

• See description.

pub fn pc_auxiliary(&self) -> bool

Get the auxiliary principal change event.

Return

• See description.

pub fn pc_aux_passive(&self) -> bool

Get the auxiliary passive principal change event.

Return

• See description.

pub fn cv_eom(&self) -> bool

Get the value to adjust successive dates to end of month.

Return

• See description.

pub fn cv_passive(&self) -> bool

Get the value to not affect the remaining cashflow.

Return

• See description.

pub fn cv_present(&self) -> bool

Get the value to designate as present value.

Return

• See description.

pub fn ic_method(&self) -> MethodType

Get the interest method used.

Return

• See description.

pub fn ic_day_count_basis(&self) -> DayCountType

Get the day count basis.

Return

• See description.

pub fn ic_days_in_year(&self) -> usize

Get the number of days in the year.

Return

• See description.

pub fn ic_effective_frequency(&self) -> FrequencyType

Get the optional effective frequency.

Return

• See description.

pub fn ic_interest_frequency(&self) -> FrequencyType

Get the optional interest amortization frequency.

Return

• See description.

pub fn ic_round_balance(&self) -> RoundType

Get the round intermediate balance results.

Return

• See description.

pub fn ic_round_decimal_digits(&self) -> Decimal

Get the round decimal digits.

Return

• See description.

pub fn sv_name(&self) -> &str

Get the name of the statistic event.

Return

• See description.

pub fn sv_eom(&self) -> bool

Get the value of adjust successive dates to end of month.

Return

• See description.

pub fn sv_is_final(&self) -> bool

Get the value to final statistic event.

Return

• See description.

pub fn set_principal_change(
    &mut self,
    principal_change_param: ElemPrincipalChange
)

Set the principal change.

Arguments

• principal_change_param - See description.

pub fn set_pc_type(&mut self, param: PrincipalType)

Set the principal change type.

Arguments

• param - See description.

pub fn set_pc_eom(&mut self, param: bool)

Set the value of adjust successive dates to end of month.

Arguments

• param - See description.

pub fn set_pc_principal_first(&mut self, param: bool)

Set the value of apply change to principal balance first for simple interest.

Arguments

• param - See description.

pub fn set_pc_balance_statistics(&mut self, param: bool)

Set the value of include with balance result statistics.

Arguments

• param - See description.

pub fn set_pc_auxiliary(&mut self, param: bool)

Set the auxiliary principal change event.

Arguments

• param - See description.

pub fn set_pc_aux_passive(&mut self, param: bool)

Set the auxiliary passive principal change event.

Arguments

• param - See description.

pub fn set_current_value(&mut self, current_value_param: ElemCurrentValue)

Set the current value.

Arguments

• current_value_param - See description.

pub fn set_cv_eom(&mut self, param: bool)

Set the value to adjust successive dates to end of month.

Arguments

• param - See description.

pub fn set_cv_passive(&mut self, param: bool)

Set the value to not affect the remaining cashflow.

Arguments

• param - See description.

pub fn set_cv_present(&mut self, param: bool)

Set the value to designate as present value.

Arguments

• param - See description.

pub fn set_interest_change(&mut self, interest_change_param: ElemInterestChange)

Set the interest change.

Arguments

• interest_change_param - See description.

pub fn set_ic_method(&mut self, param: MethodType)

Set the interest method used.

Arguments

• param - See description.

pub fn set_ic_day_count_basis(&mut self, param: DayCountType)

Set the day count basis.

Arguments

• param - See description.

pub fn set_ic_days_in_year(&mut self, param: usize)

Set the number of days in the year.

Arguments

• param - See description.

pub fn set_ic_effective_frequency(&mut self, param: FrequencyType)

Set the optional effective frequency.

Arguments

• param - See description.

pub fn set_ic_interest_frequency(&mut self, param: FrequencyType)

Set the optional interest amortization frequency.

Arguments

• param - See description.

pub fn set_ic_round_balance(&mut self, param: RoundType)

Set the round intermediate balance results.

Arguments

• param - See description.

pub fn set_ic_round_decimal_digits(&mut self, param: Decimal)

Set the round decimal digits.

Arguments

• param - See description.

pub fn set_statistic_value(&mut self, statistic_value_param: ElemStatisticValue)

Set the statistic value.

Arguments

• statistic_value_param - See description.

pub fn set_sv_name(&mut self, param: &str)

Set the name of the statistic event.

Arguments

• param - See description.

pub fn set_sv_eom(&mut self, param: bool)

Set the value of adjust successive dates to end of month.

Arguments

• param - See description.

pub fn set_sv_final(&mut self, param: bool)

Set the value to final statistic event.

Arguments

• param - See description.