ADTF: cDDLStream

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

Inheritance diagram for cDDLStream:

Public Member Functions
	cDDLStream ()
	Default CTOR.

	cDDLStream (cDDLComplex *poType, const A_UTILS_NS::cString &strName=A_UTILS_NS::cString::Empty, const A_UTILS_NS::cString &strDescription=A_UTILS_NS::cString::Empty, tDDLStreamStructVec vecStructs=tDDLStreamStructVec(), int const nCreationLevel=4)
	CTOR. More...

	cDDLStream (cDDLStream &oStream)
	Copy CTOR. More...

virtual	~cDDLStream ()
	DTOR.

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...

tResult	Create (cDDLComplex *poType, const A_UTILS_NS::cString &strName=A_UTILS_NS::cString::Empty, const A_UTILS_NS::cString &strDescription=A_UTILS_NS::cString::Empty, tDDLStreamStructVec vecStructs=tDDLStreamStructVec(), int const nCreationLevel=4)
	Creation method to fill the object with data. More...

A_UTILS_NS::cString	GetType () const
	Getter for the name of the complex data type. More...

void	SetType (cDDLComplex *const pType)
	Setter for the object of the complex data type. More...

double	GetDDLVersion () const
	Getter for the DDL version. More...

tResult	SetDDLVersion (double const fLanguageVersion)
	Setter for the DDL version. More...

cDDLComplex *	GetTypeObject () const
	Getter for the complex data-type object. More...

void	SetName (const A_UTILS_NS::cString &strName)
	Setter for the name. More...

const A_UTILS_NS::cString &	GetName () const
	Getter for the name. More...

void	SetDescription (const A_UTILS_NS::cString &strDescription)
	Setter for the description. More...

A_UTILS_NS::cString	GetDescription () const
	Getter for the description. More...

void	CloneStructs (tDDLStreamStructVec vecStructs)
	Setter for the contained structs. More...

void	RefStructs (tDDLStreamStructVec vecStructs)
	Setter for the contained structs. More...

void	AddStruct (cDDLStreamStruct *poStruct)
	Adder for a struct. More...

tResult	RemoveStruct (const A_UTILS_NS::cString &strStructName)
	removal for a struct item. More...

tDDLStreamStructVec &	GetStructs ()
	Getter for the contained structs. More...

const tDDLStreamStructVec &	GetStructs () const
	Getter for the contained structs. 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

cDDLComplex *	m_poType

A_UTILS_NS::cString	m_strDescription

tDDLStreamStructVec	m_vecStructs

bool	m_bInitFlag

int	m_nLevel

double	m_fLanguageVersion

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 27 of file ddlstream.h.

Constructor & Destructor Documentation

◆ cDDLStream() [1/2]

cDDLStream	(	cDDLComplex *	poType,
		const A_UTILS_NS::cString &	strName = `A_UTILS_NS::cString::Empty`,
		const A_UTILS_NS::cString &	strDescription = `A_UTILS_NS::cString::Empty`,
		tDDLStreamStructVec	vecStructs = `tDDLStreamStructVec()`,
		int const	nCreationLevel = `4`
	)

CTOR.

Parameters

[in]	poType	- Pointer to complex datatype object
[in]	strName	- Name of the stream (optional)
[in]	strDescription	- Description (optional)
[in]	vecStructs	- Vector of `cDDLStreamStruct` objects (optional)
[in]	nCreationLevel	- Level at creation time (optional)

◆ cDDLStream() [2/2]

cDDLStream ( cDDLStream & oStream )

Copy CTOR.

Parameters

[in] oStream - Reference to stream object to copy

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.

◆ AddStruct()

void AddStruct ( cDDLStreamStruct * poStruct )

Adder for a struct.

Parameters

[in] poStruct - Pointer to the struct object to add

Returns: void

◆ CloneStructs()

void CloneStructs ( tDDLStreamStructVec vecStructs )

Setter for the contained structs.

Parameters

[in] vecStructs - Vector of structures (complex data types)

Returns: void

◆ Create()

tResult Create	(	cDDLComplex *	poType,
		const A_UTILS_NS::cString &	strName = `A_UTILS_NS::cString::Empty`,
		const A_UTILS_NS::cString &	strDescription = `A_UTILS_NS::cString::Empty`,
		tDDLStreamStructVec	vecStructs = `tDDLStreamStructVec()`,
		int const	nCreationLevel = `4`
	)

Creation method to fill the object with data.

Parameters

[in]	poType	- Pointer to complex datatype object
[in]	strName	- Name of the stream (optional)
[in]	strDescription	- Description (optional)
[in]	vecStructs	- Vector of `cDDLStreamStruct` objects (optional)
[in]	nCreationLevel	- Level at creation time (optional)

Return values

ERR_POINTER Null-pointer committed

◆ GetCreationLevel()

int GetCreationLevel ( ) const

virtual

Getter for the creation level.

Returns: the level at creation time of this representation object

Reimplemented from cDDL.

◆ GetDDLVersion()

double GetDDLVersion ( ) const

Getter for the DDL version.

Returns: the DDL version

◆ GetDescription()

A_UTILS_NS::cString GetDescription ( ) const

Getter for the description.

Returns: the description

◆ GetName()

const A_UTILS_NS::cString& GetName ( ) const

virtual

Getter for the name.

Returns: the name

Implements IDDL.

◆ GetStructs() [1/2]

tDDLStreamStructVec& GetStructs ( )

Getter for the contained structs.

Returns: the vector of structs

◆ GetStructs() [2/2]

const tDDLStreamStructVec& GetStructs ( ) const

Getter for the contained structs.

Returns: the vector of structs

◆ GetType()

A_UTILS_NS::cString GetType ( ) const

Getter for the name of the complex data type.

Returns: name of the complex data type

◆ GetTypeObject()

cDDLComplex* GetTypeObject ( ) const

Getter for the complex data-type object.

Returns: pointer to the complex data-type 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.

◆ RefStructs()

void RefStructs ( tDDLStreamStructVec vecStructs )

Setter for the contained structs.

Parameters

[in] vecStructs - Vector of structures (complex data types)

Returns: void

◆ RemoveStruct()

tResult RemoveStruct ( const A_UTILS_NS::cString & strStructName )

removal for a struct item.

Parameters

[in] strStructName - name of struct object to remove

Return values

ERR_NOT_FOUND if not exists

◆ SetDDLVersion()

tResult SetDDLVersion ( double const fLanguageVersion )

Setter for the DDL version.

Parameters

fLanguageVersion the DDL version to set

Returns: Standard result code.

Return values

ERR_NOERROR

◆ SetDescription()

void SetDescription ( const A_UTILS_NS::cString & strDescription )

Setter for the description.

Parameters

[in] strDescription - Description of the stream

Returns: void

◆ SetName()

void SetName ( const A_UTILS_NS::cString & strName )

Setter for the name.

Parameters

[in] strName - Name of the stream

Returns: void

◆ SetType()

void SetType ( cDDLComplex *const pType )

Setter for the object of the complex data type.

Parameters

[in] pType - the type object referencing to

Returns: void

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ cDDLStream() [1/2]

◆ cDDLStream() [2/2]

Member Function Documentation

◆ Accept()

◆ AddStruct()

◆ CloneStructs()

◆ Create()

◆ GetCreationLevel()

◆ GetDDLVersion()

◆ GetDescription()

◆ GetName()

◆ GetStructs() [1/2]

◆ GetStructs() [2/2]

◆ GetType()

◆ GetTypeObject()

◆ IsInitialized()

◆ RefStructs()

◆ RemoveStruct()

◆ SetDDLVersion()

◆ SetDescription()

◆ SetName()

◆ SetType()