amfnengine 0.3.5

Amortization Functions (AmFn) Engine
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

//! The template event element definition.
// Copyright (c) 2021 ShiftLeft Software
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

use crate::core::ListEvent;

pub struct ElemTemplateEvent {
    /// Name of the template event.
    name: String,
    /// List of events.
    list_event: ListEvent,
    /// Initial template event.
    initial_event: bool,
}

/// The template event element implementation.

impl ElemTemplateEvent {
    /// Create and return a new template event.
    ///
    /// # Arguments
    ///
    /// * `name_param` - Name of template event.
    ///
    /// # Return
    ///
    /// * See description.

    pub fn new(name_param: &str) -> ElemTemplateEvent {
        ElemTemplateEvent {
            name: String::from(name_param),
            list_event: ListEvent::new(false),
            initial_event: false,
        }
    }

    /// Get the name.
    ///
    /// # Return
    ///
    /// * See description.

    pub fn name(&self) -> &str {
        self.name.as_str()
    }

    /// Get the list event.
    ///
    /// # Return
    ///
    /// * See description.

    pub fn list_event(&self) -> &ListEvent {
        &self.list_event
    }

    /// Get the mutable list event.
    ///
    /// # Return
    ///
    /// * See description.

    pub fn list_event_mut(&mut self) -> &mut ListEvent {
        &mut self.list_event
    }

    /// Get the initial event.
    ///
    /// # Return
    ///
    /// * See description.

    pub fn initial_event(&self) -> bool {
        self.initial_event
    }

    /// Set the name.
    ///
    /// # Arguments
    ///
    /// * `name_param` - See description.

    pub fn set_name(&mut self, name_param: &str) {
        self.name = String::from(name_param);
    }

    /// Set the list event.
    ///
    /// # Arguments
    ///
    /// * `list_event_param` - See description.

    pub fn set_list_event(&mut self, list_event_param: ListEvent) {
        self.list_event = list_event_param;
    }

    /// Set the initial event.
    ///
    /// # Arguments
    ///
    /// * `initial_event_param` - See description.

    pub fn set_initial_event(&mut self, initial_event_param: bool) {
        self.initial_event = initial_event_param;
    }
}