Kanzi  3.9.9
Kanzi Engine Java API
NodeComponentMetadata.NodeComponentMessageArguments Class Reference

Metadata definitions for NodeComponentMessageArguments. More...

Inheritance diagram for NodeComponentMetadata.NodeComponentMessageArguments:
[legend]

Public Member Functions

 NodeComponentMessageArguments ()
 Constructs a new messageArgumentsClassName instance.
 
 NodeComponentMessageArguments (long nativeObject)
 Wraps a native instance. More...
 
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. More...
 
TDataType getArgument (PropertyType< TDataType > propertyType)
 Returns the value of an argument. More...
 
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. More...
 
TNodeType getSource ()
 Returns the source node for a message. More...
 
MessageArgumentsWrapper getWrapper ()
 Gets a wrapper for this MessageArguments. More...
 
boolean isHandled ()
 Returns whether the message is handled. More...
 
void setArgument (PropertyType< TDataType > propertyType, TDataType value)
 Sets the value of an argument. More...
 
void setArgument (PropertyType< Integer > propertyType, EnumType value)
 Sets the value of an integer argument using a constant from an enumeration. More...
 
void setHandled (boolean handled)
 Sets the handling status for a message. More...
 

Static Public Attributes

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

Additional Inherited Members

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

Detailed Description

Constructor & Destructor Documentation

NodeComponentMessageArguments ( long  nativeObject)

Wraps a native instance.

Parameters
nativeObjectReference to a native instance.

Member Data Documentation

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

Metaclass for NodeComponentMessageArguments.

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.