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:

Public Member Functions
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 Attributes
Properties
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 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...

Detailed Description

Represents base message arguments of state manager messages.

Constructor & Destructor Documentation

kanzi::StateManager::StateManagerMessageArguments::StateManagerMessageArguments ( StateManagerSharedPtr  stateManager )

inlineexplicit

kanzi::StateManager::StateManagerMessageArguments::StateManagerMessageArguments ( )

inlineexplicit

Member Function Documentation

string kanzi::StateManager::StateManagerMessageArguments::getStateGroup ( ) const

inline

void kanzi::StateManager::StateManagerMessageArguments::setStateGroup ( const string &  stateGroupName )

inline

StateManagerSharedPtr 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:

• kanzi/core.ui/state_manager/state_manager.hpp