MIP SDK — C++ 1.18
API Reference Documentation for C++
Loading...
Searching...
No Matches
CustomAction Class Referenceabstract

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. More...

#include <mip/upe/custom_action.h>

Inheritance diagram for CustomAction:
Action

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 ~CustomAction ()
 
- Public Member Functions inherited from Action
virtual ActionType GetType () const =0
 Get the type of Action.
 
virtual ~Action ()
 
virtual void Link ()
 
virtual const std::string & GetId () const
 
virtual bool operator== (const Action &action) const
 

Protected Member Functions

 CustomAction (const std::string &id)
 
- Protected Member Functions inherited from Action
virtual bool IsEqual (const Action &action) const =0
 
 Action ()
 
 Action (const std::string &id)
 

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.

Constructor & Destructor Documentation

◆ ~CustomAction()

virtual CustomAction::~CustomAction ( )
inlinevirtual

◆ CustomAction()

CustomAction::CustomAction ( const std::string & id)
inlineprotected

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.

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