cDDLRefUnit

Decorator class for IDDLUnit objects to be used inside other cDDLUnit objects. More...

#include <ddlrefunit.h>

Inheritance diagram for cDDLRefUnit:

Public Member Functions
	cDDLRefUnit ()
	Default CTOR.
	cDDLRefUnit (IDDLUnit *poUnit, int const nPower, cDDLPrefix *poPrefix)
	CTOR with unit object.
	cDDLRefUnit (cDDLRefUnit &oRefUnit)
	CTOR with unit object.
virtual	~cDDLRefUnit ()
	DTOR.
tResult	Accept (IDDLVisitor *poVisitor)
	Acceptance method for Visitor design-pattern.
bool	IsInitialized () const
	Getter for the initialization flag.
tResult	Create (IDDLUnit *poUnit, int const nPower, cDDLPrefix *poPrefix)
	Creation method to fill the object with data.
const A_UTILS_NS::cString &	GetName () const
	Getter for the name.
IDDLUnit *	GetUnitObject () const
	Getter for the unit object.
void	SetUnitObject (IDDLUnit *const pUnit)
	Setter for the unit object.
int	GetPower () const
	Getter for the power.
void	SetPower (int const nPower)
	Setter for the power.
A_UTILS_NS::cString	GetPrefix () const
	Getter for the prefix name.
cDDLPrefix *	GetPrefixObject () const
	Getter for the prefix object.
void	SetPrefixObject (cDDLPrefix *const pPrefix)
	Setter for the prefix object.
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
IDDLUnit *	m_poUnit
int	m_nPower
cDDLPrefix *	m_poPrefix
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

Decorator class for IDDLUnit objects to be used inside other cDDLUnit objects.

Definition at line 17 of file ddlrefunit.h.

Constructor & Destructor Documentation

cDDLRefUnit() [1/2]

cDDLRefUnit	(	IDDLUnit *	poUnit,
		int const	nPower,
		cDDLPrefix *	poPrefix )

CTOR with unit object.

Parameters

[in]	poUnit	- Pointer to the unit object
[in]	nPower	- Power of the new unit related to the base units
[in]	poPrefix	- Pointer to the prefix object

cDDLRefUnit() [2/2]

cDDLRefUnit

(

cDDLRefUnit &

oRefUnit

)

CTOR with unit object.

Parameters

[in]

oRefUnit

- Pointer to the unit object

References cDDLRefUnit().

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	(	IDDLUnit *	poUnit,
		int const	nPower,
		cDDLPrefix *	poPrefix )

Creation method to fill the object with data.

Parameters

[in]	poUnit	- Pointer to the unit object
[in]	nPower	- Power of the new unit related to the base units
[in]	poPrefix	- Pointer to the prefix object

Return values

ERR_POINTER

Null-pointer committed

GetName()

const A_UTILS_NS::cString & GetName ( ) const

virtual

Getter for the name.

Returns

the name

Implements IDDL.

GetPower()

int GetPower

(

)

const

Getter for the power.

Returns

the power

GetPrefix()

A_UTILS_NS::cString GetPrefix

(

)

const

Getter for the prefix name.

Returns

the prefix name

GetPrefixObject()

cDDLPrefix * GetPrefixObject

(

)

const

Getter for the prefix object.

Returns

pointer to the prefix object

GetUnitObject()

IDDLUnit * GetUnitObject

(

)

const

Getter for the unit object.

Returns

pointer to the unit object

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.

SetPower()

void SetPower

(

int const

nPower

)

Setter for the power.

Parameters

nPower

the power

Returns

void

SetPrefixObject()

void SetPrefixObject

(

cDDLPrefix *const

pPrefix

)

Setter for the prefix object.

Parameters

pPrefix

pointer to the prefix object

Returns

void

SetUnitObject()

void SetUnitObject

(

IDDLUnit *const

pUnit

)

Setter for the unit object.

Parameters

pUnit

the unit object to set

Returns

void

Member Data Documentation

m_bInitFlag

bool m_bInitFlag

private

Definition at line 112 of file ddlrefunit.h.

m_nPower

int m_nPower

private

Definition at line 110 of file ddlrefunit.h.

m_poPrefix

cDDLPrefix* m_poPrefix

private

Definition at line 111 of file ddlrefunit.h.

m_poUnit

IDDLUnit* m_poUnit

private

Definition at line 109 of file ddlrefunit.h.