Struct amfnengine::core::elem_event::ElemEvent

pub struct ElemEvent { /* private fields */ }

Implementations

impl ElemEvent

The event element implementation.

pub fn new(
    event_type_param: &str,
    event_date_param: usize,
    date_expr_param: &str,
    sort_order_param: usize,
    value_param: Decimal,
    value_expr_param: &str,
    value_expr_balance_param: bool,
    periods_param: usize,
    periods_expr_param: &str,
    skip_mask_len_param: usize,
    skip_mask_param: u128,
    intervals_param: usize,
    frequency_param: FrequencyType,
    extension_param: ElemExtension,
    list_parameter_param: Option<ListParameter>,
    list_descriptor_param: Option<ListDescriptor>,
    event_name_param: &str,
    next_name_param: &str
) -> ElemEvent

Create a new event cashflow element.

Arguments

• event_type_param - Event type.
• event_date_param - Event date.
• date_expr_param - Date expression.
• sort_order_param - Sort order.
• value_param - Value parameter.
• value_expr_param - Value expression parameter.
• value_expr_balance_param - Value expression balance.
• periods_param - Periods parameter.
• periods_expr_param - Periods expression.
• skip_mask_len_param - Skip mask length.
• skip_mask_param - Skip mask.
• intervals_param - Intervals parameter.
• frequency_param - Frequency parameter.
• extension_param - Extension (current value, interest change, principal change, statistic value).
• list_parameter_param - List parameter.
• list_descriptor_param - List descriptor.
• event_name_param - Optional event name.
• next_name_param - Optional next event name.

Return

• See description.

pub fn event_type(&self) -> &str

Get the event type value.

Return

• See description.

pub fn event_date(&self) -> usize

Get the event date value.

Return

• See description.

pub fn date_expr(&self) -> &str

Get the date expression value.

Return

• See description.

pub fn sort_order(&self) -> usize

Get the sort order 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 value_expr_balance(&self) -> bool

Get the element value expression balance.

Return

• See description.

pub fn periods(&self) -> usize

Get the periods value.

Return

• See description.

pub fn periods_expr(&self) -> &str

Get the periods expression value.

Return

• See description.

pub fn skip_mask_len(&self) -> usize

Get the skip mask length.

Return

• See description.

pub fn skip_mask(&self) -> u128

Get the skip mask 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 list_parameter(&self) -> Option<&ListParameter>

Get the list parameter.

Return

• See description.

pub fn list_parameter_mut(&mut self) -> Option<&mut ListParameter>

Get the mutable list parameter.

Return

• See description.

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

Get the list descriptor.

Return

• See description.

pub fn event_name(&self) -> &str

Get the event name.

Return

• See description.

pub fn next_name(&self) -> &str

Get the next name.

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_event_date(&self, event_date_param: usize)

Set the event date.

Arguments

• event_date_param - See description.

pub fn set_date_expr(&mut self, date_expr_param: &str)

Set the date expression.

Arguments

• date_expr_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_value(&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_value_expr_balance(&mut self, value_expr_balance_param: bool)

Set the value expression balance.

Arguments

• value_expr_balance_param - See description.

pub fn set_periods(&self, periods_param: usize)

Set the periods.

Arguments

• periods_param - See description.

pub fn set_periods_expr(&mut self, periods_expr_param: &str)

Set the periods expression.

Arguments

• periods_expr_param - See description.

pub fn set_skip_mask(&self, skip_mask_len_param: usize, skip_mask_param: u128)

Set the skip mask.

Arguments

• skip_mask_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_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.

pub fn set_event_name(&mut self, event_name_param: &str)

Set the event name.

Arguments

• event_name_param - See description.

pub fn set_next_name(&mut self, next_name_param: &str)

Set the next name.

Arguments

• next_name_param - See description.

Trait Implementations

impl ExtensionTrait for ElemEvent

The event element 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.