Expression condition. More...

#include <kanzi/condition/expression_condition.hpp>

Inheritance diagram for kanzi::ExpressionCondition:

Public Types
enum	Operand { OperandLHS, OperandRHS }
	Expression condition operand position. More...

enum	Operation { OperationInvalid, OperationEqual, OperationNotEqual, OperationLess, OperationGreater, OperationLessOrEqual, OperationGreaterOrEqual }
	Expression condition operation. More...

Public Member Functions
void	setOperation (Operation operation)
	Sets the comparisons operation for the condition. More...

kzsError	setOperandValue (Operand operand, const Variant &value)
	Sets an operand in the comparison to be read from a fixed value. More...

kzsError	setOperandMessageArgument (Operand operand, const KzuPropertyType *messageArgument, PropertyField argumentField)
	Sets an operand in the comparison to be read from the forwarded message from the trigger. More...

kzsError	setOperandProperty (Operand operand, kzString objectPath, const KzuPropertyType *propertyType, PropertyField propertyField)
	Sets an operand in the comparison to be read from an objects property. More...

virtual void	load (KzcInputStream inputStream, const KzuBinaryFileInfo file) KZ_OVERRIDE

Public Member Functions inherited from kanzi::Condition
void	attach (Trigger *trigger)
	Attach function for condition. More...

void	detach ()
	Detach function for condition. More...

bool	check ()
	Check function for condition. More...

ConditionSharedPtr	copy () const

Trigger *	getTrigger () const

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 ExpressionConditionSharedPtr	create (Domain *domain, string_view name)

Static Public Member Functions inherited from kanzi::Condition
static ConditionSharedPtr	loadCondition (KzcInputStream inputStream, Domain domain, const KzuBinaryFileInfo *file)

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
	ExpressionCondition (Domain *domain)
	Creates an expression condition that can be attached to triggers. More...

virtual bool	onCheck () KZ_OVERRIDE
	Check function for condition. More...

virtual ConditionSharedPtr	clone () const KZ_OVERRIDE

void	onCopy (ExpressionCondition const &other)

Protected Member Functions inherited from kanzi::Condition
	Condition (Domain *domain)

virtual void	onAttach ()
	Attach function for condition. More...

virtual void	onDetach ()
	Detach function for condition. More...

void	onCopy (Condition const &other)

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

void	onCopy (const Object &other)

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

Static Protected Member Functions inherited from kanzi::Condition
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

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

Detailed Description

Expression condition.

Member Enumeration Documentation

enum kanzi::ExpressionCondition::Operand

Expression condition operand position.

Enumerator
OperandLHS	Left hand side operand.
OperandRHS	Right hand side operand.

enum kanzi::ExpressionCondition::Operation

Expression condition operation.

Enumerator
OperationInvalid	Invalid comparison.
OperationEqual	Equality comparison.
OperationNotEqual	Inequality comparison.
OperationLess	Less than comparison.
OperationGreater	Greater than comparison.
OperationLessOrEqual	Less than or equal comparison.
OperationGreaterOrEqual	Greater than or equal comparison.

Constructor & Destructor Documentation

kanzi::ExpressionCondition::ExpressionCondition ( Domain * domain )

explicitprotected

Creates an expression condition that can be attached to triggers.

Expression condition compares two operands with a specified comparison operator. Operand can be either a fixed value, a message argument from the message that the trigger forwards to the condition, or a property value that is read from an object specified by a relative path to the trigger object. Both operands and the operation must be set before the condition can be used.

Member Function Documentation

static ExpressionConditionSharedPtr kanzi::ExpressionCondition::create	(	Domain *	domain,
		string_view	name
	)

static

void kanzi::ExpressionCondition::setOperation ( Operation operation )

Sets the comparisons operation for the condition.

Not all property types support all operations. If the operation is not supported, the condition evaluates to KZ_FALSE.

kzsError kanzi::ExpressionCondition::setOperandValue	(	Operand	operand,
		const Variant &	value
	)

Sets an operand in the comparison to be read from a fixed value.

kzsError kanzi::ExpressionCondition::setOperandMessageArgument	(	Operand	operand,
		const KzuPropertyType *	messageArgument,
		PropertyField	argumentField
	)

Sets an operand in the comparison to be read from the forwarded message from the trigger.

kzsError kanzi::ExpressionCondition::setOperandProperty	(	Operand	operand,
		kzString	objectPath,
		const KzuPropertyType *	propertyType,
		PropertyField	propertyField
	)

Sets an operand in the comparison to be read from an objects property.

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

virtual

Reimplemented from kanzi::Condition.

virtual bool kanzi::ExpressionCondition::onCheck ( )

protectedvirtual

Check function for condition.

Implements kanzi::Condition.

virtual ConditionSharedPtr kanzi::ExpressionCondition::clone ( ) const

protectedvirtual

Implements kanzi::Condition.

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

protected

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

kanzi/condition/expression_condition.hpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation