RefTarget Class Reference

#include <referencemgr.h>

Class Description

Note, Do not use this class as this is used by the internal system only.

This class will be removed in future versions of the SDK.

+ Inheritance diagram for RefTarget:

Public Member Functions

 RefTarget ()
 
 RefTarget (RefTargetHandle ref, const Interval &valid=NEVER)
 
 RefTarget (const RefTarget &refTarget)
 
virtual ~RefTarget ()
 
virtual RefTargetoperator= (const RefTarget &refTarget)
 
RefTargetHandle GetRefTargetHandle () const
 
void SetRefTargetHandle (RefTargetHandle ref)
 
const IntervalGetValidity () const
 
void SetValidity (const Interval &valid)
 
bool IsHeld () const
 
void SetHeld (bool held)
 

Protected Attributes

RefTargetHandle mRef
 
Interval mValid
 
bool mHeld
 

Additional Inherited Members

- Static Public Member Functions inherited from MaxHeapOperators
static UtilExport voidoperator new (size_t size)
 Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e)
 Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new (size_t size, const char *filename, int line)
 New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
 New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new (size_t size, unsigned long flags)
 New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e, unsigned long flags)
 New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new[] (size_t size)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new[] (size_t size, const char *filename, int line)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects. More...
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new[] (size_t size, unsigned long flags)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
 
static UtilExport void operator delete (void *ptr)
 Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e)
 Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete (void *ptr, const char *filename, int line)
 Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, int block_type, const char *filename, int line)
 Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
 Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete (void *ptr, unsigned long flags)
 Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
 Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete[] (void *ptr)
 Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e)
 Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete[] (void *ptr, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, int block_type, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete[] (void *ptr, unsigned long flags)
 Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
 Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, void *placement_ptr)
 Placement new operator. More...
 
static UtilExport void operator delete (void *ptr, void *placement_ptr)
 Placement delete operator. More...
 
static UtilExport voidaligned_malloc (size_t size, size_t alignment)
 Allocates memory on a specified alignment boundary. More...
 
static UtilExport voidaligned_realloc (void *ptr, size_t size, size_t alignment)
 Reallocates memory on a specified alignment boundary. More...
 
static UtilExport void aligned_free (void *ptr)
 Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...
 

Constructor & Destructor Documentation

RefTarget ( )
inline
33 : mRef(NULL), mHeld(false) { }
#define NULL
Definition: autoptr.h:18
bool mHeld
Definition: referencemgr.h:30
RefTargetHandle mRef
Definition: referencemgr.h:28
RefTarget ( RefTargetHandle  ref,
const Interval valid = NEVER 
)
inline
34 : mRef(ref), mHeld(false) { mValid = valid; }
bool mHeld
Definition: referencemgr.h:30
Interval mValid
Definition: referencemgr.h:29
RefTargetHandle mRef
Definition: referencemgr.h:28
RefTarget ( const RefTarget refTarget)
inline
35 : mRef(refTarget.mRef), mHeld(false) { mValid = refTarget.mValid; }
bool mHeld
Definition: referencemgr.h:30
Interval mValid
Definition: referencemgr.h:29
RefTargetHandle mRef
Definition: referencemgr.h:28
virtual ~RefTarget ( )
inlinevirtual
36 {;}

Member Function Documentation

virtual RefTarget& operator= ( const RefTarget refTarget)
inlinevirtual
37 { mRef = refTarget.mRef; mValid = refTarget.mValid; return *this; }
Interval mValid
Definition: referencemgr.h:29
RefTargetHandle mRef
Definition: referencemgr.h:28
RefTargetHandle GetRefTargetHandle ( ) const
inline
39 { return mRef; }
RefTargetHandle mRef
Definition: referencemgr.h:28
void SetRefTargetHandle ( RefTargetHandle  ref)
inline
40 { mRef = ref; }
RefTargetHandle mRef
Definition: referencemgr.h:28
const Interval& GetValidity ( ) const
inline
41 { return mValid; }
Interval mValid
Definition: referencemgr.h:29
void SetValidity ( const Interval valid)
inline
42 { mValid = valid; }
Interval mValid
Definition: referencemgr.h:29
bool IsHeld ( ) const
inline
43 { return mHeld; }
bool mHeld
Definition: referencemgr.h:30
void SetHeld ( bool  held)
inline
44 { mHeld = held; }
bool mHeld
Definition: referencemgr.h:30

Member Data Documentation

RefTargetHandle mRef
protected
Interval mValid
protected
bool mHeld
protected