CustomAction Class Reference

CustomAction is a generic action class that captures all the sub-properties of the action as a property bag. More...

#include <src/api/mip/upe/custom_action.h>

Inheritance diagram for CustomAction:

Collaboration diagram for CustomAction:

Public Member Functions
virtual const std::string &	GetName () const =0
	Get action name.
virtual const std::vector< std::pair< std::string, std::string > > &	GetProperties () const =0
	Get the properties key value pair list.
virtual ActionType	GetType () const =0
	Get the type of Action.

Detailed Description

CustomAction is a generic action class that captures all the sub-properties of the action as a property bag.

The caller is responsible to understand the meaning of the action.

Definition at line 51 of file custom_action.h.

Member Function Documentation

GetName()

virtual const std::string & CustomAction::GetName ( ) const

pure virtual

Get action name.

Returns

an action name if one exists else an empty string.

GetProperties()

virtual const std::vector< std::pair< std::string, std::string > > & CustomAction::GetProperties ( ) const

pure virtual

Get the properties key value pair list.

Returns

a key value pair list.

GetType()

virtual ActionType Action::GetType ( ) const

pure virtualinherited

Get the type of Action.

Returns

ActionType The type of derived action this base class can be cast to.

---

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

• src/api/mip/upe/custom_action.h