The Sparta Modeling Framework
Loading...
Searching...
No Matches
sparta::State< EnumT, MetaDataT, MAX_MARKERS >::Marker Class Reference

Class that will mark the state for transition. More...

#include <State.hpp>

Public Member Functions

 Marker (const Marker &)=default
 
void set (MetaDataTPtr ptr=nullptr)
 Set the marker.
 
void clear ()
 Clear the marker.
 
bool isMarked () const
 Is the marker set? true if so.
 
const EnumTValueTypegetMarkerValue () const
 Return the marker value for this marker (debug use)
 

Detailed Description

template<class EnumT, class MetaDataT = void, uint32_t MAX_MARKERS = 15>
class sparta::State< EnumT, MetaDataT, MAX_MARKERS >::Marker

Class that will mark the state for transition.

Definition at line 149 of file State.hpp.

Member Function Documentation

◆ clear()

template<class EnumT , class MetaDataT = void, uint32_t MAX_MARKERS = 15>
void sparta::State< EnumT, MetaDataT, MAX_MARKERS >::Marker::clear ( )
inline

Clear the marker.

Definition at line 182 of file State.hpp.

◆ getMarkerValue()

template<class EnumT , class MetaDataT = void, uint32_t MAX_MARKERS = 15>
const EnumTValueType & sparta::State< EnumT, MetaDataT, MAX_MARKERS >::Marker::getMarkerValue ( ) const
inline

Return the marker value for this marker (debug use)

Returns
The marker value this marker represents

Definition at line 199 of file State.hpp.

◆ isMarked()

template<class EnumT , class MetaDataT = void, uint32_t MAX_MARKERS = 15>
bool sparta::State< EnumT, MetaDataT, MAX_MARKERS >::Marker::isMarked ( ) const
inline

Is the marker set? true if so.

Definition at line 191 of file State.hpp.

◆ set()

template<class EnumT , class MetaDataT = void, uint32_t MAX_MARKERS = 15>
void sparta::State< EnumT, MetaDataT, MAX_MARKERS >::Marker::set ( MetaDataTPtr  ptr = nullptr)
inline

Set the marker.

Definition at line 174 of file State.hpp.


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