WriteLogAction Class Reference
Use the WriteLogAction class to attach logging functionality to a trigger. More...
Inheritance diagram for WriteLogAction:
Static Public Member Functions | |
| static ObjectRef< WriteLogAction > | create (Domain domain, String name) |
| Creates a WriteLogAction. | |
Static Public Attributes | |
| static final Metaclass | metaclass |
| The Metaclass for the class. | |
 Static Public Attributes inherited from ForwardingAction | |
| static final Metaclass | metaclass |
| The Metaclass for the class. | |
| 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. | |
| 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 | |
| Duration | getDelay () |
| Returns the delay that Kanzi waits before it invokes an action. | |
| Trigger | getTrigger () |
| Returns the pointer to a trigger to which an action is attached. | |
| void | invoke () |
| Invokes the action. | |
| void | setDelay (Duration duration) |
| Sets the delay that Kanzi waits before it invokes an action. | |
| Public Member Functions inherited from ActionBase | |
| String | getName () |
| Gets the name of an action. | |
| 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< TType > | tryCreateObjectRef (Class< TType > clazz) |
| Tries to create an owning ObjectRef instance to this KanziObject. | |
| 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. | |
| 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 WriteLogActionMetadata | |
| DynamicPropertyType< String > | Argument0Property |
| The property type on this node that will be argument 0 for the log message. | |
| DynamicPropertyType< String > | Argument10Property |
| The property type on this node that will be argument 10 for the log message. | |
| DynamicPropertyType< String > | Argument11Property |
| The property type on this node that will be argument 11 for the log message. | |
| DynamicPropertyType< String > | Argument12Property |
| The property type on this node that will be argument 12 for the log message. | |
| DynamicPropertyType< String > | Argument13Property |
| The property type on this node that will be argument 13 for the log message. | |
| DynamicPropertyType< String > | Argument14Property |
| The property type on this node that will be argument 14 for the log message. | |
| DynamicPropertyType< String > | Argument15Property |
| The property type on this node that will be argument 15 for the log message. | |
| DynamicPropertyType< String > | Argument1Property |
| The property type on this node that will be argument 1 for the log message. | |
| DynamicPropertyType< String > | Argument2Property |
| The property type on this node that will be argument 2 for the log message. | |
| DynamicPropertyType< String > | Argument3Property |
| The property type on this node that will be argument 3 for the log message. | |
| DynamicPropertyType< String > | Argument4Property |
| The property type on this node that will be argument 4 for the log message. | |
| DynamicPropertyType< String > | Argument5Property |
| The property type on this node that will be argument 5 for the log message. | |
| DynamicPropertyType< String > | Argument6Property |
| The property type on this node that will be argument 6 for the log message. | |
| DynamicPropertyType< String > | Argument7Property |
| The property type on this node that will be argument 7 for the log message. | |
| DynamicPropertyType< String > | Argument8Property |
| The property type on this node that will be argument 8 for the log message. | |
| DynamicPropertyType< String > | Argument9Property |
| The property type on this node that will be argument 9 for the log message. | |
| DynamicPropertyType< String > | LogTextProperty |
| The text to write to the Kanzi Studio Log window when a trigger executes this action. | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.WriteLogAction") |
| Metaclass for WriteLogAction. | |
| Protected Member Functions inherited from ForwardingAction | |
| ForwardingAction (Domain domain, long handle, Metaclass metaclass) | |
| Wraps a given native ForwardingAction. | |
| 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. | |
| void | onDetach () |
| Callback called by Kanzi during detach. | |
| void | onInvoke () |
| Callback called by Kanzi when the action is invoked by its trigger without delay. | |
| void | onPrepareDelayedInvoke () |
| Callback called by Kanzi when the action is invoked by its trigger with delay. | |
| void | onUnprepareDelayedInvoke () |
Kanzi calls this callback when an action is invoked by trigger with delay, after com.rightware.kanzi.Action#onDelayedInvoke() callback, or when it cancels a delayed execution. | |
| Protected Member Functions inherited from Action | |
| Action (Domain domain, long handle, Metaclass metaclass) | |
| Wraps a given native Action. | |
| 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. | |
Detailed Description
Use the WriteLogAction class to attach logging functionality to a trigger.
When a trigger that has a WriteLogAction attached is set off, the action is executed and it writes the string that you set in the LogTextProperty to the Kanzi Studio Log window in the log category KZ_LOG_CATEGORY_GENERIC.
Member Function Documentation
◆ create()
|
static |
Creates a WriteLogAction.
- Parameters
-
domain The domain passed to the constructor. name The action name passed to the constructor.
- Returns
- A handle to the created action.