Trait amfnengine::ListTrait

pub trait ListTrait {
    fn clear(&mut self);
    fn count(&self) -> usize;
    fn index(&self) -> usize;
    fn get_element(&self, index_param: usize) -> bool;
    fn set_index(&self, index_param: usize) -> bool;
}

Common trait for all lists.

Required methods

fn clear(&mut self)

Clear elements from the list.

fn count(&self) -> usize

Get the count of the list.

Return

• See description.

fn index(&self) -> usize

Get the index of the selected element (starting from 0).

Return

• See description.

fn get_element(&self, index_param: usize) -> bool

Select an element based upon an index value.

Arguments

• index_param - The index value of the element to select (starting from 0).

Return

• True if successful, otherwise false.

fn set_index(&self, index_param: usize) -> bool

Set the element index.

Arguments

• index_param - The index element to set (starting from 0).

Loading content...

Implementors

impl ListTrait for ListAmortization

List of amortization elements list implementation.

fn clear(&mut self)

Clear all elements from the amortization list.

fn count(&self) -> usize

Get the count of the amortization list.

Return

• See description.

fn index(&self) -> usize

Get the index of the selected amortization element (starting from 0).

Return

• See description.

fn get_element(&self, index_param: usize) -> bool

Select an amortization element based upon an index value.

Arguments

• index_param - Index value of the amortization element to select (starting from 0).

Return

• True if successful, otherwise false.

fn set_index(&self, index_param: usize) -> bool

Set the list index.

Arguments

• index_param - See description.

impl ListTrait for ListColumn

List of columns list implementation.

fn clear(&mut self)

Clear all columns from the column list.

fn count(&self) -> usize

Get the count of the columns.

Return

• See description.

fn index(&self) -> usize

Get the index of the selected column (starting from 0).

Return

• See description.

fn get_element(&self, index_param: usize) -> bool

Select a column based upon an index value.

Arguments

• index_param - The index value of the column to select (starting from 0).

Return

• True if successful, otherwise false.

fn set_index(&self, index_param: usize) -> bool

Set the list index.

Arguments

• index_param - See description.

Return

• True if successful, otherwise false.

impl ListTrait for ListDescriptor

List of descriptors list implementation.

fn clear(&mut self)

Clear all descriptors from the descriptor list.

fn count(&self) -> usize

Get the count of the descriptor list.

Return

• See description.

fn index(&self) -> usize

Get the index of the selected descriptor (starting from 0).

Return

• See description.

fn get_element(&self, index_param: usize) -> bool

Select a descriptor based upon an index value.

Arguments

• index_param - The index value of the descriptor to select (starting from 0).

Return

• True if successful, otherwise false.

fn set_index(&self, index_param: usize) -> bool

Set the list index.

Arguments

• index_param - See description.

impl ListTrait for ListEvent

List of events list implementation.

fn clear(&mut self)

Clear all events from the event list.

fn count(&self) -> usize

Get the count of the event list.

Return

• See description.

fn index(&self) -> usize

Get the index of the selected event (starting from 0).

Return

• See description.

fn get_element(&self, index_param: usize) -> bool

Select an event based upon an index value.

Arguments

• index_param - The index value of the event to select (starting from 0).

Return

• True if successful, otherwise false.

fn set_index(&self, index_param: usize) -> bool

Set the list index.

Arguments

• index_param - See description.

impl ListTrait for ListParameter

List of parameters list implementation.

fn clear(&mut self)

Clear all parameters from the parameter list.

fn count(&self) -> usize

Get the count of the parameter list.

Return

• See description.

fn index(&self) -> usize

Get the index of the selected parameter (starting from 0).

Return

• See description.

fn get_element(&self, index_param: usize) -> bool

Select a parameter based upon an index value.

Arguments

• index_param - Index value of the parameter to select (starting from 0).

Return

• True if successful, otherwise false.

fn set_index(&self, index_param: usize) -> bool

Set the list index.

Arguments

• index_param - See description.

impl ListTrait for ListStatisticHelper

List of statistic helper list implementation.

fn clear(&mut self)

Clear all statistics from the statistic list.

fn count(&self) -> usize

Get the count of the statistic helper list.

Return

• See description.

fn index(&self) -> usize

Get the index of the selected statistic (starting from 0).

Return

• See description.

fn get_element(&self, index_param: usize) -> bool

Select a statistic based upon an index value.

Arguments

• index_param - Index value of the statistic to select (starting from 0).

Return

• True if successful, otherwise false.

fn set_index(&self, index_param: usize) -> bool

Set the list index.

Arguments

• index_param - See description.

Return

• True if successful, otherwise false.

impl ListTrait for ListSummary

List of summary items list implementation.

fn clear(&mut self)

Clear all summary items from the summary item list.

fn count(&self) -> usize

Get the count of the summary list.

Return

• See description.

fn index(&self) -> usize

Get the index of the selected summary item (starting from 0).

Return

• See description.

fn get_element(&self, index_param: usize) -> bool

Select a summary item based upon an index value.

Arguments

• index_param - The index value of the summary item to select (starting from 0).

Return

• True if successful, otherwise false.

fn set_index(&self, index_param: usize) -> bool

Set the list index.

Arguments

• index_param - See description.

Return

• True if successful, otherwise false.

impl ListTrait for ListCashflow

List of currently active cashflows list implementation.

fn clear(&mut self)

Clear all cashflows from the cashflow list.

fn count(&self) -> usize

Get the count of the cashflow list.

Return

• See description.

fn index(&self) -> usize

Get the index of the selected cashflow (starting from 0).

Return

• See description.

fn get_element(&self, index_param: usize) -> bool

Select a cashflow based upon an index value.

Arguments

• index_param - The index value of the cashflow to select (starting from 0).

Return

• True if successful, otherwise false.

fn set_index(&self, index_param: usize) -> bool

Set the list index.

Arguments

• index_param - See description.

impl ListTrait for ListExchangeRate

List of exchange rates list implementation.

fn clear(&mut self)

Clear all exchange rates from the exchange rate list.

fn count(&self) -> usize

Get the count of the exchange rate list.

Return

• See description.

fn index(&self) -> usize

Get the index of the selected exchange rate (starting from 0).

Return

• See description.

fn get_element(&self, index_param: usize) -> bool

Select a exchange rate based upon an index value.

Arguments

• index_param - The index value of the exchange rate to select (starting from 0).

Return

• True if successful, otherwise false.

fn set_index(&self, index_param: usize) -> bool

Set the list index.

Arguments

• index_param - See description.

impl ListTrait for ListTemplateEvent

List of template events list implementation.

fn clear(&mut self)

Clear all template events from the template event list.

fn count(&self) -> usize

Get the count of the template event list.

Return

• See description.

fn index(&self) -> usize

Get the index of the selected template event (starting from 0).

Return

• See description.

fn get_element(&self, index_param: usize) -> bool

Select an template event based upon an index value.

Arguments

• index_param - The index value of the template event to select (starting from 0).

Return

• True if successful, otherwise false.

fn set_index(&self, index_param: usize) -> bool

Set the list index.

Arguments

• index_param - See description.

impl ListTrait for ListTemplateGroup

List of template groups list implementation.

fn clear(&mut self)

Clear all template groups from the template group list.

fn count(&self) -> usize

Get the count of the template group list.

Return

• See description.

fn index(&self) -> usize

Get the index of the selected template group (starting from 0).

Return

• See description.

fn get_element(&self, index_param: usize) -> bool

Select a template group based upon an index value.

Arguments

• index_param - The index value of the template group to select (starting from 0).

Return

• True if successful, otherwise false.

fn set_index(&self, index_param: usize) -> bool

Set the list index.

Arguments

• index_param - See description.

Loading content...