Kanzi  3.9.6
Java API
StateManagerMetadata.StateChangeMessageArguments Class Reference

Metadata definitions for StateChangeMessageArguments. More...

Inheritance diagram for StateManagerMetadata.StateChangeMessageArguments:
[legend]

Public Member Functions

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

Additional Inherited Members

- Protected Member Functions inherited from MessageArguments
 MessageArguments (long nativeObject)
 Wraps a native message argument. More...
 

Detailed Description

Constructor & Destructor Documentation

◆ StateChangeMessageArguments()

StateChangeMessageArguments ( long  nativeObject)

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