ADTF  3.18.2
IDDLabstract

Interface class for object representation of DDL descriptions. More...

Inheritance diagram for IDDL:
[legend]

Public Types

enum  tag_MergeFlags { DDLMERGE_ForceOverwrite = 0x01 }
 Flags for Merging.
 

Public Member Functions

virtual ~IDDL ()
 Virtual DTOR.
 
virtual tResult Accept (IDDLVisitor *poVisitor)=0
 Acceptance method for Visitor design-pattern. More...
 
virtual bool IsInitialized () const =0
 Getter for the initialization flag. More...
 
virtual const A_UTILS_NS::cStringGetName () const =0
 Getter for the name of the representation object. More...
 
virtual bool IsPredefined () const =0
 Getter for the predefinition flag. More...
 
virtual bool IsOverwriteable () const =0
 Getter for the predefinition flag. More...
 
virtual int GetCreationLevel () const =0
 Getter for the creation level. More...
 

Detailed Description

Interface class for object representation of DDL descriptions.

E.g. it provides the Accept() method for the Visitor design-pattern.

Definition at line 24 of file ddl_intf.h.

Member Function Documentation

◆ Accept()

virtual tResult Accept ( IDDLVisitor poVisitor)
pure virtual

Acceptance method for Visitor design-pattern.

Parameters
[in]poVisitor- Pointer to Visitor instance
Return values
ERR_POINTERNull-pointer committed
ERR_NOT_FOUNDRequired node not found.
ERR_NOT_INITIALIZEDThe object was not or not correctly initialized

Implemented in cDDLUnit, cDDLStreamStruct, cDDLStreamMetaType, cDDLStream, cDDLRefUnit, cDDLProperty, cDDLPrefix, cDDLHeader, cDDLExtDeclaration, cDDLEnum, cDDLDescription, cDDLDataType, cDDLComplex, and cDDLBaseunit.

◆ GetCreationLevel()

virtual int GetCreationLevel ( ) const
pure virtual

Getter for the creation level.

Returns
the level at creation time of this representation object

Implemented in cDDLUnit, cDDLStreamMetaType, cDDLStream, cDDLProperty, cDDLPrefix, cDDLEnum, cDDLDataType, cDDLComplex, cDDLBaseunit, and cDDL.

◆ GetName()

virtual const A_UTILS_NS::cString& GetName ( ) const
pure virtual

Getter for the name of the representation object.

Returns
the name

Implemented in cDDLUnit, cDDLStreamStruct, cDDLStreamMetaType, cDDLStream, cDDLRefUnit, cDDLProperty, cDDLPrefix, cDDLHeader, cDDLExtDeclaration, cDDLEnum, cDDLDescription, cDDLDataType, cDDLComplex, and cDDLBaseunit.

◆ IsInitialized()

virtual bool IsInitialized ( ) const
pure virtual

Getter for the initialization flag.

Return values
trueThe object was initialized correctly
falseThe object was not or not correctly initialized

Implemented in cDDLUnit, cDDLStreamStruct, cDDLStreamMetaType, cDDLStream, cDDLRefUnit, cDDLProperty, cDDLPrefix, cDDLHeader, cDDLExtDeclaration, cDDLEnum, cDDLDescription, cDDLDataType, cDDLComplex, cDDLBaseunit, and cDDL.

◆ IsOverwriteable()

virtual bool IsOverwriteable ( ) const
pure virtual

Getter for the predefinition flag.

Return values
trueThe object was predefined
falseThe object was defined later

Implemented in cDDLUnit, cDDLEnum, cDDLDataType, cDDLComplex, cDDLBaseunit, and cDDL.

◆ IsPredefined()

virtual bool IsPredefined ( ) const
pure virtual

Getter for the predefinition flag.

Return values
trueThe object was predefined
falseThe object was defined later

Implemented in cDDLUnit, cDDLPrefix, cDDLEnum, cDDLDataType, cDDLComplex, cDDLBaseunit, and cDDL.