NRAOCASA: asdmbinaries::SDMDataObject Class Reference

In the former case (correlator data), an SDMDataObject is organized as a header containing descriptive informations valid for all the recorded binary data, followed by a sequence of (local header, binary data) pairs. Each (local header, binary data) pair corresponds to one integration and the full SDMDataObject corresponds to one subscan.

In the latter case (total power data), an SDMDataObject is organized as a header containing descriptive informations, followed by one (local header, binary data) pair. This pair corresponds to the data recorded during one subscan.

An instance of an SDMDataObject is never created explicitely by calling some constructors or setters methods. Instances of SDMDataObject are rather created implicitely :

Quick description.

Definition at line 205 of file SDMDataObject.h.


Public Member Functions
	SDMDataObject ()
	SDMDataObject (unsigned long long startTime, const string &dataOID, unsigned int dimensionality, const string &execBlockUID, unsigned int execBlockNum, unsigned int scanNum, unsigned int subscanNum, unsigned int numAntenna, CorrelationMode correlatorMode, const SDMDataObject::DataStruct &dataStruct)
	SDMDataObject (unsigned long long startTime, const string &dataOID, unsigned int dimensionality, unsigned int numTime, const string &execBlockUID, unsigned int execBlockNum, unsigned int scanNum, unsigned int subscanNum, unsigned int numAntenna, const SDMDataObject::DataStruct &dataStruct)
string	title () const
	Returns the title of the SDMDataObject.
void	title (const string &value)
unsigned long long	startTime () const
	Returns the start time.
void	startTime (unsigned long long value)
unsigned int	numTime () const
	Returns the number of (sub) integrations.
void	numTime (unsigned int value)
string	dataOID () const
	Returns the dataOID.
void	dataOID (const string &value)
string	execBlockUID () const
	Returns the UID of the ExecBlock.
void	execBlockUID (const string &value)
unsigned int	execBlockNum () const
	Returns the number of the ExecBlock.
void	execBlockNum (unsigned int value)
unsigned int	scanNum () const
	Returns the number of the scan.
void	scanNum (unsigned int value)
unsigned int	subscanNum () const
	Returns the number of the subscan.
void	subscanNum (int value)
string	projectPath () const
	Returns the project path.
vector< string >	projectPaths () const
	Returns the projects paths of all the data subsets present in this SDMDataObject.
unsigned int	numAntenna () const
	Returns the number of antenna.
void	numAntenna (unsigned int value)
CorrelationMode	correlationMode () const
	Returns the correlation mode.
SpectralResolutionType	spectralResolutionType () const
	Returns the spectral resolution.
bool	isTP () const
	Returns true if the data are total power data and false otherwise.
bool	isCorrelation () const
	Returns true if the data are correlator data and false otherwise.
const DataStruct &	dataStruct () const
	Returns the structure of the data.
void	dataStruct (const DataStruct &dataStruct)
const vector< SDMDataSubset > &	corrDataSubsets () const
	Returns the binary data as a sequence of integrations.
void	corrDataSubsets (const vector< SDMDataSubset > &value)
const SDMDataSubset &	sdmDataSubset (const string &projectPath) const
	Returns a reference to a SDMDataSubset given its projectPath.
bool	aborted ()
	Returns true if the observation has been aborted.
unsigned long long	abortTime ()
	Returns the time, as an unsigned long long, at which the observation has been aborted.
string	abortReason ()
	Returns the reason, as a string, why the observation has been aborted.
const SDMDataSubset &	tpDataSubset () const
	Returns the binary data for a subscan.
void	tpDataSubset (const SDMDataSubset &value)
string	toString () const
	Returns a string representation of the global header of this SDMDataObject.
void	done ()
	Makes this SDMDataObject unusable.
Private Member Functions
void	append (const SDMDataSubset &value)
unsigned int	dimensionality () const
	Returns the "dimensionality" of this SDMDataObject.
void	dimensionality (unsigned int value)
void	owns ()
	Declares itself as the owner of all its parts.
string	toXML ()
	Returns an XML representation of the global header of this SDMDataObject.
void	toXML (const BinaryPart &binaryPart, const string &elementName, ostringstream &oss) const
void	spectralWindowsToXML (const Baseband &baseband, ostringstream &oss) const
void	basebandsToXML (ostringstream &oss) const
void	dataStructToXML (ostringstream &oss)
void	updateIdImageSPW ()
Static Private Member Functions
static bool	init ()
Private Attributes
bool	valid_
	Is the SDMDataObject actually properly filled with valid data.
string	title_
	Global header variables.
long long	startTime_
string	dataOID_
unsigned int	dimensionality_
unsigned int	numTime_
string	execBlockUID_
unsigned int	execBlockNum_
unsigned int	scanNum_
unsigned int	subscanNum_
unsigned int	numAntenna_
CorrelationMode	correlationMode_
SpectralResolutionType	spectralResolutionType_
DataStruct	dataStruct_
map< string, unsigned int >	str2index_
vector< SDMDataSubset >	dataSubsets_
bool	aborted_
unsigned long long int	abortTime_
string	abortReason_
Static Private Attributes
static vector< string >	correlationModeRefs
static vector< string >	axes
static vector< string >	types
static vector< string >	apcs
static const bool	_init
static const regex	SPWID
Friends
class	SDMDataObjectReader
class	SDMDataObjectWriter
class	HeaderParser
class	SDMDataSubset
class	CorrSubsetHeaderParser
Classes
class	Baseband
	A class to describe a baseband in use during an observation. More...
class	BinaryPart
	A class to describe binary data, i.e. More...
class	DataStruct
	A class to represent the structure of binary data. More...
class	SpectralWindow
	A class to describe a spectral window in use during an observation. More...

Constructor & Destructor Documentation

asdmbinaries::SDMDataObject::SDMDataObject ( )

asdmbinaries::SDMDataObject::SDMDataObject	(	unsigned long long	startTime,
		const string &	dataOID,
		unsigned int	dimensionality,
		const string &	execBlockUID,
		unsigned int	execBlockNum,
		unsigned int	scanNum,
		unsigned int	subscanNum,
		unsigned int	numAntenna,
		CorrelationMode	correlatorMode,
		const SDMDataObject::DataStruct &	dataStruct
	)

asdmbinaries::SDMDataObject::SDMDataObject	(	unsigned long long	startTime,
		const string &	dataOID,
		unsigned int	dimensionality,
		unsigned int	numTime,
		const string &	execBlockUID,
		unsigned int	execBlockNum,
		unsigned int	scanNum,
		unsigned int	subscanNum,
		unsigned int	numAntenna,
		const SDMDataObject::DataStruct &	dataStruct
	)

Member Function Documentation

string asdmbinaries::SDMDataObject::title ( ) const

Returns the title of the SDMDataObject.

Returns:: a string.

void asdmbinaries::SDMDataObject::title ( const string & value )

unsigned long long asdmbinaries::SDMDataObject::startTime ( ) const

Returns the start time.

Returns:: a long long.

void asdmbinaries::SDMDataObject::startTime ( unsigned long long value )

unsigned int asdmbinaries::SDMDataObject::numTime ( ) const

Returns the number of (sub) integrations.

Returns:: an unsigned int.

void asdmbinaries::SDMDataObject::numTime ( unsigned int value )

string asdmbinaries::SDMDataObject::dataOID ( ) const

Returns the dataOID.

Returns:: a string.

void asdmbinaries::SDMDataObject::dataOID ( const string & value )

string asdmbinaries::SDMDataObject::execBlockUID ( ) const

Returns the UID of the ExecBlock.

Returns:: a string.

void asdmbinaries::SDMDataObject::execBlockUID ( const string & value )

unsigned int asdmbinaries::SDMDataObject::execBlockNum ( ) const

Returns the number of the ExecBlock.

Returns:: an unsigned int.

void asdmbinaries::SDMDataObject::execBlockNum ( unsigned int value )

unsigned int asdmbinaries::SDMDataObject::scanNum ( ) const

Returns the number of the scan.

Returns:: an unsigned int.

void asdmbinaries::SDMDataObject::scanNum ( unsigned int value )

unsigned int asdmbinaries::SDMDataObject::subscanNum ( ) const

Returns the number of the subscan.

Returns:: an unsigned int.

void asdmbinaries::SDMDataObject::subscanNum ( int value )

string asdmbinaries::SDMDataObject::projectPath ( ) const

Returns the project path.

The project path is a string of the form "/<s>execBlockNum</s>/<s>scanNum</s>/<s>subscanNum</s>"

vector<string> asdmbinaries::SDMDataObject::projectPaths ( ) const

Returns the projects paths of all the data subsets present in this SDMDataObject.

Returns:: a vector of string.

unsigned int asdmbinaries::SDMDataObject::numAntenna ( ) const

Returns the number of antenna.

Returns:: an unsigned int.

void asdmbinaries::SDMDataObject::numAntenna ( unsigned int value )

CorrelationMode asdmbinaries::SDMDataObject::correlationMode ( ) const

Returns the correlation mode.

Returns:: a value from enumeration CorrelationMode.

SpectralResolutionType asdmbinaries::SDMDataObject::spectralResolutionType ( ) const

Returns the spectral resolution.

Returns:: a value from enumeration SpectralResolutionType.

bool asdmbinaries::SDMDataObject::isTP ( ) const

Returns true if the data are total power data and false otherwise.

Returns:: a bool.

Note:: data are considered as total power data if CorrelationMode == AUTO_ONLY && SpectralResolutionType == BASEBAND_WIDE.

bool asdmbinaries::SDMDataObject::isCorrelation ( ) const

Returns true if the data are correlator data and false otherwise.

Returns:: a bool.

Note:: data are considered as correlator data if SpectralResolutionType != BASEBAND_WIDE.

const DataStruct& asdmbinaries::SDMDataObject::dataStruct ( ) const

Returns the structure of the data.

Returns:: a reference to a DataStruct.

void asdmbinaries::SDMDataObject::dataStruct ( const DataStruct & dataStruct )

const vector<SDMDataSubset>& asdmbinaries::SDMDataObject::corrDataSubsets ( ) const

Returns the binary data as a sequence of integrations.

This method must be used only when the SDMDataObject contains correlator data (i.e. isCorrelation() == true)

Returns:: a reference to a vector of SDMDataSubset.

void asdmbinaries::SDMDataObject::corrDataSubsets ( const vector< SDMDataSubset > & value )

const SDMDataSubset& asdmbinaries::SDMDataObject::sdmDataSubset ( const string & projectPath ) const

Returns a reference to a SDMDataSubset given its projectPath.

Parameters:

projectPath

a string containing the project path of the SDMDataSubset.

Returns:: a pointer to an SDMDataSubset.

Exceptions:

SDMDataObjectException.

bool asdmbinaries::SDMDataObject::aborted ( )

Returns true if the observation has been aborted.

This method must be used on an SDMDataObject containing correlator data,otherwise a SDMDataObjectException is thrown.

Returns:: a boolean.

Exceptions:

SDMDataObjectException.

unsigned long long asdmbinaries::SDMDataObject::abortTime ( )

Returns the time, as an unsigned long long, at which the observation has been aborted.

The returned value is significant only if the observation has been aborted, therefore the method must always be used in conjuction with the aborted method. This method must be used on an SDMDataObject containing correlator data, otherwise a SDMDataObjectException is thrown.