ifw-ccf  1.0.0
Classes | Functions | Variables
ccf::control Namespace Reference

Classes

class  AcqThread
 CCF Acquisition Thread, handling the reception of image data from the camera. More...
 
class  ActionMgr
 Responsible for the life-cycle management of actions and activities. More...
 
class  ActivityInitialising
 Provides the implementation of the Initialisation do-activity. More...
 
class  ActivityRecording
 Provides the implementation of the Recording do-activity. More...
 
class  Application
 Implements the core CCF Control Application. More...
 
class  ComAdptSim
 Simulation Communication Adapter, implementing an in-application simulation. More...
 
class  Config
 Provides access to the command line options and the configuration parameters stored in the configuration file. More...
 
class  DataContext
 Provides access to the application run-time data. More...
 
class  DcsActions
 Implements the action methods related to DcsActions. More...
 
class  DcsCmdsImpl
 Implements the CII/MAL interface. More...
 
class  MonitorThread
 Monitor Thread MPTK class. More...
 
class  ProcThread
 Processing Thread MPTK Thread implementation (see also ccf::mptk::Thread). More...
 
class  PubThread
 Publisher Thread MPTK Thread implementation (see also ccf::mptk::Thread). More...
 
class  RecActions
 Implements the action methods related to RecActions. More...
 
class  RecCmdsImpl
 Implements the CII/MAL interface. More...
 
class  RecWaitRequest
 Record Wait Request class, allocated when a client submits a RecWait Request. More...
 
class  StdActions
 RAD Action Group for the actions in connection with the "stdif". More...
 
class  StdCmdsImpl
 Implements the CII/MAL interface. More...
 

Functions

ccf::common::DbGetDb ()
 Return reference to the CCF DB object (Singleton instance). More...
 
ccf::common::ConfigBaseGetCfg ()
 Return reference to the CCF Configuration object (Singleton instance). More...
 
ccf::common::SetupBaseGetSetup ()
 Return reference to the CCF Setup object (Singleton instance). More...
 

Variables

const std::string CFG_DEF_PROCNAME = "dcsControl"
 Default application name. More...
 
const std::string CFG_KEY_INPUT_Q_SIZE = "acq.inputq.size"
 Configuration parameter defining the number of frame buffers in the Input Queue. More...
 
const std::string SETUP_KEY_SIM_FILE = "sim.file"
 Setup par referring to the simulation file to be as basis for the simulation. More...
 
Base names of threads and queues.
const std::string MON_THR_NAME = "CcfMonThr"
 
const std::string ACQ_THR_NAME = "CcfAcqThr"
 
const std::string PROC_THR_TAG = "CcfProc"
 
const std::string PUB_THR_TAG = "Pub"
 
const std::string INPUT_Q_NAME = "InputQueue"
 
const std::string OUTPUT_Q_NAME = "OutputQueue%d"
 
Thread sync signals sent on the MPTK Message Bus.
const std::string THREAD_SIG_TERM = "SigTerm"
 
const std::string THREAD_SIG_SETUP = "SigSetup"
 
const std::string THREAD_SIG_NEW_DATA = "SigNewData"
 
const std::string THREAD_SIG_PUBLISH = "SigPublish"
 
const std::string THREAD_SIG_START = "SigStart"
 
Configuration parameters defining the Processing Thread, Recipes and Publishers properties.
const std::string CFG_KEY_PROC_NAME = "proc%d.name"
 
const std::string CFG_KEY_OUTPUT_Q_SIZE = "proc%d.outputpq.size"
 
const std::string CFG_KEY_PROC_RECIPE_ADAPTER = "proc%d.recipe%d.adapter"
 
const std::string CFG_KEY_PROC_RECIPE_NAME = "proc%d.recipe%d.name"
 
const std::string CFG_KEY_PROC_PUB_ADAPTER = "proc%d.pub%d.adapter"
 
const std::string CFG_KEY_PROC_PUB_NAME = "proc%d.pub%d.name"
 
const std::string CFG_KEY_INIT_SETUP = "sys.init.setup"
 Cfg parameter defining the CCF Initialisation Setup. More...
 
const std::string CFG_KEY_MON_PERIOD = "mon.period"
 Cfg par defining the Monitor Thread period. More...
 
const std::string CONFIG_ENVVAR_DBHOST = "DB_HOST"
 Application configuration environment variables. More...
 

Constants to handle the Recording History.

const std::string ACTIVE_REC_MUTEX = "ActiveRecMutex"
 
const std::string REC_HISTORY_MUTEX = "RecHistoryMutex"
 
const std::string MUTEX_REC_WAIT_REQUESTS = "RecWaitRequests"
 
template<typename T >
void CcfRequestRejectHandler (const rad::AnyEvent &event, const std::string &state)
 Template function RAD request rejection check/handler. More...
 

Detailed Description

Function Documentation

◆ CcfRequestRejectHandler()

template<typename T >
void ccf::control::CcfRequestRejectHandler ( const rad::AnyEvent &  event,
const std::string &  state 
)

Template function RAD request rejection check/handler.

◆ GetCfg()

ccf::common::ConfigBase& ccf::control::GetCfg ( )
inline

Return reference to the CCF Configuration object (Singleton instance).

◆ GetDb()

ccf::common::Db& ccf::control::GetDb ( )
inline

Return reference to the CCF DB object (Singleton instance).

◆ GetSetup()

ccf::common::SetupBase& ccf::control::GetSetup ( )
inline

Return reference to the CCF Setup object (Singleton instance).

Variable Documentation

◆ ACQ_THR_NAME

const std::string ccf::control::ACQ_THR_NAME = "CcfAcqThr"

◆ ACTIVE_REC_MUTEX

const std::string ccf::control::ACTIVE_REC_MUTEX = "ActiveRecMutex"

◆ CFG_DEF_PROCNAME

const std::string ccf::control::CFG_DEF_PROCNAME = "dcsControl"

Default application name.

◆ CFG_KEY_INIT_SETUP

const std::string ccf::control::CFG_KEY_INIT_SETUP = "sys.init.setup"

Cfg parameter defining the CCF Initialisation Setup.

◆ CFG_KEY_INPUT_Q_SIZE

const std::string ccf::control::CFG_KEY_INPUT_Q_SIZE = "acq.inputq.size"

Configuration parameter defining the number of frame buffers in the Input Queue.

◆ CFG_KEY_MON_PERIOD

const std::string ccf::control::CFG_KEY_MON_PERIOD = "mon.period"

Cfg par defining the Monitor Thread period.

◆ CFG_KEY_OUTPUT_Q_SIZE

const std::string ccf::control::CFG_KEY_OUTPUT_Q_SIZE = "proc%d.outputpq.size"

◆ CFG_KEY_PROC_NAME

const std::string ccf::control::CFG_KEY_PROC_NAME = "proc%d.name"

◆ CFG_KEY_PROC_PUB_ADAPTER

const std::string ccf::control::CFG_KEY_PROC_PUB_ADAPTER = "proc%d.pub%d.adapter"

◆ CFG_KEY_PROC_PUB_NAME

const std::string ccf::control::CFG_KEY_PROC_PUB_NAME = "proc%d.pub%d.name"

◆ CFG_KEY_PROC_RECIPE_ADAPTER

const std::string ccf::control::CFG_KEY_PROC_RECIPE_ADAPTER = "proc%d.recipe%d.adapter"

◆ CFG_KEY_PROC_RECIPE_NAME

const std::string ccf::control::CFG_KEY_PROC_RECIPE_NAME = "proc%d.recipe%d.name"

◆ CONFIG_ENVVAR_DBHOST

const std::string ccf::control::CONFIG_ENVVAR_DBHOST = "DB_HOST"

Application configuration environment variables.

◆ INPUT_Q_NAME

const std::string ccf::control::INPUT_Q_NAME = "InputQueue"

◆ MON_THR_NAME

const std::string ccf::control::MON_THR_NAME = "CcfMonThr"

◆ MUTEX_REC_WAIT_REQUESTS

const std::string ccf::control::MUTEX_REC_WAIT_REQUESTS = "RecWaitRequests"

◆ OUTPUT_Q_NAME

const std::string ccf::control::OUTPUT_Q_NAME = "OutputQueue%d"

◆ PROC_THR_TAG

const std::string ccf::control::PROC_THR_TAG = "CcfProc"

◆ PUB_THR_TAG

const std::string ccf::control::PUB_THR_TAG = "Pub"

◆ REC_HISTORY_MUTEX

const std::string ccf::control::REC_HISTORY_MUTEX = "RecHistoryMutex"

◆ SETUP_KEY_SIM_FILE

const std::string ccf::control::SETUP_KEY_SIM_FILE = "sim.file"

Setup par referring to the simulation file to be as basis for the simulation.

◆ THREAD_SIG_NEW_DATA

const std::string ccf::control::THREAD_SIG_NEW_DATA = "SigNewData"

◆ THREAD_SIG_PUBLISH

const std::string ccf::control::THREAD_SIG_PUBLISH = "SigPublish"

◆ THREAD_SIG_SETUP

const std::string ccf::control::THREAD_SIG_SETUP = "SigSetup"

◆ THREAD_SIG_START

const std::string ccf::control::THREAD_SIG_START = "SigStart"

◆ THREAD_SIG_TERM

const std::string ccf::control::THREAD_SIG_TERM = "SigTerm"