Description of a class type. More...

#include <Safir/Dob/Typesystem/ToolSupport/TypeRepository.h>

Public Member Functions
virtual	~ClassDescription ()=default
	Destructor.

virtual const char *	FileName () const =0
	Get dou file path as a string.

virtual const char *	Summary () const =0
	Get a summary about this class.

virtual DotsC_TypeId	GetTypeId () const =0
	Get the typeId of this class.

virtual const char *	GetName () const =0
	Get qualified name of the class type.

virtual const ClassDescription *	GetBaseClass () const =0
	Get the base class description of this class.

virtual int	GetNumberOfDescendants () const =0
	Get the number of classes that inherits from this class.

virtual const ClassDescription *	GetDescendant (int index) const =0
	Get descendant class.

virtual int	GetNumberOfMembers () const =0
	Get the total number of members contained by this class including inherited members.

virtual int	GetNumberOfOwnMembers () const =0
	Get the number of members defined by this class.

virtual int	GetNumberOfInheritedMembers () const =0
	Get the number of inherited members.

virtual DotsC_MemberIndex	GetMemberIndex (const std::string &memberName) const =0
	Get index of a named member.

virtual const MemberDescription *	GetMember (DotsC_MemberIndex index) const =0
	Get a member description.

virtual int	GetNumberOfParameters () const =0
	Get the total number of parameters contained by this class including inherited parameters.

virtual int	GetNumberOfOwnParameters () const =0
	Get the number of parameters defined by this class.

virtual int	GetNumberOfInheritedParameters () const =0
	Get the number of inherited parameters.

virtual const ParameterDescription *	GetParameter (DotsC_ParameterIndex index) const =0
	Get parameter description.

virtual void	GetPropertyIds (std::set< DotsC_TypeId > &propertyIds) const =0
	Get a set of all properties in this class.

virtual const PropertyMappingDescription *	GetPropertyMapping (DotsC_TypeId propertyTypeId, bool &isInherited) const =0
	Get property mapping description for a specific property that describes how it is mapped for this class.

virtual int	GetNumberOfCreateRoutines () const =0
	Get the number of create routines in this class.

virtual const CreateRoutineDescription *	GetCreateRoutine (int index) const =0
	Get a create routine description.

virtual DotsC_TypeId	GetChecksum () const =0
	Get checksum of this class.

Detailed Description

Description of a class type.

Constructor & Destructor Documentation

◆ ~ClassDescription()

virtual Safir::Dob::Typesystem::ToolSupport::ClassDescription::~ClassDescription ( )

virtualdefault

Destructor.

Member Function Documentation

◆ FileName()

virtual const char * Safir::Dob::Typesystem::ToolSupport::ClassDescription::FileName ( ) const

pure virtual

Get dou file path as a string.

Returns: Path to file.

◆ GetBaseClass()

virtual const ClassDescription * Safir::Dob::Typesystem::ToolSupport::ClassDescription::GetBaseClass ( ) const

pure virtual

Get the base class description of this class.

Returns: Base class description.

◆ GetChecksum()

virtual DotsC_TypeId Safir::Dob::Typesystem::ToolSupport::ClassDescription::GetChecksum ( ) const

pure virtual

Get checksum of this class.

Returns: Checksum.

◆ GetCreateRoutine()

virtual const CreateRoutineDescription * Safir::Dob::Typesystem::ToolSupport::ClassDescription::GetCreateRoutine ( int index ) const

pure virtual

Get a create routine description.

Parameters

index [in] - Index of the requested create routine. Valid values are 0 to GetNumberOfCreateRoutines()-1

Returns

◆ GetDescendant()

virtual const ClassDescription * Safir::Dob::Typesystem::ToolSupport::ClassDescription::GetDescendant ( int index ) const

pure virtual

Get descendant class.

Parameters

index [in] - Index of descendant class. Valid range is 0 to GetNumberOfDescendants()-1.

Returns: Descendant class description.

◆ GetMember()

virtual const MemberDescription * Safir::Dob::Typesystem::ToolSupport::ClassDescription::GetMember ( DotsC_MemberIndex index ) const

pure virtual

Get a member description.

Parameters

index [in] - Index of the requested member. Valid values are 0 to GetNumberOfMembers()-1

Returns: Member description.

◆ GetMemberIndex()

virtual DotsC_MemberIndex Safir::Dob::Typesystem::ToolSupport::ClassDescription::GetMemberIndex ( const std::string & memberName ) const

pure virtual

Get index of a named member.

Parameters

memberName [in] - Name of the member.

Returns: Index of the member with the given name. Returns -1 if no such member exists.

◆ GetName()

virtual const char * Safir::Dob::Typesystem::ToolSupport::ClassDescription::GetName ( ) const

pure virtual

Get qualified name of the class type.

Returns: Type name.

◆ GetNumberOfCreateRoutines()

virtual int Safir::Dob::Typesystem::ToolSupport::ClassDescription::GetNumberOfCreateRoutines ( ) const

pure virtual

Get the number of create routines in this class.

Returns: Number of create routines.

◆ GetNumberOfDescendants()

virtual int Safir::Dob::Typesystem::ToolSupport::ClassDescription::GetNumberOfDescendants ( ) const

pure virtual

Get the number of classes that inherits from this class.

Returns: Number of descendant classes.

◆ GetNumberOfInheritedMembers()

virtual int Safir::Dob::Typesystem::ToolSupport::ClassDescription::GetNumberOfInheritedMembers ( ) const

pure virtual

Get the number of inherited members.

Members defined by this class itself are not included.

Returns: Number inherited members.

◆ GetNumberOfInheritedParameters()

virtual int Safir::Dob::Typesystem::ToolSupport::ClassDescription::GetNumberOfInheritedParameters ( ) const

pure virtual

Get the number of inherited parameters.

Parameters defined by this class itself are not included.

Returns: Number inherited parameters.

◆ GetNumberOfMembers()

virtual int Safir::Dob::Typesystem::ToolSupport::ClassDescription::GetNumberOfMembers ( ) const

pure virtual

Get the total number of members contained by this class including inherited members.

Returns: Number of members.

◆ GetNumberOfOwnMembers()

virtual int Safir::Dob::Typesystem::ToolSupport::ClassDescription::GetNumberOfOwnMembers ( ) const

pure virtual

Get the number of members defined by this class.

Inherited members are not included.

Returns: Number non inherited members.

◆ GetNumberOfOwnParameters()

virtual int Safir::Dob::Typesystem::ToolSupport::ClassDescription::GetNumberOfOwnParameters ( ) const

pure virtual

Get the number of parameters defined by this class.

Inherited parameters are not included.

Returns: Number non inherited parameters.

◆ GetNumberOfParameters()

virtual int Safir::Dob::Typesystem::ToolSupport::ClassDescription::GetNumberOfParameters ( ) const

pure virtual

Get the total number of parameters contained by this class including inherited parameters.

Returns: Number of parameters.

◆ GetParameter()

virtual const ParameterDescription * Safir::Dob::Typesystem::ToolSupport::ClassDescription::GetParameter ( DotsC_ParameterIndex index ) const

pure virtual

Get parameter description.

Parameters

index [in] - Index of the requested parameter. Valid values are 0 to GetNumberOfParameters()-1

Returns

◆ GetPropertyIds()

virtual void Safir::Dob::Typesystem::ToolSupport::ClassDescription::GetPropertyIds ( std::set< DotsC_TypeId > & propertyIds ) const

pure virtual

Get a set of all properties in this class.

Parameters

propertyIds [out] - Set of typeIds

◆ GetPropertyMapping()

virtual const PropertyMappingDescription * Safir::Dob::Typesystem::ToolSupport::ClassDescription::GetPropertyMapping	(	DotsC_TypeId	propertyTypeId,
		bool &	isInherited ) const

pure virtual

Get property mapping description for a specific property that describes how it is mapped for this class.

Parameters

propertyTypeId	[in] - TypeId of the property.
isInherited	[out] - Boolean value indicating if the property is inherited or not.

Returns: Property mapping description.

◆ GetTypeId()

virtual DotsC_TypeId Safir::Dob::Typesystem::ToolSupport::ClassDescription::GetTypeId ( ) const

pure virtual

Get the typeId of this class.

Returns: TypeId.

◆ Summary()

virtual const char * Safir::Dob::Typesystem::ToolSupport::ClassDescription::Summary ( ) const

pure virtual

Get a summary about this class.

Returns: Summary.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~ClassDescription()

Member Function Documentation

◆ FileName()

◆ GetBaseClass()

◆ GetChecksum()

◆ GetCreateRoutine()

◆ GetDescendant()

◆ GetMember()

◆ GetMemberIndex()

◆ GetName()

◆ GetNumberOfCreateRoutines()

◆ GetNumberOfDescendants()

◆ GetNumberOfInheritedMembers()

◆ GetNumberOfInheritedParameters()

◆ GetNumberOfMembers()

◆ GetNumberOfOwnMembers()

◆ GetNumberOfOwnParameters()

◆ GetNumberOfParameters()

◆ GetParameter()

◆ GetPropertyIds()

◆ GetPropertyMapping()

◆ GetTypeId()

◆ Summary()