Struct amfnengine::core::elem_amortization::ElemAmortization

pub struct ElemAmortization { /* private fields */ }

Implementations

impl ElemAmortization

The amortization cashflow implementation.

pub fn new(
    event_type_param: &str,
    orig_date_param: usize,
    event_date_param: usize,
    sort_order_param: usize,
    orig_value_param: Decimal,
    value_param: Decimal,
    value_expr_param: &str,
    periods_param: usize,
    intervals_param: usize,
    frequency_param: FrequencyType,
    principal_decrease_param: Decimal,
    principal_increase_param: Decimal,
    interest_param: Decimal,
    sl_interest_param: Decimal,
    value_to_interest_param: Decimal,
    value_to_principal_param: Decimal,
    acc_balance_param: Decimal,
    balance_param: Decimal,
    list_event_index_param: usize,
    event_sequence_param: usize,
    stat_sequence_param: usize,
    extension_param: ElemExtension,
    list_parameter_param: Option<ListParameter>,
    list_descriptor_param: Option<ListDescriptor>
) -> ElemAmortization

Create a new amortization cashflow element.

Arguments

• event_type_param - Event type.
• orig_date_param - Original date.
• event_date_param - Event date.
• sort_order_param - Sort order.
• orig_value_param - Original value paremeter.
• value_param - Value parameter.
• value_expr_param - Value expression parameter.
• periods_param - Periods parameter.
• intervals_param - Intervals parameter.
• frequency_param - Frequency parameter.
• principal_decrease_param - Principal decrease.
• principal_increase_param - Principal increase.
• interest_param - Interest parameter.
• sl_interest_param - Straight line interest.
• value_to_interest_param - Value to interest.
• value_to_principal_param - Value to principal.
• acc_balance_param - Accrued balance.
• balance_param - Balance.
• list_event_index_param - List event index.
• event_sequence_param - Event sequence.
• stat_sequence_param - Statistics sequence.
• extension_param - Extension (current value, interest change, principal change, statistic value).
• list_parameter_param - List parameter.
• list_descriptor_param - List descriptor.

Return

• See description.

pub fn event_type(&self) -> &str

Get the event type value.

Return

• See description.

pub fn orig_date(&self) -> usize

Get the event original date value.

Return

• See description.

pub fn event_date(&self) -> usize

Get the event date value.

Return

• See description.

pub fn sort_order(&self) -> usize

Get the sort order value.

Return

• See description.

pub fn orig_value(&self) -> Decimal

Get the original element value.

Return

• See description.

pub fn value(&self) -> Decimal

Get the element value.

Return

• See description.

pub fn value_expr(&self) -> &str

Get the element value expression.

Return

• See description.

pub fn periods(&self) -> usize

Get the periods value.

Return

• See description.

pub fn intervals(&self) -> usize

Get the intervals value.

Return

• See description.

pub fn frequency(&self) -> FrequencyType

Get the frequency value.

Return

• See description.

pub fn principal_decrease(&self) -> Decimal

Get the principal decrease value.

Return

• See description.

pub fn principal_increase(&self) -> Decimal

Get the principal increase value.

Return

• See description.

pub fn interest(&self) -> Decimal

Get the interest value.

Return

• See description.

pub fn sl_interest(&self) -> Decimal

Get the straight line interest value.

Return

• See description.

pub fn value_to_interest(&self) -> Decimal

Get the value to interest.

Return

• See description.

pub fn value_to_principal(&self) -> Decimal

Get the value to principal.

Return

• See description.

pub fn acc_balance(&self) -> Decimal

Get the accrued balance value.

Return

• See description.

pub fn balance(&self) -> Decimal

Get the balance value.

Return

• See description.

pub fn list_event_index(&self) -> usize

Get the list event index.

Return

• See description.

pub fn event_sequence(&self) -> usize

Get the event sequence.

Return

• See description.

pub fn stat_sequence(&self) -> usize

Get the statistics sequence.

Return

• See description.

pub fn list_parameter(&self) -> Option<&ListParameter>

Get the list parameter.

Return

• See description.

pub fn list_descriptor(&self) -> Option<&ListDescriptor>

Get the list descriptor.

Return

• See description.

pub fn set_event_type(&mut self, event_type_param: &str)

Set the event type.

Arguments

• event_type_param - See description.

pub fn set_original_date(&mut self, original_date_param: usize)

Set the original date.

Arguments

• original_date_param - See description.

pub fn set_event_date(&mut self, event_date_param: usize)

Set the event date.

Arguments

• event_date_param - See description.

pub fn set_sort_order(&mut self, sort_order_param: usize)

Set the sort order.

Arguments

• sort_order_param - See description.

pub fn set_orig_value(&mut self, orig_value_param: Decimal)

Set the original value.

Arguments

• orig_value_param - See description.

pub fn set_value(&mut self, value_param: Decimal)

Set the value.

Arguments

• value_param - See description.

pub fn set_value_expr(&mut self, value_expr_param: &str)

Set the value expression.

Arguments

• value__expr_param - See description.

pub fn set_periods(&mut self, periods_param: usize)

Set the periods.

Arguments

• periods_param - See description.

pub fn set_intervals(&mut self, intervals_param: usize)

Set the intervals.

Arguments

• intervals_param - See description.

pub fn set_frequency(&mut self, frequency_param: FrequencyType)

Set the frequency.

Arguments

• frequency_param - See description.

pub fn set_principal_decrease(&mut self, principal_decrease_param: Decimal)

Set the principal decrease.

Arguments

• principal_decrease_param - See description.

pub fn set_principal_increase(&mut self, principal_increase_param: Decimal)

Set the principal increase value.

Arguments

• principal_increase_param - See description.

pub fn set_interest(&mut self, interest_param: Decimal)

Set the interest value.

Arguments

• interest_param - See description.

pub fn set_sl_interest(&mut self, sl_interest_param: Decimal)

Set the straight line interest value.

Arguments

• sl_interest_param - See description.

pub fn set_value_to_interest(&mut self, value_to_interest_param: Decimal)

Set the value to interest.

Arguments

• value_to_interest_param - See description.

pub fn set_value_to_principal(&mut self, value_to_principal_param: Decimal)

Set the value to principal.

Arguments

• value_to_principal_param - See description.

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

Set the accrued balance value.

Arguments

• acc_balance_param - See description.

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

Set the balance value.

Arguments

• balance_param - See description.

pub fn set_list_event_index(&self, list_event_index_param: usize)

Set the list event index.

Arguments

• list_event_index_param - See description.

pub fn set_event_sequence(&mut self, event_sequence_param: usize)

Set the event sequence.

Arguments

• event_sequence_param - See description.

pub fn set_stat_sequence(&mut self, stat_sequence_param: usize)

Set the statistics sequence.

Arguments

• stat_sequence_param - See description.

pub fn set_list_parameter(
    &mut self,
    list_parameter_param: Option<ListParameter>
)

Set the list parameter.

Arguments

• list_parameter_param - See description.

pub fn set_list_descriptor(
    &mut self,
    list_descriptor_param: Option<ListDescriptor>
)

Set the list descriptor.

Arguments

• list_descriptor_param - See description.

Trait Implementations

impl ExtensionTrait for ElemAmortization

The amortization cashflow extension implementation.

fn elem_type(&self) -> ExtensionType

Get the element type value.

Return

• See description.

fn elem_extension(&self) -> &ElemExtension

Get the extension.

Return

• See description.

fn elem_extension_mut(&mut self) -> &mut ElemExtension

Get the mut extension.

Return

• See description.

fn set_elem_extension(&mut self, elem_extension_param: ElemExtension)

Set the extension.

Arguments

• elem_extension_param - See description.