Trigger is the base class for defining events, conditions and actions for content-driven logic programming. More...

#include <kanzi/trigger/trigger.hpp>

Inheritance diagram for kanzi::Trigger:

Public Types
typedef vector< ActionSharedPtr >	ActionContainer

typedef ActionContainer::const_iterator	ActionIterator

typedef vector < ConditionSharedPtr >	ConditionContainer

typedef ConditionContainer::const_iterator	ConditionIterator

Public Member Functions
string	getName () const

void	attach (Node *node)
	Attaches a trigger to node. More...

void	detach ()
	Detaches a trigger. More...

bool	isAttached () const
	Returns true if the trigger is attached to a node. More...

bool	isAttaching () const
	Returns true if trigger is in the process of attaching, false otherwise. More...

bool	isDetaching () const
	Returns true if the trigger currently detaching. More...

TriggerSharedPtr	copy () const
	Creates a copy of trigger. More...

void	addAction (ActionSharedPtr action)
	Adds an action to the trigger. More...

void	invokeActions () const
	Invokes actions in the trigger. More...

ActionIterator	beginActions () const

ActionIterator	endActions () const

void	addCondition (ConditionSharedPtr condition)
	Adds a condition to the trigger. More...

bool	checkConditions () const
	Checks against all conditions in the trigger. More...

ConditionIterator	beginConditions () const

ConditionIterator	endConditions () const

Node *	getNode () const
	Returns the node the trigger is attached to. More...

virtual void	load (KzcInputStream inputStream, const KzuBinaryFileInfo file)

Public Member Functions inherited from kanzi::Object
	Object (Domain *domain)

virtual	~Object ()

Domain *	getDomain () const
	Returns the domain the object belongs to. More...

KzuPropertyManager *	getPropertyManager () const
	Returns the property manager of the object. More...

KzuTaskScheduler *	getTaskScheduler () const
	Returns the task scheduler of the object. More...

KzuMessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...

ResourceManager *	getResourceManager () const
	Returns the resource manager of the object. More...

virtual const Metaclass *	getDynamicMetaclass () const
	Returns the metaclass of the dynamic type of the object. More...

bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it. More...

template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType value)
	Sets the local value of a property. More...

void	setProperty (const PropertyType< ResourceID > &propertyType, ResourceSharedPtr value)
	Sets the local value of a resource id property with a resource pointer. More...

template<typename DataType >
DataType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property. More...

template<typename DataType >
bool	getProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType &value) const
	Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...

template<typename DataType >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType value)

void	setAbstractProperty (AbstractPropertyType abstractPropertyType, ResourceSharedPtr value)

template<typename DataType >
DataType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
bool	getAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType &value) const

bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value. More...

bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property. More...

void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property. More...

void	copyLocalValues (const Object &other)
	Copies all local values from another object. More...

virtual void	onPropertyChanged (AbstractPropertyType propertyType, KzuPropertyNotificationReason reason)
	Virtual function to handle property change notifications. More...

AppliedStyleEntry *	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object. More...

void	unapplyObjectStyle (AppliedStyleEntry *appliedStyleEntry)

void	applyObjectStyles ()
	Apply all styles for an object node. More...

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles. More...

Static Public Member Functions
static TriggerSharedPtr	loadTrigger (KzcInputStream inputStream, Domain domain, const KzuBinaryFileInfo *file)
	Loads a trigger from stream. More...

Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...

Protected Member Functions
	Trigger (Domain *domain, string_view name)

virtual void	onAttach ()
	Callback called during attach. More...

virtual void	onDetach ()
	Callback called during detach. More...

virtual TriggerSharedPtr	clone () const =0
	Creates a clone of this trigger. More...

void	onCopy (const Trigger &other)
	Class copy function. More...

Protected Member Functions inherited from kanzi::Object
void	initialize ()

void	onCopy (const Object &other)

Static Protected Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Properties
static PropertyType< void * >	ForwardedMessageProperty
	ForwardedMessage property. More...

void *	getForwardedMessage () const
	Gets the value of ForwardedMessageProperty. More...

void	setForwardedMessage (void *value)
	Sets the value of ForwardedMessageProperty. More...

Additional Inherited Members
Protected Types inherited from kanzi::Object
typedef vector < AppliedStyleEntry * >	AppliedStyleContainer
	Applied style container. More...

Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object. More...

Detailed Description

Trigger is the base class for defining events, conditions and actions for content-driven logic programming.

Member Typedef Documentation

typedef vector<ActionSharedPtr> kanzi::Trigger::ActionContainer

typedef ActionContainer::const_iterator kanzi::Trigger::ActionIterator

typedef vector<ConditionSharedPtr> kanzi::Trigger::ConditionContainer

typedef ConditionContainer::const_iterator kanzi::Trigger::ConditionIterator

Constructor & Destructor Documentation

kanzi::Trigger::Trigger	(	Domain *	domain,
		string_view	name
	)

explicitprotected

Member Function Documentation

void* kanzi::Trigger::getForwardedMessage ( ) const

inline

Gets the value of ForwardedMessageProperty.

See also: setForwardedMessage()

void kanzi::Trigger::setForwardedMessage ( void * value )

inline

Sets the value of ForwardedMessageProperty.

See also: getForwardedMessage()

string kanzi::Trigger::getName ( ) const

void kanzi::Trigger::attach ( Node * node )

Attaches a trigger to node.

void kanzi::Trigger::detach ( )

Detaches a trigger.

bool kanzi::Trigger::isAttached ( ) const

inline

Returns true if the trigger is attached to a node.

bool kanzi::Trigger::isAttaching ( ) const

inline

Returns true if trigger is in the process of attaching, false otherwise.

bool kanzi::Trigger::isDetaching ( ) const

inline

Returns true if the trigger currently detaching.

TriggerSharedPtr kanzi::Trigger::copy ( ) const

Creates a copy of trigger.

void kanzi::Trigger::addAction ( ActionSharedPtr action )

Adds an action to the trigger.

void kanzi::Trigger::invokeActions ( ) const

Invokes actions in the trigger.

ActionIterator kanzi::Trigger::beginActions ( ) const

ActionIterator kanzi::Trigger::endActions ( ) const

void kanzi::Trigger::addCondition ( ConditionSharedPtr condition )

Adds a condition to the trigger.

bool kanzi::Trigger::checkConditions ( ) const

Checks against all conditions in the trigger.

ConditionIterator kanzi::Trigger::beginConditions ( ) const

ConditionIterator kanzi::Trigger::endConditions ( ) const

Node* kanzi::Trigger::getNode ( ) const

Returns the node the trigger is attached to.

static TriggerSharedPtr kanzi::Trigger::loadTrigger	(	KzcInputStream *	inputStream,
		Domain *	domain,
		const KzuBinaryFileInfo *	file
	)

static

Loads a trigger from stream.

virtual void kanzi::Trigger::load	(	KzcInputStream *	inputStream,
		const KzuBinaryFileInfo *	file
	)

virtual

virtual void kanzi::Trigger::onAttach ( )

protectedvirtual

Callback called during attach.

Reimplemented in kanzi::MessageTrigger, kanzi::OnPropertyChangedTrigger, kanzi::TimerTrigger, and kanzi::OnAttachedTrigger.

virtual void kanzi::Trigger::onDetach ( )

protectedvirtual

Callback called during detach.

Reimplemented in kanzi::MessageTrigger, kanzi::OnPropertyChangedTrigger, and kanzi::TimerTrigger.

virtual TriggerSharedPtr kanzi::Trigger::clone ( ) const

protectedpure virtual

Creates a clone of this trigger.

Implemented in kanzi::MessageTrigger, kanzi::OnPropertyChangedTrigger, kanzi::TimerTrigger, and kanzi::OnAttachedTrigger.

void kanzi::Trigger::onCopy ( const Trigger & other )

protected

Class copy function.

static PropertyTypeEditorInfoSharedPtr kanzi::Trigger::makeEditorInfo ( )

inlinestaticprotected

Member Data Documentation

PropertyType<void*> kanzi::Trigger::ForwardedMessageProperty

static

ForwardedMessage property.

The default value is 0.

See also: setForwardedMessage(), getForwardedMessage()

The documentation for this class was generated from the following file:

kanzi/trigger/trigger.hpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation