Kanzi  3.9.6
Java API
DynamicMessageType< MessageArgumentsType extends MessageArguments > Class Template Reference

DynamicMessageType is a handle to an existing message type. More...

Inheritance diagram for DynamicMessageType< MessageArgumentsType extends MessageArguments >:
[legend]

Public Member Functions

 DynamicMessageType (String name, Class< MessageArgumentsType > messageArgumentClass)
 Creates a reference to an existing message type. More...
 
 DynamicMessageType (MessageType< MessageArgumentsType > messageType)
 Creates a reference to an existing message type. More...
 
- Public Member Functions inherited from MessageType< MessageArgumentsType >
 MessageType (MessageRouting routing, Class< MessageArgumentsType > messageArgumentClass)
 Creates a new message type without a name. More...
 
 MessageType (String name, MessageRouting routing, Class< MessageArgumentsType > messageArgumentClass)
 Creates a new message type. More...
 
boolean equals (Object object)
 
Metaclass getArgumentsMetaclass ()
 Gets the metaclass of the message arguments class associated with the message type. More...
 
String getName ()
 Gets the fully qualified name of the message type in the form "Class.MessageType". More...
 
long getNative ()
 Gets a pointer to the backing C++ instance. More...
 
MessageRouting getRouting ()
 Gets the message routing of the message type. More...
 
int hashCode ()
 
String toString ()
 Gets the string presentation of the MessageType. More...
 

Detailed Description

DynamicMessageType is a handle to an existing message type.

You can use it to add and remove a message handler or to dispatch a message of that type on a node.

You can use a DynamicMessageType to access message types by their message arguments type and fully qualified name. When you do not have the message arguments type or it is irrelevant, access message types using the AbstractMessageType type.

You can pass DynamicMessageType directly to functions that take the MessageType argument. You can also query all message type info from DynamicMessageType.

Parameters
<MessageArgumentsType>Associated message arguments class, which holds the property type definitions for the arguments of this message type.

Constructor & Destructor Documentation

◆ DynamicMessageType() [1/2]

DynamicMessageType ( String  name,
Class< MessageArgumentsType >  messageArgumentClass 
)

Creates a reference to an existing message type.

Parameters
nameFully qualified name of the message type.
messageArgumentClassClass of the associated message-argument type.

◆ DynamicMessageType() [2/2]

DynamicMessageType ( MessageType< MessageArgumentsType >  messageType)

Creates a reference to an existing message type.

Parameters
messageTypeReference to an existing message type.