DatumToUpload< DataType_t > Class Template Reference

The class used to implement RAII for data uploading. More...

Public Types
typedef DataType_t	DataType
	The type of data being exchanged.

Public Member Functions
	DatumToUpload (DataUploader< DataType > &uploader)
	Constructor.
	~DatumToUpload ()
	Destructor.
	operator bool () const
	Cast to bool.
const DataType *	operator-> () const
	Overloading of the -> operator to access the datum (const version)
DataType *	operator-> ()
	Overloading of the -> operator to access the datum.
bool	operator== (const DataType *other) const
	Comparison operator with a pointer to DataType.
void	uploadDatum ()
	Uploads the datum.

Detailed Description

template<class DataType_t>
class farsa::DatumToUpload< DataType_t >

The class used to implement RAII for data uploading.

A helper class to ease the creation and upload of a datum: the datum is created when this object is created and it is uploaded when this object is destroyed. See dataexchange.h for more information

Warning

Functions in this class are NOT thread safe

Definition at line 485 of file dataexchange.h.

Member Typedef Documentation

typedef DataType_t DataType

The type of data being exchanged.

Definition at line 492 of file dataexchange.h.

Constructor & Destructor Documentation

DatumToUpload ( DataUploader< DataType > &  uploader )

inline

Constructor.

Parameters

uploader

the uploader that has to upload a new datum

Definition at line 500 of file dataexchange.h.

~DatumToUpload ( )

inline

Destructor.

Uploads the datum if it hasn't been uploaded yet

Definition at line 512 of file dataexchange.h.

Member Function Documentation

operator bool ( ) const

inline

Cast to bool.

Returns

true if the datum pointer is non-null

Definition at line 568 of file dataexchange.h.

const DataType* operator-> ( ) const

inline

Overloading of the -> operator to access the datum (const version)

Returns

a const pointer to the datum

Definition at line 537 of file dataexchange.h.

DataType* operator-> ( )

inline

Overloading of the -> operator to access the datum.

Returns

a pointer to the datum

Definition at line 547 of file dataexchange.h.

bool operator== ( const DataType *  other ) const

inline

Comparison operator with a pointer to DataType.

Parameters

other

a pointer to DataType

Returns

true if the two pointer are the same

Definition at line 558 of file dataexchange.h.

void uploadDatum ( )

inline

Uploads the datum.

From this point on the datum pointer will be NULL

Definition at line 522 of file dataexchange.h.

---

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

• utilities/include/dataexchange.h