Base class for node component message arguments. More...

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

Inheritance diagram for kanzi::NodeComponent::NodeComponentMessageArguments:

Public Member Functions
void	setTargetNodeComponentName (string_view targetNodeComponentName)
	Sets value of TargetNodeComponentName property. More...

string	getTargetNodeComponentName () const
	Gets value of TargetNodeComponentName property. 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< Node >	getSource () const

void	setHandled (bool handled)

bool	isHandled () const

chrono::milliseconds	getTimestamp () const

KzuMessageDispatcher *	getDispatcher () 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 Attributes
static PropertyType< string >	TargetNodeComponentNameProperty
	Target name property specifies the name of node component to which the message is sent. More...

Additional Inherited Members
Static Public Member Functions inherited from kanzi::MessageArguments
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Detailed Description

Base class for node component message arguments.

It contains name of node component to which the message is sent.

Member Function Documentation

void kanzi::NodeComponent::NodeComponentMessageArguments::setTargetNodeComponentName ( string_view targetNodeComponentName )

inline

Sets value of TargetNodeComponentName property.

Parameters

targetNodeComponentName Name of target node component.

string kanzi::NodeComponent::NodeComponentMessageArguments::getTargetNodeComponentName ( ) const

inline

Gets value of TargetNodeComponentName property.

PropertyType<string> kanzi::NodeComponent::NodeComponentMessageArguments::TargetNodeComponentNameProperty

static

Target name property specifies the name of node component to which the message is sent.

The message is broadcasted to all node components on a node if this property is not set or if it is set to empty string.

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