Class FSMVars

• Defined in File FSM.h

Inheritance Relationships

Base Type

• public Karana::Core::LockingBaseVars (Class LockingBaseVars)

Class Documentation

class FSMVars : public Karana::Core::LockingBaseVars

Vars for the FSM class.

Public Functions

FSMVars(const kc::ks_ptr<const FSM> &fsm)

FSMVars constructor. The constructor is not meant to be called directly. Please use the create(…) method instead to create an instance.

Parameters:

fsm – The FSM associated with this FSMVars.

~FSMVars()

Destructor.

virtual Karana::Core::NestedVars getAllVars() const override

Get all the Vars that this FSMVars has.

Returns:

NestedVars with all the Vars that this FSMVars has.

Public Members

kc::ks_ptr<kc::Var_T<std::string>> current_state

The current state of the FSM.

Public Static Functions

static Karana::Core::ks_ptr<FSMVars> create(const kc::ks_ptr<const FSM> &fsm)

Create an instance of the FSMVars.

Parameters:

fsm – The FSM associated with this FSMVars.

Returns:

A pointer to the newly created instance of FSMVars.