asdmbinaries::SDMDataSubset Class Reference

#include <SDMDataObject.h>

Public Member Functions
	SDMDataSubset (SDMDataObject *owner=0)
	SDMDataSubset (SDMDataObject *owner, unsigned long long time, unsigned long long interval, const vector< float > &autoData)
	SDMDataSubset (const SDMDataSubset &sdmDataSubset)
SDMDataSubset &	operator= (const SDMDataSubset &sdmDataSubset)
virtual	~SDMDataSubset ()
const SDMDataObject *	owner () const
unsigned int	integrationNum () const
unsigned int	subintegrationNum () const
string	projectPath () const
	Returns the project path of this SDMDataSubset.
unsigned long long	time () const
	Returns the midpoint of :.
unsigned long long	interval () const
	Returns the duration of the subscan in the case of total power data.
string	toString (unsigned int N=10) const
	Returns a description of this SDMDataSubset.
void	binAttachToXML (const string &name, ostringstream &oss)
void	tpBinAttachToXML (ostringstream &oss)
void	corrBinAttachToXML (ostringstream &oss)
void	toXML (ostringstream &oss) const
string	toXML ()
	Returns an XML representation of this SDMDataSubset.
unsigned long int	actualDurations (const ACTUALDURATIONSTYPE *&ptr) const
	Set ptr to the adress of the array of ActualDurations and returns the number of actualDurations.
uint64_t	actualDurationsPosition () const
	Returns the position (0-based, relative to the beginning of the file) of this part when it has been read in a file.
unsigned long int	actualTimes (const ACTUALTIMESTYPE *&ptr) const
	Set ptr to the adress of the array of ActualTimes and returns the number of ActualTimes.
uint64_t	actualTimesPosition () const
	Returns the position (0-based, relative to the beginning of the file) of this part when it has been read in a file.
unsigned long int	autoData (const AUTODATATYPE *&ptr) const
	Set ptr to the adress of the array of AutoData and returns the number of AutoData.
uint64_t	autoDataPosition () const
	Returns the position (0-based, relative to the beginning of the file) of this part when it has been read in a file.
unsigned long int	crossData (const SHORTCROSSDATATYPE *&ptr) const
	Set ptr to the adress of the array of short int CrossData and returns the number of short int CrossData.
unsigned long int	crossData (const INTCROSSDATATYPE *&ptr) const
	Set ptr to the adress of the array of int CrossData and Returns the number of long int CrossData.
unsigned long int	crossData (const FLOATCROSSDATATYPE *&ptr) const
	Set ptr to the adress of the array of float CrossData and Returns the number of long int CrossData.
uint64_t	crossDataPosition () const
	Returns the position (0-based, relative to the beginning of the file) of this part when it has been read in a file.
PrimitiveDataType	crossDataType () const
	Return the type of cross data values.
void	crossDataType (PrimitiveDataType value)
unsigned long int	flags (const FLAGSTYPE *&ptr) const
	Set ptr to the adress of the array of flags and returns the number of flags.
uint64_t	flagsPosition () const
	Returns the position (0-based, relative to the beginning of the file) of this part when it has been read in a file.
unsigned long int	zeroLags (const ZEROLAGSTYPE *&ptr) const
	Set ptr to the adress of the array of ZeroLags and returns the number of ZeroLags.
uint64_t	zeroLagsPosition () const
	Returns the position (0-based, relative to the beginning of the file) of this part when it has been read in a file.
bool	aborted () const
	Returns true if and only if this corresponds to an aborted [sub]integration.
unsigned long long	abortTime () const
	Returns the time when the [sub]integration has been declared aborted.
string	abortReason () const
	Returns the reason why the [sub]integration was aborted.
Private Member Functions
string	xsiType () const
Private Attributes
SDMDataObject *	owner_
unsigned int	integrationNum_
unsigned int	subintegrationNum_
CorrelationMode	ref_
unsigned long long	time_
unsigned long long	interval_
string	dataStruct_
string	flagsREF_
string	actualTimesREF_
string	actualDurationsREF_
string	zeroLagsREF_
string	crossDataREF_
PrimitiveDataType	crossDataType_
string	autoDataREF_
const ACTUALTIMESTYPE *	actualTimes_
unsigned long int	nActualTimes_
uint64_t	actualTimesPosition_
const ACTUALDURATIONSTYPE *	actualDurations_
unsigned long int	nActualDurations_
uint64_t	actualDurationsPosition_
const ZEROLAGSTYPE *	zeroLags_
unsigned long int	nZeroLags_
uint64_t	zeroLagsPosition_
const FLAGSTYPE *	flags_
unsigned long int	nFlags_
uint64_t	flagsPosition_
const INTCROSSDATATYPE *	longCrossData_
const SHORTCROSSDATATYPE *	shortCrossData_
const FLOATCROSSDATATYPE *	floatCrossData_
unsigned long int	nCrossData_
uint64_t	crossDataPosition_
const AUTODATATYPE *	autoData_
unsigned long int	nAutoData_
uint64_t	autoDataPosition_
bool	aborted_
unsigned long long int	abortTime_
string	abortReason_
Friends
class	SDMDataObject
class	SDMDataObjectReader
class	SDMDataObjectStreamReader
class	SDMDataObjectWriter
class	CorrSubsetHeaderParser
class	TPSubsetHeaderParser

Detailed Description

SDMDataObject::.

SDMDataSubset:: declarations An SDMDataSubset is a class to represent the binary data stored during :

one integration in the case of Correlator data.
one subscan in the case of Total Power Data.

Definition at line 1287 of file SDMDataObject.h.

Constructor & Destructor Documentation

asdmbinaries::SDMDataSubset::SDMDataSubset ( SDMDataObject * owner = 0 )

asdmbinaries::SDMDataSubset::SDMDataSubset	(	SDMDataObject *	owner,
		unsigned long long	time,
		unsigned long long	interval,
		const vector< float > &	autoData
	)

asdmbinaries::SDMDataSubset::SDMDataSubset ( const SDMDataSubset & sdmDataSubset )

virtual asdmbinaries::SDMDataSubset::~SDMDataSubset ( ) [virtual]

Member Function Documentation

bool asdmbinaries::SDMDataSubset::aborted ( ) const

Returns true if and only if this corresponds to an aborted [sub]integration.

Returns:: a bool.

string asdmbinaries::SDMDataSubset::abortReason ( ) const

Returns the reason why the [sub]integration was aborted.

Returns:: a string.

Note:: Of course, the returned value is not meaningful if aborted() returns false.

unsigned long long asdmbinaries::SDMDataSubset::abortTime ( ) const

Returns the time when the [sub]integration has been declared aborted.

Returns:: an unsigned long long.

Note:: Of course, the returned value is not meaningful if aborted() returns false.

unsigned long int asdmbinaries::SDMDataSubset::actualDurations ( const ACTUALDURATIONSTYPE *& ptr ) const

Set ptr to the adress of the array of ActualDurations and returns the number of actualDurations.

Parameters:

ptr

a reference to a pointer on long long.

Returns:: the number of ActualDurations.

uint64_t asdmbinaries::SDMDataSubset::actualDurationsPosition ( ) const

Returns the position (0-based, relative to the beginning of the file) of this part when it has been read in a file.

Has no meaning otherwise.

unsigned long int asdmbinaries::SDMDataSubset::actualTimes ( const ACTUALTIMESTYPE *& ptr ) const

Set ptr to the adress of the array of ActualTimes and returns the number of ActualTimes.

Parameters:

ptr

a reference to a pointer on long long.

Returns:: the number of ActualTimes.

uint64_t asdmbinaries::SDMDataSubset::actualTimesPosition ( ) const

Returns the position (0-based, relative to the beginning of the file) of this part when it has been read in a file.

Has no meaning otherwise.

unsigned long int asdmbinaries::SDMDataSubset::autoData ( const AUTODATATYPE *& ptr ) const

Set ptr to the adress of the array of AutoData and returns the number of AutoData.

Parameters:

ptr

a reference to a pointer on float.

Returns:: the number of AutoData.

uint64_t asdmbinaries::SDMDataSubset::autoDataPosition ( ) const

Returns the position (0-based, relative to the beginning of the file) of this part when it has been read in a file.

Has no meaning otherwise.

void asdmbinaries::SDMDataSubset::binAttachToXML	(	const string &	name,
		ostringstream &	oss
	)

void asdmbinaries::SDMDataSubset::corrBinAttachToXML ( ostringstream & oss )

unsigned long int asdmbinaries::SDMDataSubset::crossData ( const FLOATCROSSDATATYPE *& ptr ) const

Set ptr to the adress of the array of float CrossData and Returns the number of long int CrossData.

Parameters:

ptr

a reference to a pointer on float.

Returns:: the number of float CrossData values.

unsigned long int asdmbinaries::SDMDataSubset::crossData ( const INTCROSSDATATYPE *& ptr ) const

Set ptr to the adress of the array of int CrossData and Returns the number of long int CrossData.

Parameters:

ptr

a reference to a pointer on long int.

Returns:: the number of long int CrossData values.

unsigned long int asdmbinaries::SDMDataSubset::crossData ( const SHORTCROSSDATATYPE *& ptr ) const

Set ptr to the adress of the array of short int CrossData and returns the number of short int CrossData.

Parameters:

ptr

a reference to a pointer on short int.

Returns:: the number of short int CrossData values.

uint64_t asdmbinaries::SDMDataSubset::crossDataPosition ( ) const

Returns the position (0-based, relative to the beginning of the file) of this part when it has been read in a file.

Has no meaning otherwise.

void asdmbinaries::SDMDataSubset::crossDataType ( PrimitiveDataType value )

PrimitiveDataType asdmbinaries::SDMDataSubset::crossDataType ( ) const

Return the type of cross data values.

Returns:: a value of the enumeration PrimitiveDataTypeMod::PrimitiveDataType.

unsigned long int asdmbinaries::SDMDataSubset::flags ( const FLAGSTYPE *& ptr ) const

Set ptr to the adress of the array of flags and returns the number of flags.

Parameters:

ptr

a reference to a pointer on unsigned long int.

Returns:: the number of flags.

uint64_t asdmbinaries::SDMDataSubset::flagsPosition ( ) const

Returns the position (0-based, relative to the beginning of the file) of this part when it has been read in a file.

Has no meaning otherwise.

unsigned int asdmbinaries::SDMDataSubset::integrationNum ( ) const

unsigned long long asdmbinaries::SDMDataSubset::interval ( ) const

Returns the duration of the subscan in the case of total power data.

Note:: not relevant in the case of correlator data.

SDMDataSubset& asdmbinaries::SDMDataSubset::operator= ( const SDMDataSubset & sdmDataSubset )

const SDMDataObject* asdmbinaries::SDMDataSubset::owner ( ) const

string asdmbinaries::SDMDataSubset::projectPath ( ) const

Returns the project path of this SDMDataSubset.

the project path is a string of the form :

/<execblock-number>/<scan-number>/<subscan-number>/<integration-number> in the case of correlator data.
/<execblock-number>/<scan-number>/<subscan-number> in the case of total power data.

unsigned int asdmbinaries::SDMDataSubset::subintegrationNum ( ) const

unsigned long long asdmbinaries::SDMDataSubset::time ( ) const

Returns the midpoint of :.