Open CASCADE Technology  7.3.1.dev
Public Member Functions
NCollection_Shared< T, typename > Class Template Reference

Template defining a class derived from the specified base class and Standard_Transient, and supporting OCCT RTTI. More...

#include <NCollection_Shared.hxx>

Inheritance diagram for NCollection_Shared< T, typename >:
Inheritance graph
[legend]

Public Member Functions

 NCollection_Shared ()
 Default constructor. More...
 
template<typename T1 >
 NCollection_Shared (const T1 &arg1)
 Constructor with single argument. More...
 
template<typename T1 >
 NCollection_Shared (T1 &arg1)
 Constructor with single argument. More...
 
template<typename T1 , typename T2 >
 NCollection_Shared (const T1 &arg1, const T2 &arg2)
 Constructor with two arguments. More...
 
template<typename T1 , typename T2 >
 NCollection_Shared (T1 &arg1, const T2 &arg2)
 Constructor with two arguments. More...
 
template<typename T1 , typename T2 >
 NCollection_Shared (const T1 &arg1, T2 &arg2)
 Constructor with two arguments. More...
 
template<typename T1 , typename T2 >
 NCollection_Shared (T1 &arg1, T2 &arg2)
 Constructor with two arguments. 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...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. 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...
 

Detailed Description

template<class T, typename = typename opencascade::std::enable_if<! opencascade::std::is_base_of<Standard_Transient, T>::value>::type>
class NCollection_Shared< T, typename >

Template defining a class derived from the specified base class and Standard_Transient, and supporting OCCT RTTI.

This provides possibility to use Handes for types not initially intended to be dynamically allocated.

Current limitation is that only copy and constructors with 1-3 arguments are defined, calling those of the argument class (default constructor must be available). It can be improved when perfect forwarding of template arguments is supported by all compilers used for OCCT.

The intent is similar to std::make_shared<> in STL, except that this implementation defines a separate type.

Constructor & Destructor Documentation

◆ NCollection_Shared() [1/7]

template<class T, typename = typename opencascade::std::enable_if<! opencascade::std::is_base_of<Standard_Transient, T>::value>::type>
NCollection_Shared< T, typename >::NCollection_Shared ( )
inline

Default constructor.

◆ NCollection_Shared() [2/7]

template<class T, typename = typename opencascade::std::enable_if<! opencascade::std::is_base_of<Standard_Transient, T>::value>::type>
template<typename T1 >
NCollection_Shared< T, typename >::NCollection_Shared ( const T1 &  arg1)
inline

Constructor with single argument.

◆ NCollection_Shared() [3/7]

template<class T, typename = typename opencascade::std::enable_if<! opencascade::std::is_base_of<Standard_Transient, T>::value>::type>
template<typename T1 >
NCollection_Shared< T, typename >::NCollection_Shared ( T1 &  arg1)
inline

Constructor with single argument.

◆ NCollection_Shared() [4/7]

template<class T, typename = typename opencascade::std::enable_if<! opencascade::std::is_base_of<Standard_Transient, T>::value>::type>
template<typename T1 , typename T2 >
NCollection_Shared< T, typename >::NCollection_Shared ( const T1 &  arg1,
const T2 &  arg2 
)
inline

Constructor with two arguments.

◆ NCollection_Shared() [5/7]

template<class T, typename = typename opencascade::std::enable_if<! opencascade::std::is_base_of<Standard_Transient, T>::value>::type>
template<typename T1 , typename T2 >
NCollection_Shared< T, typename >::NCollection_Shared ( T1 &  arg1,
const T2 &  arg2 
)
inline

Constructor with two arguments.

◆ NCollection_Shared() [6/7]

template<class T, typename = typename opencascade::std::enable_if<! opencascade::std::is_base_of<Standard_Transient, T>::value>::type>
template<typename T1 , typename T2 >
NCollection_Shared< T, typename >::NCollection_Shared ( const T1 &  arg1,
T2 &  arg2 
)
inline

Constructor with two arguments.

◆ NCollection_Shared() [7/7]

template<class T, typename = typename opencascade::std::enable_if<! opencascade::std::is_base_of<Standard_Transient, T>::value>::type>
template<typename T1 , typename T2 >
NCollection_Shared< T, typename >::NCollection_Shared ( T1 &  arg1,
T2 &  arg2 
)
inline

Constructor with two arguments.


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