Safir::Dob::Typesystem::ToolSupport::PropertyDescription Class Reference

Description of a property type. More...

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

Public Member Functions
virtual	~PropertyDescription ()=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 property.
virtual DotsC_TypeId	GetTypeId () const =0
	Get the typeId of this property.
virtual const char *	GetName () const =0
	Get qualified name of the property type.
virtual int	GetNumberOfMembers () const =0
	Get the number of members contained by this property.
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.

Detailed Description

Description of a property type.

Constructor & Destructor Documentation

~PropertyDescription()

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

virtualdefault

Destructor.

Member Function Documentation

FileName()

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

pure virtual

Get dou file path as a string.

Returns

Path to file.

GetMember()

virtual const MemberDescription * Safir::Dob::Typesystem::ToolSupport::PropertyDescription::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::PropertyDescription::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::PropertyDescription::GetName ( ) const

pure virtual

Get qualified name of the property type.

Returns

Type name.

GetNumberOfMembers()

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

pure virtual

Get the number of members contained by this property.

Returns

Number of members.

GetTypeId()

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

pure virtual

Get the typeId of this property.

Returns

TypeId.

Summary()

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

pure virtual

Get a summary about this property.

Returns

Summary.