cDDL

The abstract helper class for representation classes for DDL descriptions. More...

#include <ddl.h>

Inheritance diagram for cDDL:

Public Member Functions
virtual	~cDDL ()
	DTOR.
virtual bool	IsInitialized () const
	Getter for the initialization flag.
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.
virtual tResult	Accept (IDDLVisitor *poVisitor)=0
	Acceptance method for Visitor design-pattern.
virtual const A_UTILS_NS::cString &	GetName () const =0
	Getter for the name of the representation object.

Static Public Member Functions
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()).

Additional Inherited Members
Public Types inherited from IDDL
enum	tag_MergeFlags { DDLMERGE_ForceOverwrite = 0x01 }
	Flags for Merging. More...

Detailed Description

The abstract helper class for representation classes for DDL descriptions.

Definition at line 16 of file builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/extern/pkg_ddl/include/adtfddl/ddlrepresentation/ddl.h.

Constructor & Destructor Documentation

~cDDL()

virtual ~cDDL ( )

inlinevirtual

DTOR.

Definition at line 23 of file builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/extern/pkg_ddl/include/adtfddl/ddlrepresentation/ddl.h.

Member Function Documentation

Clone()

template<typename T>

static T * Clone ( T * pvObj )

inlinestatic

Functor for use with std::transform() to clone the objects where the elements of a vector point at.

Template Parameters

T	- Representation object type (e.g. Prefix)

Parameters

[in]

pvObj

- Pointer to the object to clone

Returns

Pointer to cloned instance of T or NULL if there was no original instance (pvObj == NULL).

Definition at line 103 of file builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/extern/pkg_ddl/include/adtfddl/ddlrepresentation/ddl.h.

References Ref().

DeleteChild()

template<typename T>

static T * DeleteChild ( T * pvObj )

inlinestatic

Functor for use with std::transform() to delete all objects where the elements of a vector point at.

Parameters

[in]

pvObj

- Pointer to the object to delete

Returns

Pointer to the predefined object that was not deleted (see remarks).

Remarks

Objects which are declarated as predefined are not deleted.

Definition at line 41 of file builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/extern/pkg_ddl/include/adtfddl/ddlrepresentation/ddl.h.

Referenced by cDDLAutoVec< vectorType >::AutoDelete().

GetCreationLevel()

virtual int GetCreationLevel ( ) const

virtual

Getter for the creation level.

Returns

the level at creation time of this representation object

Implements IDDL.

Reimplemented in cDDLPrefix, cDDLProperty, cDDLStream, and cDDLStreamMetaType.

IsEqual()

static bool IsEqual ( IDDL * poLHS, IDDL * poRHS )

static

Predicate to compare 2 DDL representation objects (for use with std::unique()).

Parameters

[in]	poLHS	- Pointer to the object on left-hand side
[in]	poRHS	- Pointer to the object on right-hand side

Return values

true	if the objects have the same name
false	else

IsInitialized()

virtual 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

Implements IDDL.

Reimplemented in cDDLDescription, cDDLExtDeclaration, cDDLHeader, cDDLPrefix, cDDLProperty, cDDLRefUnit, cDDLStream, cDDLStreamMetaType, and cDDLStreamStruct.

IsOverwriteable()

virtual bool IsOverwriteable ( ) const

virtual

Getter for the predefinition flag.

Return values

true	The object was predefined
false	The object was defined later

Implements IDDL.

IsPredefined()

virtual bool IsPredefined ( ) const

virtual

Getter for the predefinition flag.

Return values

true	The object was predefined
false	The object was defined later

Implements IDDL.

Reimplemented in cDDLPrefix.

IsSorted()

static bool IsSorted ( IDDL * poLHS, IDDL * poRHS )

static

Sort predicate to compare to 2 DDL representation objects (for use with std::sort()).

Parameters

[in]	poLHS	- Pointer to the object on left-hand side
[in]	poRHS	- Pointer to the object on right-hand side

Return values

true	if the left argument goes before the right one.
false	else

MoveChild()

template<typename T>

static tResult MoveChild ( T * pvObj, const int nFrom, const int nTo )

inlinestatic

Method moves element within the list.

Parameters

[in]	pvObj	- Pointer to the list object
[in]	nFrom	- Position of element in the list
[in]	nTo	- New position of element in the list

Returns

ERR_OUT_OF_RANGE - nFrom and nTo parameters are out of range.

ERR_NOERROR

Definition at line 66 of file builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/extern/pkg_ddl/include/adtfddl/ddlrepresentation/ddl.h.

References RETURN_ERROR, RETURN_IF_POINTER_NULL, and RETURN_NOERROR.

Ref()

template<typename T>

static T * Ref ( T * pvObj )

inlinestatic

Functor for use with std::transform() to ref the objects where the elements of a vector point at, this is for the Always_there.

Template Parameters

T	- Representation object type (e.g. Prefix)

Parameters

[in]

pvObj

- Pointer to the object to clone

Returns

Pointer to ref instance of T or NULL if there was no original instance (pvObj == NULL).

Definition at line 125 of file builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/extern/pkg_ddl/include/adtfddl/ddlrepresentation/ddl.h.

Referenced by Clone().