STK::TRef<-1 > Struct Reference

#include <STK_IContainerRef.h>

Inheritance diagram for STK::TRef<-1 >:

Public Member Functions
bool	isRef () const
bool	ref () const
void	exchange (TRef const &T)
	swap this with the container T.
void	setRef (bool ref) const
	Modify the container : can become a reference or the owner of the data.

Protected Member Functions
	TRef (bool ref)
	Default constructor We have to specify the member ref_.
	~TRef ()
	destructor.

Private Attributes
bool	ref_
	Is it a "true" container or a wrapper ? ref_ should be false if this own its own data, true otherwise.

Detailed Description

Definition at line 69 of file STK_IContainerRef.h.

Constructor & Destructor Documentation

TRef()

STK::TRef<-1 >::TRef ( bool  ref )

inlineexplicitprotected

Default constructor We have to specify the member ref_.

Parameters

ref	: false if this own its own data.

Definition at line 75 of file STK_IContainerRef.h.

: ref_(ref) {}

~TRef()

STK::TRef<-1 >::~TRef ( )

inlineprotected

destructor.

Definition at line 77 of file STK_IContainerRef.h.

{}

Member Function Documentation

exchange()

void STK::TRef<-1 >::exchange ( TRef<-1 > const &  T )

inline

swap this with the container T.

Parameters

T	the container to swap with this

Definition at line 87 of file STK_IContainerRef.h.

{ std::swap(ref_, T.ref_);}

Referenced by STK::MemAllocator< Type_, Size_ >::exchange(), and STK::MemSAllocator1D< Type_, NzMax_ >::exchange().

isRef()

bool STK::TRef<-1 >::isRef ( ) const

inline

Returns

true if *this is reference container, false otherwise

Definition at line 81 of file STK_IContainerRef.h.

{ return ref_;}

Referenced by STK::List1D< Type_ >::clear(), STK::List1D< Type_ >::erase(), STK::DataFrame::freeCols(), STK::DataFrame::freeMem(), STK::List1D< Type_ >::freeMem(), STK::DataFrame::insertDataFrame(), STK::List1D< Type_ >::insertElt(), STK::DataFrame::merge(), STK::List1D< Type_ >::merge(), STK::List1D< Type_ >::popBack(), STK::List1D< Type_ >::pushBack(), STK::DataFrame::pushBackDataFrame(), STK::List1D< Type_ >::resizeImpl(), STK::DataFrame::shift(), STK::List1D< Type_ >::shiftImpl(), STK::DataFrame::~DataFrame(), and STK::List1D< Type_ >::~List1D().

ref()

bool STK::TRef<-1 >::ref ( ) const

inline

Returns

true if *this is reference container, false otherwise

Definition at line 83 of file STK_IContainerRef.h.

{ return ref_;}

Referenced by STK::DataFrame::DataFrame(), STK::List1D< Type_ >::List1D(), STK::MemAllocator< Type_, Size_ >::MemAllocator(), STK::MemAllocator< Type_, Size_ >::MemAllocator(), STK::MemAllocator< Type_, Size_ >::MemAllocator(), STK::MemSAllocator1D< Type_, NzMax_ >::move(), and STK::MemAllocator< Type_, Size_ >::setPtr().

setRef()

void STK::TRef<-1 >::setRef ( bool  ref ) const

inline

Modify the container : can become a reference or the owner of the data.

To use with care if we want to avoid memory leak.

Parameters

ref	: false if this own its own data.

Definition at line 92 of file STK_IContainerRef.h.

{ ref_ = ref;}

Member Data Documentation

ref_

bool STK::TRef<-1 >::ref_

mutableprivate

Is it a "true" container or a wrapper ? ref_ should be false if this own its own data, true otherwise.

Definition at line 98 of file STK_IContainerRef.h.

---

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

• STK_IContainerRef.h