Namespaces
	common

	control

	loglevel

	mptk

	protocols

	stdpub
	MudpiCreator source file.

	stdrecipe

	tools

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

Typedefs
using	TypeNumMap = boost::bimap< std::string, DataTypes >

Enumerations
enum	LogLevel { LogLevel::OFF = 0, LogLevel::FATAL = 100, LogLevel::ERROR = 200, LogLevel::WARN = 300, LogLevel::INFO = 400, LogLevel::DEBUG = 500, LogLevel::DEBUG2 = 501, LogLevel::DEBUG3 = 502, LogLevel::TRACE = 600, LogLevel::NOT_SET = -1 }
	Log levels defined for CCF; adds two debugging levels: DEBUG2, DEBUG3. More...

enum	DataTypes : int { DataTypes::ARRAY = 1 << 0, DataTypes::INVALID = 1 << 4, DataTypes::CHAR = 1 << 5, DataTypes::BYTE = 1 << 6, DataTypes::BOOL = 1 << 7, DataTypes::INT16 = 1 << 8, DataTypes::UINT16 = 1 << 9, DataTypes::INT32 = 1 << 10, DataTypes::UINT32 = 1 << 11, DataTypes::INT64 = 1 << 12, DataTypes::UINT64 = 1 << 13, DataTypes::FLOAT = 1 << 16, DataTypes::DOUBLE = 1 << 17, DataTypes::COMPLEX = 1 << 19, DataTypes::STRING = CHAR \| ARRAY, DataTypes::FLOAT_COMPLEX = FLOAT \| COMPLEX, DataTypes::DOUBLE_COMPLEX = DOUBLE \| COMPLEX, DataTypes::BITMASK = 1 << 21, DataTypes::UNSPECIFIED = 1 << 20 }

Functions
log4cplus::Logger &	Logger ()

std::optional< DataTypes >	GetDataType (const std::string &data_type, bool permissive=true)
	Get data type as an optional enumeration. More...

std::optional< std::string >	GetDataTypeStr (const DataTypes data_type)
	Get data type as an optional string. More...

int	GetSizeInBytes (const DataTypes data_type)
	Get the number of bytes used by the given type. More...

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

Variables
DB state nodes names.
const std::string	DB_DELIM = std::string(utils::bat::CONFIG_DB_DELIMITER)

const std::string	DB_NODE_SM_STATUS_STATE

const std::string	DB_NODE_SM_STATUS_SUBSTATE

const std::string	DB_NODE_SM_STATE

Standard metadata keywords.
constexpr auto	META_KEY_EXPO_RATE = "MetaExpoType"

constexpr auto	META_KEY_EXPO_TIME = "MetaExpoTime"

constexpr auto	META_KEY_EXPO_WIN_BINX = "MetaExpoWinBinX"

constexpr auto	META_KEY_EXPO_WIN_BINY = "MetaExpoWinBinY"

constexpr auto	META_KEY_EXPO_WIN_STARTX = "MetaExpoWinStartX"

constexpr auto	META_KEY_EXPO_WIN_STARTY = "MetaExpoWinStartY"

constexpr auto	META_KEY_SYSTEM = "MetaSystem"

constexpr auto	META_KEY_CAM_NAME = "MetaCamName"

constexpr auto	META_KEY_CAM_ID = "MetaCamId"

constexpr auto	META_KEY_CAM_MODEL = "MetaCamModel"

constexpr auto	META_KEY_CAM_CHIPMODEL = "MetaCamChipModel"

constexpr auto	META_KEY_CAM_TYPE = "MetaCamType"

Configuration parameter names.
constexpr auto	CFG_NODE_ACQUISITION = "acquisition"

constexpr auto	CFG_NODE_MONITORING = "monitoring"

constexpr auto	CFG_NODE_PROCESSING = "processing"

constexpr auto	CFG_NODE_RECORDING = "recording"

constexpr auto	CFG_NODE_SERVER = "server"

constexpr auto	CFG_NODE_TASKS = "tasks"

constexpr auto	CFG_KEY_ADAPTER = "adapter"

constexpr auto	CFG_KEY_ADDRESS = "address"

constexpr auto	CFG_KEY_ALLOW_FRAME_SKIPPING = "allow_frame_skipping"

constexpr auto	CFG_KEY_ALLOW_LOST_FRAMES = "allow_lost_frames"

constexpr auto	CFG_KEY_DEVICES = "devices"

constexpr auto	CFG_KEY_HEIGHT = "height"

constexpr auto	CFG_KEY_ID = "id"

constexpr auto	CFG_KEY_IMAGE_DIR = "image_dir"

constexpr auto	CFG_KEY_INIT_SETUP = "init_setup"

constexpr auto	CFG_KEY_INPUT_QUEUE_SIZE = "input_queue_size"

constexpr auto	CFG_KEY_MANUFACTURER = "manufacturer"

constexpr auto	CFG_KEY_MAPPING = "mapping"

constexpr auto	CFG_KEY_MAX_RATE = "max_rate"

constexpr auto	CFG_KEY_MAX_RESOLUTION = "max_resolution"

constexpr auto	CFG_KEY_METADATA_MAP = "metadata_map"

constexpr auto	CFG_KEY_MODEL = "model"

constexpr auto	CFG_KEY_NAME = "name"

constexpr auto	CFG_KEY_NAMES = "names"

constexpr auto	CFG_KEY_NB_OF_SAMPLES = "nb_of_samples"

constexpr auto	CFG_KEY_OUPUT_QUEUE_SIZE = "output_queue_size"

constexpr auto	CFG_KEY_PERIOD = "period"

constexpr auto	CFG_KEY_PIPELINE = "pipeline"

constexpr auto	CFG_KEY_PROPERTIES = "properties"

constexpr auto	CFG_KEY_PROTOCOL = "protocol"

constexpr auto	CFG_KEY_PUBLISHERS = "publishers"

constexpr auto	CFG_KEY_RECIPES = "recipes"

constexpr auto	CFG_KEY_REC_HIST_EXP = "rec_hist_expiration"

constexpr auto	CFG_KEY_REC_HIST_SIZE = "rec_hist_size"

constexpr auto	CFG_KEY_RESOLUTION = "resolution"

constexpr auto	CFG_KEY_SDK = "sdk"

constexpr auto	CFG_KEY_SIMULATION = "simulation"

constexpr auto	CFG_KEY_SIM_ADDRESS = "sim_address"

constexpr auto	CFG_KEY_TYPE = "type"

constexpr auto	CFG_KEY_VALUE = "value"

constexpr auto	CFG_KEY_WIDTH = "width"

Setup parameter names.
constexpr auto	SETUP_NODE_EXPO = "expo"

constexpr auto	SETUP_NODE_SIM = "sim"

constexpr auto	SETUP_KEY_ADDRESS = "address"

constexpr auto	SETUP_KEY_BASENAME = "basename"

constexpr auto	SETUP_KEY_BIN_X = "bin_x"

constexpr auto	SETUP_KEY_BIN_Y = "bin_y"

constexpr auto	SETUP_KEY_DELAY = "delay"

constexpr auto	SETUP_KEY_ENABLED = "enabled"

constexpr auto	SETUP_KEY_FILE = "file"

constexpr auto	SETUP_KEY_FORMAT = "format"

constexpr auto	SETUP_KEY_FRAME_RATE = "frame_rate"

constexpr auto	SETUP_KEY_FRAME_RATE_LIMIT = "frame_rate_limit"

constexpr auto	SETUP_KEY_MAX_RATE = "max_rate"

constexpr auto	SETUP_KEY_MAX_SHIFT = "max_shift"

constexpr auto	SETUP_KEY_MAX_SHIFT_PR_FRAME = "max_shift_pr_frame"

constexpr auto	SETUP_KEY_MAX_SIZE = "max_size"

constexpr auto	SETUP_KEY_MODE = "mode"

constexpr auto	SETUP_KEY_NB = "nb"

constexpr auto	SETUP_KEY_RATE = "rate"

constexpr auto	SETUP_KEY_NOISE = "noise"

constexpr auto	SETUP_KEY_PORT = "port"

constexpr auto	SETUP_KEY_TIME = "time"

constexpr auto	SETUP_KEY_TYPE = "type"

constexpr auto	SETUP_KEY_WIN_START_X = "win_start_x"

constexpr auto	SETUP_KEY_WIN_START_Y = "win_start_y"

constexpr auto	SETUP_KEY_WIN_WIDTH = "win_width"

constexpr auto	SETUP_KEY_WIN_HEIGHT = "win_height"

Simulation type.
constexpr auto	SIM_TYPE_FILE_STR = "File"

constexpr auto	SIM_TYPE_PATTERN1_STR = "Pattern1"

Logging levels literal names.
constexpr auto	CCF_VERSION = "1.2.0"
	Version of CCF. More...

constexpr auto	IFW_VERSION = "4.0"
	Version of IFW. More...

constexpr auto	NO_VALUE = "__NO__VALUE__"

LogLevel	LogLevelToNb (const std::string &log_level)

std::string	LogLevelToString (const LogLevel log_level)

States (composite).
enum	ThreadType { ThreadType::MONITOR = 1, ThreadType::ACQUISITION, ThreadType::PROCESSING, ThreadType::PUBLISHER, ThreadType::UNDEFINED = -1 }

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

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

constexpr auto	STATE_ON_NOT_OP_NOT_READY = "On::NotOperational::NotReady"

constexpr auto	STATE_ON_NOT_OP_READY = "On::NotOperational::Ready"

constexpr auto	STATE_ON_OP_IDLE = "On::Operational::Idle"

constexpr auto	STATE_ON_OP_ACQ = "On::Operational::Acquisition"

constexpr auto	STATE_ON_OP_ACQ_NOT_REC = "On::Operational::Acquisition::NotRecording"

constexpr auto	STATE_ON_OP_ACQ_REC = "On::Operational::Acquisition::Recording"

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 nullptr 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	Bitpix { Bitpix::UNKNOWN = -1, Bitpix::BYTE = 8, Bitpix::PRESCALED = -8, Bitpix::INT16 = 16, Bitpix::UINT16 = -16, Bitpix::INT32 = 32, Bitpix::FLOAT = -32, Bitpix::INT64 = 64, Bitpix::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...

constexpr auto	SUCCESS = "Success"

constexpr auto	FAILURE = "Failure"

std::string	StatusToStr (ccf::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...

DataTypes	BitpixToDataType (const Bitpix bitpix)
	Converts the FITS BITPIX value into a data type. More...

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

constexpr auto	EXPO_MODE_FINITE = "Finite"

constexpr auto	EXPO_MODE_CONTINUOUS = "Continuous"

constexpr auto	EXPO_MODE_INACTIVE = "Inactive"

constexpr auto	REC_ID_PREFIX = "RecId"

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

Publisher Status names.
constexpr auto	PUB_STAT_NAME_ACTIVE = "Active"

constexpr auto	PUB_STAT_NAME_COMPLETED = "Completed"

constexpr auto	PUB_STAT_NAME_STOPPED = "Stopped"

constexpr auto	PUB_STAT_NAME_ABORTED = "Aborted"

constexpr auto	PUB_STAT_NAME_FAILED = "Failed"

constexpr auto	PUB_STAT_NAME_UNDEFINED = "Undefined"

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

std::string	BuildKey (const std::vector< std::string > &elements)
	Build a concatenated key from a number of elements (<el1>.<el2.>...). More...

std::vector< std::string >	SplitKey (const std::string &key)
	Split up a concatenated key. More...

Detailed Description

Copyright: ESO - European Southern Observatory

Typedef Documentation

◆ TypeNumMap

using ccf::TypeNumMap = typedef boost::bimap<std::string, DataTypes>

Enumeration Type Documentation

◆ Bitpix

enum ccf::Bitpix

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

◆ DataTypes

enum ccf::DataTypes : int

strong

Enumerator
ARRAY
INVALID
CHAR
BYTE
BOOL
INT16
UINT16
INT32
UINT32
INT64
UINT64
FLOAT
DOUBLE
COMPLEX
STRING
FLOAT_COMPLEX
DOUBLE_COMPLEX
BITMASK
UNSPECIFIED

◆ ExpoMode

enum ccf::ExpoMode

strong

Exposure modes.

Enumerator
FINITE
CONTINUOUS
INACTIVE

◆ HwStatus

enum ccf::HwStatus

strong

HW status values.

Enumerator
NOT_OK
OK

◆ LogLevel

enum ccf::LogLevel

strong

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

Enumerator
OFF
FATAL
ERROR
WARN
INFO
DEBUG
DEBUG2
DEBUG3
TRACE
NOT_SET

◆ ProcStatus

enum ccf::ProcStatus

strong

Possible states for a Processing Recipe defined.

Enumerator
UNDEFINED
IDLE
PROCESSING
FINISHED
FAILED

◆ PubStatus

enum ccf::PubStatus

strong

Defines the various possible states of a Data Publisher.

Enumerator
ACTIVE
COMPLETED
STOPPED
ABORTED
FAILED
UNDEFINED

◆ PubType

enum ccf::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::SimType

strong

Simulation type.

Enumerator
FILE
PATTERN1

◆ Status

enum ccf::Status

strong

General status variable.

Enumerator
FAILURE
SUCCESS

◆ ThreadType

enum ccf::ThreadType

strong

Enumerator
MONITOR
ACQUISITION
PROCESSING
PUBLISHER
UNDEFINED

Function Documentation

◆ AssertPtr()

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

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

◆ BitpixToDataType()

DataTypes ccf::BitpixToDataType ( const Bitpix bitpix )

inline

Converts the FITS BITPIX value into a data type.

◆ BuildKey()

std::string ccf::BuildKey ( const std::vector< std::string > & elements )

Build a concatenated key from a number of elements (<el1>.<el2.>...).

◆ CopyRecStatusObj()

void ccf::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::DecomposeSmStatus	(	const std::string &	sm_state,
		std::string &	sum_state,
		std::string &	sum_substate
	)

◆ ExpoModeToNb()

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

Convert exposure mode from number representation to string.

◆ GetDataType()

std::optional<DataTypes> ccf::GetDataType	(	const std::string &	data_type,
		bool	permissive = `true`
	)

inline

Get data type as an optional enumeration.

Parameters

data_type string representation of the data type.

◆ GetDataTypeStr()

std::optional<std::string> ccf::GetDataTypeStr ( const DataTypes data_type )

inline

Get data type as an optional string.

Parameters

data_type enumeration of the data type.

◆ GetDb()

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

inline

Return the reference to the CCF DB Singleton instance.

◆ GetSizeInBytes()

int ccf::GetSizeInBytes ( const DataTypes data_type )

inline

Get the number of bytes used by the given type.

Parameters

data_type image data type.

◆ Logger()

log4cplus::Logger & ccf::Logger ( )

◆ LogLevelToNb()

LogLevel ccf::LogLevelToNb ( const std::string & log_level )

inline

◆ LogLevelToString()

std::string ccf::LogLevelToString ( const LogLevel log_level )

inline

◆ PubStatusNameToStr()

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

Publisher status, number representation to string.

◆ ReceiveThrMsg()

bool ccf::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::RecStatusNameToStr ( recif::RecStatusNames rec_status_nb )

Recording Status name, number to string representation.

◆ ResetRecStatusObj()

void ccf::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::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.

◆ SplitKey()

std::vector< std::string > ccf::SplitKey ( const std::string & key )

Split up a concatenated key.

◆ StatusToStr()

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

Convert the status from number to string.

Variable Documentation

◆ CCF_VERSION

constexpr auto ccf::CCF_VERSION = "1.2.0"

constexpr

Version of CCF.

◆ CFG_KEY_ADAPTER

constexpr auto ccf::CFG_KEY_ADAPTER = "adapter"

constexpr

◆ CFG_KEY_ADDRESS

constexpr auto ccf::CFG_KEY_ADDRESS = "address"

constexpr

◆ CFG_KEY_ALLOW_FRAME_SKIPPING

constexpr auto ccf::CFG_KEY_ALLOW_FRAME_SKIPPING = "allow_frame_skipping"

constexpr

◆ CFG_KEY_ALLOW_LOST_FRAMES

constexpr auto ccf::CFG_KEY_ALLOW_LOST_FRAMES = "allow_lost_frames"

constexpr

◆ CFG_KEY_DEVICES

constexpr auto ccf::CFG_KEY_DEVICES = "devices"

constexpr

◆ CFG_KEY_HEIGHT

constexpr auto ccf::CFG_KEY_HEIGHT = "height"

constexpr

◆ CFG_KEY_ID

constexpr auto ccf::CFG_KEY_ID = "id"

constexpr

◆ CFG_KEY_IMAGE_DIR

constexpr auto ccf::CFG_KEY_IMAGE_DIR = "image_dir"

constexpr

◆ CFG_KEY_INIT_SETUP

constexpr auto ccf::CFG_KEY_INIT_SETUP = "init_setup"

constexpr

◆ CFG_KEY_INPUT_QUEUE_SIZE

constexpr auto ccf::CFG_KEY_INPUT_QUEUE_SIZE = "input_queue_size"

constexpr

◆ CFG_KEY_MANUFACTURER

constexpr auto ccf::CFG_KEY_MANUFACTURER = "manufacturer"

constexpr

◆ CFG_KEY_MAPPING

constexpr auto ccf::CFG_KEY_MAPPING = "mapping"

constexpr

◆ CFG_KEY_MAX_RATE

constexpr auto ccf::CFG_KEY_MAX_RATE = "max_rate"

constexpr

◆ CFG_KEY_MAX_RESOLUTION

constexpr auto ccf::CFG_KEY_MAX_RESOLUTION = "max_resolution"

constexpr

◆ CFG_KEY_METADATA_MAP

constexpr auto ccf::CFG_KEY_METADATA_MAP = "metadata_map"

constexpr

◆ CFG_KEY_MODEL

constexpr auto ccf::CFG_KEY_MODEL = "model"

constexpr

◆ CFG_KEY_NAME

constexpr auto ccf::CFG_KEY_NAME = "name"

constexpr

◆ CFG_KEY_NAMES

constexpr auto ccf::CFG_KEY_NAMES = "names"

constexpr

◆ CFG_KEY_NB_OF_SAMPLES

constexpr auto ccf::CFG_KEY_NB_OF_SAMPLES = "nb_of_samples"

constexpr

◆ CFG_KEY_OUPUT_QUEUE_SIZE

constexpr auto ccf::CFG_KEY_OUPUT_QUEUE_SIZE = "output_queue_size"

constexpr

◆ CFG_KEY_PERIOD

constexpr auto ccf::CFG_KEY_PERIOD = "period"

constexpr

◆ CFG_KEY_PIPELINE

constexpr auto ccf::CFG_KEY_PIPELINE = "pipeline"

constexpr

◆ CFG_KEY_PROPERTIES

constexpr auto ccf::CFG_KEY_PROPERTIES = "properties"

constexpr

◆ CFG_KEY_PROTOCOL

constexpr auto ccf::CFG_KEY_PROTOCOL = "protocol"

constexpr

◆ CFG_KEY_PUBLISHERS

constexpr auto ccf::CFG_KEY_PUBLISHERS = "publishers"

constexpr

◆ CFG_KEY_REC_HIST_EXP

constexpr auto ccf::CFG_KEY_REC_HIST_EXP = "rec_hist_expiration"

constexpr

◆ CFG_KEY_REC_HIST_SIZE

constexpr auto ccf::CFG_KEY_REC_HIST_SIZE = "rec_hist_size"

constexpr

◆ CFG_KEY_RECIPES

constexpr auto ccf::CFG_KEY_RECIPES = "recipes"

constexpr

◆ CFG_KEY_RESOLUTION

constexpr auto ccf::CFG_KEY_RESOLUTION = "resolution"

constexpr

◆ CFG_KEY_SDK

constexpr auto ccf::CFG_KEY_SDK = "sdk"

constexpr

◆ CFG_KEY_SIM_ADDRESS

constexpr auto ccf::CFG_KEY_SIM_ADDRESS = "sim_address"

constexpr

◆ CFG_KEY_SIMULATION

constexpr auto ccf::CFG_KEY_SIMULATION = "simulation"

constexpr

◆ CFG_KEY_TYPE

constexpr auto ccf::CFG_KEY_TYPE = "type"

constexpr

◆ CFG_KEY_VALUE

constexpr auto ccf::CFG_KEY_VALUE = "value"

constexpr

◆ CFG_KEY_WIDTH

constexpr auto ccf::CFG_KEY_WIDTH = "width"

constexpr

◆ CFG_NODE_ACQUISITION

constexpr auto ccf::CFG_NODE_ACQUISITION = "acquisition"

constexpr

◆ CFG_NODE_MONITORING

constexpr auto ccf::CFG_NODE_MONITORING = "monitoring"

constexpr

◆ CFG_NODE_PROCESSING

constexpr auto ccf::CFG_NODE_PROCESSING = "processing"

constexpr

◆ CFG_NODE_RECORDING

constexpr auto ccf::CFG_NODE_RECORDING = "recording"

constexpr

◆ CFG_NODE_SERVER

constexpr auto ccf::CFG_NODE_SERVER = "server"

constexpr

◆ CFG_NODE_TASKS

constexpr auto ccf::CFG_NODE_TASKS = "tasks"

constexpr

◆ DB_DELIM

const std::string ccf::DB_DELIM = std::string(utils::bat::CONFIG_DB_DELIMITER)

◆ DB_NODE_SM_STATE

const std::string ccf::DB_NODE_SM_STATE

Initial value:

=

("sm" + DB_DELIM + "state")

◆ DB_NODE_SM_STATUS_STATE

const std::string ccf::DB_NODE_SM_STATUS_STATE

Initial value:

=

("sm" + DB_DELIM + "status" + DB_DELIM + "state")

◆ DB_NODE_SM_STATUS_SUBSTATE

const std::string ccf::DB_NODE_SM_STATUS_SUBSTATE

Initial value:

=

("sm" + DB_DELIM + "status" + DB_DELIM + "substate")

◆ EXPO_MODE_CONTINUOUS

constexpr auto ccf::EXPO_MODE_CONTINUOUS = "Continuous"

constexpr

◆ EXPO_MODE_FINITE

constexpr auto ccf::EXPO_MODE_FINITE = "Finite"

constexpr

◆ EXPO_MODE_INACTIVE

constexpr auto ccf::EXPO_MODE_INACTIVE = "Inactive"

constexpr

◆ FAILURE

constexpr auto ccf::FAILURE = "Failure"

constexpr

◆ IFW_VERSION

constexpr auto ccf::IFW_VERSION = "4.0"

constexpr

Version of IFW.

◆ META_KEY_CAM_CHIPMODEL

constexpr auto ccf::META_KEY_CAM_CHIPMODEL = "MetaCamChipModel"

constexpr

◆ META_KEY_CAM_ID

constexpr auto ccf::META_KEY_CAM_ID = "MetaCamId"

constexpr

◆ META_KEY_CAM_MODEL

constexpr auto ccf::META_KEY_CAM_MODEL = "MetaCamModel"

constexpr

◆ META_KEY_CAM_NAME

constexpr auto ccf::META_KEY_CAM_NAME = "MetaCamName"

constexpr

◆ META_KEY_CAM_TYPE

constexpr auto ccf::META_KEY_CAM_TYPE = "MetaCamType"

constexpr

◆ META_KEY_EXPO_RATE

constexpr auto ccf::META_KEY_EXPO_RATE = "MetaExpoType"

constexpr

◆ META_KEY_EXPO_TIME

constexpr auto ccf::META_KEY_EXPO_TIME = "MetaExpoTime"

constexpr

◆ META_KEY_EXPO_WIN_BINX

constexpr auto ccf::META_KEY_EXPO_WIN_BINX = "MetaExpoWinBinX"

constexpr

◆ META_KEY_EXPO_WIN_BINY

constexpr auto ccf::META_KEY_EXPO_WIN_BINY = "MetaExpoWinBinY"

constexpr

◆ META_KEY_EXPO_WIN_STARTX

constexpr auto ccf::META_KEY_EXPO_WIN_STARTX = "MetaExpoWinStartX"

constexpr

◆ META_KEY_EXPO_WIN_STARTY

constexpr auto ccf::META_KEY_EXPO_WIN_STARTY = "MetaExpoWinStartY"

constexpr

◆ META_KEY_SYSTEM

constexpr auto ccf::META_KEY_SYSTEM = "MetaSystem"

constexpr

◆ NO_VALUE

constexpr auto ccf::NO_VALUE = "__NO__VALUE__"

constexpr

◆ PUB_STAT_NAME_ABORTED

constexpr auto ccf::PUB_STAT_NAME_ABORTED = "Aborted"

constexpr

◆ PUB_STAT_NAME_ACTIVE

constexpr auto ccf::PUB_STAT_NAME_ACTIVE = "Active"

constexpr

◆ PUB_STAT_NAME_COMPLETED

constexpr auto ccf::PUB_STAT_NAME_COMPLETED = "Completed"

constexpr

◆ PUB_STAT_NAME_FAILED

constexpr auto ccf::PUB_STAT_NAME_FAILED = "Failed"

constexpr

◆ PUB_STAT_NAME_STOPPED

constexpr auto ccf::PUB_STAT_NAME_STOPPED = "Stopped"

constexpr

◆ PUB_STAT_NAME_UNDEFINED

constexpr auto ccf::PUB_STAT_NAME_UNDEFINED = "Undefined"

constexpr

◆ REC_ID_PREFIX

constexpr auto ccf::REC_ID_PREFIX = "RecId"

constexpr

◆ SETUP_KEY_ADDRESS

constexpr auto ccf::SETUP_KEY_ADDRESS = "address"

constexpr

◆ SETUP_KEY_BASENAME

constexpr auto ccf::SETUP_KEY_BASENAME = "basename"

constexpr

◆ SETUP_KEY_BIN_X

constexpr auto ccf::SETUP_KEY_BIN_X = "bin_x"

constexpr

◆ SETUP_KEY_BIN_Y

constexpr auto ccf::SETUP_KEY_BIN_Y = "bin_y"

constexpr

◆ SETUP_KEY_DELAY

constexpr auto ccf::SETUP_KEY_DELAY = "delay"

constexpr

◆ SETUP_KEY_ENABLED

constexpr auto ccf::SETUP_KEY_ENABLED = "enabled"

constexpr

◆ SETUP_KEY_FILE

constexpr auto ccf::SETUP_KEY_FILE = "file"

constexpr

◆ SETUP_KEY_FORMAT

constexpr auto ccf::SETUP_KEY_FORMAT = "format"

constexpr

◆ SETUP_KEY_FRAME_RATE

constexpr auto ccf::SETUP_KEY_FRAME_RATE = "frame_rate"

constexpr

◆ SETUP_KEY_FRAME_RATE_LIMIT

constexpr auto ccf::SETUP_KEY_FRAME_RATE_LIMIT = "frame_rate_limit"

constexpr

◆ SETUP_KEY_MAX_RATE

constexpr auto ccf::SETUP_KEY_MAX_RATE = "max_rate"

constexpr

◆ SETUP_KEY_MAX_SHIFT

constexpr auto ccf::SETUP_KEY_MAX_SHIFT = "max_shift"

constexpr

◆ SETUP_KEY_MAX_SHIFT_PR_FRAME

constexpr auto ccf::SETUP_KEY_MAX_SHIFT_PR_FRAME = "max_shift_pr_frame"

constexpr

◆ SETUP_KEY_MAX_SIZE

constexpr auto ccf::SETUP_KEY_MAX_SIZE = "max_size"

constexpr

◆ SETUP_KEY_MODE

constexpr auto ccf::SETUP_KEY_MODE = "mode"

constexpr

◆ SETUP_KEY_NB

constexpr auto ccf::SETUP_KEY_NB = "nb"

constexpr

◆ SETUP_KEY_NOISE

constexpr auto ccf::SETUP_KEY_NOISE = "noise"

constexpr

◆ SETUP_KEY_PORT

constexpr auto ccf::SETUP_KEY_PORT = "port"

constexpr

◆ SETUP_KEY_RATE

constexpr auto ccf::SETUP_KEY_RATE = "rate"

constexpr

◆ SETUP_KEY_TIME

constexpr auto ccf::SETUP_KEY_TIME = "time"

constexpr

◆ SETUP_KEY_TYPE

constexpr auto ccf::SETUP_KEY_TYPE = "type"

constexpr

◆ SETUP_KEY_WIN_HEIGHT

constexpr auto ccf::SETUP_KEY_WIN_HEIGHT = "win_height"

constexpr

◆ SETUP_KEY_WIN_START_X

constexpr auto ccf::SETUP_KEY_WIN_START_X = "win_start_x"

constexpr

◆ SETUP_KEY_WIN_START_Y

constexpr auto ccf::SETUP_KEY_WIN_START_Y = "win_start_y"

constexpr

◆ SETUP_KEY_WIN_WIDTH

constexpr auto ccf::SETUP_KEY_WIN_WIDTH = "win_width"

constexpr

◆ SETUP_NODE_EXPO

constexpr auto ccf::SETUP_NODE_EXPO = "expo"

constexpr

◆ SETUP_NODE_SIM

constexpr auto ccf::SETUP_NODE_SIM = "sim"

constexpr

◆ SIM_TYPE_FILE_STR

constexpr auto ccf::SIM_TYPE_FILE_STR = "File"

constexpr

◆ SIM_TYPE_PATTERN1_STR

constexpr auto ccf::SIM_TYPE_PATTERN1_STR = "Pattern1"

constexpr

◆ STATE_ON_NOT_OP_NOT_READY

constexpr auto ccf::STATE_ON_NOT_OP_NOT_READY = "On::NotOperational::NotReady"

constexpr

◆ STATE_ON_NOT_OP_READY

constexpr auto ccf::STATE_ON_NOT_OP_READY = "On::NotOperational::Ready"

constexpr

◆ STATE_ON_OP_ACQ

constexpr auto ccf::STATE_ON_OP_ACQ = "On::Operational::Acquisition"

constexpr

◆ STATE_ON_OP_ACQ_NOT_REC

constexpr auto ccf::STATE_ON_OP_ACQ_NOT_REC = "On::Operational::Acquisition::NotRecording"

constexpr

◆ STATE_ON_OP_ACQ_REC

constexpr auto ccf::STATE_ON_OP_ACQ_REC = "On::Operational::Acquisition::Recording"

constexpr

◆ STATE_ON_OP_IDLE

constexpr auto ccf::STATE_ON_OP_IDLE = "On::Operational::Idle"

constexpr

◆ SUCCESS

constexpr auto ccf::SUCCESS = "Success"

constexpr

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Logging levels literal names.

States (composite).

Execution status.

Exposure modes.

Publisher Status names.

Detailed Description

Typedef Documentation

◆ TypeNumMap

Enumeration Type Documentation

◆ Bitpix

◆ DataTypes

◆ ExpoMode

◆ HwStatus

◆ LogLevel

◆ ProcStatus

◆ PubStatus

◆ PubType

◆ SimType

◆ Status

◆ ThreadType

Function Documentation

◆ AssertPtr()

◆ BitpixToDataType()

◆ BuildKey()

◆ CopyRecStatusObj()

◆ DecomposeSmStatus()

◆ ExpoModeToNb()

◆ GetDataType()

◆ GetDataTypeStr()

◆ GetDb()

◆ GetSizeInBytes()

◆ Logger()

◆ LogLevelToNb()

◆ LogLevelToString()

◆ PubStatusNameToStr()

◆ ReceiveThrMsg()

◆ RecStatusNameToStr()

◆ ResetRecStatusObj()

◆ SendThrMsg()

◆ SplitKey()

◆ StatusToStr()

Variable Documentation

◆ CCF_VERSION

◆ CFG_KEY_ADAPTER

◆ CFG_KEY_ADDRESS

◆ CFG_KEY_ALLOW_FRAME_SKIPPING

◆ CFG_KEY_ALLOW_LOST_FRAMES

◆ CFG_KEY_DEVICES

◆ CFG_KEY_HEIGHT

◆ CFG_KEY_ID

◆ CFG_KEY_IMAGE_DIR

◆ CFG_KEY_INIT_SETUP

◆ CFG_KEY_INPUT_QUEUE_SIZE

◆ CFG_KEY_MANUFACTURER

◆ CFG_KEY_MAPPING

◆ CFG_KEY_MAX_RATE

◆ CFG_KEY_MAX_RESOLUTION

◆ CFG_KEY_METADATA_MAP

◆ CFG_KEY_MODEL

◆ CFG_KEY_NAME

◆ CFG_KEY_NAMES

◆ CFG_KEY_NB_OF_SAMPLES

◆ CFG_KEY_OUPUT_QUEUE_SIZE

◆ CFG_KEY_PERIOD

◆ CFG_KEY_PIPELINE

◆ CFG_KEY_PROPERTIES

◆ CFG_KEY_PROTOCOL

◆ CFG_KEY_PUBLISHERS

◆ CFG_KEY_REC_HIST_EXP

◆ CFG_KEY_REC_HIST_SIZE

◆ CFG_KEY_RECIPES

◆ CFG_KEY_RESOLUTION

◆ CFG_KEY_SDK

◆ CFG_KEY_SIM_ADDRESS