Namespaces
	fits

	test

Classes
class	AppBase
	Class to be used as parent for CCF application type of classes. More...

class	Base
	Class to be used as parent all CCF classes. More...

class	ComAdptBase
	Class to be used as parent for CCF Communication Adapters. More...

class	ConfigBase
	Config class for CCF applications. More...

class	DataFrame
	Frame class used to store the data and metadata for one frames received from the camera. More...

class	Db
	Interface to the OLDB and Pub/Sub. More...

class	DcsClient
	Used to implement CCF Control client applications. More...

class	FrameQueue
	The FrameQueue class implements a queue, to manage a set of CCF DataFrame instances as a ring buffer. More...

class	FrameStatistics
	Class used by the threads to store info for generating performance statistics. More...

class	InternalDb
	DB implementing (partially) the rad::DbAdapter interface; used for internal/test purposes. More...

class	NameMapping
	Implements a name mapping service, based on a Name Mapping File to be loaded and installed. More...

class	PubBase
	Class for implementing CCF Data Publishers. More...

class	PublisherStatus
	Class used by a Publisher to handle its own publisher status. More...

class	RecipeBase
	Processing Recipe base class. All recipes shall be derived from this class. More...

class	SetupBase
	Global setup class for CCF applications. More...

Functions
std::string	GetHostAddress_ ()

void	_CheckIfReqSupported (const std::string &request)

std::string	GetHostAddress ()

Db &	GetDb ()
	Return the reference to the CCF DB Singleton instance. More...

SetupBase &	GetSetup ()

std::string	GetImageDir ()
	Get the name of the image output folder. More...

std::string	PackParameters (const ctd::param::ParameterSet &parameters)
	Serialise the parameters contained in the parameter set. More...

void	UnpackParameters (const std::string &parameters, ctd::param::ParameterSet &par_set)
	Unpacke the serialised parameters and store the information in the provided parameter set object. More...

void	AddFileStored (const std::string &new_file)

Variables
const std::string	CCF_VERSION = "1.0.0"
	Version of CCF. More...

const std::string	IFW_VERSION = "3.0"
	Version of IFW. More...

const std::string	CFG_DEF_LOGLEVEL = "INFO"
	Default logging level. More...

const std::string	CFG_PRIM_DID = "dit/stddid/primary.did"
	Name of primary dictionary. More...

DB state nodes names.
const std::string	DB_NODE_SM_STATUS_STATE = "sm.status.state"

const std::string	DB_NODE_SM_STATUS_SUBSTATE = "sm.status.substate"

const std::string	DB_NODE_SM_STATE = "sm.state"

Standard metadata keywords.
const std::string	META_KEY_EXPO_RATE = "MetaExpoType"

const std::string	META_KEY_EXPO_TIME = "MetaExpoTime"

const std::string	META_KEY_EXPO_WIN_BINX = "MetaExpoWinBinX"

const std::string	META_KEY_EXPO_WIN_BINY = "MetaExpoWinBinY"

const std::string	META_KEY_EXPO_WIN_STARTX = "MetaExpoWinStartX"

const std::string	META_KEY_EXPO_WIN_STARTY = "MetaExpoWinStartY"

const std::string	META_KEY_SYSTEM = "MetaSystem"

const std::string	META_KEY_CAM_NAME = "MetaCamName"

const std::string	META_KEY_CAM_ID = "MetaCamId"

const std::string	META_KEY_CAM_MODEL = "MetaCamModel"

const std::string	META_KEY_CAM_CHIPMODEL = "MetaCamChipModel"

const std::string	META_KEY_CAM_TYPE = "MetaCamType"

Setup parameter names.
const std::string	SETUP_KEY_EXPO_TIME = "expo.time"

const std::string	SETUP_KEY_EXPO_MODE = "expo.mode"

const std::string	SETUP_KEY_EXPO_NB = "expo.nb"

const std::string	SETUP_KEY_EXPO_WIN_START_X = "expo.win.start_x"

const std::string	SETUP_KEY_EXPO_WIN_START_Y = "expo.win.start_y"

const std::string	SETUP_KEY_EXPO_WIN_WIDTH = "expo.win.width"

const std::string	SETUP_KEY_EXPO_WIN_HEIGHT = "expo.win.height"

const std::string	SETUP_KEY_EXPO_BIN_X = "expo.bin_x"

const std::string	SETUP_KEY_EXPO_BIN_Y = "expo.bin_y"

const std::string	SETUP_KEY_EXPO_FRAME_RATE = "expo.frame.rate"

const std::string	SETUP_KEY_EXPO_FRAME_RATE_LIMIT = "expo.frame.rate.limit"

const std::string	SETUP_KEY_SIM_TYPE = "sim.type"

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

const std::string	SETUP_KEY_SIM_MAX_SHIFT_PR_FRAME = "sim.max_shift_pr_frame"

const std::string	SETUP_KEY_SIM_MAX_SHIFT = "sim.max_shift"

const std::string	SETUP_KEY_SIM_NOISE = "sim.noise"

const std::string	SETUP_KEY_PROC_ENABLED = "proc%d.enabled"

const std::string	PROP_KEY_FRAME_RATE_LIMIT = "expo.frame.rate.limit"

Simulation type.
const std::string	SIM_TYPE_FILE_STR = "File"

const std::string	SIM_TYPE_PATTERN1_STR = "Pattern1"

Configuration system parameters.
const std::string	CFG_SYS_NAME = "sys.name"

const std::string	CFG_SYS_DID = "sys.did%d"

const std::string	CFG_SYS_REQ_ENDPOINT = "sys.req.endpoint"

const std::string	CFG_SYS_DB_ENDPOINT = "sys.db.endpoint"

const std::string	CFG_SYS_DB_TIMEOUT_SEC = "sys.db.timeout.sec"

const std::string	CFG_SYS_DB_PREFIX = "sys.db.prefix"

const std::string	CFG_SYS_SM_SCXML = "sys.sm.scxml"

const std::string	CFG_SYS_LOG_LEVEL = "sys.log.level"

const std::string	CFG_SYS_LOG_PROPERTIES = "sys.log.properties"

const std::string	CFG_SYS_PUB_SUB_ENDPOINT = "sys.pub_sub.endpoint"

const std::string	CFG_SYS_REQ_HIST_SIZE = "sys.req.hist.size"

const std::string	CFG_SYS_REQ_HIST_EXP = "sys.req.hist.expiration"

const std::string	CFG_SYS_SIMULATION = "sys.simulation"

Monitor Thread configuration.
const std::string	CFG_MON_PERIOD = "mon.period"

const std::string	CFG_MON_NB_OF_SAMPLES = "mon.nb_of_samples"

Configuration camera parameters.
const std::string	CFG_CAM_NAME = "cam.name"

const std::string	CFG_CAM_ID = "cam.id"

const std::string	CFG_CAM_MODEL = "cam.model"

const std::string	CFG_CAM_CHIP_MODEL = "cam.chip.model"

const std::string	CFG_CAM_TYPE = "cam.type"

const std::string	CFG_CAM_MANUFACTURER = "cam.manufacturer"

const std::string	CFG_CAM_ADAPTER_PROTOCOL = "cam.adapter.protocol"

const std::string	CFG_CAM_ADAPTER_MAPPING = "cam.adapter.mapping"

const std::string	CFG_CAM_ADAPTER_API = "cam.adapter.api"

const std::string	CFG_CAM_ADAPTER_ADDRESS = "cam.adapter.address"

const std::string	CFG_CAM_ADAPTER_SIM_ADDRESS = "cam.adapter.sim_address"

const std::string	CFG_CAM_ADAPTER_PROPERTY = "cam.adapter.property%d"

const std::string	CFG_CAM_CHIP_WIDTH = "cam.chip.width"

const std::string	CFG_CAM_CHIP_HEIGHT = "cam.chip.height"

const std::string	CFG_CAM_CHIP_MAX_RES = "cam.chip.max_resolution"

const std::string	CFG_CAM_CHIP_RESOLUTION = "cam.chip.resolution"

Publisher related setup parameters.
const std::string	SETUP_KEY_PUB_ENABLED = "proc%d.pub%d.enabled"

const std::string	SETUP_KEY_PUB_BASE_DELAY = "proc%d.pub%d.pub_base.delay"

DB key names updated in the OLDB by a Data Pubslisher.
const std::string	DB_NODE_PUB_ID = "id"

const std::string	DB_NODE_PUB_NAME = "name"

const std::string	DB_NODE_ADAPTER = "adapter"

const std::string	DB_NODE_PUB_START = "start"

const std::string	DB_NODE_PUB_STATUS = "status"

const std::string	DB_NODE_PUB_FRAMES_HANDLED = "frames_handled"

const std::string	DB_NODE_PUB_VOLUME_HANDLED = "volume_handled"

const std::string	DB_NODE_PUB_NB_OF_FILES_STORED = "nb_of_files_stored"

const std::string	DB_NODE_PUB_FILES_STORED = "files_stored"

States (composite).
enum	LogLevel { LogLevel::OFF = 60000, LogLevel::FATAL = 50000, LogLevel::ERROR = 40000, LogLevel::WARN = 30000, LogLevel::INFO = 20000, LogLevel::DEBUG = 10000, LogLevel::DEBUG2 = 9000, LogLevel::DEBUG3 = 8000, LogLevel::TRACE = 0, LogLevel::ALL = TRACE, LogLevel::NOT_SET = -1 }
	Log levels defined for CCF; adds two debugging levels: DEBUG2, DEBUG3. More...

enum	HwStatus { HwStatus::NOT_OK = 0, HwStatus::OK }
	HW status values. More...

enum	Status { Status::FAILURE = 0, Status::SUCCESS = 1 }
	General status variable. More...

const std::string	STATE_ON_NOT_OP_NOT_READY = "On::NotOperational::NotReady"

const std::string	STATE_ON_NOT_OP_READY = "On::NotOperational::Ready"

const std::string	STATE_ON_OP_IDLE = "On::Operational::Idle"

const std::string	STATE_ON_OP_ACQ = "On::Operational::Acquisition"

const std::string	STATE_ON_OP_ACQ_NOT_REC = "On::Operational::Acquisition::NotRecording"

const std::string	STATE_ON_OP_ACQ_REC = "On::Operational::Acquisition::Recording"

const std::string	CFG_KEY_SYS_IMAGE_DIR = "sys.image.dir"
	Cfg parameter defining the directory in the DATAROOT where data will be stored. More...

void	SendThrMsg (const std::string &command, const std::string &sender_thread_id, const std::string &receiver_thread_id, const std::string &data)
	Send MPTK message via internal Message Bus. More...

bool	ReceiveThrMsg (const std::string &receiver_thread_id, const double time_out, ccf::mptk::Message &message)
	Receive a message from the given thread. Returns true if message received. More...

void	AssertPtr (const void *ptr, const std::string &object, const std::string &location)
	Check that pointer is not NULL and raise rad::exception in case it is. More...

void	DecomposeSmStatus (const std::string &sm_state, std::string &sum_state, std::string &sum_substate)

Execution status.
enum	ImageDataType { ImageDataType::UNKNOWN = -1, ImageDataType::BYTE = 8, ImageDataType::PRESCALED = -8, ImageDataType::INT16 = 16, ImageDataType::UINT16 = -16, ImageDataType::INT32 = 32, ImageDataType::FLOAT = -32, ImageDataType::INT64 = 64, ImageDataType::DOUBLE = -64 }
	CCF image data types. Based on the values defined for BITPIX in the FITS standard. More...

enum	PubType { PubType::UNDEFINED = -1, PubType::RECORDING = 1, PubType::NOT_RECORDING }
	A Publisher may be Recording or Not-Recording. A Recording Publisher publishes data into files. More...

enum	PubStatus { PubStatus::ACTIVE = recif::RecStatusNames::Active, PubStatus::COMPLETED = recif::RecStatusNames::Completed, PubStatus::STOPPED = recif::RecStatusNames::Stopped, PubStatus::ABORTED = recif::RecStatusNames::Aborted, PubStatus::FAILED = recif::RecStatusNames::Failed, PubStatus::UNDEFINED = recif::RecStatusNames::Undefined }
	Defines the various possible states of a Data Publisher. More...

enum	ProcStatus { ProcStatus::UNDEFINED = -1, ProcStatus::IDLE = 1, ProcStatus::PROCESSING = 32, ProcStatus::FINISHED = 128, ProcStatus::FAILED = 256 }
	Possible states for a Processing Recipe defined. More...

enum	ExpoMode { ExpoMode::FINITE = 1, ExpoMode::CONTINUOUS, ExpoMode::INACTIVE }
	Exposure modes. More...

const std::string	SUCCESS = "Success"

const std::string	FAILURE = "Failure"

std::string	StatusToStr (ccf::common::Status status)
	Convert the status from number to string. More...

void	ResetRecStatusObj (std::shared_ptr< recif::RecStatus > &rec_status_obj, const recif::RecStatusNames rec_status=recif::RecStatusNames::Undefined)
	Reset the members of the Recording Status Object. More...

void	CopyRecStatusObj (const std::shared_ptr< recif::RecStatus > &src_rec_status_obj, const std::shared_ptr< recif::RecStatus > &trg_rec_status_obj)
	Cope the members of one Recording Status Object to another. More...

Exposure modes.
enum	SimType { SimType::FILE = 1, SimType::PATTERN1 }
	Simulation type. More...

const std::string	EXPO_MODE_FINITE = "Finite"

const std::string	EXPO_MODE_CONTINUOUS = "Continuous"

const std::string	EXPO_MODE_INACTIVE = "Inactive"

const std::string	REC_ID_PREFIX = "RecId"

ExpoMode	ExpoModeToNb (const std::string &expo_mode)
	Convert exposure mode from number representation to string. More...

Publisher Status names.
const std::string	PUB_STAT_NAME_ACTIVE = "Active"

const std::string	PUB_STAT_NAME_COMPLETED = "Completed"

const std::string	PUB_STAT_NAME_STOPPED = "Stopped"

const std::string	PUB_STAT_NAME_ABORTED = "Aborted"

const std::string	PUB_STAT_NAME_FAILED = "Failed"

const std::string	PUB_STAT_NAME_UNDEFINED = "Undefined"

LogLevel	LogLevelStrToNb (const std::string &log_level)
	Log level string to number representation. More...

std::string	PubStatusNameToStr (PubStatus pub_status_nb)
	Publisher status, number representation to string. More...

std::string	RecStatusNameToStr (recif::RecStatusNames rec_status_nb)
	Recording Status name, number to string representation. More...

Cfg par to allow silent frame skipping, i.e. no error reported, but frames skipped registered in statistics.
const std::string	CFG_ACQ_LOST_FRAMES = "acq.allow_lost_frames"

const std::string	CFG_ACQ_FRAME_SKIPPING = "acq.allow_frame_skipping"

const std::string	CFG_ACQ_PRIORITY = "acq.priority"

const std::string	CFG_PROC_SKIP_FRAMES = "proc%d.allow_frame_skipping"
	Cfg par to allow silent frame skipping, i.e. no error reported, but frames skipped registered in statistics. More...

const std::string	CFG_PROC_PRIORITY = "proc%d.priority"

const std::string	CFG_PUB_PRIORITY = "proc%d.pub%d.priority"

ConfigBase &	GetCfg ()
	Return reference to the singleton instance of the configuration. More...

Processing Recipe related standard setup parameter names.
const std::string	SETUP_KEY_RECIPE_ENABLED = "proc%d.recipe%d.enabled"

const std::string	SETUP_KEY_RECIPE_BASE_DELAY = "proc%d.recipe%d.recipe_base.delay"

template<class SRC_IM_TYPE , class TRG_IM_TYPE >
void	ConvertImage (SRC_IM_TYPE image_buffer, uint32_t pixels, TRG_IM_TYPE target_buf, uint32_t target_buf_size)
	Convert the given image from one pixel type to another. A buffer is allocated internally, which must be free'd by the user. More...

void	PrepCplImage (const ccf::common::DataFrame &frame, cpl_image *image, ccf::common::ImageDataType target_data_type, uint32_t *target_buffer_size)

Detailed Description

Copyright: ESO - European Southern Observatory

::

Copyright: ESO - European Southern Observatory

Enumeration Type Documentation

◆ ExpoMode

enum ccf::common::ExpoMode

strong

Exposure modes.

Enumerator
FINITE
CONTINUOUS
INACTIVE

◆ HwStatus

enum ccf::common::HwStatus

strong

HW status values.

Enumerator
NOT_OK
OK

◆ ImageDataType

enum ccf::common::ImageDataType

strong

CCF image data types. Based on the values defined for BITPIX in the FITS standard.

Enumerator
UNKNOWN
BYTE
PRESCALED
INT16
UINT16
INT32
FLOAT
INT64
DOUBLE

◆ LogLevel

enum ccf::common::LogLevel

strong

Log levels defined for CCF; adds two debugging levels: DEBUG2, DEBUG3.

Enumerator
OFF
FATAL
ERROR
WARN
INFO
DEBUG
DEBUG2
DEBUG3
TRACE
ALL
NOT_SET

◆ ProcStatus

enum ccf::common::ProcStatus

strong

Possible states for a Processing Recipe defined.

Enumerator
UNDEFINED
IDLE
PROCESSING
FINISHED
FAILED

◆ PubStatus

enum ccf::common::PubStatus

strong

Defines the various possible states of a Data Publisher.

Enumerator
ACTIVE
COMPLETED
STOPPED
ABORTED
FAILED
UNDEFINED

◆ PubType

enum ccf::common::PubType

strong

A Publisher may be Recording or Not-Recording. A Recording Publisher publishes data into files.

Enumerator
UNDEFINED
RECORDING
NOT_RECORDING

◆ SimType

enum ccf::common::SimType

strong

Simulation type.

Enumerator
FILE
PATTERN1

◆ Status

enum ccf::common::Status

strong

General status variable.

Enumerator
FAILURE
SUCCESS

Function Documentation

◆ _CheckIfReqSupported()

void ccf::common::_CheckIfReqSupported ( const std::string & request )

◆ AddFileStored()

void ccf::common::AddFileStored ( const std::string & new_file )

◆ AssertPtr()

void ccf::common::AssertPtr	(	const void *	ptr,
		const std::string &	object,
		const std::string &	location
	)

Check that pointer is not NULL and raise rad::exception in case it is.

◆ ConvertImage()

template<class SRC_IM_TYPE , class TRG_IM_TYPE >

void ccf::common::ConvertImage	(	SRC_IM_TYPE *	image_buffer,
		uint32_t	pixels,
		TRG_IM_TYPE **	target_buf,
		uint32_t *	target_buf_size
	)

Convert the given image from one pixel type to another. A buffer is allocated internally, which must be free'd by the user.

◆ CopyRecStatusObj()

void ccf::common::CopyRecStatusObj	(	const std::shared_ptr< recif::RecStatus > &	src_rec_status_obj,
		const std::shared_ptr< recif::RecStatus > &	trg_rec_status_obj
	)

Cope the members of one Recording Status Object to another.

◆ DecomposeSmStatus()

void ccf::common::DecomposeSmStatus	(	const std::string &	sm_state,
		std::string &	sum_state,
		std::string &	sum_substate
	)

◆ ExpoModeToNb()

ExpoMode ccf::common::ExpoModeToNb ( const std::string & expo_mode )

Convert exposure mode from number representation to string.

◆ GetCfg()

ConfigBase& ccf::common::GetCfg ( )

inline

Return reference to the singleton instance of the configuration.

◆ GetDb()

Db& ccf::common::GetDb ( )

inline

Return the reference to the CCF DB Singleton instance.

◆ GetHostAddress()

std::string ccf::common::GetHostAddress ( )

Find the host IP address to send frames back to. This uses the getifaddrs() function to get all network interfaces of the local system, and loops through them until the first IP4 interface which has the flag IFF_UP but NOT the flag IFF_LOOPBACK (ie localhost)

◆ GetHostAddress_()

std::string ccf::common::GetHostAddress_ ( )

◆ GetImageDir()

std::string ccf::common::GetImageDir ( )

Get the name of the image output folder.

◆ GetSetup()

SetupBase& ccf::common::GetSetup ( )

inline

◆ LogLevelStrToNb()

LogLevel ccf::common::LogLevelStrToNb ( const std::string & log_level )

Log level string to number representation.

◆ PackParameters()

std::string ccf::common::PackParameters ( const ctd::param::ParameterSet & parameters )

Serialise the parameters contained in the parameter set.

◆ PrepCplImage()

void ccf::common::PrepCplImage	(	const ccf::common::DataFrame &	frame,
		cpl_image **	image,
		ccf::common::ImageDataType *	target_data_type,
		uint32_t *	target_buffer_size
	)

Create a CPL Image object from the image contained in the CCF Frame Object. As CPL only support int32, float and double, other pixel data types will be converted. Note: The user must perform a "cpl_image_delete()" on the allocated CPL Image object.

◆ PubStatusNameToStr()

std::string ccf::common::PubStatusNameToStr ( PubStatus pub_status_nb )

Publisher status, number representation to string.

◆ ReceiveThrMsg()

bool ccf::common::ReceiveThrMsg	(	const std::string &	receiver_thread_id,
		const double	time_out,
		ccf::mptk::Message &	message
	)

Receive a message from the given thread. Returns true if message received.

◆ RecStatusNameToStr()

std::string ccf::common::RecStatusNameToStr ( recif::RecStatusNames rec_status_nb )

Recording Status name, number to string representation.

◆ ResetRecStatusObj()

void ccf::common::ResetRecStatusObj	(	std::shared_ptr< recif::RecStatus > &	rec_status_obj,
		const recif::RecStatusNames	rec_status
	)

Reset the members of the Recording Status Object.

◆ SendThrMsg()

void ccf::common::SendThrMsg	(	const std::string &	command,
		const std::string &	sender_thread_id,
		const std::string &	receiver_thread_id,
		const std::string &	data
	)

Send MPTK message via internal Message Bus.

◆ StatusToStr()

std::string ccf::common::StatusToStr ( ccf::common::Status status )

Convert the status from number to string.

◆ UnpackParameters()

void ccf::common::UnpackParameters	(	const std::string &	parameters,
		ctd::param::ParameterSet &	par_set
	)

Unpacke the serialised parameters and store the information in the provided parameter set object.

Variable Documentation

◆ CCF_VERSION

const std::string ccf::common::CCF_VERSION = "1.0.0"

Version of CCF.

◆ CFG_ACQ_FRAME_SKIPPING

const std::string ccf::common::CFG_ACQ_FRAME_SKIPPING = "acq.allow_frame_skipping"

◆ CFG_ACQ_LOST_FRAMES

const std::string ccf::common::CFG_ACQ_LOST_FRAMES = "acq.allow_lost_frames"

◆ CFG_ACQ_PRIORITY

const std::string ccf::common::CFG_ACQ_PRIORITY = "acq.priority"

◆ CFG_CAM_ADAPTER_ADDRESS

const std::string ccf::common::CFG_CAM_ADAPTER_ADDRESS = "cam.adapter.address"

◆ CFG_CAM_ADAPTER_API

const std::string ccf::common::CFG_CAM_ADAPTER_API = "cam.adapter.api"

◆ CFG_CAM_ADAPTER_MAPPING

const std::string ccf::common::CFG_CAM_ADAPTER_MAPPING = "cam.adapter.mapping"

◆ CFG_CAM_ADAPTER_PROPERTY

const std::string ccf::common::CFG_CAM_ADAPTER_PROPERTY = "cam.adapter.property%d"

◆ CFG_CAM_ADAPTER_PROTOCOL

const std::string ccf::common::CFG_CAM_ADAPTER_PROTOCOL = "cam.adapter.protocol"

◆ CFG_CAM_ADAPTER_SIM_ADDRESS

const std::string ccf::common::CFG_CAM_ADAPTER_SIM_ADDRESS = "cam.adapter.sim_address"

◆ CFG_CAM_CHIP_HEIGHT

const std::string ccf::common::CFG_CAM_CHIP_HEIGHT = "cam.chip.height"

◆ CFG_CAM_CHIP_MAX_RES

const std::string ccf::common::CFG_CAM_CHIP_MAX_RES = "cam.chip.max_resolution"

◆ CFG_CAM_CHIP_MODEL

const std::string ccf::common::CFG_CAM_CHIP_MODEL = "cam.chip.model"

◆ CFG_CAM_CHIP_RESOLUTION

const std::string ccf::common::CFG_CAM_CHIP_RESOLUTION = "cam.chip.resolution"

◆ CFG_CAM_CHIP_WIDTH

const std::string ccf::common::CFG_CAM_CHIP_WIDTH = "cam.chip.width"

◆ CFG_CAM_ID

const std::string ccf::common::CFG_CAM_ID = "cam.id"

◆ CFG_CAM_MANUFACTURER

const std::string ccf::common::CFG_CAM_MANUFACTURER = "cam.manufacturer"

◆ CFG_CAM_MODEL

const std::string ccf::common::CFG_CAM_MODEL = "cam.model"

◆ CFG_CAM_NAME

const std::string ccf::common::CFG_CAM_NAME = "cam.name"

◆ CFG_CAM_TYPE

const std::string ccf::common::CFG_CAM_TYPE = "cam.type"

◆ CFG_DEF_LOGLEVEL

const std::string ccf::common::CFG_DEF_LOGLEVEL = "INFO"

Default logging level.

◆ CFG_KEY_SYS_IMAGE_DIR

const std::string ccf::common::CFG_KEY_SYS_IMAGE_DIR = "sys.image.dir"

Cfg parameter defining the directory in the DATAROOT where data will be stored.

◆ CFG_MON_NB_OF_SAMPLES

const std::string ccf::common::CFG_MON_NB_OF_SAMPLES = "mon.nb_of_samples"

◆ CFG_MON_PERIOD

const std::string ccf::common::CFG_MON_PERIOD = "mon.period"

◆ CFG_PRIM_DID

const std::string ccf::common::CFG_PRIM_DID = "dit/stddid/primary.did"

Name of primary dictionary.

◆ CFG_PROC_PRIORITY

const std::string ccf::common::CFG_PROC_PRIORITY = "proc%d.priority"

◆ CFG_PROC_SKIP_FRAMES

const std::string ccf::common::CFG_PROC_SKIP_FRAMES = "proc%d.allow_frame_skipping"

Cfg par to allow silent frame skipping, i.e. no error reported, but frames skipped registered in statistics.

◆ CFG_PUB_PRIORITY

const std::string ccf::common::CFG_PUB_PRIORITY = "proc%d.pub%d.priority"

◆ CFG_SYS_DB_ENDPOINT

const std::string ccf::common::CFG_SYS_DB_ENDPOINT = "sys.db.endpoint"

◆ CFG_SYS_DB_PREFIX

const std::string ccf::common::CFG_SYS_DB_PREFIX = "sys.db.prefix"

◆ CFG_SYS_DB_TIMEOUT_SEC

const std::string ccf::common::CFG_SYS_DB_TIMEOUT_SEC = "sys.db.timeout.sec"

◆ CFG_SYS_DID

const std::string ccf::common::CFG_SYS_DID = "sys.did%d"

◆ CFG_SYS_LOG_LEVEL

const std::string ccf::common::CFG_SYS_LOG_LEVEL = "sys.log.level"

◆ CFG_SYS_LOG_PROPERTIES

const std::string ccf::common::CFG_SYS_LOG_PROPERTIES = "sys.log.properties"

◆ CFG_SYS_NAME

const std::string ccf::common::CFG_SYS_NAME = "sys.name"

◆ CFG_SYS_PUB_SUB_ENDPOINT

const std::string ccf::common::CFG_SYS_PUB_SUB_ENDPOINT = "sys.pub_sub.endpoint"

◆ CFG_SYS_REQ_ENDPOINT

const std::string ccf::common::CFG_SYS_REQ_ENDPOINT = "sys.req.endpoint"

◆ CFG_SYS_REQ_HIST_EXP

const std::string ccf::common::CFG_SYS_REQ_HIST_EXP = "sys.req.hist.expiration"

◆ CFG_SYS_REQ_HIST_SIZE

const std::string ccf::common::CFG_SYS_REQ_HIST_SIZE = "sys.req.hist.size"

◆ CFG_SYS_SIMULATION

const std::string ccf::common::CFG_SYS_SIMULATION = "sys.simulation"

◆ CFG_SYS_SM_SCXML

const std::string ccf::common::CFG_SYS_SM_SCXML = "sys.sm.scxml"

◆ DB_NODE_ADAPTER

const std::string ccf::common::DB_NODE_ADAPTER = "adapter"

◆ DB_NODE_PUB_FILES_STORED

const std::string ccf::common::DB_NODE_PUB_FILES_STORED = "files_stored"

◆ DB_NODE_PUB_FRAMES_HANDLED

const std::string ccf::common::DB_NODE_PUB_FRAMES_HANDLED = "frames_handled"

◆ DB_NODE_PUB_ID

const std::string ccf::common::DB_NODE_PUB_ID = "id"

◆ DB_NODE_PUB_NAME

const std::string ccf::common::DB_NODE_PUB_NAME = "name"

◆ DB_NODE_PUB_NB_OF_FILES_STORED

const std::string ccf::common::DB_NODE_PUB_NB_OF_FILES_STORED = "nb_of_files_stored"

◆ DB_NODE_PUB_START

const std::string ccf::common::DB_NODE_PUB_START = "start"

◆ DB_NODE_PUB_STATUS

const std::string ccf::common::DB_NODE_PUB_STATUS = "status"

◆ DB_NODE_PUB_VOLUME_HANDLED

const std::string ccf::common::DB_NODE_PUB_VOLUME_HANDLED = "volume_handled"

◆ DB_NODE_SM_STATE

const std::string ccf::common::DB_NODE_SM_STATE = "sm.state"

◆ DB_NODE_SM_STATUS_STATE

const std::string ccf::common::DB_NODE_SM_STATUS_STATE = "sm.status.state"

◆ DB_NODE_SM_STATUS_SUBSTATE

const std::string ccf::common::DB_NODE_SM_STATUS_SUBSTATE = "sm.status.substate"

◆ EXPO_MODE_CONTINUOUS

const std::string ccf::common::EXPO_MODE_CONTINUOUS = "Continuous"

◆ EXPO_MODE_FINITE

const std::string ccf::common::EXPO_MODE_FINITE = "Finite"

◆ EXPO_MODE_INACTIVE

const std::string ccf::common::EXPO_MODE_INACTIVE = "Inactive"

◆ FAILURE

const std::string ccf::common::FAILURE = "Failure"

◆ IFW_VERSION

const std::string ccf::common::IFW_VERSION = "3.0"

Version of IFW.

◆ META_KEY_CAM_CHIPMODEL

const std::string ccf::common::META_KEY_CAM_CHIPMODEL = "MetaCamChipModel"

◆ META_KEY_CAM_ID

const std::string ccf::common::META_KEY_CAM_ID = "MetaCamId"

◆ META_KEY_CAM_MODEL

const std::string ccf::common::META_KEY_CAM_MODEL = "MetaCamModel"

◆ META_KEY_CAM_NAME

const std::string ccf::common::META_KEY_CAM_NAME = "MetaCamName"

◆ META_KEY_CAM_TYPE

const std::string ccf::common::META_KEY_CAM_TYPE = "MetaCamType"

◆ META_KEY_EXPO_RATE

const std::string ccf::common::META_KEY_EXPO_RATE = "MetaExpoType"

◆ META_KEY_EXPO_TIME

const std::string ccf::common::META_KEY_EXPO_TIME = "MetaExpoTime"

◆ META_KEY_EXPO_WIN_BINX

const std::string ccf::common::META_KEY_EXPO_WIN_BINX = "MetaExpoWinBinX"

◆ META_KEY_EXPO_WIN_BINY

const std::string ccf::common::META_KEY_EXPO_WIN_BINY = "MetaExpoWinBinY"

◆ META_KEY_EXPO_WIN_STARTX

const std::string ccf::common::META_KEY_EXPO_WIN_STARTX = "MetaExpoWinStartX"

◆ META_KEY_EXPO_WIN_STARTY

const std::string ccf::common::META_KEY_EXPO_WIN_STARTY = "MetaExpoWinStartY"

◆ META_KEY_SYSTEM

const std::string ccf::common::META_KEY_SYSTEM = "MetaSystem"

◆ PROP_KEY_FRAME_RATE_LIMIT

const std::string ccf::common::PROP_KEY_FRAME_RATE_LIMIT = "expo.frame.rate.limit"

◆ PUB_STAT_NAME_ABORTED

const std::string ccf::common::PUB_STAT_NAME_ABORTED = "Aborted"

◆ PUB_STAT_NAME_ACTIVE

const std::string ccf::common::PUB_STAT_NAME_ACTIVE = "Active"

◆ PUB_STAT_NAME_COMPLETED

const std::string ccf::common::PUB_STAT_NAME_COMPLETED = "Completed"

◆ PUB_STAT_NAME_FAILED

const std::string ccf::common::PUB_STAT_NAME_FAILED = "Failed"

◆ PUB_STAT_NAME_STOPPED

const std::string ccf::common::PUB_STAT_NAME_STOPPED = "Stopped"

◆ PUB_STAT_NAME_UNDEFINED

const std::string ccf::common::PUB_STAT_NAME_UNDEFINED = "Undefined"

◆ REC_ID_PREFIX

const std::string ccf::common::REC_ID_PREFIX = "RecId"

◆ SETUP_KEY_EXPO_BIN_X

const std::string ccf::common::SETUP_KEY_EXPO_BIN_X = "expo.bin_x"

◆ SETUP_KEY_EXPO_BIN_Y

const std::string ccf::common::SETUP_KEY_EXPO_BIN_Y = "expo.bin_y"

◆ SETUP_KEY_EXPO_FRAME_RATE

const std::string ccf::common::SETUP_KEY_EXPO_FRAME_RATE = "expo.frame.rate"

◆ SETUP_KEY_EXPO_FRAME_RATE_LIMIT

const std::string ccf::common::SETUP_KEY_EXPO_FRAME_RATE_LIMIT = "expo.frame.rate.limit"

◆ SETUP_KEY_EXPO_MODE

const std::string ccf::common::SETUP_KEY_EXPO_MODE = "expo.mode"

◆ SETUP_KEY_EXPO_NB

const std::string ccf::common::SETUP_KEY_EXPO_NB = "expo.nb"

◆ SETUP_KEY_EXPO_TIME

const std::string ccf::common::SETUP_KEY_EXPO_TIME = "expo.time"

◆ SETUP_KEY_EXPO_WIN_HEIGHT

const std::string ccf::common::SETUP_KEY_EXPO_WIN_HEIGHT = "expo.win.height"

◆ SETUP_KEY_EXPO_WIN_START_X

const std::string ccf::common::SETUP_KEY_EXPO_WIN_START_X = "expo.win.start_x"

◆ SETUP_KEY_EXPO_WIN_START_Y

const std::string ccf::common::SETUP_KEY_EXPO_WIN_START_Y = "expo.win.start_y"

◆ SETUP_KEY_EXPO_WIN_WIDTH

const std::string ccf::common::SETUP_KEY_EXPO_WIN_WIDTH = "expo.win.width"

◆ SETUP_KEY_PROC_ENABLED

const std::string ccf::common::SETUP_KEY_PROC_ENABLED = "proc%d.enabled"

◆ SETUP_KEY_PUB_BASE_DELAY

const std::string ccf::common::SETUP_KEY_PUB_BASE_DELAY = "proc%d.pub%d.pub_base.delay"

◆ SETUP_KEY_PUB_ENABLED

const std::string ccf::common::SETUP_KEY_PUB_ENABLED = "proc%d.pub%d.enabled"

◆ SETUP_KEY_RECIPE_BASE_DELAY

const std::string ccf::common::SETUP_KEY_RECIPE_BASE_DELAY = "proc%d.recipe%d.recipe_base.delay"

◆ SETUP_KEY_RECIPE_ENABLED

const std::string ccf::common::SETUP_KEY_RECIPE_ENABLED = "proc%d.recipe%d.enabled"

◆ SETUP_KEY_SIM_FILE

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

◆ SETUP_KEY_SIM_MAX_SHIFT

const std::string ccf::common::SETUP_KEY_SIM_MAX_SHIFT = "sim.max_shift"

◆ SETUP_KEY_SIM_MAX_SHIFT_PR_FRAME

const std::string ccf::common::SETUP_KEY_SIM_MAX_SHIFT_PR_FRAME = "sim.max_shift_pr_frame"

◆ SETUP_KEY_SIM_NOISE

const std::string ccf::common::SETUP_KEY_SIM_NOISE = "sim.noise"

◆ SETUP_KEY_SIM_TYPE

const std::string ccf::common::SETUP_KEY_SIM_TYPE = "sim.type"

◆ SIM_TYPE_FILE_STR

const std::string ccf::common::SIM_TYPE_FILE_STR = "File"

◆ SIM_TYPE_PATTERN1_STR

const std::string ccf::common::SIM_TYPE_PATTERN1_STR = "Pattern1"

◆ STATE_ON_NOT_OP_NOT_READY

const std::string ccf::common::STATE_ON_NOT_OP_NOT_READY = "On::NotOperational::NotReady"

◆ STATE_ON_NOT_OP_READY

const std::string ccf::common::STATE_ON_NOT_OP_READY = "On::NotOperational::Ready"

◆ STATE_ON_OP_ACQ

const std::string ccf::common::STATE_ON_OP_ACQ = "On::Operational::Acquisition"

◆ STATE_ON_OP_ACQ_NOT_REC

const std::string ccf::common::STATE_ON_OP_ACQ_NOT_REC = "On::Operational::Acquisition::NotRecording"

◆ STATE_ON_OP_ACQ_REC

const std::string ccf::common::STATE_ON_OP_ACQ_REC = "On::Operational::Acquisition::Recording"

◆ STATE_ON_OP_IDLE

const std::string ccf::common::STATE_ON_OP_IDLE = "On::Operational::Idle"

◆ SUCCESS

const std::string ccf::common::SUCCESS = "Success"

Namespaces

Classes

Functions

Variables

States (composite).

Execution status.

Exposure modes.

Publisher Status names.

Cfg par to allow silent frame skipping, i.e. no error reported, but frames skipped registered in statistics.

Processing Recipe related standard setup parameter names.

Detailed Description

Enumeration Type Documentation

◆ ExpoMode

◆ HwStatus

◆ ImageDataType

◆ LogLevel

◆ ProcStatus

◆ PubStatus

◆ PubType

◆ SimType

◆ Status

Function Documentation

◆ _CheckIfReqSupported()

◆ AddFileStored()

◆ AssertPtr()

◆ ConvertImage()

◆ CopyRecStatusObj()

◆ DecomposeSmStatus()

◆ ExpoModeToNb()

◆ GetCfg()

◆ GetDb()

◆ GetHostAddress()

◆ GetHostAddress_()

◆ GetImageDir()

◆ GetSetup()

◆ LogLevelStrToNb()

◆ PackParameters()

◆ PrepCplImage()

◆ PubStatusNameToStr()

◆ ReceiveThrMsg()

◆ RecStatusNameToStr()

◆ ResetRecStatusObj()

◆ SendThrMsg()

◆ StatusToStr()

◆ UnpackParameters()

Variable Documentation

◆ CCF_VERSION

◆ CFG_ACQ_FRAME_SKIPPING

◆ CFG_ACQ_LOST_FRAMES

◆ CFG_ACQ_PRIORITY

◆ CFG_CAM_ADAPTER_ADDRESS

◆ CFG_CAM_ADAPTER_API

◆ CFG_CAM_ADAPTER_MAPPING

◆ CFG_CAM_ADAPTER_PROPERTY

◆ CFG_CAM_ADAPTER_PROTOCOL

◆ CFG_CAM_ADAPTER_SIM_ADDRESS

◆ CFG_CAM_CHIP_HEIGHT

◆ CFG_CAM_CHIP_MAX_RES

◆ CFG_CAM_CHIP_MODEL

◆ CFG_CAM_CHIP_RESOLUTION

◆ CFG_CAM_CHIP_WIDTH

◆ CFG_CAM_ID

◆ CFG_CAM_MANUFACTURER

◆ CFG_CAM_MODEL

◆ CFG_CAM_NAME

◆ CFG_CAM_TYPE

◆ CFG_DEF_LOGLEVEL

◆ CFG_KEY_SYS_IMAGE_DIR

◆ CFG_MON_NB_OF_SAMPLES

◆ CFG_MON_PERIOD

◆ CFG_PRIM_DID

◆ CFG_PROC_PRIORITY

◆ CFG_PROC_SKIP_FRAMES

◆ CFG_PUB_PRIORITY

◆ CFG_SYS_DB_ENDPOINT

◆ CFG_SYS_DB_PREFIX

◆ CFG_SYS_DB_TIMEOUT_SEC

◆ CFG_SYS_DID

◆ CFG_SYS_LOG_LEVEL

◆ CFG_SYS_LOG_PROPERTIES