ifw-ccf 5.0.2
|
Namespaces | |
namespace | common |
namespace | control |
namespace | mptk |
namespace | protocols |
namespace | stdpub |
MudpiCreator public header file. This class was copied from the MELT CS repository. | |
namespace | stdrecipe |
namespace | tools |
Classes | |
class | Base |
Class to be used as parent all CCF classes. More... | |
Functions | |
void | SetApplicationLogName (const std::string &app_name) |
log4cplus::Logger & | Logger () |
log4cplus::Logger & | FastLogger () |
ifw::ccf::common::Db & | GetDb () |
Return the reference to the CCF DB Singleton instance. | |
ifw::ccf::common::Setup & | GetSetup () |
Return the reference to the CCF DB Singleton instance. | |
Variables | |
std::string | ccf_application_name |
constexpr auto | CCF_VERSION = "1.2.0" |
Version of CCF. | |
constexpr auto | IFW_VERSION = "4.0" |
Version of IFW. | |
constexpr auto | NO_VALUE = "__NO__VALUE__" |
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_TELEMETRY = "telemetry" |
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_AUTO_ADJUST_TIME_RATE = "auto_adjust_time_rate" |
constexpr auto | CFG_KEY_ALLOW_FRAME_SKIPPING = "allow_frame_skipping" |
constexpr auto | CFG_KEY_ALLOW_LOST_FRAMES = "allow_lost_frames" |
constexpr auto | CFG_KEY_AUTO_STOP_ACQ_AFTER_REC = "auto_stop_acq_after_rec" |
constexpr auto | CFG_KEY_ENABLED = "enabled" |
constexpr auto | CFG_KEY_DEVICES = "devices" |
constexpr auto | CFG_KEY_HEIGHT = "height" |
constexpr auto | CFG_KEY_ID = "id" |
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_METADATA_KEY = "metadata_key" |
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_OLDB_NODE = "oldb_node" |
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" |
constexpr auto | CFG_KEY_WRITE_ON_INIT = "write_on_init" |
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_INTERFACE = "interface" |
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" |
States (composite). | |
enum class | ThreadType { MONITOR = 1 , ACQUISITION , PROCESSING , PUBLISHER , UNDEFINED = -1 } |
enum class | HwStatus { NOT_OK = 0 , OK } |
HW status values. More... | |
enum class | Status { FAILURE = 0 , 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_name, const std::string &receiver_thread_name, const std::string &data) |
Send MPTK message via internal Message Bus. | |
bool | ReceiveThrMsg (const std::string &receiver_thread_name, const double time_out, ifw::ccf::mptk::Message &message) |
Receive a message from the given thread. Returns true if message received. | |
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. | |
void | DecomposeSmStatus (const std::string &sm_state, std::string &sum_state, std::string &sum_substate) |
Execution status. | |
enum class | PubType { UNDEFINED = -1 , RECORDING = 1 , NOT_RECORDING } |
A Publisher may be Recording or Not-Recording. A Recording Publisher publishes data into files. More... | |
enum class | PubStatus { ACTIVE = recif::RecStatusNames::Active , COMPLETED = recif::RecStatusNames::Completed , STOPPED = recif::RecStatusNames::Stopped , ABORTED = recif::RecStatusNames::Aborted , FAILED = recif::RecStatusNames::Failed , UNDEFINED = recif::RecStatusNames::Undefined } |
Defines the various possible states of a Data Publisher. More... | |
enum class | ProcStatus { UNDEFINED = -1 , IDLE = 1 , PROCESSING = 32 , FINISHED = 128 , FAILED = 256 } |
Possible states for a Processing Recipe defined. More... | |
enum class | ExpoMode { FINITE = 1 , CONTINUOUS , INACTIVE } |
Exposure modes. More... | |
constexpr auto | SUCCESS = "Success" |
constexpr auto | FAILURE = "Failure" |
std::string | StatusToStr (ifw::ccf::Status status) |
Convert the status from number to string. | |
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. | |
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. | |
Exposure modes. | |
enum class | SimType { FILE = 1 , 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. | |
DB state nodes names. | |
const std::string | DB_DELIM = std::string(ifw::core::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 |
ifw::fnd::datatype::DataType | CiiCfgNodeToIfwDataType (elt::configng::CiiConfigInstanceNode &node) |
Determine IFW data type from a CII Cfg Node. | |
void | PrintStackTrace () |
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. | |
std::string | RecStatusNameToStr (recif::RecStatusNames rec_status_nb) |
Recording Status name, number to string representation. | |
std::string | BuildKey (const std::vector< std::string > &elements) |
Build a concatenated key from a number of elements (<el1>.<el2.>...). | |
std::vector< std::string > | SplitKey (const std::string &key) |
Split up a concatenated key. | |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
void ifw::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.
std::string ifw::ccf::BuildKey | ( | const std::vector< std::string > & | elements | ) |
Build a concatenated key from a number of elements (<el1>.<el2.>...).
ifw::fnd::datatype::DataType ifw::ccf::CiiCfgNodeToIfwDataType | ( | elt::configng::CiiConfigInstanceNode & | node | ) |
Determine IFW data type from a CII Cfg Node.
void ifw::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.
void ifw::ccf::DecomposeSmStatus | ( | const std::string & | sm_state, |
std::string & | sum_state, | ||
std::string & | sum_substate ) |
Decompose the SM status string proivided by the SM, as follows: (sum state) ::= Off | NotOperational | Operational (sum substate) ::= Idle | Acquisition | Recording | Error
ExpoMode ifw::ccf::ExpoModeToNb | ( | const std::string & | expo_mode | ) |
Convert exposure mode from number representation to string.
log4cplus::Logger & ifw::ccf::FastLogger | ( | ) |
|
inline |
Return the reference to the CCF DB Singleton instance.
|
inline |
Return the reference to the CCF DB Singleton instance.
log4cplus::Logger & ifw::ccf::Logger | ( | ) |
void ifw::ccf::PrintStackTrace | ( | ) |
std::string ifw::ccf::PubStatusNameToStr | ( | PubStatus | pub_status_nb | ) |
Publisher status, number representation to string.
bool ifw::ccf::ReceiveThrMsg | ( | const std::string & | receiver_thread_name, |
const double | time_out, | ||
ifw::ccf::mptk::Message & | message ) |
Receive a message from the given thread. Returns true if message received.
std::string ifw::ccf::RecStatusNameToStr | ( | recif::RecStatusNames | rec_status_nb | ) |
Recording Status name, number to string representation.
void ifw::ccf::ResetRecStatusObj | ( | std::shared_ptr< recif::RecStatus > & | rec_status_obj, |
const recif::RecStatusNames | rec_status ) |
Reset the members of the Recording Status Object.
void ifw::ccf::SendThrMsg | ( | const std::string & | command, |
const std::string & | sender_thread_name, | ||
const std::string & | receiver_thread_name, | ||
const std::string & | data ) |
Send MPTK message via internal Message Bus.
void ifw::ccf::SetApplicationLogName | ( | const std::string & | app_name | ) |
std::vector< std::string > ifw::ccf::SplitKey | ( | const std::string & | key | ) |
Split up a concatenated key.
std::string ifw::ccf::StatusToStr | ( | ifw::ccf::Status | status | ) |
Convert the status from number to string.
|
extern |
|
constexpr |
Version of CCF.
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
const std::string ifw::ccf::DB_DELIM = std::string(ifw::core::utils::bat::CONFIG_DB_DELIMITER) |
const std::string ifw::ccf::DB_NODE_SM_STATE |
const std::string ifw::ccf::DB_NODE_SM_STATUS_STATE |
const std::string ifw::ccf::DB_NODE_SM_STATUS_SUBSTATE |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
Version of IFW.
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |