Class CModuleEntity

• Defined in File module_entity.h

Inheritance Relationships

Base Type

• public CDefinitionEntity (Class CDefinitionEntity)

Derived Type

• public CRootEntity (Class CRootEntity)

Class Documentation

class CModuleEntity : public CDefinitionEntity

The module definition of an IDL file.

The module section of the IDL file contains multiple definitions of nested modules, const definitions and type definitions.

Subclassed by CRootEntity

Public Functions

CModuleEntity(const CContextPtr &rptrContext, CEntityPtr ptrParent)

Default constructor.

Parameters:

• rptrContext – [in] Reference to the smart pointer holding the parse context. Must not be NULL.

• ptrParent – [in] Pointer to the parent class holding this entity. This must not be NULL.

virtual ~CModuleEntity() override = default

Destructor.

inline virtual sdv::idl::EEntityType GetType() const override

Get the type of the entity. Overload of CEntity::GetType.

Returns:

Returns the module entity type.

virtual void Process() override

Process the code. Overload of CEntity::Process.

virtual bool Supports(EDefinitionSupport eSupport) const override

Request whether the definition supports the content. Overload of CDefintionEntity::Supports.

Parameters:

eSupport – [in] The type of support that is requested.

Returns:

Returns ‘true’ when the definition supports the content; ‘false’ otherwise.

inline virtual bool IsRootEntity() const override

Is this definition a root entity? Overload of CDefinitionEntity::IsRootEntity.

The root entity is not expecting curly brackets ‘{…}’.

Returns:

Returns whether this is a root entity (which is not the case).

virtual bool IsExtendable() const override

Is the entity extendable? Overload of CEntity::IsExtendable.

Allow extendability of the module entity.

Returns:

Returns whether the entity is extendable.

virtual bool SupportsChildren() const override

Does the entity support children? Overload of CEntity::SupportsChildren.

The module supports children.

Returns:

Return whether the entity support children.

Protected Functions

CModuleEntity(CParser &rParser, const CContextPtr &rptrContext)

Root entity constructor (name is ‘root’ and no parent).

Parameters:

• rParser – [in] Reference to the parser.

• rptrContext – [in] Reference to the smart pointer holding the parse context. Must not be NULL.