core::dit::did::Header Class Reference

Data Interface Dictionary header class. More...

#include <header.hpp>

Public Member Functions
	Header ()
	~Header ()
void	Clear ()
	Reset the object. More...
void	Parse (const elt::configng::CiiConfigDocument &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...
std::string	GetDescription () const
	Return Description. More...
std::string	ToString (const HdrField fields=HdrField::ALL, const bool compact=false) const
	Get string copy of one or more header fields. More...

Detailed Description

Data Interface Dictionary header class.

Constructor & Destructor Documentation

Header()

core::dit::did::Header::Header

(

)

~Header()

core::dit::did::Header::~Header

(

)

Member Function Documentation

Clear()

void core::dit::did::Header::Clear

(

)

Reset the object.

GetDescription()

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

(

)

const

Return Description.

GetName()

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

(

)

const

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

GetScope()

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

(

)

const

Return scope.

Parse()

void core::dit::did::Header::Parse

(

const elt::configng::CiiConfigDocument &

did

)

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

Parameters

did_buf

ToString()

std::string core::dit::did::Header::ToString	(	const HdrField	fields = HdrField::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.

---

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

• dit/did/didlib/src/include/core/dit/did/header.hpp
• dit/did/didlib/src/header.cpp