Dispatch message action. More...

#include <kanzi/action/dispatch_message_action.hpp>

Inheritance diagram for kanzi::DispatchMessageAction:

Public Types
enum	DispatchMode { DispatchModeNode, DispatchModeSend, DispatchModePost }
	Dispatch mode. More...

Public Member Functions
void	addValueBinding (const Variant &sourceValue, AbstractPropertyType targetArgument)
	Add a value binding to a dispatch message action. More...

void	addArgumentBinding (AbstractPropertyType sourceArgument, AbstractPropertyType targetArgument)
	Add an argument binding to a dispatch message action. More...

void	addObjectNodePropertyBinding (string_view sourceObjectPath, AbstractPropertyType sourcePropertyType, AbstractPropertyType targetArgument)
	Add an object node property binding to a dispatch message action. More...

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

Public Member Functions inherited from kanzi::Action
string	getName () const

void	attach (Trigger *trigger)
	Attaches the action to a trigger. More...

void	detach ()
	Detaches the action. More...

void	invoke ()
	Invokes the action. More...

ActionSharedPtr	copy () const
	Create a copy of the action. More...

Trigger *	getTrigger () const
	Returns the trigger the action is attached to. More...

chrono::milliseconds	getDelay () const

void	setDelay (chrono::milliseconds interval)

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 PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

static DispatchMessageActionSharedPtr	create (Domain *domain, string_view name)

Static Public Member Functions inherited from kanzi::Action
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

static ActionSharedPtr	loadAction (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
	DispatchMessageAction (Domain *domain, string_view name)
	Create a dispatch message action. More...

virtual void	onAttach () KZ_OVERRIDE
	Attach dispatch message action. More...

virtual void	onInvoke () KZ_OVERRIDE
	Callback called during invoke. More...

virtual void	onPrepareDelayedInvoke () KZ_OVERRIDE
	Callback called before delayed invoke. More...

virtual void	onDelayedInvoke () KZ_OVERRIDE
	Callback called during delayed invoke. More...

virtual ActionSharedPtr	clone () const KZ_OVERRIDE

void	onCopy (const DispatchMessageAction &other)

Protected Member Functions inherited from kanzi::Action
	Action (Domain *domain, string_view name)

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

virtual void	onUnprepareDelayedInvoke ()
	Callback called after delayed invoke. More...

void	onCopy (const Action &other)

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

void	onCopy (const Object &other)

Properties
static PropertyType< string >	MessageTypeProperty
	MessageType property. More...

static PropertyType < DispatchMessageAction::DispatchMode >	DispatchModeProperty
	DispatchMode property. More...

static PropertyType< string >	RoutingTargetProperty
	RoutingTarget property. More...

static PropertyType< string >	RoutingTargetLookupProperty
	RoutingTargetLookup property. More...

string	getMessageType () const
	Gets the value of MessageTypeProperty. More...

void	setMessageType (string value)
	Sets the value of MessageTypeProperty. More...

DispatchMessageAction::DispatchMode	getDispatchMode () const
	Gets the value of DispatchModeProperty. More...

void	setDispatchMode (DispatchMessageAction::DispatchMode value)
	Sets the value of DispatchModeProperty. More...

string	getRoutingTarget () const
	Gets the value of RoutingTargetProperty. More...

void	setRoutingTarget (string value)
	Sets the value of RoutingTargetProperty. More...

string	getRoutingTargetLookup () const
	Gets the value of RoutingTargetLookupProperty. More...

void	setRoutingTargetLookup (string value)
	Sets the value of RoutingTargetLookupProperty. More...

Additional Inherited Members
Static Public Attributes inherited from kanzi::Action
static PropertyType< int >	DelayProperty
	Delay property. More...

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

Dispatch message action.

Member Enumeration Documentation

enum kanzi::DispatchMessageAction::DispatchMode

Dispatch mode.

Enumerator
DispatchModeNode
DispatchModeSend
DispatchModePost

Constructor & Destructor Documentation

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

explicitprotected

Create a dispatch message action.

Member Function Documentation

void kanzi::DispatchMessageAction::addValueBinding	(	const Variant &	sourceValue,
		AbstractPropertyType	targetArgument
	)

Add a value binding to a dispatch message action.

void kanzi::DispatchMessageAction::addArgumentBinding	(	AbstractPropertyType	sourceArgument,
		AbstractPropertyType	targetArgument
	)

Add an argument binding to a dispatch message action.

void kanzi::DispatchMessageAction::addObjectNodePropertyBinding	(	string_view	sourceObjectPath,
		AbstractPropertyType	sourcePropertyType,
		AbstractPropertyType	targetArgument
	)