r_Ref_Any Class Reference

The class r_Ref_Any is defined to support a reference to any type. More...

#include <ref.hh>

Public Member Functions
	r_Ref_Any ()
	default constructor
	r_Ref_Any (const r_Ref_Any &)
	copy constructor
	r_Ref_Any (const r_OId &initOId, r_Transaction *ta=NULL)
	constructor for creating a reference with an oid
	r_Ref_Any (r_Object *)
	Dereferencing the self object results in loading the object with initOId.
	r_Ref_Any (void *)
	constructor getting a general pointer
	~r_Ref_Any ()
	destructor deletes referenced object from main memory and database
r_Ref_Any &	operator= (const r_Ref_Any &)
	assignment operator for assigning a r_Ref_Any pointer
r_Ref_Any &	operator= (r_Object *)
	assignment operator for assigning a pointer to a persistent capable object
void	destroy ()
	delete from main memory
void	delete_object ()
	deletes referenced object from main memory and database
	operator const void * () const
	operator void * ()
	operator r_Point * ()
	operator r_Sinterval * ()
	operator r_Minterval * ()
	operator r_OId * ()
	operator r_Scalar * ()
	operator r_Structure * ()
	operator r_Primitive * ()
int	operator! () const
	operator for validity test
int	is_null () const
	method for reference validity test
int	operator== (const r_Ref_Any &) const
	The method delivers true iff the oid and/or the memory pointer are valid.
int	operator!= (const r_Ref_Any &) const
int	operator== (const r_Object *) const
	compares the memory pointer (does not load the object)
int	operator!= (const r_Object *) const
	compares the memory pointer (does not load the object)
const r_OId &	get_oid () const
	get oid
	r_Ref_Any (const r_OId &, r_Object *, r_Transaction *ta=NULL)
	constructor getting oid and memory pointer
unsigned int	is_oid_valid () const
void *	get_memory_ptr () const
	get memory pointer (without loading the object)
r_Transaction *	get_transaction () const
	get transaction

Protected Attributes
r_Transaction *	ta {NULL}

Detailed Description

The class r_Ref_Any is defined to support a reference to any type.

Its primary purpose is to handle generic refernces and allow conversions of r_Refs in the type hierarchy. A r_Ref_Any object can be used as an intermediary between any two types r_Ref<X> and r_Ref<Y> where X and Y are different types. A r_Ref<T> can always be converted to a r_Ref_Any; there is a function to perform the conversion in the r_Ref<T> template. Each r_Ref<T> class has a constructor and assignment operator that takes a reference to a r_Ref_Any.

Constructor & Destructor Documentation

r_Ref_Any() [1/6]

r_Ref_Any::r_Ref_Any

(

)

default constructor

r_Ref_Any() [2/6]

r_Ref_Any::r_Ref_Any

(

const r_Ref_Any &

)

copy constructor

r_Ref_Any() [3/6]

r_Ref_Any::r_Ref_Any	(	const r_OId &	initOId,
		r_Transaction *	ta = NULL
	)

constructor for creating a reference with an oid

r_Ref_Any() [4/6]

r_Ref_Any::r_Ref_Any

(

r_Object *

)

Dereferencing the self object results in loading the object with initOId.

constructor getting a pointer to a persistent capable object

r_Ref_Any() [5/6]

r_Ref_Any::r_Ref_Any

(

void *

)

constructor getting a general pointer

~r_Ref_Any()

r_Ref_Any::~r_Ref_Any

(

)

destructor deletes referenced object from main memory and database

r_Ref_Any() [6/6]

r_Ref_Any::r_Ref_Any	(	const r_OId &	,
		r_Object *	,
		r_Transaction *	ta = NULL
	)

constructor getting oid and memory pointer

Member Function Documentation

delete_object()

void r_Ref_Any::delete_object

(

)

deletes referenced object from main memory and database

destroy()

void r_Ref_Any::destroy

(

)

delete from main memory

get_memory_ptr()

void * r_Ref_Any::get_memory_ptr

(

)

const

get memory pointer (without loading the object)

get_oid()

const r_OId & r_Ref_Any::get_oid

(

)

const

get oid

get_transaction()

r_Transaction * r_Ref_Any::get_transaction

(

)

const

get transaction

is_null()

int r_Ref_Any::is_null

(

)

const

method for reference validity test

is_oid_valid()

unsigned int r_Ref_Any::is_oid_valid

(

)

const

operator const void *()

r_Ref_Any::operator const void *

(

)

const

operator r_Minterval *()

r_Ref_Any::operator r_Minterval *

(

)

operator r_OId *()

r_Ref_Any::operator r_OId *

(

)

operator r_Point *()

r_Ref_Any::operator r_Point *

(

)

operator r_Primitive *()

r_Ref_Any::operator r_Primitive *

(

)

operator r_Scalar *()

r_Ref_Any::operator r_Scalar *

(

)

operator r_Sinterval *()

r_Ref_Any::operator r_Sinterval *

(

)

operator r_Structure *()

r_Ref_Any::operator r_Structure *

(

)

operator void *()

r_Ref_Any::operator void *

(

)

operator!()

int r_Ref_Any::operator!

(

)

const

operator for validity test

operator!=() [1/2]

int r_Ref_Any::operator!=

(

const r_Object *

)

const

compares the memory pointer (does not load the object)

operator!=() [2/2]

int r_Ref_Any::operator!=

(

const r_Ref_Any &

)

const

operator=() [1/2]

r_Ref_Any & r_Ref_Any::operator=

(

const r_Ref_Any &

)

assignment operator for assigning a r_Ref_Any pointer

operator=() [2/2]

r_Ref_Any & r_Ref_Any::operator=

(

r_Object *

)

assignment operator for assigning a pointer to a persistent capable object

operator==() [1/2]

int r_Ref_Any::operator==

(

const r_Object *

)

const

compares the memory pointer (does not load the object)

operator==() [2/2]

int r_Ref_Any::operator==

(

const r_Ref_Any &

)

const

The method delivers true iff the oid and/or the memory pointer are valid.

Member Data Documentation

ta

r_Transaction* r_Ref_Any::ta {NULL}

protected

---

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

• ref.hh