scram::mef::CcfEvent

A basic event that represents a multiple failure of a group of events due to a common cause. More...

#include <ccf_group.h>

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

Public Functions

	Name
	CcfEvent(std::vector< Gate * > members, const CcfGroup * ccf_group)<br>Constructs CCF event with specific name that is used for internal purposes.
const CcfGroup &	ccf_group() const
const std::vector< Gate * > &	members() const

Additional inherited members

Public Functions inherited from scram::mef::BasicEvent

	Name
virtual	~BasicEvent() =default
bool	HasExpression() const
void	expression(Expression * expression)<br>Sets the expression of this basic event.
Expression &	expression() const
double	p() const
void	Validate() const<br>Validates the probability expressions for the primary event.
bool	HasCcf() const<br>Indicates if this basic event has been set to be in a CCF group.
const Gate &	ccf_gate() const
void	ccf_gate(std::unique_ptr< Gate > gate)<br>Sets the common cause failure group gate that can represent this basic event in analysis with common cause information.

Public Attributes inherited from scram::mef::BasicEvent

	Name
constexpr const char *	kTypeString <br>In errors.

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 Attributes inherited from scram::mef::Event

	Name
constexpr const char *	kTypeString <br>For error messages.

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

cpp

class scram::mef::CcfEvent;

A basic event that represents a multiple failure of a group of events due to a common cause.

This event is generated out of a common cause group. This class is a helper to report correctly the CCF events.

Public Functions Documentation

function CcfEvent

cpp

CcfEvent(
    std::vector< Gate * > members,
    const CcfGroup * ccf_group
)

Constructs CCF event with specific name that is used for internal purposes.

Parameters:

members The members that this CCF event represents as multiple failure.
ccf_group The CCF group that created this event.

This name is formatted with the CcfGroup. The creator CCF group and the member events of this specific CCF event are saved for reporting.

function ccf_group

cpp

inline const CcfGroup & ccf_group() const

Return: The CCF group that created this CCF event.

function members

cpp

inline const std::vector< Gate * > & members() const

Return: Members of this CCF event. The members also own this CCF event through parentship.

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

scram::mef::CcfEvent ​

Public Functions ​

Additional inherited members ​

Detailed Description ​

Public Functions Documentation ​

function CcfEvent ​

function ccf_group ​

function members ​