EVA ICS v4 C++ SDK
Public Member Functions | Public Attributes | List of all members
eva::controller::Action< T > Class Template Reference

#include <eva4-ffi-sdk.hpp>

Collaboration diagram for eva::controller::Action< T >:
Collaboration graph
[legend]

Public Member Functions

 Action (ActionData< T > a)
 
void markPending ()
 
void markRunning ()
 
void markCompleted (string out)
 
void markFailed (string err, int8_t exitcode)
 
void markCanceled ()
 
void markTerminated ()
 

Public Attributes

uuidBuf uuid
 
OID oid
 
chrono::microseconds timeout
 
uint8_t priority
 
params
 

Detailed Description

template<typename T>
class eva::controller::Action< T >

Action class

Template Parameters
Taction parameters kind (e.g. UnitActionParams)

Constructor & Destructor Documentation

◆ Action()

template<typename T >
eva::controller::Action< T >::Action ( ActionData< T >  a)
inline

Constructs a class from ActionData payload

Parameters
apayload

Member Function Documentation

◆ markCanceled()

template<typename T >
void eva::controller::Action< T >::markCanceled ( )
inline

Mark the action canceled

Exceptions
Exception

◆ markCompleted()

template<typename T >
void eva::controller::Action< T >::markCompleted ( string  out)
inline

Mark the action completed

Parameters
outaction output
Exceptions
Exception

◆ markFailed()

template<typename T >
void eva::controller::Action< T >::markFailed ( string  err,
int8_t  exitcode 
)
inline

Mark the action failed

Parameters
erraction error
exitcodeerror exit code (custom)
Exceptions
Exception

◆ markPending()

template<typename T >
void eva::controller::Action< T >::markPending ( )
inline

Mark the action pending

Exceptions
Exception

◆ markRunning()

template<typename T >
void eva::controller::Action< T >::markRunning ( )
inline

Mark the action running

Exceptions
Exception

◆ markTerminated()

template<typename T >
void eva::controller::Action< T >::markTerminated ( )
inline

Mark the action terminated

Exceptions
Exception

Member Data Documentation

◆ oid

template<typename T >
OID eva::controller::Action< T >::oid

action OID

◆ params

template<typename T >
T eva::controller::Action< T >::params

action parameters

◆ priority

template<typename T >
uint8_t eva::controller::Action< T >::priority

action priority

◆ timeout

template<typename T >
chrono::microseconds eva::controller::Action< T >::timeout

action timeout

◆ uuid

template<typename T >
uuidBuf eva::controller::Action< T >::uuid

action uuid


The documentation for this class was generated from the following file:
The official SDK for EVA ICS
Technical documentation: https://info.bma.ai/en/actual/eva4/sdk/cpp/
© Bohemia Automation / Altertech