Kanzi  3.9.5
Kanzi Engine API
kanzi::ActivityConcept::StatusChangedMessageArguments Class Reference

Message arguments for the StatusChangedMessage. More...

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

Inheritance diagram for kanzi::ActivityConcept::StatusChangedMessageArguments:
[legend]

Properties

Specifies the status of an Activity.

Since
Kanzi 3.9.1. Renamed ActivityArgument to ActivityStatus.
static PropertyType< int > ActivityStatus
 
Status getStatus () const
 /} More...
 
void setStatus (Status status)
 Sets the status of an Activity. More...
 

Additional Inherited Members

- Public Member Functions inherited from kanzi::ActivityConcept::ActivityMessageArguments
string getName () const
 Gets the name of the Activity included in the message. More...
 
void setName (string_view name)
 Sets the name of the Activity included in the 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 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...
 
- Static Public Attributes inherited from kanzi::ActivityConcept::ActivityMessageArguments
static PropertyType< string > ActivityName
 

Detailed Description

Message arguments for the StatusChangedMessage.

Member Function Documentation

◆ getStatus()

Status kanzi::ActivityConcept::StatusChangedMessageArguments::getStatus ( ) const
inline

/}

Gets the status of an Activity.

Returns
The status of the Activity.

◆ setStatus()

void kanzi::ActivityConcept::StatusChangedMessageArguments::setStatus ( Status  status)
inline

Sets the status of an Activity.

Parameters
statusThe status of an Activity.

Member Data Documentation

◆ ActivityStatus

PropertyType<int> kanzi::ActivityConcept::StatusChangedMessageArguments::ActivityStatus
static

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