core::dit::did Namespace Reference

Classes
class	Did
	Data Interface Dictionary class. More...
class	Header
	Data Interface Dictionary header class. More...
class	FormatSpecifier
	class to handle the format specifier of a DID record. Format is: %[parameter][flags][width][.precision][length]type More...
class	Record
	Data Interface Dictionary keyword record class. More...

Enumerations
enum class	HdrField { NAME = 1 , SCOPE = 2 , DESCRIPTION = 4 , ALL = (NAME | SCOPE | DESCRIPTION) }
	Dictionary header field types. More...
enum class	DataType {   BOOL = 1 , DOUBLE = 2 , INTEGER = 4 , STRING = 8 ,   ALL = (BOOL | DOUBLE | INTEGER | STRING) }
	Dictionary data types. More...
enum class	RecField {   FORMAT = 1 , UNIT = 2 , COMMENT = 4 , DESCRIPTION = 8 ,   TYPE = 128 , ALL = (FORMAT | UNIT | COMMENT | DESCRIPTION | TYPE) }
	Dictionary keyword record field types. More...
enum	HdrSpec {   NONE = 0 , FIRST , LAST , ALL ,   ALL = (NAME | SCOPE | DESCRIPTION) , ALL = (BOOL | DOUBLE | INTEGER | STRING) , ALL = (FORMAT | UNIT | COMMENT | DESCRIPTION | TYPE) }
	Used to refer to which header(s) to address. More...

Functions
log4cplus::Logger &	Logger ()
DataType	DataTypeToNum (const std::string &type)
	Map type from string to numeric representation. More...
std::string	DataTypeToStr (const DataType type)
	Map type from numeric to string representation. More...
std::string	RecFieldToStr (const RecField field)
	Map record field from numeric to string representation. More...
RecField	RecFieldToNum (const std::string &field)
	Map record field from string to numeric representation. More...
std::ostream &	operator<< (std::ostream &os, const Did &did)

Variables
const std::string	DID_SCHEMA_INCLUDE = "!cfg.include schema/core/dit/did/did.schema.yaml"
const std::string	HDR_TAG = "header"
const std::string	HDR_FIELD_NAME = "name"
const std::string	HDR_FIELD_SCOPE = "scope"
const std::string	HDR_FIELD_DESCRIPTION = "description"
const std::map< HdrField, std::string >	HDR_FIELDS_NB_MAP
const std::map< std::string, HdrField >	HDR_FIELDS_NAME_MAP
const std::string	REC_TYPE_BOOL = "DidBoolKey"
const std::string	REC_TYPE_DOUBLE = "DidDblKey"
const std::string	REC_TYPE_INTEGER = "DidIntKey"
const std::string	REC_TYPE_STRING = "DidStrKey"
const std::string	REC_FIELD_FORMAT = "format"
const std::string	REC_FIELD_UNIT = "unit"
const std::string	REC_FIELD_COMMENT = "comment"
const std::string	REC_FIELD_DESCRIPTION = "description"
const std::string	REC_FIELD_TYPE = "type"

Detailed Description

Copyright

ESO - European Southern Observatory

Enumeration Type Documentation

DataType

enum core::dit::did::DataType

strong

Dictionary data types.

Enumerator
BOOL
DOUBLE
INTEGER
STRING
ALL

HdrField

enum core::dit::did::HdrField

strong

Dictionary header field types.

Enumerator
NAME
SCOPE
DESCRIPTION
ALL

HdrSpec

enum core::dit::did::HdrSpec

Used to refer to which header(s) to address.

Enumerator
NONE
FIRST
LAST
ALL
ALL
ALL
ALL

RecField

enum core::dit::did::RecField

strong

Dictionary keyword record field types.

Enumerator
FORMAT
UNIT
COMMENT
DESCRIPTION
TYPE
ALL

Function Documentation

DataTypeToNum()

DataType core::dit::did::DataTypeToNum

(

const std::string &

type

)

Map type from string to numeric representation.

DataTypeToStr()

std::string core::dit::did::DataTypeToStr

(

const DataType

type

)

Map type from numeric to string representation.

Logger()

log4cplus::Logger & core::dit::did::Logger

(

)

operator<<()

std::ostream& core::dit::did::operator<<	(	std::ostream &	os,
		const Did &	did
	)

RecFieldToNum()

RecField core::dit::did::RecFieldToNum

(

const std::string &

field

)

Map record field from string to numeric representation.

RecFieldToStr()

std::string core::dit::did::RecFieldToStr

(

const RecField

field

)

Map record field from numeric to string representation.

Variable Documentation

DID_SCHEMA_INCLUDE

const std::string core::dit::did::DID_SCHEMA_INCLUDE = "!cfg.include schema/core/dit/did/did.schema.yaml"

HDR_FIELD_DESCRIPTION

const std::string core::dit::did::HDR_FIELD_DESCRIPTION = "description"

HDR_FIELD_NAME

const std::string core::dit::did::HDR_FIELD_NAME = "name"

HDR_FIELD_SCOPE

const std::string core::dit::did::HDR_FIELD_SCOPE = "scope"

HDR_FIELDS_NAME_MAP

const std::map<std::string, HdrField> core::dit::did::HDR_FIELDS_NAME_MAP

Initial value:

{
    {HDR_FIELD_NAME, HdrField::NAME},
    {HDR_FIELD_SCOPE, HdrField::SCOPE},
    {HDR_FIELD_DESCRIPTION, HdrField::DESCRIPTION}}

HDR_FIELDS_NB_MAP

const std::map<HdrField, std::string> core::dit::did::HDR_FIELDS_NB_MAP

Initial value:

= {
    {HdrField::NAME, HDR_FIELD_NAME},
    {HdrField::SCOPE, HDR_FIELD_SCOPE},
    {HdrField::DESCRIPTION, HDR_FIELD_DESCRIPTION}}

HDR_TAG

const std::string core::dit::did::HDR_TAG = "header"

REC_FIELD_COMMENT

const std::string core::dit::did::REC_FIELD_COMMENT = "comment"

REC_FIELD_DESCRIPTION

const std::string core::dit::did::REC_FIELD_DESCRIPTION = "description"

REC_FIELD_FORMAT

const std::string core::dit::did::REC_FIELD_FORMAT = "format"

REC_FIELD_TYPE

const std::string core::dit::did::REC_FIELD_TYPE = "type"

REC_FIELD_UNIT

const std::string core::dit::did::REC_FIELD_UNIT = "unit"

REC_TYPE_BOOL

const std::string core::dit::did::REC_TYPE_BOOL = "DidBoolKey"

REC_TYPE_DOUBLE

const std::string core::dit::did::REC_TYPE_DOUBLE = "DidDblKey"

REC_TYPE_INTEGER

const std::string core::dit::did::REC_TYPE_INTEGER = "DidIntKey"

REC_TYPE_STRING

const std::string core::dit::did::REC_TYPE_STRING = "DidStrKey"