Kanzi 3.9.10
StateManagerMetadata.StateChangeMessageArguments Class Reference

Metadata definitions for StateChangeMessageArguments. More...

Inheritance diagram for StateManagerMetadata.StateChangeMessageArguments:
[legend]

Public Member Functions

 StateChangeMessageArguments ()
 Constructs a new messageArgumentsClassName instance.
 
 StateChangeMessageArguments (long nativeObject)
 Wraps a native instance.
 
Boolean getImmediateProperty ()
 Gets the value of Immediate.
 
void setImmediateProperty (Boolean value)
 Sets the value of Immediate.
 
- Public Member Functions inherited from StateManagerMetadata.StateManagerMessageArguments
 StateManagerMessageArguments ()
 Constructs a new messageArgumentsClassName instance.
 
 StateManagerMessageArguments (long nativeObject)
 Wraps a native instance.
 
String getStateGroupProperty ()
 Gets the value of StateGroup.
 
void setStateGroupProperty (String value)
 Sets the value of StateGroup.
 
- 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 DynamicPropertyType< BooleanImmediateProperty
 Whether to change the state instantly, without playing a transition animation.
 
static final AbstractMetaclass metaclass
 Metaclass for StateChangeMessageArguments.
 
- Static Public Attributes inherited from StateManagerMetadata.StateManagerMessageArguments
static final AbstractMetaclass metaclass
 Metaclass for StateManagerMessageArguments.
 
static final DynamicPropertyType< String > StateGroupProperty
 The state group that contains the state to which you want to transition.
 

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 StateChangeMessageArguments.

Constructor & Destructor Documentation

◆ StateChangeMessageArguments()

Wraps a native instance.

Parameters
nativeObjectReference to a native instance.

Member Data Documentation

◆ ImmediateProperty

final DynamicPropertyType<Boolean> ImmediateProperty
static
Initial value:
=
new DynamicPropertyType<>("MessageArgument.StateManager.Immediate", Boolean.class)

Whether to change the state instantly, without playing a transition animation.

◆ metaclass

final AbstractMetaclass metaclass
static
Initial value:
=
new AbstractMetaclass("Kanzi.StateManager.StateChangeMessageArguments")

Metaclass for StateChangeMessageArguments.