cDDLExtDeclaration

Representation of an external declaration inside the header of a DDL description. More...

#include <ddlextdeclaration.h>

Inheritance diagram for cDDLExtDeclaration:

Public Member Functions
	cDDLExtDeclaration ()
	Default CTOR.
	cDDLExtDeclaration (const A_UTILS_NS::cString &strKey, const A_UTILS_NS::cString &strValue)
	CTOR.
	cDDLExtDeclaration (cDDLExtDeclaration &oExtDecl)
	Copy CTOR.
virtual	~cDDLExtDeclaration ()
	DTOR.
tResult	Accept (IDDLVisitor *poVisitor)
	Acceptance method for Visitor design-pattern.
const A_UTILS_NS::cString &	GetName () const
	Getter for the name of the representation object.
bool	IsInitialized () const
	Getter for the initialization flag.
tResult	Create (const A_UTILS_NS::cString &strKey, const A_UTILS_NS::cString &strValue)
	Creation method to fill the object with data.
A_UTILS_NS::cString	GetKey () const
	Getter for the key.
void	SetKey (const A_UTILS_NS::cString &strKey)
	Setter for the key.
A_UTILS_NS::cString	GetValue () const
	Getter for the value.
void	SetValue (const A_UTILS_NS::cString &strValue)
	Setter for the Value.
Public Member Functions inherited from cDDL
virtual	~cDDL ()
	DTOR.
virtual bool	IsPredefined () const
	Getter for the predefinition flag.
virtual bool	IsOverwriteable () const
	Getter for the predefinition flag.
virtual int	GetCreationLevel () const
	Getter for the creation level.
Public Member Functions inherited from IDDL
virtual	~IDDL ()
	Virtual DTOR.

Private Attributes
A_UTILS_NS::cString	m_strKey
A_UTILS_NS::cString	m_strValue
bool	m_bInitFlag

Additional Inherited Members
Public Types inherited from IDDL
enum	tag_MergeFlags { DDLMERGE_ForceOverwrite = 0x01 }
	Flags for Merging. More...
Static Public Member Functions inherited from cDDL
template<typename T>
static T *	DeleteChild (T *pvObj)
	Functor for use with std::transform() to delete all objects where the elements of a vector point at.
template<typename T>
static tResult	MoveChild (T *pvObj, const int nFrom, const int nTo)
	Method moves element within the list.
template<typename T>
static T *	Clone (T *pvObj)
	Functor for use with std::transform() to clone the objects where the elements of a vector point at.
template<typename T>
static T *	Ref (T *pvObj)
	Functor for use with std::transform() to ref the objects where the elements of a vector point at, this is for the Always_there.
static bool	IsEqual (IDDL *poLHS, IDDL *poRHS)
	Predicate to compare 2 DDL representation objects (for use with std::unique()).
static bool	IsSorted (IDDL *poLHS, IDDL *poRHS)
	Sort predicate to compare to 2 DDL representation objects (for use with std::sort()).

Detailed Description

Representation of an external declaration inside the header of a DDL description.

Definition at line 17 of file ddlextdeclaration.h.

Constructor & Destructor Documentation

cDDLExtDeclaration() [1/2]

cDDLExtDeclaration	(	const A_UTILS_NS::cString &	strKey,
		const A_UTILS_NS::cString &	strValue )

CTOR.

Parameters

[in]	strKey	- Name of the additional information
[in]	strValue	- Value of the additional information

cDDLExtDeclaration() [2/2]

cDDLExtDeclaration

(

cDDLExtDeclaration &

oExtDecl

)

Copy CTOR.

Parameters

[in]

oExtDecl

- Reference to ExtDeclaration object to copy

References cDDLExtDeclaration().

Member Function Documentation

Accept()

tResult Accept ( IDDLVisitor * poVisitor )

virtual

Acceptance method for Visitor design-pattern.

Parameters

[in]

poVisitor

- Pointer to Visitor instance

Return values

ERR_POINTER	Null-pointer committed
ERR_NOT_FOUND	Required node not found.
ERR_NOT_INITIALIZED	The object was not or not correctly initialized

Implements IDDL.

Create()

tResult Create	(	const A_UTILS_NS::cString &	strKey,
		const A_UTILS_NS::cString &	strValue )

Creation method to fill the object with data.

Parameters

[in]	strKey	- Name of the additional information
[in]	strValue	- Value of the additional information

Return values

ERR_INVALID_ARG

Empty key committed

GetKey()

A_UTILS_NS::cString GetKey

(

)

const

Getter for the key.

Returns

the key

GetName()

const A_UTILS_NS::cString & GetName ( ) const

virtual

Getter for the name of the representation object.

Returns

the name

Implements IDDL.

GetValue()

A_UTILS_NS::cString GetValue

(

)

const

Getter for the value.

Returns

the value

IsInitialized()

bool IsInitialized ( ) const

virtual

Getter for the initialization flag.

Return values

true	The object was initialized correctly
false	The object was not or not correctly initialized

Reimplemented from cDDL.

Member Data Documentation

m_bInitFlag

bool m_bInitFlag

private

Definition at line 83 of file ddlextdeclaration.h.

m_strKey

A_UTILS_NS::cString m_strKey

private

Definition at line 80 of file ddlextdeclaration.h.

m_strValue

A_UTILS_NS::cString m_strValue

private

Definition at line 81 of file ddlextdeclaration.h.