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:
kanzi::MessageArguments kanzi::AnimationPlayer::StartedMessageArguments kanzi::PropertyTargetInterpolator::CompletedMessageArguments

Public Member Functions

void setSourceNodeComponentName (string_view sourceNodeComponentName)
 Sets the value of the SourceNodeComponentNameProperty. More...
 
string getSourceNodeComponentName () const
 Gets the value of the SourceNodeComponentNameProperty. More...
 
- Public Member Functions inherited from kanzi::MessageArguments
 MessageArguments ()
 
 MessageArguments (AbstractMessageType messageType)
 
 ~MessageArguments ()
 
template<typename TDataType >
TDataType getArgument (const PropertyType< TDataType > &argumentType) const
 
bool getAbstractArgument (AbstractPropertyType argumentType, Variant &variant) const
 
template<typename TDataType >
void setArgument (const PropertyType< TDataType > &argumentType, typename PropertyType< TDataType >::DataType value)
 
void setAbstractArgument (AbstractPropertyType argumentType, const Variant &variant)
 
bool isFrom (const Node &source) const
 
shared_ptr< NodegetSource () const
 
void setHandled (bool handled)
 
bool isHandled () const
 
chrono::milliseconds getTimestamp () const
 
KzuMessageDispatchergetDispatcher () const
 
AbstractMessageType getType () const
 
void setSource (Node *source)
 
void setTimestamp (chrono::milliseconds timestamp)
 
void setValid (bool valid)
 
bool isValid () const
 
void setDispatcher_internal (KzuMessageDispatcher *dispatcher)
 Internal function. More...
 
void setType_internal (AbstractMessageType type)
 Internal function. 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 PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 

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

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

Sets the value of the SourceNodeComponentNameProperty.

Parameters
sourceNodeComponentNameName of source node component.
string kanzi::NodeComponent::NodeComponentSourceMessageArguments::getSourceNodeComponentName ( ) const
inline

Gets the value of the SourceNodeComponentNameProperty.

Returns
Name of source node component.
static PropertyTypeEditorInfoSharedPtr kanzi::NodeComponent::NodeComponentSourceMessageArguments::makeEditorInfo ( )
static

Member Data Documentation

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: