Kanzi 3.9.10
NodeMetadata.NodeComponentMessageArguments Class Reference

Metadata definitions for NodeComponentMessageArguments. More...

Inheritance diagram for NodeMetadata.NodeComponentMessageArguments:
[legend]

Public Member Functions

 NodeComponentMessageArguments ()
 Constructs a new messageArgumentsClassName instance.
 
 NodeComponentMessageArguments (long nativeObject)
 Wraps a native instance.
 
String getTargetNameProperty ()
 Gets the value of TargetName.
 
void setTargetNameProperty (String value)
 Sets the value of TargetName.
 
- Public Member Functions inherited from MessageArguments
 MessageArguments ()
 Constructs a new MessageArguments object.
 
TDataType getArgument (PropertyType< TDataType > propertyType)
 Returns the value of an argument.
 
TDataType getOptionalArgument (PropertyType< TDataType > propertyType)
 Returns the value of an argument, but does not use the default value if there are no inputs to the argument value.
 
TNodeType getSource ()
 Returns the source node for a message.
 
MessageArgumentsWrapper getWrapper ()
 Gets a wrapper for this MessageArguments.
 
boolean isHandled ()
 Returns whether the message is handled.
 
void setArgument (PropertyType< Integer > propertyType, EnumType value)
 Sets the value of an integer argument using a constant from an enumeration.
 
void setArgument (PropertyType< TDataType > propertyType, TDataType value)
 Sets the value of an argument.
 
void setHandled (boolean handled)
 Sets the handling status for a message.
 

Static Public Attributes

static final AbstractMetaclass metaclass
 Metaclass for NodeComponentMessageArguments.
 
static final DynamicPropertyType< String > TargetNameProperty
 Sets the name of the node component that receives this message.
 

Additional Inherited Members

- Static Public Member Functions inherited from MessageArguments
static MessageArgumentsWrapper getWrapper (MessageArguments messageArguments)
 Gets a wrapper for a MessageArguments object.
 
- Protected Member Functions inherited from MessageArguments
 MessageArguments (long nativeObject)
 Wraps a native message argument.
 
 MessageArguments (MessageArgumentsWrapper wrapper)
 Wraps a native message argument.
 

Detailed Description

Metadata definitions for NodeComponentMessageArguments.

Constructor & Destructor Documentation

◆ NodeComponentMessageArguments()

Wraps a native instance.

Parameters
nativeObjectReference to a native instance.

Member Data Documentation

◆ metaclass

final AbstractMetaclass metaclass
static
Initial value:
=
new AbstractMetaclass("Kanzi.NodeComponent.NodeComponentMessageArguments")

Metaclass for NodeComponentMessageArguments.

◆ TargetNameProperty

final DynamicPropertyType<String> TargetNameProperty
static
Initial value:
=
new DynamicPropertyType<>(
"NodeComponent.NodeComponentMessageArguments.TargetName", String.class)

Sets the name of the node component that receives this message.

To send this message to every node component in this node, use an empty string.