Kanzi Framework  3.9.0
Kanzi Engine API
kanzi::ExclusiveActivityHostConcept::ImplicitActivityChangeRequestMessageArguments Class Reference

Base class for Exclusive Activity Host Concept message argument classes. More...

#include <kanzi/ui/node/concept/activity/exclusive_activity_host_concept.hpp>

Inheritance diagram for kanzi::ExclusiveActivityHostConcept::ImplicitActivityChangeRequestMessageArguments:
[legend]

Public Member Functions

bool getLooping () const
 Gets the looping property from message. More...
 
void setLooping (bool looping)
 Sets the looping property for message. More...
 
- 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< NodegetSource () 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...
 
MessageArgumentsoperator= (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

Sets how an Exclusive Activity Host reacts to the NextMessage and PreviousMessage when it reaches its last and first Activity nodes.

When set to true and an Exclusive Activity Host node reaches:

  • The last Activity node, the Exclusive Activity Host node reacts to the NextMessage by activating the first Activity node in that Exclusive Activity Host.
  • The first Activity node, the Exclusive Activity Host node reacts to the PreviousMessage by activating the last Activity node in that Exclusive Activity Host.
static PropertyType< bool > Looping
 

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 MetaclassgetStaticMetaclass ()
 Initializes and returns static metadata of base MessageArguments class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Initializes and returns the Kanzi Studio editor information. More...
 

Detailed Description

Base class for Exclusive Activity Host Concept message argument classes.

Member Function Documentation

◆ setLooping()

void kanzi::ExclusiveActivityHostConcept::ImplicitActivityChangeRequestMessageArguments::setLooping ( bool  looping)
inline

Sets the looping property for message.

Parameters
loopingThe looping for the message.

◆ getLooping()

bool kanzi::ExclusiveActivityHostConcept::ImplicitActivityChangeRequestMessageArguments::getLooping ( ) const
inline

Gets the looping property from message.

Returns
The looping property value.

Member Data Documentation

◆ Looping

PropertyType<bool> kanzi::ExclusiveActivityHostConcept::ImplicitActivityChangeRequestMessageArguments::Looping
static

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