ifw-core
7.0.0
Loading...
Searching...
No Matches
header.hpp
Go to the documentation of this file.
1
6
7
#ifndef IFW_DIT_DID_HEADER_HPP_
8
#define IFW_DIT_DID_HEADER_HPP_
9
10
#include <string>
11
12
#include <
ifw/core/dit/did/defines.hpp
>
13
14
namespace
ifw::core::dit::did
{
15
17
class
Header
{
18
public
:
19
Header
();
20
21
~Header
();
22
24
void
Clear
();
25
31
void
Parse
(
const
elt::configng::CiiConfigDocument&
did
);
32
34
std::string
GetName
()
const
;
35
37
std::string
GetScope
()
const
;
38
40
std::string
GetDescription
()
const
;
41
47
std::string
ToString
(
const
HdrField
fields =
HdrField::ALL
,
48
const
bool
compact =
false
)
const
;
49
50
private
:
51
std::string m_name;
52
std::string m_scope;
53
std::string m_description;
54
};
55
56
}
// namespace ifw::core::dit::did
57
58
#endif
// !IFW_DIT_DID_HEADER_HPP_
ifw::core::dit::did::Header::Clear
void Clear()
Reset the object.
Definition
header.cpp:21
ifw::core::dit::did::Header::ToString
std::string ToString(const HdrField fields=HdrField::ALL, const bool compact=false) const
Get string copy of one or more header fields.
Definition
header.cpp:58
ifw::core::dit::did::Header::Parse
void Parse(const elt::configng::CiiConfigDocument &did)
Parse Parse/extract the fields of the DID header, contained in the string buffer.
Definition
header.cpp:28
ifw::core::dit::did::Header::GetName
std::string GetName() const
Return (file)name, from where the dictionary was loaded.
Definition
header.cpp:43
ifw::core::dit::did::Header::~Header
~Header()
Definition
header.cpp:17
ifw::core::dit::did::Header::GetDescription
std::string GetDescription() const
Return Description.
Definition
header.cpp:53
ifw::core::dit::did::Header::GetScope
std::string GetScope() const
Return scope.
Definition
header.cpp:48
ifw::core::dit::did::Header::Header
Header()
Definition
header.cpp:13
defines.hpp
ifw::core::dit::did
Definition
defines.cpp:15
ifw::core::dit::did::HdrField
HdrField
Dictionary header field types.
Definition
defines.hpp:28
ifw::core::dit::did::HdrField::ALL
@ ALL
Definition
defines.hpp:33
dit
did
didlib
src
include
ifw
core
dit
did
header.hpp
Generated by
1.13.2