Kanzi  3.9.6
Kanzi Engine API
kanzi::StateManager::GoToNextDefinedStateMessageArguments Class Reference

Represents message arguments of GoToNextDefinedState message of state manager. More...

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

Inheritance diagram for kanzi::StateManager::GoToNextDefinedStateMessageArguments:
[legend]

Additional Inherited Members

- Public Member Functions inherited from kanzi::StateManager::GoToDefinedStateMessageArguments
 GoToDefinedStateMessageArguments ()
 Constructor, do not use state manager message argument used in base message argument class. More...
 
bool isLoopStates () const
 
void setLoopStates (bool loopStates)
 
- Public Member Functions inherited from kanzi::StateManager::StateChangeMessageArguments
bool isImmediate () const
 
void setImmediate (bool immediate)
 
 StateChangeMessageArguments (StateManagerSharedPtr stateManager)
 
 StateChangeMessageArguments ()
 
- Public Member Functions inherited from kanzi::StateManager::StateManagerMessageArguments
string getStateGroup () const
 
StateManagerSharedPtr getStateManager () const
 
void setStateGroup (const string &stateGroupName)
 
 StateManagerMessageArguments (StateManagerSharedPtr stateManager)
 
 StateManagerMessageArguments ()
 
- Public Member Functions inherited from kanzi::MessageArguments
bool getAbstractArgument (AbstractPropertyType argumentType, Variant &variant) const
 Returns the value of an argument using AbstractPropertyType. More...
 
template<typename TDataType >
TDataType getArgument (const PropertyType< TDataType > &argumentType) const
 Returns the value of an argument. More...
 
detail::MessageDispatcher * getDispatcher () const
 Returns the message dispatcher that dispatches a message. More...
 
template<typename TDataType >
optional< TDataType > getOptionalArgument (const PropertyType< TDataType > &argumentType) const
 Returns the value of an argument. More...
 
shared_ptr< Node > getSource () const
 Returns the source node for a message. More...
 
TimePoint getTimestamp () const
 Returns the timestamp of a message. More...
 
AbstractMessageType getType () const
 Returns the message type of these message arguments as an AbstractMessageType instance. More...
 
bool isFrom (const Node &source) const
 Returns whether a node is the source node of a message. More...
 
bool isHandled () const
 Returns whether the message is handled. More...
 
bool isValid () const
 Returns whether a message is valid. More...
 
 MessageArguments ()=default
 Constructor. More...
 
 MessageArguments (const MessageArguments &)=delete
 Deleted copy. More...
 
MessageArguments & operator= (const MessageArguments &)=delete
 Deleted assignment. More...
 
void setAbstractArgument (AbstractPropertyType argumentType, const Variant &variant)
 Sets the value of an argument using AbstractPropertyType. More...
 
template<typename TDataType >
void setArgument (const PropertyType< TDataType > &argumentType, typename PropertyType< TDataType >::DataType value)
 Sets the value of an argument. More...
 
void setDispatcher (detail::MessageDispatcher *dispatcher)
 Sets a dispatcher for a message. More...
 
void setHandled (bool handled)
 Sets the handling status for a message. More...
 
void setSource (Node *source)
 Sets the source node that dispatches a message. More...
 
void setTimestamp (TimePoint timestamp)
 Sets the timestamp of a message. More...
 
void setType (AbstractMessageType type)
 Sets the type of a message. More...
 
void setValid (bool valid)
 Sets the validity of a message. More...
 
 ~MessageArguments ()
 Destructor. More...
 
- Static Public Member Functions inherited from kanzi::MessageArguments
static size_t getArgumentAllocatorPoolSize ()
 Gets the current size of memory pool of argument entries. More...
 
static const Metaclass * getStaticMetaclass ()
 Initializes and returns static metadata of base MessageArguments class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Initializes and returns the Kanzi Studio editor information. More...
 
- Static Public Attributes inherited from kanzi::StateManager::GoToDefinedStateMessageArguments
static PropertyType< bool > MessageArgumentStateManagerLoopStatesProperty
 MessageArgumentStateManagerLoopStates property. More...
 
- Static Public Attributes inherited from kanzi::StateManager::StateChangeMessageArguments
static PropertyType< bool > MessageArgumentStateManagerImmediateProperty
 MessageArgumentStateManagerImmediate property. More...
 
- Static Public Attributes inherited from kanzi::StateManager::StateManagerMessageArguments
static PropertyType< string > MessageArgumentStateManagerStateGroupProperty
 MessageArgumentStateManagerStateGroup property. More...
 

Detailed Description

Represents message arguments of GoToNextDefinedState message of state manager.


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