scram::mef::FunctionalEvent

Representation of functional events in event trees.

#include <event_tree.h>

Inherits from scram::mef::Element, scram::mef::Usage, scram::mef::ContainerElement, boost::noncopyable

Public Functions

	Name
int	order() const
void	order(int order)<br>Sets the functional event order.
	Element(std::string name)<br>Constructs an element with an original name.

Public Attributes

	Name
constexpr const char *	kTypeString <br>Type string for error messages.

Additional inherited members

Public Types inherited from scram::mef::Element

	Name
using ext::linear_set< Attribute, AttributeKey >	AttributeMap <br>Unique attribute map keyed with the attribute names.

Public Functions inherited from scram::mef::Element

	Name
const std::string &	name() const
std::string_view	name_view() const
const std::string &	label() const
void	label(std::string label)<br>Sets the element label.
const AttributeMap &	attributes() const
void	AddAttribute(Attribute attr)<br>Adds an attribute to the attribute map of this element.
void	SetAttribute(Attribute attr)<br>Sets an attribute to the attribute map.
const Attribute *	GetAttribute(std::string_view name) const
std::optional< Attribute >	RemoveAttribute(std::string_view name)<br>Removes an attribute of this element.

Protected Functions inherited from scram::mef::Element

	Name
	~Element() =default
void	name(std::string name)<br>Resets the element name.

Public Functions inherited from scram::mef::Usage

	Name
bool	usage() const
void	usage(bool usage)

Protected Functions inherited from scram::mef::Usage

	Name
	~Usage() =default

Protected Functions inherited from scram::mef::ContainerElement

	Name
const Element *	container() const

Friends inherited from scram::mef::ContainerElement

	Name
class	Container

Public Functions Documentation

function order

inline int order() const

Return:

• The order of the functional event in the event tree.
• 0 if no order has been assigned.

function order

inline void order(
    int order
)

Sets the functional event order.

function Element

explicit Element(
    std::string name
)

Constructs an element with an original name.

Parameters:

• name The local identifier name.

Exceptions:

• LogicError The name is required and empty.
• ValidityError The name is malformed.

The name is expected to conform to identifier requirements described in the MEF documentation and additions.

Public Attributes Documentation

variable kTypeString

static constexpr const char * kTypeString = "functional event";

Type string for error messages.

---

Updated on 2025-11-11 at 16:51:08 +0000