|
ifw-ccf
3.0.0-pre2
|
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 class | LogLevel { OFF = 0 , FATAL = 100 , ERROR = 200 , WARN = 300 , INFO = 400 , DEBUG = 500 , DEBUG2 = 501 , DEBUG3 = 502 , TRACE = 600 , NOT_SET = -1 } |
| Log levels defined for CCF; adds two debugging levels: DEBUG2, DEBUG3. More... | |
| enum class | DataTypes : int { ARRAY = 1 << 0 , INVALID = 1 << 4 , CHAR = 1 << 5 , BYTE = 1 << 6 , BOOL = 1 << 7 , INT16 = 1 << 8 , UINT16 = 1 << 9 , INT32 = 1 << 10 , UINT32 = 1 << 11 , INT64 = 1 << 12 , UINT64 = 1 << 13 , FLOAT = 1 << 16 , DOUBLE = 1 << 17 , COMPLEX = 1 << 19 , STRING = CHAR | ARRAY , FLOAT_COMPLEX = FLOAT | COMPLEX , DOUBLE_COMPLEX = DOUBLE | COMPLEX , BITMASK = 1 << 21 , 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_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" |
| 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_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. More... | |
| bool | ReceiveThrMsg (const std::string &receiver_thread_name, 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 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 (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 int8_t bitpix) |
| Converts the FITS BITPIX value into a data type. More... | |
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. More... | |
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) |
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... | |
| using ccf::TypeNumMap = typedef boost::bimap<std::string, DataTypes> |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
| 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.
|
inline |
Converts the FITS BITPIX value into a data type.
| std::string ccf::BuildKey | ( | const std::vector< std::string > & | elements | ) |
Build a concatenated key from a number of elements (<el1>.<el2.>...).
| 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.
| void 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 ccf::ExpoModeToNb | ( | const std::string & | expo_mode | ) |
Convert exposure mode from number representation to string.
|
inline |
Get data type as an optional enumeration.
| data_type | string representation of the data type. |
|
inline |
Get data type as an optional string.
| data_type | enumeration of the data type. |
|
inline |
Return the reference to the CCF DB Singleton instance.
|
inline |
Get the number of bytes used by the given type.
| data_type | image data type. |
| log4cplus::Logger & ccf::Logger | ( | ) |
|
inline |
|
inline |
| std::string ccf::PubStatusNameToStr | ( | PubStatus | pub_status_nb | ) |
Publisher status, number representation to string.
| bool ccf::ReceiveThrMsg | ( | const std::string & | receiver_thread_name, |
| const double | time_out, | ||
| ccf::mptk::Message & | message | ||
| ) |
Receive a message from the given thread. Returns true if message received.
| std::string ccf::RecStatusNameToStr | ( | recif::RecStatusNames | rec_status_nb | ) |
Recording Status name, number to string representation.
| void ccf::ResetRecStatusObj | ( | std::shared_ptr< recif::RecStatus > & | rec_status_obj, |
| const recif::RecStatusNames | rec_status | ||
| ) |
Reset the members of the Recording Status Object.
| void 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.
| std::vector< std::string > ccf::SplitKey | ( | const std::string & | key | ) |
Split up a concatenated key.
| std::string ccf::StatusToStr | ( | ccf::Status | status | ) |
Convert the status from number to string.
|
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 |
| const std::string ccf::DB_DELIM = std::string(utils::bat::CONFIG_DB_DELIMITER) |
| const std::string ccf::DB_NODE_SM_STATE |
| const std::string ccf::DB_NODE_SM_STATUS_STATE |
| const std::string 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 |