cDDLStreamMetaType

Representation of a stream inside a DDL description. More...

Inheritance diagram for cDDLStreamMetaType:

Public Member Functions
	cDDLStreamMetaType ()=default
	Default CTOR.
	cDDLStreamMetaType (const A_UTILS_NS::cString &strName, const A_UTILS_NS::cString &strVersion, tDDLPropertyVec &&vecProperties=tDDLPropertyVec(), const cDDLStreamMetaType *pParent=nullptr)
	CTOR. More...
	cDDLStreamMetaType (const cDDLStreamMetaType &oStreamMetaType)
	cDDLStreamMetaType (cDDLStreamMetaType &&oStreamMetaType)=default
cDDLStreamMetaType &	operator= (cDDLStreamMetaType &&oStreamMetaType)=default
tResult	Accept (IDDLVisitor *poVisitor)
	Acceptance method for Visitor design-pattern. More...
bool	IsInitialized () const
	Getter for the initialization flag. More...
int	GetCreationLevel () const
	Getter for the creation level. More...
const A_UTILS_NS::cString &	GetName () const
	Getter for the name. More...
void	SetName (const A_UTILS_NS::cString &strName)
	Setter for the name. More...
const A_UTILS_NS::cString &	GetVersion () const
	Getter for the version. More...
void	CloneProperties (const tDDLPropertyVec &vecStructs)
	Setter for the contained structs. More...
tDDLPropertyVec &	GetProperties ()
	Getter for the contained properties. More...
const tDDLPropertyVec &	GetProperties () const
	Getter for the contained properties. More...
const cDDLStreamMetaType *	GetParentObject () const
	Pointer to the parent stream meta type. More...
const A_UTILS_NS::cString &	GetParent () const
	Getter for the name of the parent. More...
Public Member Functions inherited from cDDL
virtual	~cDDL ()
	DTOR.
virtual bool	IsPredefined () const
	Getter for the predefinition flag. More...
virtual bool	IsOverwriteable () const
	Getter for the predefinition flag. More...
Public Member Functions inherited from IDDL
virtual	~IDDL ()
	Virtual DTOR.

Private Attributes
A_UTILS_NS::cString	m_strName
A_UTILS_NS::cString	m_strVersion
tDDLPropertyVec	m_vecProperties
const cDDLStreamMetaType *	m_pParent = nullptr
bool	m_bInitFlag = false

Additional Inherited Members
Public Types inherited from IDDL
enum	tag_MergeFlags { DDLMERGE_ForceOverwrite = 0x01 }
	Flags for Merging.
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. More...
template<typename T >
static tResult	MoveChild (T *pvObj, const int nFrom, const int nTo)
	Method moves element within the list. More...
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. More...
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. More...
static bool	IsEqual (IDDL *poLHS, IDDL *poRHS)
	Predicate to compare 2 DDL representation objects (for use with std::unique()). More...
static bool	IsSorted (IDDL *poLHS, IDDL *poRHS)
	Sort predicate to compare to 2 DDL representation objects (for use with std::sort()). More...

Detailed Description

Representation of a stream inside a DDL description.

Definition at line 17 of file ddlstreammetatype.h.

Constructor & Destructor Documentation

cDDLStreamMetaType()

cDDLStreamMetaType	(	const A_UTILS_NS::cString &	strName,
		const A_UTILS_NS::cString &	strVersion,
		tDDLPropertyVec &&	vecProperties = tDDLPropertyVec(),
		const cDDLStreamMetaType *	pParent = nullptr
	)

CTOR.

Parameters

[in]	strName	- Name of the stream meta type
[in]	strVersion	- Version of the stream meta type
[in]	vecProperties	- The properties.
[in]	pParent	- the stream meta type parent (optional)

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.

CloneProperties()

void CloneProperties

(

const tDDLPropertyVec &

vecStructs

)

Setter for the contained structs.

Parameters

[in]

vecStructs

- Vector of structures (complex data types)

Returns

void

GetCreationLevel()

int GetCreationLevel ( ) const

virtual

Getter for the creation level.

Returns

the level at creation time of this representation object

Reimplemented from cDDL.

GetName()

const A_UTILS_NS::cString& GetName ( ) const

virtual

Getter for the name.

Returns

the name

Implements IDDL.

GetParent()

const A_UTILS_NS::cString& GetParent

(

)

const

Getter for the name of the parent.

Returns

The name of the parent.

GetParentObject()

const cDDLStreamMetaType* GetParentObject

(

)

const

Pointer to the parent stream meta type.

Returns

Pointer to the parent stream meta type.

GetProperties() [1/2]

tDDLPropertyVec& GetProperties

(

)

Getter for the contained properties.

Returns

the vector of properties

GetProperties() [2/2]

const tDDLPropertyVec& GetProperties

(

)

const

Getter for the contained properties.

Returns

the vector of properties

GetVersion()

const A_UTILS_NS::cString& GetVersion

(

)

const

Getter for the version.

Returns

the version

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.

SetName()

void SetName

(

const A_UTILS_NS::cString &

strName

)

Setter for the name.

Parameters

[in]

strName

- Name of the stream

Returns

void