Struct IEntityInfo#

Defined in File core_idl.h

Inheritance Relationships#

Derived Type#

public CEntity (Class CEntity)

Struct Documentation#

struct IEntityInfo#

Entity base information interface.

Subclassed by CEntity

Public Functions

virtual EEntityType GetType() const = 0#

Get the type of the entity. Default type is EEntityType::type_unknown.

Returns:: Returns the type of the entity.

virtual sdv::u8string GetName() const = 0#

Get the name of the entity.

Returns:: Returns the name string.

virtual sdv::u8string GetScopedName() const = 0#

Get the scoped name of the entity (including the modules separated by the scope separator).

The scoped name is composed of the entities of the parents separated by the scope operator ‘::’. For members of a compound entity (struct, union), the separation is done through the member operator ‘.’.

Returns:: The scoped name build from the entities of the parents separated by ‘::’. An empty name means global scope.

virtual bool ForwardDeclaration() const = 0#

Is the entity defined as (forward) declaration only?

Returns:: Returns ‘true’ when the entity is defined as forward declaration; otherwise returns ‘false’.

virtual uint64_t GetId() const = 0#

Get the entity ID. This ID is a hash value composed from its definition and all declarative members not including const values. The ID can be used to uniquely identify the entity (e.g. as interface ID or exception ID).

Returns:: The ID of the entity.

virtual IInterfaceAccess *GetParent() const = 0#

Get the parent entity of this entity.

Returns:: Returns an interface to the parent entity or NULL when this is the root parent (when there is no parent).

EEntityType GetType() const

Get the type of the entity. Default type is EEntityType::type_unknown.

Returns:: Returns the type of the entity.

u8string GetName() const

Get the name of the entity.

Returns:: Returns the name string.

u8string GetScopedName() const

Get the scoped name of the entity (including the modules separated by the scope separator).

The scoped name is composed of the entities of the parents separated by the scope operator ‘::’. For members of a compound entity (struct, union), the separation is done through the member operator ‘.’.

Returns:: The scoped name build from the entities of the parents separated by ‘::’. An empty name means global scope.

boolean ForwardDeclaration() const

Is the entity defined as (forward) declaration only?

Returns:: Returns ‘true’ when the entity is defined as forward declaration; otherwise returns ‘false’.

uint64 GetId() const