IDDL

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

#include <ddl_intf.h>

Inheritance diagram for IDDL:

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

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

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 Enumeration Documentation

tag_MergeFlags

enum tag_MergeFlags

Flags for Merging.

Definition at line 79 of file ddl_intf.h.

Constructor & Destructor Documentation

~IDDL()

virtual ~IDDL ( )

inlinevirtual

Virtual DTOR.

Definition at line 30 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_POINTER	Null-pointer committed
ERR_NOT_FOUND	Required node not found.
ERR_NOT_INITIALIZED	The object was not or not correctly initialized

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

GetCreationLevel()

virtual int GetCreationLevel ( ) const

pure virtual

Getter for the creation level.

Returns

the level at creation time of this representation object

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

GetName()

virtual const A_UTILS_NS::cString & GetName ( ) const

pure virtual

Getter for the name of the representation object.

Returns

the name

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

IsInitialized()

virtual bool IsInitialized ( ) const

pure virtual

Getter for the initialization flag.

Return values

true	The object was initialized correctly
false	The object was not or not correctly initialized

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

IsOverwriteable()

virtual bool IsOverwriteable ( ) const

pure virtual

Getter for the predefinition flag.

Return values

true	The object was predefined
false	The object was defined later

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

IsPredefined()

virtual bool IsPredefined ( ) const

pure virtual

Getter for the predefinition flag.

Return values

true	The object was predefined
false	The object was defined later

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