kanzi::DispatchMessageAction Class Reference

Dispatch message action. More...

#include <kanzi/core.ui/action/dispatch_message_action.hpp>

Inheritance diagram for kanzi::DispatchMessageAction:
kanzi::ForwardingAction kanzi::Action kanzi::Object kanzi::MetaObject kanzi::PropertyObject

Public Types

enum  DispatchMode { DispatchModeNode, DispatchModeSend, DispatchModePost }
 Dispatch mode. More...
 
- Public Types inherited from kanzi::ForwardingAction
typedef map< AbstractPropertyType, BindingSharedPtrBindingContainer
 
typedef BindingContainer::const_iterator BindingConstIterator
 
- Public Types inherited from kanzi::PropertyObject
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef vector< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef PropertyStorageContainer::const_iterator PropertyStorageConstIterator
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 

Static Public Member Functions

static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
static DispatchMessageActionSharedPtr create (Domain *domain, string_view name)
 
- Static Public Member Functions inherited from kanzi::ForwardingAction
static ForwardingActionSharedPtr 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 ActionSharedPtr loadAction (Domain *domain, KzbFile &kzbFile, KzbMemoryParser &parser)
 
- Static Public Member Functions inherited from kanzi::Object
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 
- Static Public Member Functions inherited from kanzi::MetaObject
static const MetaclassgetStaticMetaclass ()
 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)
 
virtual void setTarget (BindingSharedPtr, AbstractPropertyType targetArgument, PropertyField targetField) KZ_OVERRIDE
 Called when binding is added, does nothing by default but allows derived classes to set the binding target. More...
 
- Protected Member Functions inherited from kanzi::ForwardingAction
 ForwardingAction (Domain *domain, string_view name)
 Create a set property action. More...
 
BindingSharedPtr loadBinding (KzcInputStream *inputStream, const KzuBinaryFileInfo *file)
 Loads binding object from binary. More...
 
BindingSharedPtr loadBinding (KzbFile &kzbFile, KzbMemoryParser &parser)
 
void addBinding (AbstractPropertyType argumentType, BindingSharedPtr binding)
 Adds binding object to action. More...
 
void removeBinding (AbstractPropertyType argumentType)
 Removes binding object from action. More...
 
void removeAllBindings ()
 Removes all binding objects from this action. More...
 
void onCopy (const ForwardingAction &other)
 
Variant getArgument (AbstractPropertyType argumentType)
 
void setSource (BindingSharedPtr binding, const Variant &sourceValue)
 Called when value binding is added. More...
 
void setSource (BindingSharedPtr binding, AbstractPropertyType sourceArgument, PropertyField sourceField)
 Called when argument binding is added. More...
 
void setSource (BindingSharedPtr binding, string_view sourceObjectPath, AbstractPropertyType sourcePropertyType, PropertyField sourceField)
 Called when property binding is added. More...
 
- 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)
 
- Protected Member Functions inherited from kanzi::MetaObject
 MetaObject ()
 
void initialize ()
 
- Protected Member Functions inherited from kanzi::PropertyObject
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *owner)
 
void removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
 
AbstractPropertyTypeDescriptor::ValueSourceEntrygetTopValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) const
 
AbstractPropertyTypeDescriptor::ValueSourceEntrygetTopValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourceEntryfindLocalValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
 
PropertyStoragePtr findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
 Gets property storage intrusive pointer that can be used to hold a reference until end of operation. More...
 
PropertyStoragePtr constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
PropertyStoragePtr acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType)
 
void validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
 
void copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 Copy local value from property storage. More...
 
PropertyStorageContainer::iterator beginPropertyStorage ()
 
PropertyStorageContainer::iterator endPropertyStorage ()
 
virtual void notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason)
 
void onCopy (const PropertyObject &other)
 

Properties

static PropertyType< string > MessageTypeProperty
 MessageType property. More...
 
static PropertyType< DispatchMessageAction::DispatchModeDispatchModeProperty
 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

- Public Member Functions inherited from kanzi::ForwardingAction
BindingSharedPtr addValueBinding (const Variant &sourceValue, AbstractPropertyType targetArgument)
 Add binding from value to object node or message argument. More...
 
BindingSharedPtr addValueBinding (const Variant &sourceValue, AbstractPropertyType targetArgument, PropertyField targetField)
 Add binding from value to object node or message argument. More...
 
BindingSharedPtr addArgumentBinding (AbstractPropertyType sourceArgument, AbstractPropertyType targetArgument)
 Add binding from message argument to object node or message argument. More...
 
BindingSharedPtr addArgumentBinding (AbstractPropertyType sourceArgument, PropertyField sourceField, AbstractPropertyType targetArgument, PropertyField targetField)
 Add binding from message argument to object node or message argument. More...
 
BindingSharedPtr addPropertyBinding (string_view sourceObjectPath, AbstractPropertyType sourcePropertyType, AbstractPropertyType targetArgument)
 Add binding from property to object node or message argument. More...
 
BindingSharedPtr addPropertyBinding (string_view sourceObjectPath, AbstractPropertyType sourcePropertyType, PropertyField sourceField, AbstractPropertyType targetArgument, PropertyField targetField)
 Add binding from property to object node or message argument. More...
 
BindingConstIterator beginBindings () const
 
BindingConstIterator endBindings () const
 
virtual void load (KzcInputStream *inputStream, const KzuBinaryFileInfo *file) KZ_OVERRIDE
 
virtual void load (KzbFile &kzbFile, KzbMemoryParser &parser) 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...
 
TriggergetTrigger () const
 Returns the trigger the action is attached to. More...
 
chrono::milliseconds getDelay () const
 
void setDelay (chrono::milliseconds delay)
 
- Public Member Functions inherited from kanzi::Object
 Object (Domain *domain)
 
virtual ~Object ()
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
KzuTaskSchedulergetTaskScheduler () const
 Returns the task scheduler of the object. More...
 
KzuMessageDispatchergetMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object. More...
 
virtual const MetaclassgetDynamicMetaclass () const KZ_OVERRIDE
 Returns the metaclass of the dynamic type of the object. More...
 
AppliedStyleEntrySharedPtr applyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object. More...
 
void unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
 
void applyObjectStyles ()
 Apply all styles for an object node. More...
 
void unapplyObjectStyles ()
 Unapplies and removes all applied styles. More...
 
- Public Member Functions inherited from kanzi::MetaObject
virtual ~MetaObject ()
 
bool isTypeOf (const Metaclass *objectType) const
 Determines if the type of this object is the given type or derived from it. More...
 
- Public Member Functions inherited from kanzi::PropertyObject
 PropertyObject ()
 
virtual ~PropertyObject ()
 
template<typename DataType >
void setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 Sets the local value of a property. More...
 
void removeKzbProperties ()
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property. More...
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalProperty (const PropertyType< DataType > &propertyType) 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 >
PropertyType< DataType >::Traits::ReturnType getPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers. More...
 
template<typename DataType >
void setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
void setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
bool isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
 
void clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value. More...
 
bool hasBaseValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value, disregarding modifiers. More...
 
bool hasLocalValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a local value set for the property. More...
 
bool hasNonClassValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a value of any precedence higher than class default value set for the property. More...
 
void removeLocalValue (AbstractPropertyType propertyType)
 Removes the local value associated with the property. More...
 
void copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
 Copies local value of single property from another object. More...
 
void copyLocalValues (const PropertyObject &other)
 Copies all local values from another object. More...
 
virtual void onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
 Virtual function to handle property change notifications. More...
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *owner)
 
template<typename DataType >
void removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *owner)
 
template<typename DataType >
void addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
void validatePropertyModifiers (AbstractPropertyType propertyType)
 
template<typename DataType >
void addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
size_t getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType)
 Gets number of current notification handlers for given property type. More...
 
- Static Public Attributes inherited from kanzi::Action
static PropertyType< int > DelayProperty
 Delay property. More...
 
- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 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

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

string kanzi::DispatchMessageAction::getMessageType ( ) const
inline

Gets the value of MessageTypeProperty.

See also
setMessageType()
void kanzi::DispatchMessageAction::setMessageType ( string  value)
inline

Sets the value of MessageTypeProperty.

See also
getMessageType()
DispatchMessageAction::DispatchMode kanzi::DispatchMessageAction::getDispatchMode ( ) const
inline

Gets the value of DispatchModeProperty.

See also
setDispatchMode()
void kanzi::DispatchMessageAction::setDispatchMode ( DispatchMessageAction::DispatchMode  value)
inline

Sets the value of DispatchModeProperty.

See also
getDispatchMode()
string kanzi::DispatchMessageAction::getRoutingTarget ( ) const
inline

Gets the value of RoutingTargetProperty.

See also
setRoutingTarget()
void kanzi::DispatchMessageAction::setRoutingTarget ( string  value)
inline

Sets the value of RoutingTargetProperty.

See also
getRoutingTarget()
string kanzi::DispatchMessageAction::getRoutingTargetLookup ( ) const
inline
void kanzi::DispatchMessageAction::setRoutingTargetLookup ( string  value)
inline
static PropertyTypeEditorInfoSharedPtr kanzi::DispatchMessageAction::makeEditorInfo ( )
static
static DispatchMessageActionSharedPtr kanzi::DispatchMessageAction::create ( Domain domain,
string_view  name 
)
static
virtual void kanzi::DispatchMessageAction::onAttach ( )
protectedvirtual

Attach dispatch message action.

Reimplemented from kanzi::Action.

virtual void kanzi::DispatchMessageAction::onInvoke ( )
protectedvirtual

Callback called during invoke.

Reimplemented from kanzi::Action.

virtual void kanzi::DispatchMessageAction::onPrepareDelayedInvoke ( )
protectedvirtual

Callback called before delayed invoke.

Reimplemented from kanzi::Action.

virtual void kanzi::DispatchMessageAction::onDelayedInvoke ( )
protectedvirtual

Callback called during delayed invoke.

Reimplemented from kanzi::Action.

virtual ActionSharedPtr kanzi::DispatchMessageAction::clone ( ) const
protectedvirtual

Implements kanzi::Action.

void kanzi::DispatchMessageAction::onCopy ( const DispatchMessageAction other)
protected
virtual void kanzi::DispatchMessageAction::setTarget ( BindingSharedPtr  ,
AbstractPropertyType  targetArgument,
PropertyField  targetField 
)
protectedvirtual

Called when binding is added, does nothing by default but allows derived classes to set the binding target.

Reimplemented from kanzi::ForwardingAction.

Member Data Documentation

PropertyType<string> kanzi::DispatchMessageAction::MessageTypeProperty
static

MessageType property.

The default value is "".

See also
setMessageType(), getMessageType()
PropertyType<DispatchMessageAction::DispatchMode> kanzi::DispatchMessageAction::DispatchModeProperty
static

DispatchMode property.

The default value is DispatchMessageAction::DispatchModePost.

See also
setDispatchMode(), getDispatchMode()
PropertyType<string> kanzi::DispatchMessageAction::RoutingTargetProperty
static

RoutingTarget property.

The default value is ".".

See also
setRoutingTarget(), getRoutingTarget()
PropertyType<string> kanzi::DispatchMessageAction::RoutingTargetLookupProperty
static

RoutingTargetLookup property.

The default value is "".

See also
setRoutingTargetLookup(), getRoutingTargetLookup()

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