Kanzi  3.9.9
Kanzi Engine Java API
SetPropertyAction Class Reference

SetPropertyAction sets the value of a property of a target node based on: More...

Inheritance diagram for SetPropertyAction:
[legend]

Static Public Member Functions

static ObjectRef< SetPropertyActioncreate (Domain domain, String name)
 Creates an instance of SetPropertyAction. More...
 

Static Public Attributes

static final Metaclass metaclass
 The Metaclass for the class. More...
 
- Static Public Attributes inherited from ForwardingAction
static final Metaclass metaclass
 The Metaclass for the class. More...
 
- Static Public Attributes inherited from Action
static final Metaclass metaclass = com.rightware.kanzi.metadata.ActionMetadata.metaclass
 The Metaclass for the class.
 
- Static Public Attributes inherited from ActionBase
static final Metaclass metaclass
 The Metaclass for the class. More...
 
- Static Public Attributes inherited from KanziObject
static final Metaclass metaclass = new AbstractMetaclass("Kanzi.Object")
 The Metaclass for the class.
 

Additional Inherited Members

- Public Member Functions inherited from ForwardingAction
void close ()
 Close the object, and release native resources.
 
- Public Member Functions inherited from Action
void close ()
 Close the object, and release native resources.
 
Duration getDelay ()
 Returns the delay that Kanzi waits before it invokes an action. More...
 
Trigger getTrigger ()
 Returns the pointer to a trigger to which an action is attached. More...
 
void invoke ()
 Invokes the action.
 
void setDelay (Duration duration)
 Sets the delay that Kanzi waits before it invokes an action. More...
 
- Public Member Functions inherited from ActionBase
String getName ()
 Gets the name of an action. More...
 
- Public Member Functions inherited from KanziObject
boolean equals (Object object)
 
Domain getDomain ()
 Returns the domain the object belongs to. More...
 
Metaclass getDynamicMetaclass ()
 Returns the metaclass of the dynamic type of the object. More...
 
long getNative ()
 Gets a pointer to the backing C++ instance. More...
 
TDataType getOptionalProperty (PropertyType< TDataType > propertyType)
 Returns the current value of a property type, but does not use the default value if there are no inputs to the property value. More...
 
TDataType getProperty (PropertyType< TDataType > propertyType)
 Returns the current value of a property type. More...
 
int hashCode ()
 
boolean hasValue (PropertyType< TDataType > propertyType)
 Evaluates whether there are any inputs into the property value. More...
 
boolean isStale ()
 Test if the object is stale i.e. More...
 
void removeLocalValue (PropertyType< TDataType > propertyType)
 Removes the local value associated with the property. More...
 
void setProperty (PropertyType< TDataType > propertyType, TDataType value)
 Sets the local value of a property type. More...
 
ObjectRef< TType > tryCreateObjectRef (Class< TType > clazz)
 Tries to create an owning ObjectRef instance to this KanziObject. More...
 
- Public Attributes inherited from ActionBaseMetadata
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.ActionBase")
 Metaclass for ActionBase.
 
- Public Attributes inherited from ActionMetadata
DynamicPropertyType< Integer > DelayProperty
 The time in milliseconds after which Kanzi invokes the action. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.Action")
 Metaclass for Action.
 
- Public Attributes inherited from ForwardingActionMetadata
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.ForwardingAction")
 Metaclass for ForwardingAction.
 
- Public Attributes inherited from SetPropertyActionMetadata
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.SetPropertyAction")
 Metaclass for SetPropertyAction.
 
DynamicPropertyType< String > TargetObjectPathProperty
 The item that contains the target property. More...
 
- Protected Member Functions inherited from ForwardingAction
 ForwardingAction (Domain domain, long handle, Metaclass metaclass)
 Wraps a given native ForwardingAction. More...
 
void initialize ()
 Initializes the ForwardingAction.
 
void onAttach ()
 Callback called by Kanzi during attach.
 
void onDelayedInvoke ()
 Callback called by Kanzi when the action is invoked by trigger with delay, after the delay duration expires. More...
 
void onDetach ()
 Callback called by Kanzi during detach.
 
void onInvoke ()
 Callback called by Kanzi when the action is invoked by its trigger without delay. More...
 
void onPrepareDelayedInvoke ()
 Callback called by Kanzi when the action is invoked by its trigger with delay. More...
 
void onUnprepareDelayedInvoke ()
 Kanzi calls this callback when an action is invoked by trigger with delay, after Action#onDelayedInvoke() callback, or when it cancels a delayed execution. More...
 
- Protected Member Functions inherited from Action
 Action (Domain domain, long handle, Metaclass metaclass)
 Wraps a given native Action. More...
 
void initialize ()
 Initializes the Action.
 
void onAttach ()
 Callback called by Kanzi during attach.
 
void onDelayedInvoke ()
 Callback called by Kanzi when the action is invoked by trigger with delay, after the delay duration expires. More...
 
void onDetach ()
 Callback called by Kanzi during detach.
 
void onInvoke ()
 Callback called by Kanzi when the action is invoked by its trigger without delay. More...
 
void onPrepareDelayedInvoke ()
 Callback called by Kanzi when the action is invoked by its trigger with delay. More...
 
void onUnprepareDelayedInvoke ()
 Kanzi calls this callback when an action is invoked by trigger with delay, after Action#onDelayedInvoke() callback, or when it cancels a delayed execution. More...
 
- Static Protected Member Functions inherited from ForwardingAction
static< Derived extends Action > ObjectRef< Derived > createDerived (Domain domain, String name, Metaclass metaclass)
 Creates a derived class instance. More...
 
- Static Protected Member Functions inherited from Action
static< Derived extends Action > ObjectRef< Derived > createDerived (Domain domain, String name, Metaclass metaclass)
 Creates a derived class instance. More...
 

Detailed Description

SetPropertyAction sets the value of a property of a target node based on:

Member Function Documentation

static ObjectRef<SetPropertyAction> create ( Domain  domain,
String  name 
)
static

Creates an instance of SetPropertyAction.

Parameters
domainPointer to domain.
nameName for the action instance.
Returns
handle to the created SetPropertyAction instance.

Member Data Documentation

final Metaclass metaclass
static