ADTF  3.18.2
cDDLCloner

Implementation of IDDLFactorMethod for cloning of DDL representations. More...

Inheritance diagram for cDDLCloner:
[legend]

Public Member Functions

 cDDLCloner ()
 Default CTOR.
 
cDDLDescriptionGetDDL () const
 Getter for the DDL object. More...
 
tResult CreateNew (double fVersion=0)
 Method to build up a new DDL hierarchy. More...
 
void DestroyDDL ()
 Method to destroy the DDL object and all contained objects.
 
tResult BuildHeader ()
 Method to build a header object. More...
 
tResult BuildUnits ()
 Method to build a units object hierarchy. More...
 
tResult BuildDatatypes ()
 Method to build a datatypes object hierarchy. More...
 
tResult BuildEnums ()
 Method to build a enums object hierarchy. More...
 
tResult BuildStructs ()
 Method to build a structs object hierarchy. More...
 
tResult BuildStreams ()
 Method to build a streams object hierarchy. More...
 
tResult BuildStreamMetaTypes ()
 Method to build a streams object hierarchy. More...
 
tResult SetOriginal (const cDDLDescription *poOriginal)
 Setter method for the original DDL object. More...
 
- Public Member Functions inherited from IDDLFactoryMethod
virtual ~IDDLFactoryMethod ()
 DTOR.
 

Private Attributes

cDDLDescriptionm_poDDL
 
const cDDLDescriptionm_poOriginal
 

Detailed Description

Implementation of IDDLFactorMethod for cloning of DDL representations.

Definition at line 15 of file ddlcloner.h.

Member Function Documentation

◆ BuildDatatypes()

tResult BuildDatatypes ( )
virtual

Method to build a datatypes object hierarchy.

Return values
ERR_UNKNOWN_FORMATExpected XML hierarchy not found
ERR_NO_CLASSCross reference not resolvable (e.g. unit)

Implements IDDLFactoryMethod.

◆ BuildEnums()

tResult BuildEnums ( )
virtual

Method to build a enums object hierarchy.

Return values
ERR_UNKNOWN_FORMATExpected XML hierarchy not found
ERR_NO_CLASSCross reference not resolvable (e.g. RefEnums)
ERR_UNKNOWNNot all firstly unknown structs have been resolved

Implements IDDLFactoryMethod.

◆ BuildHeader()

tResult BuildHeader ( )
virtual

Method to build a header object.

Return values
ERR_UNKNOWN_FORMATExpected XML hierarchy not found

Implements IDDLFactoryMethod.

◆ BuildStreamMetaTypes()

tResult BuildStreamMetaTypes ( )
virtual

Method to build a streams object hierarchy.

Return values
ERR_UNKNOWN_FORMATExpected XML hierarchy not found
ERR_NO_CLASSCross reference not resolvable (e.g. struct)

Implements IDDLFactoryMethod.

◆ BuildStreams()

tResult BuildStreams ( )
virtual

Method to build a streams object hierarchy.

Return values
ERR_UNKNOWN_FORMATExpected XML hierarchy not found
ERR_NO_CLASSCross reference not resolvable (e.g. struct)

Implements IDDLFactoryMethod.

◆ BuildStructs()

tResult BuildStructs ( )
virtual

Method to build a structs object hierarchy.

Return values
ERR_UNKNOWN_FORMATExpected XML hierarchy not found
ERR_NO_CLASSCross reference not resolvable (e.g. datatype)
ERR_UNKNOWNNot all firstly unknown structs have been resolved

Implements IDDLFactoryMethod.

◆ BuildUnits()

tResult BuildUnits ( )
virtual

Method to build a units object hierarchy.

Return values
ERR_UNKNOWN_FORMATExpected XML hierarchy not found
ERR_NO_CLASSCross reference not resolvable (e.g. refUnit)
ERR_UNKNOWNNot all firstly unknown units have been resolved

Implements IDDLFactoryMethod.

◆ CreateNew()

tResult CreateNew ( double  fVersion = 0)
virtual

Method to build up a new DDL hierarchy.

Parameters
[in]fVersionThe version of the DDL hierarchy to be created. 0 Means newest version.
Return values
ERR_NOT_INITIALIZEDNot yet initialized (see setter methods in concrete classes, e.g. cDDLImporter::SetFile())
ERR_UNKNOWN_FORMATExpected XML hierarchy not found
ERR_NO_CLASSCross reference not resolvable (e.g. refUnit)
ERR_UNKNOWNCross reference has not been resolved
ERR_NOT_FOUNDAt least one mandatory element (e.g. header) was not found.

Implements IDDLFactoryMethod.

◆ GetDDL()

cDDLDescription* GetDDL ( ) const
virtual

Getter for the DDL object.

Returns
the DDL object
Attention
The caller/user has the responsibility for the created DDL object! Especially take this aspect into consideration in matters of the deallocation of memory!

Implements IDDLFactoryMethod.

◆ SetOriginal()

tResult SetOriginal ( const cDDLDescription poOriginal)

Setter method for the original DDL object.

Parameters
[in]poOriginal- Pointer to the DDL object
Return values
ERR_POINTERNull-pointer committed