scenario_simulator_v2 C++ API
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
openscenario_interpreter::syntax::StoryboardElement Class Reference

#include <storyboard_element.hpp>

Inheritance diagram for openscenario_interpreter::syntax::StoryboardElement:
Inheritance graph
[legend]
Collaboration diagram for openscenario_interpreter::syntax::StoryboardElement:
Collaboration graph
[legend]

Public Member Functions

 StoryboardElement (const Trigger &stop_trigger)
 
 StoryboardElement (const Trigger &start_trigger, const Trigger &stop_trigger)
 
 StoryboardElement (const std::size_t maximum_execution_count, const Trigger &start_trigger)
 
 StoryboardElement (const std::size_t maximum_execution_count=1)
 
auto state () const -> const auto &
 
template<StoryboardElementState::value_type State>
auto is () const
 
auto override ()
 
void addTransitionCallback (StoryboardElementState::value_type transition, std::function< void(const StoryboardElement &)> callback)
 
auto transitionTo (const Object &state) -> bool
 
virtual auto evaluate () -> Object
 

Protected Member Functions

auto rename (const std::string &name) const
 
auto unique (const std::string &name)
 
template<typename U , typename Node , typename... Ts>
auto readStoryboardElement (const Node &node, Scope &inner_scope, Ts &&... xs)
 
template<typename U , typename Node , typename... Ts>
auto readCatalogedStoryboardElement (const Node &node, Scope &inner_scope, Ts &&... xs)
 

Protected Attributes

Trigger stop_trigger
 
const std::size_t maximum_execution_count = 1
 
std::size_t current_execution_count = 0
 
Object current_state = standby_state
 
Elements elements
 
Trigger start_trigger {{ConditionGroup()}}
 
std::unordered_set< std::string > names
 

Constructor & Destructor Documentation

◆ StoryboardElement() [1/4]

openscenario_interpreter::syntax::StoryboardElement::StoryboardElement ( const Trigger stop_trigger)
inlineexplicit

◆ StoryboardElement() [2/4]

openscenario_interpreter::syntax::StoryboardElement::StoryboardElement ( const Trigger start_trigger,
const Trigger stop_trigger 
)
inlineexplicit

◆ StoryboardElement() [3/4]

openscenario_interpreter::syntax::StoryboardElement::StoryboardElement ( const std::size_t  maximum_execution_count,
const Trigger start_trigger 
)
inlineexplicit

◆ StoryboardElement() [4/4]

openscenario_interpreter::syntax::StoryboardElement::StoryboardElement ( const std::size_t  maximum_execution_count = 1)
inlineexplicit

Member Function Documentation

◆ addTransitionCallback()

void openscenario_interpreter::syntax::StoryboardElement::addTransitionCallback ( StoryboardElementState::value_type  transition,
std::function< void(const StoryboardElement &)>  callback 
)
inline

◆ evaluate()

virtual auto openscenario_interpreter::syntax::StoryboardElement::evaluate ( ) -> Object
inlinevirtual

◆ is()

template<StoryboardElementState::value_type State>
auto openscenario_interpreter::syntax::StoryboardElement::is ( ) const
inline

◆ override()

auto openscenario_interpreter::syntax::StoryboardElement::override ( )
inline

◆ readCatalogedStoryboardElement()

template<typename U , typename Node , typename... Ts>
auto openscenario_interpreter::syntax::StoryboardElement::readCatalogedStoryboardElement ( const Node &  node,
Scope inner_scope,
Ts &&...  xs 
)
inlineprotected

◆ readStoryboardElement()

template<typename U , typename Node , typename... Ts>
auto openscenario_interpreter::syntax::StoryboardElement::readStoryboardElement ( const Node &  node,
Scope inner_scope,
Ts &&...  xs 
)
inlineprotected

◆ rename()

auto openscenario_interpreter::syntax::StoryboardElement::rename ( const std::string &  name) const
inlineprotected

◆ state()

auto openscenario_interpreter::syntax::StoryboardElement::state ( ) const -> const auto &
inline

◆ transitionTo()

auto openscenario_interpreter::syntax::StoryboardElement::transitionTo ( const Object state) -> bool
inline

◆ unique()

auto openscenario_interpreter::syntax::StoryboardElement::unique ( const std::string &  name)
inlineprotected

Member Data Documentation

◆ current_execution_count

std::size_t openscenario_interpreter::syntax::StoryboardElement::current_execution_count = 0
protected

◆ current_state

Object openscenario_interpreter::syntax::StoryboardElement::current_state = standby_state
protected

◆ elements

Elements openscenario_interpreter::syntax::StoryboardElement::elements
protected

◆ maximum_execution_count

const std::size_t openscenario_interpreter::syntax::StoryboardElement::maximum_execution_count = 1
protected

◆ names

std::unordered_set<std::string> openscenario_interpreter::syntax::StoryboardElement::names
protected

◆ start_trigger

Trigger openscenario_interpreter::syntax::StoryboardElement::start_trigger {{ConditionGroup()}}
protected

◆ stop_trigger

Trigger openscenario_interpreter::syntax::StoryboardElement::stop_trigger
protected

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