This class provides legacy interface (type descriptor) to run-time type information (RTTI) for OCCT classes inheriting from Standard_Transient. More...

#include <Standard_Type.hxx>

Inheritance diagram for Standard_Type:

[legend]

Public Member Functions
Standard_CString	SystemName () const
	Returns the system type name of the class (typeinfo.name)

Standard_CString	Name () const
	Returns the given name of the class type (get_type_name)

Standard_Size	Size () const
	Returns the size of the class instance in bytes.

const Handle< Standard_Type > &	Parent () const
	Returns descriptor of the base class in the hierarchy.

Standard_Boolean	SubType (const Handle< Standard_Type > &theOther) const
	Returns True if this type is the same as theOther, or inherits from theOther. Note that multiple inheritance is not supported.

Standard_Boolean	SubType (const Standard_CString theOther) const
	Returns True if this type is the same as theOther, or inherits from theOther. Note that multiple inheritance is not supported.

void	Print (Standard_OStream &theStream) const
	Prints type (address of descriptor + name) to a stream.

	~Standard_Type ()
	Destructor removes the type from the registry.

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

Standard_Boolean	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Boolean	IsKind (const Standard_CString theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.

Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

virtual void	Delete () const
	Memory deallocator for transient classes.

Static Public Member Functions
template<class T >
static const Handle< Standard_Type > &	Instance ()
	Template function returning instance of the type descriptor for an argument class.

static Standard_Type *	Register (const std::type_info &theInfo, const char *theName, Standard_Size theSize, const Handle< Standard_Type > &theParent)
	Register a type; returns either new or existing descriptor.

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Detailed Description

This class provides legacy interface (type descriptor) to run-time type information (RTTI) for OCCT classes inheriting from Standard_Transient.

In addition to features provided by standard C++ RTTI (type_info), Standard_Type allows passing descriptor as an object and using it for analysis of the type:

get descriptor of a parent class
get user-defined name of the class
get size of the object

Use static template method Instance() to get descriptor for a given type. Objects supporting OCCT RTTI return their type descriptor by method DynamicType().

To be usable with OCCT type system, the class should provide:

typedef base_type to its base class in the hierarchy
method get_type_name() returning programmer-defined name of the class (as a statically allocated constant C string or string literal)

Note that user-defined name is used since typeid.name() is usually mangled in compiler-dependent way.

Only single chain of inheritance is supported, with a root base class Standard_Transient.

Constructor & Destructor Documentation

◆ ~Standard_Type()

Standard_Type::~Standard_Type ( )

Destructor removes the type from the registry.

Member Function Documentation

◆ Instance()

template<class T >

static const Handle< Standard_Type > & Standard_Type::Instance ( )

inlinestatic

Template function returning instance of the type descriptor for an argument class.

For optimization, each type is registered only once (due to use of the static variable).

See helper macro DEFINE_STANDARD_RTTI for defining these items in the class.

◆ Name()

Standard_CString Standard_Type::Name ( ) const

inline

Returns the given name of the class type (get_type_name)

◆ Parent()

const Handle< Standard_Type > & Standard_Type::Parent ( ) const

inline

Returns descriptor of the base class in the hierarchy.

◆ Print()

void Standard_Type::Print ( Standard_OStream & theStream ) const

Prints type (address of descriptor + name) to a stream.

◆ Register()

static Standard_Type * Standard_Type::Register	(	const std::type_info &	theInfo,
		const char *	theName,
		Standard_Size	theSize,
		const Handle< Standard_Type > &	theParent
	)

static

Register a type; returns either new or existing descriptor.

Parameters

theInfo	object stores system name of the class
theName	name of the class to be stored in Name field
theSize	size of the class instance
theParent	base class in the Transient hierarchy

Note that this function is intended for use by opencascade::type_instance only.

◆ Size()

Standard_Size Standard_Type::Size ( ) const

inline

Returns the size of the class instance in bytes.

◆ SubType() [1/2]

Standard_Boolean Standard_Type::SubType ( const Handle< Standard_Type > & theOther ) const

Returns True if this type is the same as theOther, or inherits from theOther. Note that multiple inheritance is not supported.

◆ SubType() [2/2]

Standard_Boolean Standard_Type::SubType ( const Standard_CString theOther ) const

Returns True if this type is the same as theOther, or inherits from theOther. Note that multiple inheritance is not supported.

◆ SystemName()

Standard_CString Standard_Type::SystemName ( ) const

inline

Returns the system type name of the class (typeinfo.name)

The documentation for this class was generated from the following file:

Standard_Type.hxx

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~Standard_Type()

Member Function Documentation

◆ Instance()

◆ Name()

◆ Parent()

◆ Print()

◆ Register()

◆ Size()

◆ SubType() [1/2]

◆ SubType() [2/2]

◆ SystemName()