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

void	setTargetNodeComponentName (string_view targetNodeComponentName)
	Sets value of TargetNodeComponentName property.

Public Member Functions inherited from kanzi::MessageArguments
bool	getAbstractArgument (AbstractPropertyType argumentType, Variant &variant) const
	Returns the value of an argument using AbstractPropertyType.

template<typename TDataType >
TDataType	getArgument (const PropertyType< TDataType > &argumentType) const
	Returns the value of an argument.

detail::MessageDispatcher *	getDispatcher () const
	Returns the message dispatcher that dispatches a message.

template<typename TDataType >
optional< TDataType >	getOptionalArgument (const PropertyType< TDataType > &argumentType) const
	Returns the value of an argument.

shared_ptr< Node >	getSource () const
	Returns the source node for a message.

TimePoint	getTimestamp () const
	Returns the timestamp of a message.

AbstractMessageType	getType () const
	Returns the message type of these message arguments as an AbstractMessageType instance.

bool	isFrom (const Node &source) const
	Returns whether a node is the source node of a message.

bool	isHandled () const
	Returns whether the message is handled.

bool	isValid () const
	Returns whether a message is valid.

	MessageArguments ()=default
	Constructor.

	MessageArguments (const MessageArguments &)=delete
	Deleted copy.

MessageArguments &	operator= (const MessageArguments &)=delete
	Deleted assignment.

void	setAbstractArgument (AbstractPropertyType argumentType, const Variant &variant)
	Sets the value of an argument using AbstractPropertyType.

template<typename TDataType >
void	setArgument (const PropertyType< TDataType > &argumentType, typename PropertyType< TDataType >::DataType value)
	Sets the value of an argument.

void	setDispatcher (detail::MessageDispatcher *dispatcher)
	Sets a dispatcher for a message.

void	setHandled (bool handled)
	Sets the handling status for a message.

void	setSource (Node *source)
	Sets the source node that dispatches a message.

void	setTimestamp (TimePoint timestamp)
	Sets the timestamp of a message.

void	setType (AbstractMessageType type)
	Sets the type of a message.

void	setValid (bool valid)
	Sets the validity of a message.

	~MessageArguments ()
	Destructor.

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.

static const Metaclass *	getStaticMetaclass ()
	Initializes and returns static metadata of base MessageArguments class.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Initializes and returns the Kanzi Studio editor information.

Static Public Attributes
static PropertyType< string >	TargetNodeComponentNameProperty
	Target name property specifies the name of node component to which the message is sent.

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

◆ setTargetNodeComponentName()

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

inline

Sets value of TargetNodeComponentName property.

Parameters

targetNodeComponentName Name of target node component.

◆ getTargetNodeComponentName()

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

inline

Gets value of TargetNodeComponentName property.

Returns: Name of target node component.

◆ makeEditorInfo()

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

static

Member Data Documentation

◆ TargetNodeComponentNameProperty

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:

kanzi/core.ui/node_component/node_component.hpp

Public Member Functions

Static Public Member Functions