Kanzi 3.9.10
OnPropertyChangedTrigger Class Reference

Invokes associated actions on setting of a property type, specified by SourcePropertyTypeProperty, on a source node, specified by SourceNodeProperty. More...

Inheritance diagram for OnPropertyChangedTrigger:
[legend]

Static Public Member Functions

static ObjectRef< OnPropertyChangedTriggercreate (Domain domain, String name)
 Creates an instance of OnPropertyChangedTrigger.
 

Static Public Attributes

static final Metaclass metaclass
 The Metaclass for the class.
 
- Static Public Attributes inherited from Trigger
static final Metaclass metaclass
 The Metaclass for the class.
 
- Static Public Attributes inherited from NodeComponent
static final Metaclass metaclass
 The Metaclass for the class.
 
- 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 Trigger
void addAction (Action action)
 Adds an action to the trigger.
 
void addCondition (Condition condition)
 Adds an condition to the trigger.
 
boolean checkConditions ()
 Checks against all conditions in the trigger.
 
void close ()
 Close the object, and release native resources.
 
void invokeActions ()
 Invokes actions in the trigger.
 
Iterable< ActioniterateActions ()
 Gets an Iterable object used to iterate the Actions.
 
Iterable< ConditioniterateConditions ()
 Gets an Iterable object used to iterate the Conditions.
 
- Public Member Functions inherited from NodeComponent
String getName ()
 Gets the value of #NameProperty.
 
Node getNode ()
 Returns the node the node component is attached to or null if node component is not attached to a node.
 
NodeComponentState getState ()
 Gets the state of node component indicating if component is attached to a node, detached from any node or in process of attaching/detaching.
 
boolean isAttached ()
 Indicates whether node component is attached to a node.
 
boolean isAttaching ()
 Indicates whether node component is in the process of attaching to a node.
 
boolean isAttachingOrAttached ()
 Indicates whether node component is in the process of attaching to a node or already attached.
 
boolean isDetached ()
 Indicates whether node component is detached from any node.
 
boolean isDetaching ()
 Indicates whether node component currently detaching from the node.
 
boolean isDetachingOrDetached ()
 Indicates whether node component is in the process of detaching from the node or already detached.
 
void setName (String value)
 Sets the value of #NameProperty.
 
- Public Member Functions inherited from KanziObject
boolean equals (Object object)
 
Domain getDomain ()
 Returns the domain the object belongs to.
 
Metaclass getDynamicMetaclass ()
 Returns the metaclass of the dynamic type of the object.
 
long getNative ()
 Gets a pointer to the backing C++ instance.
 
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.
 
TDataType getProperty (PropertyType< TDataType > propertyType)
 Returns the current value of a property type.
 
int hashCode ()
 
boolean hasValue (PropertyType< TDataType > propertyType)
 Evaluates whether there are any inputs into the property value.
 
boolean isStale ()
 Test if the object is stale i.e.
 
void removeLocalValue (PropertyType< TDataType > propertyType)
 Removes the local value associated with the property.
 
void setProperty (PropertyType< TDataType > propertyType, TDataType value)
 Sets the local value of a property type.
 
ObjectRef< TTypetryCreateObjectRef (Class< TType > clazz)
 Tries to create an owning ObjectRef instance to this KanziObject.
 
- Public Attributes inherited from NodeComponentMetadata
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.NodeComponent")
 Metaclass for NodeComponent.
 
DynamicPropertyType< String > NameProperty
 Name.
 
- Public Attributes inherited from TriggerMetadata
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.Trigger")
 Metaclass for Trigger.
 
- Public Attributes inherited from OnPropertyChangedTriggerMetadata
DynamicPropertyType< BooleanIgnoreIdenticalValueProperty
 Invoke the trigger only on change in the monitored property's value.
 
DynamicPropertyType< BooleanIgnoreInitialValueProperty
 Invoke the trigger only when the value of the monitored property changes after the trigger is already attached.
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.OnPropertyChangedTrigger")
 Metaclass for OnPropertyChangedTrigger.
 
DynamicPropertyType< String > SourceNodeProperty
 The node for which this trigger monitors property changes.
 
DynamicPropertyType< String > SourcePropertyTypeProperty
 The property type the changes of which trigger this trigger.
 
- Protected Member Functions inherited from Trigger
 Trigger (Domain domain, long handle, Metaclass metaclass)
 Wraps a given native Trigger.
 
void attachOverride ()
 Called when the Trigger is attached to a node.
 
void detachOverride ()
 Called when a Trigger is detached from a Node.
 
void initialize ()
 Initializes the Trigger.
 
- Protected Member Functions inherited from NodeComponent
 NodeComponent (Domain domain, long handle, Metaclass metaclass)
 Wraps a given native Node Component.
 
void removeNodeComponentMessageFilter (Node.MessageSubscriptionToken token)
 Removes message handler added via com.rightware.kanzi.NodeComponent#addNodeComponentMessageHandler function.
 
- Static Protected Member Functions inherited from Trigger
static< Derived extends NodeComponent > ObjectRef< DerivedcreateDerived (Domain domain, String name, Metaclass metaclass)
 Creates a derived class instance.
 

Detailed Description

Invokes associated actions on setting of a property type, specified by SourcePropertyTypeProperty, on a source node, specified by SourceNodeProperty.

By default, invocation is performed also when setting to identical values. This behavior can be changed with IgnoreIdenticalValueProperty.

Member Function Documentation

◆ create()

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

Creates an instance of OnPropertyChangedTrigger.

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

Member Data Documentation

◆ metaclass

final Metaclass metaclass
static
Initial value:
=
com.rightware.kanzi.metadata.OnPropertyChangedTriggerMetadata.metaclass

The Metaclass for the class.