#include <iDataFileTransmission.hh>

Inheritance diagram for iDataFileTransmission:

Collaboration diagram for iDataFileTransmission:

Public Member Functions
	iDataFileTransmission ()
virtual	~iDataFileTransmission ()
int	ComputeSizeEvent ()
	This function is implemented in child classes Computation of the size of each event according to the mandatory/optional correction fields.
int	PrepareDataFile ()
	This function is implemented in child classes Store different kind of information inside arrays (data relative to specific correction as well as basic raw data for the case data is loaded in RAM) Use the flag provided by the user to determine how the data has to be sorted (preloaded or read on the fly)
vEvent *	GetEventFromBuffer (char *ap_buffer, int a_th)
	This function is implemented in child classes Read an event from the position pointed by 'ap_buffer', parse the generic or modality-specific information, and store them in the (multithreaded) 'm2p_BufferEvent' object.
int	PROJ_InitFile ()
	This function is implemented in child classes Initialize the fstream objets for output writing as well as some other variables specific to the Projection script.
int	PROJ_GetScannerSpecificParameters ()
	This function is implemented in child classes It is used to set several variables of the datafile when using the projection script. Get modality specific parameters from the scanner object, through the scannerManager.
int	PROJ_WriteEvent (vEvent *ap_Event, int a_th)
	This function is implemented in child classes Write event according to the chosen type of data.
int	PROJ_WriteHeader ()
	This function is implemented in child classes. Generate a header file according to the projection and data output informations.
Private Member Functions
int	CheckSpecificParameters ()
	This function is implemented in child classes Check specific parameters of child classes.
int	CheckFileSizeConsistency ()
int	ReadSpecificInfoInHeader ()
	This function is implemented in child classes Read and check modality-specific information from the header datafile.

Detailed Description

Inherit from vDataFile.

Nothing is implemented yet here. The constructor throw an error for the moment.
All pure virtual functions are simply declared and return a dummy value.

Definition at line 24 of file iDataFileTransmission.hh.

Constructor & Destructor Documentation

iDataFileTransmission::iDataFileTransmission ( )

Definition at line 28 of file iDataFileTransmission.cc.

Here is the call graph for this function:

iDataFileTransmission::~iDataFileTransmission ( ) [virtual]

Definition at line 39 of file iDataFileTransmission.cc.

Member Function Documentation

int iDataFileTransmission::CheckFileSizeConsistency ( ) [inline, private, virtual]

Implements vDataFile.

Definition at line 49 of file iDataFileTransmission.hh.

int iDataFileTransmission::CheckSpecificParameters ( ) [inline, private, virtual]

This function is implemented in child classes
Check specific parameters of child classes.

Returns:: 0 if success, and positive value otherwise.

Implements vDataFile.

Definition at line 48 of file iDataFileTransmission.hh.

int iDataFileTransmission::ComputeSizeEvent ( ) [inline, virtual]

This function is implemented in child classes
Computation of the size of each event according to the mandatory/optional correction fields.

Returns:: 0 is success, positive value otherwise

Implements vDataFile.

Definition at line 36 of file iDataFileTransmission.hh.

vEvent* iDataFileTransmission::GetEventFromBuffer	(	char *	ap_buffer,
		int	a_th
	)		`[inline, virtual]`

This function is implemented in child classes
Read an event from the position pointed by 'ap_buffer', parse the generic or modality-specific information, and store them in the (multithreaded) 'm2p_BufferEvent' object.

Parameters:

ap_buffer	: address pointing to the event to recover in the event buffer array
a_th	: index of the thread from which the function was called

Returns:: the thread-specific 'm2p_BufferEvent' object containing the modality-specific information for the event

Implements vDataFile.

Definition at line 38 of file iDataFileTransmission.hh.

int iDataFileTransmission::PrepareDataFile ( ) [inline, virtual]

This function is implemented in child classes
Store different kind of information inside arrays (data relative to specific correction as well as basic raw data for the case data is loaded in RAM)
Use the flag provided by the user to determine how the data has to be sorted (preloaded or read on the fly)

Returns:: 0 is success, positive value otherwise

Implements vDataFile.

Definition at line 37 of file iDataFileTransmission.hh.

int iDataFileTransmission::PROJ_GetScannerSpecificParameters ( ) [inline, virtual]

This function is implemented in child classes
It is used to set several variables of the datafile when using the projection script.
Get modality specific parameters from the scanner object, through the scannerManager.

Returns:: 0 if success, positive value otherwise

Implements vDataFile.

Definition at line 40 of file iDataFileTransmission.hh.

int iDataFileTransmission::PROJ_InitFile ( ) [inline, virtual]

This function is implemented in child classes
Initialize the fstream objets for output writing as well as some other variables specific to the Projection script.

Returns:: 0 if success, and positive value otherwise.

Implements vDataFile.

Definition at line 39 of file iDataFileTransmission.hh.

int iDataFileTransmission::PROJ_WriteEvent	(	vEvent *	ap_Event,
		int	a_th
	)		`[inline, virtual]`

This function is implemented in child classes
Write event according to the chosen type of data.

Parameters:

ap_Event	: Event to write
a_th	: index of the thread from which the function was called

Returns:: 0 if success, and positive value otherwise.

Implements vDataFile.

Definition at line 41 of file iDataFileTransmission.hh.

int iDataFileTransmission::PROJ_WriteHeader ( ) [inline, virtual]

This function is implemented in child classes.
Generate a header file according to the projection and data output informations.

Returns:: 0 if success, and positive value otherwise.

Implements vDataFile.

Definition at line 42 of file iDataFileTransmission.hh.

int iDataFileTransmission::ReadSpecificInfoInHeader ( ) [inline, private, virtual]

This function is implemented in child classes
Read and check modality-specific information from the header datafile.

Returns:: 0 if success, and positive value otherwise.

Implements vDataFile.

Definition at line 50 of file iDataFileTransmission.hh.

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

Public Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation