Standard_Transient Class Reference

Abstract class which forms the root of the entire Transient class hierarchy. More...

#include <Standard_Transient.hxx>

Inheritance diagram for Standard_Transient:

Public Member Functions
	Standard_Transient ()
	Empty constructor. More...
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing. More...
Standard_Transient &	operator= (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...

Support of run-time type information (RTTI)
typedef void	base_type
	Returns a type descriptor about this object. 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_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. More...
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...

Reference counting, for use by handle<>
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...

Detailed Description

Abstract class which forms the root of the entire Transient class hierarchy.

Member Typedef Documentation

typedef void Standard_Transient::base_type

Returns a type descriptor about this object.

Constructor & Destructor Documentation

Standard_Transient::Standard_Transient ( )

inline

Empty constructor.

Standard_Transient::Standard_Transient ( const Standard_Transient &  )

inline

Copy constructor – does nothing.

virtual Standard_Transient::~Standard_Transient ( )

inlinevirtual

Destructor must be virtual.

Member Function Documentation

Standard_Integer Standard_Transient::DecrementRefCounter

(

)

const

Decrements the reference counter of this object; returns the decremented value.

virtual void Standard_Transient::Delete ( ) const

virtual

Memory deallocator for transient classes.

Reimplemented in AIS_InteractiveContext, and MMgt_TShared.

virtual const opencascade::handle<Standard_Type>& Standard_Transient::DynamicType ( ) const

virtual

Returns a type descriptor about this object.

static const opencascade::handle<Standard_Type>& Standard_Transient::get_type_descriptor ( )

static

Returns type descriptor of Standard_Transient class.

static const char* Standard_Transient::get_type_name ( )

inlinestatic

Returns a type descriptor about this object.

Standard_Integer Standard_Transient::GetRefCount ( ) const

inline

Get the reference counter of this object.

void Standard_Transient::IncrementRefCounter

(

)

const

Increments the reference counter of this object.

Standard_Boolean Standard_Transient::IsInstance

(

const opencascade::handle< Standard_Type > &

theType

)

const

Returns a true value if this is an instance of Type.

Standard_Boolean Standard_Transient::IsInstance

(

const Standard_CString

theTypeName

)

const

Returns a true value if this is an instance of TypeName.

Standard_Boolean Standard_Transient::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 Standard_Transient::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& Standard_Transient::operator= ( const Standard_Transient &  )

inline

Assignment operator, needed to avoid copying reference counter.

Standard_Transient* 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.

---

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

• Standard_Transient.hxx