scram::mef::HouseEvent

Representation of a house event in a fault tree. More...

#include <event.h>

Inherits from scram::mef::Event, scram::mef::Id, scram::mef::Usage, scram::mef::Element, scram::mef::Role, scram::mef::ContainerElement, boost::noncopyable

Public Functions

	Name
	HouseEvent(HouseEvent && )<br>For the (N)RVO only (undefined!).
void	state(bool constant)<br>Sets the state for House event.
bool	state() const

Public Attributes

	Name
constexpr const char *	kTypeString <br>In errors.
HouseEvent	kTrue <br>Literal True event.
HouseEvent	kFalse <br>Literal False event.

Additional inherited members

Public Functions inherited from scram::mef::Event

	Name
virtual	~Event() =0<br>Abstract class.
	Id(std::string name, std::string base_path ="", RoleSpecifier role =RoleSpecifier::kPublic)<br>Constructs an element with an original name.

Public Functions inherited from scram::mef::Id

	Name
const std::string &	unique_name(const Element & element)<br>Produces unique name for the model element within the same type.
const std::string &	unique_name(const Id & element)
	Id(std::string name, std::string base_path ="", RoleSpecifier role =RoleSpecifier::kPublic)<br>Constructs an element with an original name.
const std::string &	id() const
std::string_view	id_view() const
std::string_view	full_path() const
void	id(std::string name)<br>Resets the element ID.

Protected Functions inherited from scram::mef::Id

	Name
	~Id() =default

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

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
	Element(std::string name)<br>Constructs an element with an original 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::Role

	Name
	Role(RoleSpecifier role =RoleSpecifier::kPublic, std::string base_path ="")<br>Sets the role of an element upon creation.
RoleSpecifier	role() const
const std::string &	base_path() const

Protected Functions inherited from scram::mef::Role

	Name
	~Role() =default

Protected Functions inherited from scram::mef::ContainerElement

	Name
const Element *	container() const

Friends inherited from scram::mef::ContainerElement

	Name
class	Container

Detailed Description

class scram::mef::HouseEvent;

Representation of a house event in a fault tree.

Note: House Events with unset/uninitialized expressions default to False.

Public Functions Documentation

function HouseEvent

HouseEvent(
    HouseEvent && 
)

For the (N)RVO only (undefined!).

function state

inline void state(
    bool constant
)

Sets the state for House event.

Parameters:

• constant False or True for the state of this house event.

function state

inline bool state() const

Return: The true or false state of this house event.

Public Attributes Documentation

variable kTypeString

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

In errors.

variable kTrue

static HouseEvent kTrue = []() {
  HouseEvent house_event("__true__");
  house_event.state(true);
  return house_event;
}();

Literal True event.

variable kFalse

static HouseEvent kFalse;

Literal False event.

---

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