MIRA
Public Member Functions | Public Attributes | List of all members
HistoryState Class Reference

A pseudo state representing the history of a state. More...

#include <sm/TransitionTarget.h>

Inheritance diagram for HistoryState:
Inheritance graph
[legend]

Public Member Functions

 HistoryState (TransitionTargetPtr p, uint32 sid)
 

Public Attributes

std::string historyType
 The type of history (deep or shallow) More...
 
TransitionTargetPtr parent
 The parent state. More...
 
uint32 sortID
 An increasing id used for sorting states noting the order of the states found in the document. More...
 
std::string id
 The name of the state (manually given or auto generated) More...
 
std::vector< XMLDom::iteratoronEntry
 Executable content executed when the state is entered. More...
 
std::vector< XMLDom::iteratoronExit
 Executable content executed when the state is exited. More...
 
std::map< std::string, std::string > dataModel
 The data model for this state. More...
 
TransitionTargetList children
 The direct children of this state. More...
 
HistoryStateList history
 The history children of this state. More...
 
TransitionTargetList final
 The final children of this state. More...
 
TransitionTargetPtr initial
 The initial child of this state. More...
 
TransitionList transitions
 The transitions of this state. More...
 
bool firstEntry
 Flag that is reset when the state is entered for the first time. More...
 

Detailed Description

A pseudo state representing the history of a state.

Constructor & Destructor Documentation

◆ HistoryState()

HistoryState ( TransitionTargetPtr  p,
uint32  sid 
)
inline

Member Data Documentation

◆ historyType

std::string historyType

The type of history (deep or shallow)

◆ parent

TransitionTargetPtr parent
inherited

The parent state.

◆ sortID

uint32 sortID
inherited

An increasing id used for sorting states noting the order of the states found in the document.

◆ id

std::string id
inherited

The name of the state (manually given or auto generated)

◆ onEntry

std::vector<XMLDom::iterator> onEntry
inherited

Executable content executed when the state is entered.

◆ onExit

std::vector<XMLDom::iterator> onExit
inherited

Executable content executed when the state is exited.

◆ dataModel

std::map<std::string, std::string> dataModel
inherited

The data model for this state.

◆ children

TransitionTargetList children
inherited

The direct children of this state.

◆ history

HistoryStateList history
inherited

The history children of this state.

◆ final

TransitionTargetList final
inherited

The final children of this state.

◆ initial

TransitionTargetPtr initial
inherited

The initial child of this state.

◆ transitions

TransitionList transitions
inherited

The transitions of this state.

◆ firstEntry

bool firstEntry
inherited

Flag that is reset when the state is entered for the first time.


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