Open CASCADE Technology  7.3.1.dev
Public Member Functions | Static Public Member Functions
Standard_Type Class Reference

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:
Inheritance graph
[legend]

Public Member Functions

Standard_CString SystemName () const
 Returns the system type name of the class (typeinfo.name) More...
 
Standard_CString Name () const
 Returns the given name of the class type (get_type_name) More...
 
Standard_Size Size () const
 Returns the size of the class instance in bytes. More...
 
const Handle< Standard_Type > & Parent () const
 Returns descriptor of the base class in the hierarchy. More...
 
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. More...
 
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. More...
 
void Print (Standard_OStream &theStream) const
 Prints type (address of descriptor + name) to a stream. More...
 
 ~Standard_Type ()
 Destructor removes the type from the registry. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
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. More...
 
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. More...
 
Standard_TransientThis () 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. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

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. More...
 
static Standard_TypeRegister (const char *theSystemName, const char *theName, Standard_Size theSize, const Handle< Standard_Type > &theParent)
 Register a type; returns either new or existing descriptor. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 

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:

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:

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 char *  theSystemName,
const char *  theName,
Standard_Size  theSize,
const Handle< Standard_Type > &  theParent 
)
static

Register a type; returns either new or existing descriptor.

Parameters
theSystemNamename of the class as returned by typeid(class).name()
theNamename of the class to be stored in Name field
theSizesize of the class instance
theParentbase 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: