TimerTrigger Class Reference

Use the TimerTrigger to execute actions at the time interval that you set with the IntervalProperty. More...

Inheritance diagram for TimerTrigger:

Static Public Member Functions
static ObjectRef< TimerTrigger >	create (Domain domain, String name)
	Creates a timer trigger.

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< Action >	iterateActions ()
	Gets an Iterable object used to iterate the Actions.
Iterable< Condition >	iterateConditions ()
	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	setFlagKeepDuringPatching (PropertyType< TDataType > propertyType)
	Sets the flag to indicate that the property was loaded from KZB.
void	setProperty (PropertyType< TDataType > propertyType, TDataType value)
	Sets the local value of a property type.
ObjectRef< TType >	tryCreateObjectRef (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 TimerTriggerMetadata
DynamicPropertyType< Integer >	IntervalProperty
	The interval in milliseconds on which the trigger is triggered.
AbstractMetaclass	metaclass = new AbstractMetaclass("Kanzi.TimerTrigger")
	Metaclass for TimerTrigger.
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< Derived >	createDerived (Domain domain, String name, Metaclass metaclass)
	Creates a derived class instance.

Detailed Description

Use the TimerTrigger to execute actions at the time interval that you set with the IntervalProperty.

Member Function Documentation

create()

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

static

Creates a timer trigger.

Parameters

domain	The domain to which the trigger belongs.
name	The name of the trigger.

Returns

handle to the created timer trigger instance.

Member Data Documentation

metaclass

final Metaclass metaclass

static

Initial value:

=
        com.rightware.kanzi.metadata.TimerTriggerMetadata.metaclass

The Metaclass for the class.