Struct amfnengine::core::elem_balance_result::ElemBalanceResult

pub struct ElemBalanceResult { /* private fields */ }

Implementations

impl ElemBalanceResult

Balance result definition implementation.

pub fn new() -> ElemBalanceResult

Create a new balance result definition.

Return

• See description.

pub fn copy(&self) -> ElemBalanceResult

Copy this result definition as a new result definition.

Return

• See description.

pub fn clear(&mut self)

Clear all values.

pub fn prin_total(&self) -> usize

Get the total number of TYPE_PRINCIPAL_CHANGEs with statistics set.

Return

• See description.

pub fn prin_present(&self) -> usize

Get the number of TYPE_PRINCIPAL_CHANGEs following first current value present with statistics set.

Return

• See description.

pub fn interest_total(&self) -> Decimal

Get the total compounded interest charged not including any remaining interest.

Return

• See description.

pub fn interest_present(&self) -> Decimal

Get the compounded interest following first current value present.

Return

• See description.

pub fn sl_interest_total(&self) -> Decimal

Get the total straight-line interest charged not including any remaining interest.

Return

• See description.

pub fn sl_interest_present(&self) -> Decimal

Get the straight-line interest following first current value present.

Return

• See description.

pub fn acc_balance(&self) -> Decimal

Get the final accrued interest balance.

Return

• See description.

pub fn balance(&self) -> Decimal

Get the final balance.

Return

• See description.

pub fn balance_date(&self) -> usize

Get the final balance date.

Return

• See description.

pub fn prin_decrease(&self) -> Decimal

Get the total value of TYPE_PRINCIPAL_CHANGE decreases without auxiliary set.

Return

• See description.

pub fn prin_increase(&self) -> Decimal

Get the total value of TYPE_PRINCIPAL_CHANGE increases without auxiliary set.

Return

• See description.

pub fn aux_active_decrease(&self) -> Decimal

Get the value of active TYPE_PRINCIPAL_CHANGE decreases with auxiliary set.

Return

• See description.

pub fn aux_active_increase(&self) -> Decimal

Get the value of active TYPE_PRINCIPAL_CHANGE increases with auxiliary set.

Return

• See description.

pub fn aux_passive_decrease(&self) -> Decimal

Get the value of passive TYPE_PRINCIPAL_CHANGE decreases with auxiliary set.

Return

• See description.

pub fn aux_passive_increase(&self) -> Decimal

Get the value of passive TYPE_PRINCIPAL_CHANGE increases with auxiliary set.

Return

• See description.

pub fn polarity(&self) -> i32

Get the polarity of the cashflow.

Return

• -1=Negative cashflow, 1=Positive cashflow.

pub fn acc_balance_seen(&self) -> bool

Get the accrued interest balance seen.

Return

• True if accrued interest balance seen, otherwise false.

pub fn rule_of_78_seen(&self) -> bool

Get the Rule of 78 seen.

Return

• True if rule of 78 seen, otherwise false.

pub fn prin_first_index(&self) -> usize

Get the first principal change.

Return

• See description.

pub fn prin_first_stat_index(&self) -> usize

Get the first principal change with statistics set.

Return

• See description.

pub fn prin_first_pv_index(&self) -> usize

Get the first principal change after PV.

Return

• See description.

pub fn prin_first_stat_pv_index(&self) -> usize

Get the first principal change with statistics set after PV.

Return

• See description.

pub fn prin_last_index(&self) -> usize

Get the last principal change.

Return

• See description.

pub fn prin_last_stat_index(&self) -> usize

Get the last principal change with statistics set.

Return

• See description.

pub fn cur_first_pv_index(&self) -> usize

Get the first current value with PV set.

Return

• See description.

pub fn int_first_index(&self) -> usize

Get the first interest change.

Return

• See description.

pub fn int_last_index(&self) -> usize

Get the last interest change.

Return

• See description.

pub fn result_yield(&self) -> Decimal

Get the result yield.

Return

• See description.

pub fn result_decimal(&self) -> Decimal

Get the result decimal.

Return

• See description.

pub fn result_integer(&self) -> i32

Get the result integer.

Return

• See description.

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

Increment the total number of TYPE_PRINCIPAL_CHANGEs with statistics set.

Arguments

• param - See description.

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

Increment the number of TYPE_PRINCIPAL_CHANGEs following first current value present with statistics set.

Arguments

• param - See description.

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

Increment the total compounded interest charged not including any remaining interest.

Arguments

• param - See description.

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

Increment the compounded interest following first current value present not including any remaining interest.

Arguments

• param - See description.

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

Increment the total straight-line interest charged not including any remaining interest.

Arguments

• param - See description.

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

Increment the straight-line interest following first current value present not including any remaining interest.

Arguments

• param - See description.

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

Increment the total value of TYPE_PRINCIPAL_CHANGE decreases without auxiliary set.

Arguments

• param - See description.

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

Increment the total value of TYPE_PRINCIPAL_CHANGE increases without auxiliary set.

Arguments

• param - See description.

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

Increment the value of active TYPE_PRINCIPAL_CHANGE decreases with auxiliary set.

Arguments

• param - See description.

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

Increment the value of active TYPE_PRINCIPAL_CHANGE increases with auxiliary set.

Arguments

• param - See description.

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

Increment the value of passive TYPE_PRINCIPAL_CHANGE decreases with auxiliary set.

Arguments

• param - See description.

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

Increment the value of passive TYPE_PRINCIPAL_CHANGE increases with auxiliary set.

Arguments

• param - See description.

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

Set the final accrued interest balance.

Arguments

• param - See description.

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

Set the final balance.

Arguments

• param - See description.

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

Set the final balance date.

Arguments

• param - See description.

pub fn set_polarity(&mut self, param: i32)

Set the polarity of the cashflow.

Arguments

• param - See description.

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

Set the accrued interest balance seen.

Arguments

• param - See description.

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

Set the rule of 78 seen.

Arguments

• param - See description.

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

Set the first principal change.

Arguments

• param - See description.

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

Set the first principal change with statistics set.

Arguments

• param - See description.

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

Set the first principal change after PV.

Arguments

• param - See description.

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

Set the first principal change with statistics set after PV.

Arguments

• param - See description.

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

Set the last principal change.

Arguments

• param - See description.

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

Set the last principal change with statistics set.

Arguments

• param - See description.

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

Set the first current value with PV set.

Arguments

• param - See description.

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

Set the first interest change.

Arguments

• param - See description.

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

Set the last interest change.

Arguments

• param - See description.

pub fn set_result_yield(&self, param: Decimal)

Set the result yield.

Arguments

• param - See description.

pub fn set_result_decimal(&self, param: Decimal)

Set the result decimal.

Arguments

• param - See description.

pub fn set_result_integer(&self, param: i32)

Set the result integer.

Arguments

• param - See description.

Trait Implementations

impl Default for ElemBalanceResult

Balance result definition default implementation.

fn default() -> Self

Create a new balance result definition.

Return

• See description.