Safir::Dob::Typesystem::ToolSupport::CreateRoutineDescription Class Reference

Description of a create routine. More...

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

Public Member Functions
virtual	~CreateRoutineDescription ()=default
	Destructor.
virtual const char *	Summary () const =0
	Get a summary about this create routine.
virtual const char *	GetName () const =0
	Get create routine name.
virtual int	GetNumberOfInParameters () const =0
	Get the number of in parameters for this create routine.
virtual const MemberDescription *	GetInParameterMember (int index) const =0
	Get member description for an in parameter.
virtual int	GetNumberOfDefaultValues () const =0
	Get number of default values that this create routine will set.
virtual const MemberDescription *	GetDefaultValueMember (int index) const =0
	Get member description for a default value.
virtual std::pair< const ParameterDescription *, int >	GetDefaultValue (int index) const =0
	Get parameter description for a default value.

Detailed Description

Description of a create routine.

Constructor & Destructor Documentation

~CreateRoutineDescription()

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

virtualdefault

Destructor.

Member Function Documentation

GetDefaultValue()

virtual std::pair< const ParameterDescription *, int > Safir::Dob::Typesystem::ToolSupport::CreateRoutineDescription::GetDefaultValue ( int index ) const

pure virtual

Get parameter description for a default value.

Parameters

index

[in] - Index of default value. Valid 0 to GetNumberOfDefaultValues()-1.

Returns

Pair containing a parameter description and an array index.

GetDefaultValueMember()

virtual const MemberDescription * Safir::Dob::Typesystem::ToolSupport::CreateRoutineDescription::GetDefaultValueMember ( int index ) const

pure virtual

Get member description for a default value.

Parameters

index

[in] - Index of default value. Valid 0 to GetNumberOfDefaultValues()-1.

Returns

Member description.

GetInParameterMember()

virtual const MemberDescription * Safir::Dob::Typesystem::ToolSupport::CreateRoutineDescription::GetInParameterMember ( int index ) const

pure virtual

Get member description for an in parameter.

Parameters

index

[in] - Index of in parameter. Valid 0 to GetNumberOfInParameters()-1.

Returns

Member description.

GetName()

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

pure virtual

Get create routine name.

Returns

Create routine name.

GetNumberOfDefaultValues()

virtual int Safir::Dob::Typesystem::ToolSupport::CreateRoutineDescription::GetNumberOfDefaultValues ( ) const

pure virtual

Get number of default values that this create routine will set.

Returns

Number of default values.

GetNumberOfInParameters()

virtual int Safir::Dob::Typesystem::ToolSupport::CreateRoutineDescription::GetNumberOfInParameters ( ) const

pure virtual

Get the number of in parameters for this create routine.

Returns

Number of in parameters.

Summary()

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

pure virtual

Get a summary about this create routine.

Returns

Summary.