dit::did::Header Class Reference

Data Interface Dictionary header class. More...

#include <Header.hpp>

Public Types
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, 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, 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	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, 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, 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	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, 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, 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...

Public Member Functions
	Header ()
	Header (const ctd::file::Yaml &did)
	Header constructor extracting the DID header files from DID loaded in buffer. More...
	~Header ()
void	Parse (const ctd::file::Yaml &did)
	Parse Parse/extract the fields of the DID header, contained in the string buffer. More...
std::string	GetName () const
	Return (file)name, from where the dictionary was loaded. More...
std::string	GetScope () const
	Return scope. More...
ctd::defines::IsoTime	GetCreationDate () const
	Return creation date (ISO8601). More...
std::string	GetVersion () const
	Return version (control string). More...
const ctd::defines::List < std::string > &	GetIncludes () const
	Return reference to list of include files. More...
std::string	GetDescription () const
	Return Description. More...
std::string	Print (DidHdrField fields=DID_HDR_FIELD_ALL, const bool compact=false) const
	Get string copy of one or more header fields. More...
	Header ()
	Header (const ctd::file::Yaml &did)
	Header constructor extracting the DID header files from DID loaded in buffer. More...
	~Header ()
void	Parse (const ctd::file::Yaml &did)
	Parse Parse/extract the fields of the DID header, contained in the string buffer. More...
std::string	GetName () const
	Return (file)name, from where the dictionary was loaded. More...
std::string	GetScope () const
	Return scope. More...
ctd::defines::IsoTime	GetCreationDate () const
	Return creation date (ISO8601). More...
std::string	GetVersion () const
	Return version (control string). More...
const ctd::defines::List < std::string > &	GetIncludes () const
	Return reference to list of include files. More...
std::string	GetDescription () const
	Return Description. More...
std::string	Print (DidHdrField fields=DID_HDR_FIELD_ALL, const bool compact=false) const
	Get string copy of one or more header fields. More...
	Header ()
	Header (const ctd::file::Yaml &did)
	Header constructor extracting the DID header files from DID loaded in buffer. More...
	~Header ()
void	Parse (const ctd::file::Yaml &did)
	Parse Parse/extract the fields of the DID header, contained in the string buffer. More...
std::string	GetName () const
	Return (file)name, from where the dictionary was loaded. More...
std::string	GetScope () const
	Return scope. More...
ctd::defines::IsoTime	GetCreationDate () const
	Return creation date (ISO8601). More...
std::string	GetVersion () const
	Return version (control string). More...
const ctd::defines::List < std::string > &	GetIncludes () const
	Return reference to list of include files. More...
std::string	GetDescription () const
	Return Description. More...
std::string	Print (DidHdrField fields=DID_HDR_FIELD_ALL, const bool compact=false) const
	Get string copy of one or more header fields. More...

Static Public Attributes
static const std::string	HEADER_TAG = "Header"
static const std::string	DID_HDR_FIELD_NAME_STR = "Name"
static const std::string	DID_HDR_FIELD_SCOPE_STR = "Scope"
static const std::string	DID_HDR_FIELD_CRE_DATE_STR = "CreationDate"
static const std::string	DID_HDR_FIELD_VERSION_STR = "Version"
static const std::string	DID_HDR_FIELD_INCLUDE_STR = "Include"
static const std::string	DID_HDR_FIELD_DESCRIPTION_STR = "Description"
static const std::map < DidHdrField, std::string >	s_did_hdr_fields_nb_map
static const std::map < std::string, DidHdrField >	s_did_hdr_fields_name_map

Detailed Description

Data Interface Dictionary header class.

Member Enumeration Documentation

enum dit::did::Header::DidHdrField

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

enum dit::did::Header::DidHdrField

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

enum dit::did::Header::DidHdrField

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

Constructor & Destructor Documentation

dit::did::Header::Header

(

)

dit::did::Header::Header ( const ctd::file::Yaml &  did )

explicit

Header constructor extracting the DID header files from DID loaded in buffer.

Parameters

did_buf

String buffer containing the DID.

dit::did::Header::~Header

(

)

dit::did::Header::Header

(

)

dit::did::Header::Header ( const ctd::file::Yaml &  did )

explicit

Header constructor extracting the DID header files from DID loaded in buffer.

Parameters

did_buf

String buffer containing the DID.

dit::did::Header::~Header

(

)

dit::did::Header::Header

(

)

dit::did::Header::Header ( const ctd::file::Yaml &  did )

explicit

Header constructor extracting the DID header files from DID loaded in buffer.

Parameters

did_buf

String buffer containing the DID.

dit::did::Header::~Header

(

)

Member Function Documentation

ctd::defines::IsoTime dit::did::Header::GetCreationDate

(

)

const

Return creation date (ISO8601).

ctd::defines::IsoTime dit::did::Header::GetCreationDate

(

)

const

Return creation date (ISO8601).

ctd::defines::IsoTime dit::did::Header::GetCreationDate

(

)

const

Return creation date (ISO8601).

std::string dit::did::Header::GetDescription

(

)

const

Return Description.

std::string dit::did::Header::GetDescription

(

)

const

Return Description.

std::string dit::did::Header::GetDescription

(

)

const

Return Description.

const ctd::defines::List<std::string>& dit::did::Header::GetIncludes

(

)

const

Return reference to list of include files.

const ctd::defines::List<std::string>& dit::did::Header::GetIncludes

(

)

const

Return reference to list of include files.

const ctd::defines::List< std::string > & dit::did::Header::GetIncludes

(

)

const

Return reference to list of include files.

std::string dit::did::Header::GetName

(

)

const

Return (file)name, from where the dictionary was loaded.

std::string dit::did::Header::GetName

(

)

const

Return (file)name, from where the dictionary was loaded.

std::string dit::did::Header::GetName

(

)

const

Return (file)name, from where the dictionary was loaded.

std::string dit::did::Header::GetScope

(

)

const

Return scope.

std::string dit::did::Header::GetScope

(

)

const

Return scope.

std::string dit::did::Header::GetScope

(

)

const

Return scope.

std::string dit::did::Header::GetVersion

(

)

const

Return version (control string).

std::string dit::did::Header::GetVersion

(

)

const

Return version (control string).

std::string dit::did::Header::GetVersion

(

)

const

Return version (control string).

void dit::did::Header::Parse

(

const ctd::file::Yaml &

did

)

Parse Parse/extract the fields of the DID header, contained in the string buffer.

Parameters

did_buf

void dit::did::Header::Parse

(

const ctd::file::Yaml &

did

)

Parse Parse/extract the fields of the DID header, contained in the string buffer.

Parameters

did_buf

void dit::did::Header::Parse

(

const ctd::file::Yaml &

did

)

Parse Parse/extract the fields of the DID header, contained in the string buffer.

Parameters

did_buf

std::string dit::did::Header::Print	(	DidHdrField	fields = DID_HDR_FIELD_ALL,
		const bool	compact = false
	)		const

Get string copy of one or more header fields.

Parameters

fields

Header fields to return.

Returns

Buffer with header fields, separated with newline if multiple requested.

std::string dit::did::Header::Print	(	DidHdrField	fields = DID_HDR_FIELD_ALL,
		const bool	compact = false
	)		const

Get string copy of one or more header fields.

Parameters

fields

Header fields to return.

Returns

Buffer with header fields, separated with newline if multiple requested.

std::string dit::did::Header::Print	(	DidHdrField	fields = DID_HDR_FIELD_ALL,
		const bool	compact = false
	)		const

Get string copy of one or more header fields.

Parameters

fields

Header fields to return.

Returns

Buffer with header fields, separated with newline if multiple requested.

Member Data Documentation

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

static

static const std::map< std::string, DidHdrField > dit::did::Header::s_did_hdr_fields_name_map

static

Initial value:

{
    {Header::DID_HDR_FIELD_NAME_STR,
                Header::DID_HDR_FIELD_NAME},
    {Header::DID_HDR_FIELD_SCOPE_STR,
                Header::DID_HDR_FIELD_SCOPE},
    {Header::DID_HDR_FIELD_CRE_DATE_STR,
                Header::DID_HDR_FIELD_CRE_DATE},
    {Header::DID_HDR_FIELD_VERSION_STR,
                Header::DID_HDR_FIELD_VERSION},
    {Header::DID_HDR_FIELD_INCLUDE_STR,
                Header::DID_HDR_FIELD_INCLUDE},
    {Header::DID_HDR_FIELD_DESCRIPTION_STR,
                Header::DID_HDR_FIELD_DESCRIPTION}
}

static const std::map< DidHdrField, std::string > dit::did::Header::s_did_hdr_fields_nb_map

static

Initial value:

= {
    {Header::DID_HDR_FIELD_NAME,
     Header::DID_HDR_FIELD_NAME_STR},
    {Header::DID_HDR_FIELD_SCOPE,
     Header::DID_HDR_FIELD_SCOPE_STR},
    {Header::DID_HDR_FIELD_CRE_DATE,
     Header::DID_HDR_FIELD_CRE_DATE_STR},
    {Header::DID_HDR_FIELD_VERSION,
     Header::DID_HDR_FIELD_VERSION_STR},
    {Header::DID_HDR_FIELD_INCLUDE,
     Header::DID_HDR_FIELD_INCLUDE_STR},
    {Header::DID_HDR_FIELD_DESCRIPTION,
     Header::DID_HDR_FIELD_DESCRIPTION_STR}
}

---

The documentation for this class was generated from the following files:

• dit/did/src/include/dit/did/Header.hpp
• INTROOT/include/dit/did/Header.hpp
• INTROOT/sources/dit/did/src/include/dit/did/Header.hpp
• dit/did/src/Header.cpp
• INTROOT/sources/dit/did/src/Header.cpp