Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
Public Types | Public Member Functions | List of all members
ska::cheetah::rfim::policy::Policy< PolicyType > Class Template Reference

Policy executor. Performs the sequence of operations required to use the Policy object Any policy conforming to the requirements of the rfim::PolicyInfo template can be used. More...

#include <cheetah/rfim/policy/Policy.h>

Inheritance diagram for ska::cheetah::rfim::policy::Policy< PolicyType >:
Inheritance graph
Collaboration diagram for ska::cheetah::rfim::policy::Policy< PolicyType >:
Collaboration graph

Public Types

typedef PolicyInfo< PolicyType >::ReturnType ReturnType
 
typedef PolicyInfo< PolicyType >::DataArgumentType ArgumentType
 
typedef PolicyInfo< PolicyType >::AdapterType AdapterType
 

Public Member Functions

template<typename Handler >
ReturnType exec (Handler, ArgumentType &data)
 start a single Policy sequence. 1) a data adapter is requested from the policy 2) the argument and the adapter are then passed to the provided handler, which should use the adpater interface to modify data. 3) the policies return type is generatoed by the adpater after the handler returns More...
 
ReturnType null_op (ArgumentType &data)
 Generates the appropriate ReturnType for the Policy but performs no actions in the data.
 
template<typename HandlerType >
Policy< PolicyType >::ReturnType exec (HandlerType handler, ArgumentType &arg)
 

Detailed Description

template<typename PolicyType>
class ska::cheetah::rfim::policy::Policy< PolicyType >

Policy executor. Performs the sequence of operations required to use the Policy object Any policy conforming to the requirements of the rfim::PolicyInfo template can be used.

Definition at line 40 of file Policy.h.

Member Function Documentation

◆ exec()

template<typename PolicyType>
template<typename Handler >
ReturnType ska::cheetah::rfim::policy::Policy< PolicyType >::exec ( Handler  ,
ArgumentType &  data 
)
inline

start a single Policy sequence. 1) a data adapter is requested from the policy 2) the argument and the adapter are then passed to the provided handler, which should use the adpater interface to modify data. 3) the policies return type is generatoed by the adpater after the handler returns

Template Parameters
Handlersignature dhould be (ArgumentType const& data, AdapterType& data_adapter) the data_adapter interface should be any data modifications inside the handler and represents the same data as passed in ArgumentType

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