Safir::Dob::Typesystem::ToolSupport::MemberDescription Class Reference

Description of a member. More...

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

Public Member Functions
virtual	~MemberDescription ()=default
	Destructor.
virtual const char *	Summary () const =0
	Get a summary about this member.
virtual DotsC_TypeId	GetTypeId () const =0
	If this member has MemberType Enumeration or Object, the specific typeId of that type can be retrieved by this method.
virtual const char *	GetName () const =0
	Get member name.
virtual DotsC_MemberType	GetMemberType () const =0
	Get type of this member.
virtual DotsC_CollectionType	GetCollectionType () const =0
	Get the collection type of this member.
virtual DotsC_MemberType	GetKeyType () const =0
	Get key type of this member.
virtual DotsC_TypeId	GetKeyTypeId () const =0
	If this member has CollectionType Dictionary and KeyType Enumeration, the specific typeId of that enumeration can be retrieved by this method.
virtual int	GetArraySize () const =0
	Get the array size of this member.
virtual int	GetMaxLength () const =0
	If member type is String this method returns the maximum allowed string length.

Detailed Description

Description of a member.

Constructor & Destructor Documentation

~MemberDescription()

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

virtualdefault

Destructor.

Member Function Documentation

GetArraySize()

virtual int Safir::Dob::Typesystem::ToolSupport::MemberDescription::GetArraySize ( ) const

pure virtual

Get the array size of this member.

Returns

Array size. If member is not an array, 1 is returned. Use GetCollectionType() method to determine if member is an array.

GetCollectionType()

virtual DotsC_CollectionType Safir::Dob::Typesystem::ToolSupport::MemberDescription::GetCollectionType ( ) const

pure virtual

Get the collection type of this member.

Returns

Collection type.

GetKeyType()

virtual DotsC_MemberType Safir::Dob::Typesystem::ToolSupport::MemberDescription::GetKeyType ( ) const

pure virtual

Get key type of this member.

Only valid if CollectionType=DictionaryCollectionType, use GetCollectionType() method.

Returns

Key member type.

GetKeyTypeId()

virtual DotsC_TypeId Safir::Dob::Typesystem::ToolSupport::MemberDescription::GetKeyTypeId ( ) const

pure virtual

If this member has CollectionType Dictionary and KeyType Enumeration, the specific typeId of that enumeration can be retrieved by this method.

If KeyType is not Enum the result of this method is undefined. Hence always use this in conjunction with GetKeyType().

Returns

TypeId of the enumeration type that is key type for this dictionary member.

GetMaxLength()

virtual int Safir::Dob::Typesystem::ToolSupport::MemberDescription::GetMaxLength ( ) const

pure virtual

If member type is String this method returns the maximum allowed string length.

If MemberType is not String the result of this method is undefined. Hence always use this in conjunction with GetMemberType().

Returns

Max string length.

GetMemberType()

virtual DotsC_MemberType Safir::Dob::Typesystem::ToolSupport::MemberDescription::GetMemberType ( ) const

pure virtual

Get type of this member.

If member type is Enumeration or Object, use GetTypeId() to determine specific type.

Returns

Parameter value member type.

GetName()

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

pure virtual

Get member name.

Returns

Member name.

GetTypeId()

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

pure virtual

If this member has MemberType Enumeration or Object, the specific typeId of that type can be retrieved by this method.

If MemberType is not Enum or Object the result of this method is undefined. Hence always use this in conjunction with GetMemberType().

Returns

TypeId of this member. Must always be a class or enumeration typeId.

Summary()

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

pure virtual

Get a summary about this member.

Returns

Summary.