Open CASCADE Technology Reference Manual 8.0.0.dev-68d3dc89
 
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Loading...
Searching...
No Matches
NCollection_Haft< CPPClass > Class Template Reference

Template CLI class providing the way to encapsulate instance of C++ class as a field in the C++/CLI (ref) class. More...

#include <NCollection_Haft.h>

Public Member Functions

 NCollection_Haft ()
 Initialize CLI Haft object by default-constructed C++ object.
 
template<class T>
 NCollection_Haft (const T *aPtr)
 Initialize CLI Haft object by compatible C++ pointer.
 
 NCollection_Haft (const CPPClass &aPtr)
 Initialize CLI Haft object by C++ class object.
 
 ~NCollection_Haft ()
 Destructor - invoked explicitly by delete, or automatically when local variable is scoped out.
 
 !NCollection_Haft ()
 Finalizer - called undeterministically by garbage collector.
 
CPPClass & operator() ()
 Function call operator is provided to access underlying C++ object.
 

Protected Member Functions

void Nullify ()
 Invalidate the haft.
 

Protected Attributes

CPPClass * myPtr
 

Detailed Description

template<class CPPClass>
class NCollection_Haft< CPPClass >

Template CLI class providing the way to encapsulate instance of C++ class as a field in the C++/CLI (ref) class.

It can be helpful to encapsulate OCCT Handles, maps, arrays, etc.

Use of variable of the Haft type is very similar to that of encapsulated class:

  • Default constructor creates default-constructed C++ instance
  • Non-default construction is possible by copy or by initialization from compatible pointer (e.g. Haft for Handle can be initialized by pointer returned by operator new for a handled class)
  • Underlying C++ instance is accessed by operator ()

Constructor & Destructor Documentation

◆ NCollection_Haft() [1/3]

template<class CPPClass>
NCollection_Haft< CPPClass >::NCollection_Haft ( )
inline

Initialize CLI Haft object by default-constructed C++ object.

◆ NCollection_Haft() [2/3]

template<class CPPClass>
template<class T>
NCollection_Haft< CPPClass >::NCollection_Haft ( const T * aPtr)
inline

Initialize CLI Haft object by compatible C++ pointer.

◆ NCollection_Haft() [3/3]

template<class CPPClass>
NCollection_Haft< CPPClass >::NCollection_Haft ( const CPPClass & aPtr)
inline

Initialize CLI Haft object by C++ class object.

◆ ~NCollection_Haft()

template<class CPPClass>
NCollection_Haft< CPPClass >::~NCollection_Haft ( )
inline

Destructor - invoked explicitly by delete, or automatically when local variable is scoped out.

◆ !NCollection_Haft()

template<class CPPClass>
NCollection_Haft< CPPClass >::!NCollection_Haft ( )
inline

Finalizer - called undeterministically by garbage collector.

Member Function Documentation

◆ Nullify()

template<class CPPClass>
void NCollection_Haft< CPPClass >::Nullify ( )
inlineprotected

Invalidate the haft.

◆ operator()()

template<class CPPClass>
CPPClass & NCollection_Haft< CPPClass >::operator() ( )
inline

Function call operator is provided to access underlying C++ object.

Field Documentation

◆ myPtr

template<class CPPClass>
CPPClass* NCollection_Haft< CPPClass >::myPtr
protected

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