ifw-core  2.0.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Enumerations | Functions | Variables
dit::did Namespace Reference

Classes

class  Did
 Data Interface Dictionary class. More...
 
class  Header
 Data Interface Dictionary header class. More...
 
class  Range
 Class to contain limits for one range. More...
 
class  FormatSpecifier
 class to handle the format specifier of a DID record. More...
 
class  Record
 Data Interface Dictionary keyword record class. More...
 

Enumerations

enum  HeaderSpecifier { DID_HDR_NONE = 0, DID_HDR_FIRST, DID_HDR_LAST, DID_HDR_ALL }
 Used to refer to which header(s) to address. More...
 
enum  DidHdrField {
  DID_HDR_FIELD_NAME = 1, DID_HDR_FIELD_SCOPE = 2, DID_HDR_FIELD_CRE_DATE = 4, DID_HDR_FIELD_VERSION = 8,
  DID_HDR_FIELD_INCLUDE = 16, DID_HDR_FIELD_DESCRIPTION = 32, DID_HDR_FIELD_ALL
}
 Dictionary header field types. More...
 
enum  DidRecField {
  DID_REC_FIELD_CLASS = 2, DID_REC_FIELD_TYPE = 4, DID_REC_FIELD_FORMAT = 8, DID_REC_FIELD_DEFAULT = 16,
  DID_REC_FIELD_UNIT = 32, DID_REC_FIELD_RANGE = 64, DID_REC_FIELD_COMMENT = 128, DID_REC_FIELD_TAGS = 256,
  DID_REC_FIELD_DESCRIPTION = 512, DID_REC_FIELD_ALL
}
 Dictionary keyword record field types. More...
 

Functions

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

Variables

const std::string HEADER_TAG = "Header"
 
const std::string DID_HDR_FIELD_NAME_STR = "Name"
 
const std::string DID_HDR_FIELD_SCOPE_STR = "Scope"
 
const std::string DID_HDR_FIELD_CRE_DATE_STR = "CreationDate"
 
const std::string DID_HDR_FIELD_VERSION_STR = "Version"
 
const std::string DID_HDR_FIELD_INCLUDE_STR = "Include"
 
const std::string DID_HDR_FIELD_DESCRIPTION_STR = "Description"
 
const std::map< DidHdrField,
std::string > 
DID_HDR_FIELDS_NB_MAP
 
const std::map< std::string,
DidHdrField
DID_HDR_FIELDS_NAME_MAP
 
const std::string DID_REC_FIELD_CLASS_STR = "Class"
 
const std::string DID_REC_FIELD_TYPE_STR = "Type"
 
const std::string DID_REC_FIELD_FORMAT_STR = "Format"
 
const std::string DID_REC_FIELD_DEFAULT_STR = "Default"
 
const std::string DID_REC_FIELD_UNIT_STR = "Unit"
 
const std::string DID_REC_FIELD_RANGE_STR = "Range"
 
const std::string DID_REC_FIELD_COMMENT_STR = "Comment"
 
const std::string DID_REC_FIELD_TAGS_STR = "Tags"
 
const std::string DID_REC_FIELD_DESCRIPTION_STR = "Description"
 
const std::map< DidRecField,
std::string > 
DID_REC_FIELDS_NB_MAP
 map to map from record "class" field numeric to string representation. More...
 
const std::map< std::string,
DidRecField
DID_REC_FIELDS_NAME_MAP
 map to map from record "class" field string to numeric representation. More...
 

Detailed Description

Enumeration Type Documentation

Dictionary header field types.

Enumerator
DID_HDR_FIELD_NAME 
DID_HDR_FIELD_SCOPE 
DID_HDR_FIELD_CRE_DATE 
DID_HDR_FIELD_VERSION 
DID_HDR_FIELD_INCLUDE 
DID_HDR_FIELD_DESCRIPTION 
DID_HDR_FIELD_ALL 

Dictionary keyword record field types.

Enumerator
DID_REC_FIELD_CLASS 
DID_REC_FIELD_TYPE 
DID_REC_FIELD_FORMAT 
DID_REC_FIELD_DEFAULT 
DID_REC_FIELD_UNIT 
DID_REC_FIELD_RANGE 
DID_REC_FIELD_COMMENT 
DID_REC_FIELD_TAGS 
DID_REC_FIELD_DESCRIPTION 
DID_REC_FIELD_ALL 

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

Enumerator
DID_HDR_NONE 
DID_HDR_FIRST 
DID_HDR_LAST 
DID_HDR_ALL 

Function Documentation

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

Variable Documentation

const std::string dit::did::DID_HDR_FIELD_CRE_DATE_STR = "CreationDate"
const std::string dit::did::DID_HDR_FIELD_DESCRIPTION_STR = "Description"
const std::string dit::did::DID_HDR_FIELD_INCLUDE_STR = "Include"
const std::string dit::did::DID_HDR_FIELD_NAME_STR = "Name"
const std::string dit::did::DID_HDR_FIELD_SCOPE_STR = "Scope"
const std::string dit::did::DID_HDR_FIELD_VERSION_STR = "Version"
const std::map<std::string, DidHdrField> dit::did::DID_HDR_FIELDS_NAME_MAP
Initial value:
{
}
Definition: Header.hpp:25
const std::string DID_HDR_FIELD_DESCRIPTION_STR
Definition: Header.hpp:44
const std::string DID_HDR_FIELD_INCLUDE_STR
Definition: Header.hpp:43
Definition: Header.hpp:26
const std::string DID_HDR_FIELD_SCOPE_STR
Definition: Header.hpp:40
const std::string DID_HDR_FIELD_NAME_STR
Definition: Header.hpp:39
const std::string DID_HDR_FIELD_VERSION_STR
Definition: Header.hpp:42
const std::string DID_HDR_FIELD_CRE_DATE_STR
Definition: Header.hpp:41
Definition: Header.hpp:29
Definition: Header.hpp:30
Definition: Header.hpp:27
Definition: Header.hpp:28
const std::map<DidHdrField, std::string> dit::did::DID_HDR_FIELDS_NB_MAP
Initial value:
= {
}
Definition: Header.hpp:25
const std::string DID_HDR_FIELD_DESCRIPTION_STR
Definition: Header.hpp:44
const std::string DID_HDR_FIELD_INCLUDE_STR
Definition: Header.hpp:43
Definition: Header.hpp:26
const std::string DID_HDR_FIELD_SCOPE_STR
Definition: Header.hpp:40
const std::string DID_HDR_FIELD_NAME_STR
Definition: Header.hpp:39
const std::string DID_HDR_FIELD_VERSION_STR
Definition: Header.hpp:42
const std::string DID_HDR_FIELD_CRE_DATE_STR
Definition: Header.hpp:41
Definition: Header.hpp:29
Definition: Header.hpp:30
Definition: Header.hpp:27
Definition: Header.hpp:28
const std::string dit::did::DID_REC_FIELD_CLASS_STR = "Class"
const std::string dit::did::DID_REC_FIELD_COMMENT_STR = "Comment"
const std::string dit::did::DID_REC_FIELD_DEFAULT_STR = "Default"
const std::string dit::did::DID_REC_FIELD_DESCRIPTION_STR = "Description"
const std::string dit::did::DID_REC_FIELD_FORMAT_STR = "Format"
const std::string dit::did::DID_REC_FIELD_RANGE_STR = "Range"
const std::string dit::did::DID_REC_FIELD_TAGS_STR = "Tags"
const std::string dit::did::DID_REC_FIELD_TYPE_STR = "Type"
const std::string dit::did::DID_REC_FIELD_UNIT_STR = "Unit"
const std::map<std::string, DidRecField> dit::did::DID_REC_FIELDS_NAME_MAP
Initial value:
= {
}
const std::string DID_REC_FIELD_CLASS_STR
Definition: Record.hpp:119
Definition: Record.hpp:109
Definition: Record.hpp:105
const std::string DID_REC_FIELD_TAGS_STR
Definition: Record.hpp:126
const std::string DID_REC_FIELD_DEFAULT_STR
Definition: Record.hpp:122
Definition: Record.hpp:106
Definition: Record.hpp:102
const std::string DID_REC_FIELD_FORMAT_STR
Definition: Record.hpp:121
const std::string DID_REC_FIELD_UNIT_STR
Definition: Record.hpp:123
Definition: Record.hpp:103
Definition: Record.hpp:104
const std::string DID_REC_FIELD_DESCRIPTION_STR
Definition: Record.hpp:127
Definition: Record.hpp:107
Definition: Record.hpp:108
const std::string DID_REC_FIELD_TYPE_STR
Definition: Record.hpp:120
const std::string DID_REC_FIELD_RANGE_STR
Definition: Record.hpp:124
const std::string DID_REC_FIELD_COMMENT_STR
Definition: Record.hpp:125
Definition: Record.hpp:101

map to map from record "class" field string to numeric representation.

const std::map<DidRecField, std::string> dit::did::DID_REC_FIELDS_NB_MAP
Initial value:
= {
}
const std::string DID_REC_FIELD_CLASS_STR
Definition: Record.hpp:119
Definition: Record.hpp:109
Definition: Record.hpp:105
const std::string DID_REC_FIELD_TAGS_STR
Definition: Record.hpp:126
const std::string DID_REC_FIELD_DEFAULT_STR
Definition: Record.hpp:122
Definition: Record.hpp:106
Definition: Record.hpp:102
const std::string DID_REC_FIELD_FORMAT_STR
Definition: Record.hpp:121
const std::string DID_REC_FIELD_UNIT_STR
Definition: Record.hpp:123
Definition: Record.hpp:103
Definition: Record.hpp:104
const std::string DID_REC_FIELD_DESCRIPTION_STR
Definition: Record.hpp:127
Definition: Record.hpp:107
Definition: Record.hpp:108
const std::string DID_REC_FIELD_TYPE_STR
Definition: Record.hpp:120
const std::string DID_REC_FIELD_RANGE_STR
Definition: Record.hpp:124
const std::string DID_REC_FIELD_COMMENT_STR
Definition: Record.hpp:125
Definition: Record.hpp:101

map to map from record "class" field numeric to string representation.

const std::string dit::did::HEADER_TAG = "Header"