kanzi::StateManager::StateManagerMessageArguments Class Reference

Represents base message arguments of state manager messages. More...

#include <kanzi/core.ui/state_manager/state_manager.hpp>

Inheritance diagram for kanzi::StateManager::StateManagerMessageArguments:
kanzi::MessageArguments kanzi::StateManager::EnteredStateMessageArguments kanzi::StateManager::LeftStateMessageArguments kanzi::StateManager::StateChangeMessageArguments kanzi::StateManager::TransitionMessageArguments kanzi::StateManager::GoToDefinedStateMessageArguments kanzi::StateManager::GoToStateMessageArguments kanzi::StateManager::TransitionFinishedMessageArguments kanzi::StateManager::TransitionStartedMessageArguments kanzi::StateManager::GoToNextDefinedStateMessageArguments kanzi::StateManager::GoToPreviousDefinedStateMessageArguments

Public Member Functions

 StateManagerMessageArguments (StateManager *stateManager)
 
string getStateGroup () const
 
void setStateGroup (const string &stateGroupName)
 
StateManagergetStateManager () const
 
- Public Member Functions inherited from kanzi::MessageArguments
 MessageArguments ()
 
 MessageArguments (AbstractMessageType messageType)
 
 ~MessageArguments ()
 
template<typename TDataType >
TDataType getArgument (const PropertyType< TDataType > &argumentType) const
 
bool getAbstractArgument (AbstractPropertyType argumentType, Variant &variant) const
 
template<typename TDataType >
void setArgument (const PropertyType< TDataType > &argumentType, typename PropertyType< TDataType >::DataType value)
 
void setAbstractArgument (AbstractPropertyType argumentType, const Variant &variant)
 
bool isFrom (const Node &source) const
 
shared_ptr< NodegetSource () const
 
void setHandled (bool handled)
 
bool isHandled () const
 
chrono::milliseconds getTimestamp () const
 
KzuMessageDispatchergetDispatcher () const
 
AbstractMessageType getType () const
 
void setSource (Node *source)
 
void setTimestamp (chrono::milliseconds timestamp)
 
void setValid (bool valid)
 
bool isValid () const
 
void setDispatcher_internal (KzuMessageDispatcher *dispatcher)
 Internal function. More...
 
void setType_internal (AbstractMessageType type)
 Internal function. More...
 

Static Public Attributes

static PropertyType< string > MessageArgumentStateManagerStateGroupProperty
 MessageArgumentStateManagerStateGroup property. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from kanzi::MessageArguments
static size_t getArgumentAllocatorPoolSize ()
 Gets the current size of memory pool of argument entries. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 

Detailed Description

Represents base message arguments of state manager messages.

Constructor & Destructor Documentation

kanzi::StateManager::StateManagerMessageArguments::StateManagerMessageArguments ( StateManager stateManager)
inlineexplicit

Member Function Documentation

string kanzi::StateManager::StateManagerMessageArguments::getStateGroup ( ) const
inline
void kanzi::StateManager::StateManagerMessageArguments::setStateGroup ( const string &  stateGroupName)
inline
StateManager* kanzi::StateManager::StateManagerMessageArguments::getStateManager ( ) const
inline

Member Data Documentation

PropertyType<string> kanzi::StateManager::StateManagerMessageArguments::MessageArgumentStateManagerStateGroupProperty
static

MessageArgumentStateManagerStateGroup property.

The default value is "".

See also
setMessageArgumentStateManagerStateGroup(), getMessageArgumentStateManagerStateGroup()

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