$darkmode
Public Member Functions | Protected Member Functions | List of all members
cloe::actions::Bundle Class Reference
Inheritance diagram for cloe::actions::Bundle:
[legend]
Collaboration diagram for cloe::actions::Bundle:
[legend]

Public Member Functions

 Bundle (const std::string &name, std::vector< ActionPtr > &&actions)
 
ActionPtr clone () const override
 
void operator() (const Sync &s, TriggerRegistrar &r) override
 
bool is_significant () const override
 
- Public Member Functions inherited from cloe::Entity
 Entity (const std::string &name)
 
 Entity (const std::string &name, const std::string &desc)
 
std::string name () const
 
void set_name (const std::string &name)
 
std::string description () const
 
void set_description (const std::string &desc)
 

Protected Member Functions

void to_json (Json &j) const override
 
- Protected Member Functions inherited from cloe::Action
Logger logger () const
 

Additional Inherited Members

- Protected Attributes inherited from cloe::Entity
std::string name_
 
std::string desc_
 

Member Function Documentation

◆ clone()

ActionPtr cloe::actions::Bundle::clone ( ) const
overridevirtual

Clone this action with correct state information.

This happens when a sticky trigger evaluates to true.

Implements cloe::Action.

Here is the call graph for this function:

◆ is_significant()

bool cloe::actions::Bundle::is_significant ( ) const
overridevirtual

Return whether this action is a significant action.

All actions that have an effect on the result of a simulation are significant. Actions that are not significant are:

realtime_factor log

Insignificant actions are concealable, which removes them from the trigger history. This must be explicitly specified when inserting a trigger.

Reimplemented from cloe::Action.

◆ operator()()

void cloe::actions::Bundle::operator() ( const Sync &  ,
TriggerRegistrar &   
)
overridevirtual

Execute the action.

Implements cloe::Action.

Here is the call graph for this function:

◆ to_json()

void cloe::actions::Bundle::to_json ( Json &  j) const
inlineoverrideprotectedvirtual

Describe the action state so that the same action can be re-created through it's JSON representation with the corresponding ActionFactory.

Implements cloe::Action.

The documentation for this class was generated from the following files: