Kanzi  3.9.5
Java API
WriteLogAction Class Reference

Writes a message to the Kanzi Studio Log window. More...

Inheritance diagram for WriteLogAction:
[legend]

Static Public Member Functions

static ObjectRef< T > create (Domain domain, String name)
 Constructs a new WriteLogAction. More...
 

Static Public Attributes

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 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...
 
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...
 
- 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 WriteLogActionMetadata
DynamicPropertyType< String > LogTextProperty
 The text to write to the Kanzi Studio Log window when a trigger executes this action. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.WriteLogAction")
 Metaclass for WriteLogAction.
 
- 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 Action
static< Derived extends Action > ObjectRef< Derived > createDerived (Domain domain, String name, Metaclass metaclass)
 Creates a derived class instance. More...
 

Detailed Description

Writes a message to the Kanzi Studio Log window.

Member Function Documentation

◆ create()

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

Constructs a new WriteLogAction.

Parameters
domainUI Domain where this object belongs.
nameName of the object.

Member Data Documentation

◆ metaclass

final Metaclass metaclass
static