Struct amfnengine::core::list_summary::ListSummary

pub struct ListSummary { /* fields omitted */ }

Implementations

impl ListSummary

List of summary items implementation.

pub fn new() -> ListSummary

Create and return a new list of summary elements.

Return

• See description.

pub fn add_summary(
    &mut self,
    name_param: &str,
    label_param: &str,
    label_expr_param: &str,
    result_param: &str,
    result_expr_param: &str
) -> bool

Add a new summary item into the summary item list.

Arguments

• name_param - Summary element name.
• label_param - Summary element label.
• label_expr_param - Element label expression.
• result_param - Summary element result.
• result_expr_param - Element result expression.

Return

• True if successful, otherwise false.

pub fn list(&self) -> &Vec<ElemSummary>

Get the vector of summary events.

Return

• See description.

pub fn name(&self) -> &str

Get the name of the summary item.

Return

• See description.

pub fn label(&self) -> &str

Get the label of the summary item.

Return

• See description.

pub fn label_expr(&self) -> &str

Get the label expression of the summary item.

Return

• See description.

pub fn result(&self) -> &str

Get the result of the summary item.

Return

• See description.

pub fn result_expr(&self) -> &str

Get the result expression of the summary item.

Return

• See description.

pub fn remove(&mut self) -> bool

Remove the selected summary item from the summary item list.

Return

• True if successful, otherwise false.

Trait Implementations

impl Default for ListSummary

List of summary items default implementation.

fn default() -> Self

Create and return a new list of summary elements.

Return

• See description.

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.