Struct amfnengine::engine::list_template_group::ListTemplateGroup

pub struct ListTemplateGroup { /* private fields */ }

Implementations

impl ListTemplateGroup

Implementation for the list of template groups.

pub fn new(calc_manager_param: &Rc<RefCell<CalcManager>>) -> ListTemplateGroup

Create and return a new list template group.

Arguments

• calc_manager_param - Calculation manager.

Return

• See description.

pub fn add_template_group(&mut self, group_param: &str) -> Result<(), ErrorType>

Add a new template group into the template group list. If the group name results in a duplicate entry, an incrementing number starting from 2 is appended to the group until a non-duplicate entry is found.

Arguments

• group_param - Group name of the template group.

Return

• ERROR_NONE if successful, otherwise error code.

pub fn append_template_groups(&mut self, list_template_group: ListTemplateGroup)

Append to the template group list.

Arguments

• list_template_group - See description.

pub fn create_template_group(
    &self,
    group_param: &str,
    elem_preferences_orig_opt: Option<ElemPreferences>,
    copy_propagate: bool
) -> Result<ElemTemplateGroup, ErrorType>

Add a new template group into the template group list. If the group name results in a duplicate entry, an incrementing number starting from 2 is appended to the group until a non-duplicate entry is found.

Arguments

• group_param - Group name of the template group.
• elem_preferences_orig_opt - Original preferences element to copy (or None).
• copy_propagate - Copy only descriptors marked as “propagate” (otherwise copy all descriptors).

Return

• ERROR_NONE if successful, otherwise error code.

pub fn copy_with_calc_manager(
    &self,
    calc_manager_param: &Rc<RefCell<CalcManager>>
) -> ListTemplateGroup

Performs a deep copy of the template group list and returns a new template group list.

Arguments

• calc_manager_param - Calculation manager.

Return

• See description.

pub fn copy_selected(&self) -> ElemTemplateGroup

Performs a deep copy of the template group element and returns a new template group element.

Return

• ERROR_NONE if successful, otherwise error code.

pub fn evaluate_descriptors(&self)

Evaluate all of the descriptors in the template group. For each descriptor that specifies an expression, execute the expression using the list of parameters.

pub fn group(&self) -> &str

Get the group name of the template group.

Return

• See description.

pub fn preferences(&self) -> &ElemPreferences

Get the preferences element.

Return

• See description.

pub fn preferences_mut(&mut self) -> &mut ElemPreferences

Get the mutable preferences element.

Return

• See description.

pub fn list_template_event(&self) -> &ListTemplateEvent

Get the list of template events.

Return

• See description.

pub fn list_template_event_mut(&mut self) -> &mut ListTemplateEvent

Get the mutable list of template events.

Return

• See description.

pub fn sort_on_add(&mut self) -> bool

Retrieve when the template group list is sorted.

Return

• See description.

pub fn get_element_by_group(
    &self,
    group_param: &str,
    select_param: bool
) -> bool

Select a template group based upon a group name.

Arguments

• group_param - The group name of the template group to select.
• select_param - If true select element, otherwise restore current element.

Return

• True if successful, otherwise false.

pub fn remove(&mut self) -> bool

Remove the selected template group from the template group list.

Return

• True if successful, otherwise false.

pub fn set_group(&mut self, group_param: &str) -> bool

Set the group name of the template group.

Arguments

• group_param - See description.

Return

• True if successful, otherwise false.

pub fn set_sort_on_add(&mut self, sort_on_add_param: bool) -> bool

Determines when the template group list is sorted.

Arguments

• sort_on_add_param - If true sort when an template group is added, otherwise do not sort (for bulk adds).

Return

• True if successful, otherwise false.

pub fn set_sort_updated(&mut self, sort_updated_param: bool) -> bool

Set sort updated.

Arguments

• sort_updated_param - If true sort updated otherwise false.

pub fn sort(&mut self)

Sort the template group list.

Trait Implementations

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.