Kanzi  3.9.3
Java API
Condition Class Referenceabstract

Condition for triggers. More...

Inheritance diagram for Condition:
[legend]

Public Member Functions

boolean check ()
 Check function for condition.
 
void close ()
 Close the object, and release native resources.
 
Trigger getTrigger ()
 Returns the pointer to a trigger to which an condition is attached. 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...
 
EnumType getProperty (PropertyType< Integer > propertyType, Class< EnumType > enumClass)
 Returns the current value of an integer property type converted to a matching constant from specified enumeration. 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...
 
void setProperty (PropertyType< Integer > propertyType, EnumType value)
 Sets the local value of an integer property type using a constant from an enumeration. More...
 

Static Public Attributes

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.
 

Protected Member Functions

 Condition (Domain domain, long handle, Metaclass metaclass)
 Wraps a given native Condition. More...
 
void initialize ()
 Initializes the Condition.
 
void onAttach ()
 Callback called by Kanzi during attach.
 
abstract boolean onCheck ()
 Check function for condition. More...
 
void onDetach ()
 Callback called by Kanzi during detach.
 

Static Protected Member Functions

static< Derived extends Condition > ObjectRef< Derived > createDerived (Domain domain, Metaclass metaclass)
 Creates a derived class instance. More...
 

Additional Inherited Members

- Public Attributes inherited from ConditionMetadata
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.Condition")
 Metaclass for Condition.
 

Detailed Description

Condition for triggers.

Constructor & Destructor Documentation

◆ Condition()

Condition ( Domain  domain,
long  handle,
Metaclass  metaclass 
)
protected

Wraps a given native Condition.

Called by KanziObject.connectObject(ObjectWrapper) when connecting to a native condition.

Parameters
domainUI Domain where this condition belongs.
handleNative object that is backing this condition.
metaclassMetaclass data for this condition.

Member Function Documentation

◆ createDerived()

static <Derived extends Condition> ObjectRef<Derived> createDerived ( Domain  domain,
Metaclass  metaclass 
)
staticprotected

Creates a derived class instance.

Call this method as part of the create method for a derived class.

Parameters
domainUI Domain where this condition belongs.
metaclassMetaclass data of the condition.
Returns
An ObjectRef that holds the created instance.

◆ getTrigger()

Trigger getTrigger ( )

Returns the pointer to a trigger to which an condition is attached.

Returns
The attached trigger.

◆ onCheck()

abstract boolean onCheck ( )
abstractprotected

Check function for condition.

Returns
true if the condition is valid

Member Data Documentation

◆ metaclass

final Metaclass metaclass
static
Initial value:

The Metaclass for the class.