Kanzi  3.9.4
Kanzi Engine API
kanzi::NodeComponent::NodeComponentSourceMessageArguments Class Reference

Base class for message arguments that are sent by a node component. More...

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

Inheritance diagram for kanzi::NodeComponent::NodeComponentSourceMessageArguments:
[legend]

Public Member Functions

string getSourceNodeComponentName () const
 Gets the value of the SourceNodeComponentNameProperty. More...
 
void setSourceNodeComponentName (string_view sourceNodeComponentName)
 Sets the value of the SourceNodeComponentNameProperty. 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

static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- 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

static PropertyType< string > SourceNodeComponentNameProperty
 Specifies the name of a node component that is sending a message. More...
 

Detailed Description

Base class for message arguments that are sent by a node component.

It contains the name of a node component that sent the message.

Member Function Documentation

◆ setSourceNodeComponentName()

void kanzi::NodeComponent::NodeComponentSourceMessageArguments::setSourceNodeComponentName ( string_view  sourceNodeComponentName)
inline

Sets the value of the SourceNodeComponentNameProperty.

Parameters
sourceNodeComponentNameName of source node component.

◆ getSourceNodeComponentName()

string kanzi::NodeComponent::NodeComponentSourceMessageArguments::getSourceNodeComponentName ( ) const
inline

Gets the value of the SourceNodeComponentNameProperty.

Returns
Name of source node component.

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::NodeComponent::NodeComponentSourceMessageArguments::makeEditorInfo ( )
static

Member Data Documentation

◆ SourceNodeComponentNameProperty

PropertyType<string> kanzi::NodeComponent::NodeComponentSourceMessageArguments::SourceNodeComponentNameProperty
static

Specifies the name of a node component that is sending a message.

The name can be empty in either of these cases:

  • If a node component name is not set in Kanzi Studio
  • If a node component code sends the message without setting the name

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