SPARK::AtomicClass Namespace Reference

Definition of the atomic class API library used to manage the private data from the callbacks asociated with each SPARK::TObject and SPARK::TInverse instances. More...

Functions
template<typename DataType> void	SetData (TObject *object, DataType *data)
	Sets pointer to private data in TObject instance.
template<typename StaticDataType> void	SetData (TInverse *inverse, StaticDataType *staticData)
	Sets pointer to static private data in TInverse instance.
template<typename DataType> DataType *	GetData (TObject *object)
	Returns address of private data of type DataType attached to the TObject instance.
template<typename StaticDataType> StaticDataType *	GetData (TInverse *inverse)
	Returns address of static private data of type StaticDataType attached to the TInverse instance.
template<typename DataType, typename DeletePolicyType> bool	DeleteData (TObject *object, DataType *dummy1=0, DeletePolicyType *dummy2=0)
	Deallocates private data of type DataType attached to a TObject instance.
template<typename StaticDataType, typename DeletePolicyType> bool	DeleteData (TInverse *inverse, StaticDataType *dummy1=0, DeletePolicyType *dummy2=0)
	Deallocates private data of type StaticDataType attached to a TInverse instance.

---

Detailed Description

Definition of the atomic class API library used to manage the private data from the callbacks asociated with each SPARK::TObject and SPARK::TInverse instances.

---

Function Documentation

template<typename DataType> void SetData (  TObject *  object, DataType *  data )

Sets pointer to private data in TObject instance. Parameters: object  Address of the TObject instance (use THIS macro from within the callback body) data  Address of the private data to be stored within the TObject instance

Here is the call graph for this function:

template<typename StaticDataType> void SetData (  TInverse *  inverse, StaticDataType *  staticData )

Sets pointer to static private data in TInverse instance. Parameters: inverse  Address of the TInverse instance (use THIS macro from within the static callback body) staticData  Address of the static private data to be stored within the TInverse instance

Here is the call graph for this function:

template<typename DataType> DataType* GetData (  TObject *  object  )

Returns address of private data of type DataType attached to the TObject instance. Returns: Pointer to private data as DataType* Parameters: object  (use THIS macro from within the callback body)

Here is the call graph for this function:

template<typename StaticDataType> StaticDataType* GetData (  TInverse *  inverse  )

Returns address of static private data of type StaticDataType attached to the TInverse instance. Returns: Pointer to static private data as StaticDataType* Parameters: inverse  (use THIS macro from within the static callback body)

Here is the call graph for this function:

template<typename DataType, typename DeletePolicyType> bool DeleteData (  TObject *  object, DataType *  dummy1 = 0, DeletePolicyType *  dummy2 = 0 )

Deallocates private data of type DataType attached to a TObject instance. Parameters: object  Address of the TObject instance (use THIS macro from within the callback body) dummy1  Never specify this parameter. It is used as a workaround for a bug in MSVC++ dummy2  Never specify this parameter. It is used as a workaround for a bug in MSVC++ Precondition: DeletePolicyType must define a static method named apply() that performs the deletion task. Possible policy candidates are: SPARK::delete_policy and SPARK::delete_array_policy Postcondition: Private data is deallocated and pointer in TObject instance is reset to 0

template<typename StaticDataType, typename DeletePolicyType> bool DeleteData (  TInverse *  inverse, StaticDataType *  dummy1 = 0, DeletePolicyType *  dummy2 = 0 )

Deallocates private data of type StaticDataType attached to a TInverse instance. Parameters: inverse  Address of the TInverse instance (use THIS macro from within the static callback body) dummy1  Never specify this parameter. It is used as a workaround for a bug in MSVC++ dummy2  Never specify this parameter. It is used as a workaround for a bug in MSVC++ Precondition: DeletePolicyType must define a static method named apply() that performs the deletion task. Possible policy candidates are: SPARK::delete_policy and SPARK::delete_array_policy Postcondition: Private data is deallocated and pointer in TInverse instance is reset to 0

---