ADTF  3.18.2
ddlheader.h
Go to the documentation of this file.
1 
7 #ifndef _DDL_HEADER_H_INCLUDED_
8 #define _DDL_HEADER_H_INCLUDED_
9 
10 namespace adtf_ddl
11 {
12 
13  class cDDLExtDeclaration;
14 
18  typedef std::vector<cDDLExtDeclaration*> tDDLExtDeclarationVec;
22  typedef tDDLExtDeclarationVec::iterator tDDLExtDeclarationIt;
23 
27  class cDDLHeader : public cDDL
28  {
29  public:
34 
44  cDDLHeader(double const fLanguageVersion,
45  const A_UTILS_NS::cString& strAuthor,
46  tDate const sDateCreation,
47  tDate const sDateChange,
48  const A_UTILS_NS::cString& strDescription,
50 
56 
60  virtual ~cDDLHeader();
61 
62  tResult Accept(IDDLVisitor *poVisitor);
63 
64  const A_UTILS_NS::cString& GetName() const;
65 
66  bool IsInitialized() const;
67 
79  tResult Create(double const fLanguageVersion, const A_UTILS_NS::cString& strAuthor,
80  tDate const sDateCreation, tDate const sDateChange,
81  const A_UTILS_NS::cString& strDescription,
83 
88  double GetLanguageVersion() const;
89 
95  void SetLanguageVersion(double const fLanguageVersion);
96 
102 
109  void SetAuthor(const A_UTILS_NS::cString& strAuthor);
110 
116 
123  void SetDateCreation(tDate const sDateCreation);
124 
130 
137  void SetDateChange(tDate const sDateChange);
138 
144 
148  void SetDescription(const A_UTILS_NS::cString& strDescription);
149 
156  void SetExtDeclarations(tDDLExtDeclarationVec vecDDLExtDeclarations);
157 
165  void AddExtDeclaration(cDDLExtDeclaration * poExtDeclaration, int nPos = -1);
166 
173 
179 
185 
197  static tDate DateFromString(const A_UTILS_NS::cString& strDate);
198 
199  private:
200  double m_fLanguageVersion;
201  A_UTILS_NS::cString m_strAuthor;
202  tDate m_sDateCreation;
203  tDate m_sDateChange;
204  A_UTILS_NS::cString m_strDescription;
205  tDDLExtDeclarationVec m_vecDDLExtDeclarations;
206 
207  bool m_bInitFlag;
208  };
209 
210 } // namespace adtf_ddl
211 
212 #endif // _DDL_HEADER_H_INCLUDED_
Abstract base class/interface for Visitor design-pattern.
Representation of an external declaration inside the header of a DDL description.
Representation of the header of a DDL description.
Definition: ddlheader.h:28
tResult RemoveExtDeclaration(const A_UTILS_NS::cString &strKey)
Removes the external declaration with the given key.
const A_UTILS_NS::cString & GetName() const
Getter for the name of the representation object.
static tDate DateFromString(const A_UTILS_NS::cString &strDate)
Helper method to extract a date out of a string.
tDate GetDateChange() const
Getter for the change date.
void SetDateChange(tDate const sDateChange)
Setter for the change date.
A_UTILS_NS::cString GetDescription() const
Getter for the description.
void SetAuthor(const A_UTILS_NS::cString &strAuthor)
Setter for the author.
void SetExtDeclarations(tDDLExtDeclarationVec vecDDLExtDeclarations)
Setter for the external declarations.
bool IsInitialized() const
Getter for the initialization flag.
A_UTILS_NS::cString GetAuthor() const
Getter for the author.
virtual ~cDDLHeader()
DTOR.
tResult Create(double const fLanguageVersion, const A_UTILS_NS::cString &strAuthor, tDate const sDateCreation, tDate const sDateChange, const A_UTILS_NS::cString &strDescription, tDDLExtDeclarationVec vecExtDecls=tDDLExtDeclarationVec())
Creation method to fill the object with data.
double GetLanguageVersion() const
Getter for the language version.
cDDLHeader(cDDLHeader &oHeader)
Copy CTOR.
tDate GetDateCreation() const
Getter for the creation date.
cDDLHeader(double const fLanguageVersion, const A_UTILS_NS::cString &strAuthor, tDate const sDateCreation, tDate const sDateChange, const A_UTILS_NS::cString &strDescription, tDDLExtDeclarationVec vecExtDecls=tDDLExtDeclarationVec())
CTOR.
void AddExtDeclaration(cDDLExtDeclaration *poExtDeclaration, int nPos=-1)
Adder for an external declaration.
cDDLHeader()
Default CTOR.
tDDLExtDeclarationVec & GetExtDeclarations()
Getter for the external declarations.
void SetDateCreation(tDate const sDateCreation)
Setter for the creation date.
void SetDescription(const A_UTILS_NS::cString &strDescription)
Setter for the description.
const tDDLExtDeclarationVec & GetExtDeclarations() const
Getter for the external declarations.
void SetLanguageVersion(double const fLanguageVersion)
Setter for the language version.
tResult Accept(IDDLVisitor *poVisitor)
Acceptance method for Visitor design-pattern.
Namespace for the mainpage_pkg_ddl.
std::vector< cDDLExtDeclaration * > tDDLExtDeclarationVec
Container type of cDDLExtDeclaration objects.
Definition: ddlheader.h:13
tDDLExtDeclarationVec::iterator tDDLExtDeclarationIt
Iterator type for tDDLExtDeclarationVec.
Definition: ddlheader.h:22
Date Structure to define dates.
Definition: structs.h:25