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

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

Inheritance diagram for kanzi::NodeComponent::NodeComponentTargetMessageArguments:

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 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 >	TargetNodeComponentNameProperty
	Target name property specifies the name of node component to which the message is sent. More...

Detailed Description

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

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

Member Function Documentation

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

inline

Sets value of TargetNodeComponentName property.

Parameters

targetNodeComponentName Name of target node component.

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

inline

Gets value of TargetNodeComponentName property.

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

static

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

static

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

The message is broadcast 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: