Kanzi  3.9.8
Kanzi Engine Java API
NodeComponentMetadata.NodeComponentSourceMessageArguments Class Reference

Metadata definitions for NodeComponentSourceMessageArguments. More...

Inheritance diagram for NodeComponentMetadata.NodeComponentSourceMessageArguments:
[legend]

Public Member Functions

 NodeComponentSourceMessageArguments ()
 Construct a new messageArgumentsClassName instance.
 
 NodeComponentSourceMessageArguments (long nativeObject)
 Wrap a native instance. More...
 
String getSourceNameProperty ()
 Getter for SourceNameProperty.
 
void setSourceNameProperty (String value)
 Setter for SourceNameProperty.
 
- 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 NodeComponentSourceMessageArguments. More...
 
static final DynamicPropertyType< String > SourceNameProperty
 Name of the node component that sent the 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

NodeComponentSourceMessageArguments ( long  nativeObject)

Wrap a native instance.

Parameters
nativeObjectReference to a native instance.

Member Data Documentation

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

Metaclass for NodeComponentSourceMessageArguments.

final DynamicPropertyType<String> SourceNameProperty
static
Initial value:
=
new DynamicPropertyType<>(
"NodeComponent.NodeComponentSourceMessageArguments.SourceName", String.class)

Name of the node component that sent the message.