SDMDataObject:: declarations. More...

#include <SDMDataObject.h>

Classes
class	AutoDataBinaryPart
	A subclass of binaryPart to describe the autodata. More...
class	Baseband
	SDMDataObject::Baseband:: declarations. More...
class	BinaryPart
	SDMDataObject::BinaryPart:: declarations. More...
class	DataStruct
	SDMDataObject::DataStruct:: declarations. More...
class	SpectralWindow
	SDMDataObject::SpectralWindow:: declarations. More...
class	ZeroLagsBinaryPart
	A subclass of binaryPart to describe the zeroLags. More...
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)
const ByteOrder *	byteOrder () const
	Returns the byte order of the binary parts.
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.
OptionalSpectralResolutionType	spectralResolutionType () const
	Returns the spectral resolution.
ProcessorType	processorType () const
	Returns the processor type.
CorrelatorType	correlatorType () const
	Returns the correlator type.
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 () const
	Returns true if the observation has been aborted.
unsigned long long	abortTime () const
	Returns the time, as an unsigned long long, at which the observation has been aborted.
string	abortReason () const
	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.
	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.
OptionalSpectralResolutionType	spectralResolutionType () const
	Returns the spectral resolution.
ProcessorType	processorType () const
	Returns the processor type.
CorrelatorType	correlatorType () const
	Returns the correlator type.
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 () const
	Returns true if the observation has been aborted.
unsigned long long	abortTime () const
	Returns the time, as an unsigned long long, at which the observation has been aborted.
string	abortReason () const
	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	toXML (const AutoDataBinaryPart &autoDataBinaryPart, const string &elementName, ostringstream &oss) const
void	toXML (const ZeroLagsBinaryPart &zeroLagsBinaryPart, const string &elementName, ostringstream &oss) const
void	spectralWindowsToXML (const vector< Baseband > &basebands, unsigned int ibb, ostringstream &oss) const
void	basebandsToXML (ostringstream &oss) const
void	dataStructToXML (ostringstream &oss)
void	updateIdImageSPW ()
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	toXML (const AutoDataBinaryPart &autoDataBinaryPart, const string &elementName, ostringstream &oss) const
void	toXML (const ZeroLagsBinaryPart &zeroLagsBinaryPart, const string &elementName, ostringstream &oss) const
void	spectralWindowsToXML (const vector< Baseband > &basebands, unsigned int ibb, ostringstream &oss) const
void	basebandsToXML (ostringstream &oss) const
void	dataStructToXML (ostringstream &oss)
void	updateIdImageSPW ()
Static Private Member Functions
static bool	init ()
static bool	init ()
Private Attributes
bool	valid_
	Is the SDMDataObject actually properly filled with valid data.
string	title_
	Global header variables.
const ByteOrder *	byteOrder_
int	schemaVersion_
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_
OptionalSpectralResolutionType	spectralResolutionType_
ProcessorType	processorType_
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	SDMDataObjectStreamReader
class	SDMDataObjectReader
class	SDMDataObjectWriter
class	HeaderParser
class	SDMDataSubset
class	CorrSubsetHeaderParser

Detailed Description

SDMDataObject:: declarations.

A class to represent ALMA binary data. Two situations can be handled by this class:

Correlator data
Total power data

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 :

on output, while creating a MIME message containing ALMA binary data by using the class SDMDataObjectWriter; actual parameters passed to methods of this class are assembled together to form an SDMDataObject which is in turn converted into a MIME message,
on input, while reading a MIME message containing ALMA binary data by using the class SDMDataObjectReader; the result of the parsing of the MIME message is returned in an SDMDataObject.

Accessing the different parts of an SDMDataObject.

We give here a quick list of the method which allows to retrieve the different parts of an SDMDataObject :

title() : the general title for these binary data.
startTime() : Epoch when started the observation for the data collected in this SDMDataObject. This must be equal to the mid-point interval minus half the interval of the first data dump.
numTime() : number of (sub)integrations stored in this SDMDataObject.
dataOID() : Data object identifier given to this SDMDataObject once it's been converted into a MIME message and archived in the bulkstore.
execBlockUID() : the archive UID of the exec block.
execBlockNum() : the execblock number (one-based).
scanNum() : the scan number (one-based).
subscanNum() : the subscan number (one-based).
projectPath() : a string built from the string representations of execBlockNum, scanNum and subscanNum prefixed with '/' characters. E.g. if execBlockNum==10 && scanNum==1 && subscanNum==1 then projectPath=="/10/1/1".
numAntenna() : Number of antenna scheduled to produce the data.
correlationMode() : the correlation mode encoded as a value of the enumeration CorrelationMode.
spectralResolutionType() : the type of spectral resolution defined as a value of the enumeration SpectralResolutionType.
dataStruct() : a instance of DataStruct describing the structure of the binary data.
corrDataSubsets() : a vector of SDMDataSubset containing the collection of (sub) integrations in the case of correlator data.
sdmDataSubset() : an SDMDataSubset given its project path.
tpDataSubset() : a single SDMDataSubset containing all the binary data of a subscan in the case of total power data.

Definition at line 332 of file SDMDataObject.h.

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
	)

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

bool asdmbinaries::SDMDataObject::aborted ( ) const

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 bool.

Exceptions:

SDMDataObjectException.

bool asdmbinaries::SDMDataObject::aborted ( ) const

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 bool.

Exceptions:

SDMDataObjectException.

string asdmbinaries::SDMDataObject::abortReason ( ) const

Returns the reason, as a string, why 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.

Returns:: a string.

Exceptions:

SDMDataObjectException

string asdmbinaries::SDMDataObject::abortReason ( ) const

Returns the reason, as a string, why 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.

Returns:: a string.

Exceptions:

SDMDataObjectException

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

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.

Returns:: an unsigned long long.

Exceptions:

SDMDataObjectException

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

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.

Returns:: an unsigned long long.

Exceptions:

SDMDataObjectException

void asdmbinaries::SDMDataObject::append ( const SDMDataSubset & value ) [private]

void asdmbinaries::SDMDataObject::basebandsToXML ( ostringstream & oss ) const [private]

const ByteOrder* asdmbinaries::SDMDataObject::byteOrder ( ) const

Returns the byte order of the binary parts.

Returns:: a pointer of a ByteOrder instance.

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 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 )

CorrelationMode asdmbinaries::SDMDataObject::correlationMode ( ) const

Returns the correlation mode.

Returns:: a value from enumeration CorrelationMode.

CorrelationMode asdmbinaries::SDMDataObject::correlationMode ( ) const

Returns the correlation mode.

Returns:: a value from enumeration CorrelationMode.

CorrelatorType asdmbinaries::SDMDataObject::correlatorType ( ) const

Returns the correlator type.

Returns:: a value from the enumeration CorrelatorType if processorType == CORRELATOR else an SDMDataObjectException is thrown.

Exceptions:

SDMDataException

CorrelatorType asdmbinaries::SDMDataObject::correlatorType ( ) const

Returns the correlator type.

Returns:: a value from the enumeration CorrelatorType if processorType == CORRELATOR else an SDMDataObjectException is thrown.

Exceptions:

SDMDataException

string asdmbinaries::SDMDataObject::dataOID ( ) const

Returns the dataOID.

Returns:: a string.

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

string asdmbinaries::SDMDataObject::dataOID ( ) const

Returns the dataOID.

Returns:: a string.

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

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 DataStruct& asdmbinaries::SDMDataObject::dataStruct ( ) const

Returns the structure of the data.

Returns:: a reference to a DataStruct.

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

void asdmbinaries::SDMDataObject::dataStructToXML ( ostringstream & oss ) [private]

unsigned int asdmbinaries::SDMDataObject::dimensionality ( ) const [private]

Returns the "dimensionality" of this SDMDataObject.

A value of

0 corresponds to total power data.
1 corresponds to correlator data.

void asdmbinaries::SDMDataObject::dimensionality ( unsigned int value ) [private]

unsigned int asdmbinaries::SDMDataObject::dimensionality ( ) const [private]

Returns the "dimensionality" of this SDMDataObject.

A value of

0 corresponds to total power data.
1 corresponds to correlator data.

void asdmbinaries::SDMDataObject::dimensionality ( unsigned int value ) [private]

void asdmbinaries::SDMDataObject::done ( )

Makes this SDMDataObject unusable.

After a call to this method any request to this instance will generate an exception.

void asdmbinaries::SDMDataObject::done ( )

Makes this SDMDataObject unusable.

After a call to this method any request to this instance will generate an exception.

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::execBlockNum ( ) const

Returns the number of the ExecBlock.

Returns:: an unsigned int.

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

string asdmbinaries::SDMDataObject::execBlockUID ( ) const

Returns the UID of the ExecBlock.

Returns:: a string.

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

string asdmbinaries::SDMDataObject::execBlockUID ( ) const

Returns the UID of the ExecBlock.

Returns:: a string.

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

static bool asdmbinaries::SDMDataObject::init ( ) [static, private]

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.

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.

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::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.

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

Returns the number of antenna.

Returns:: an unsigned int.

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

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

Returns the number of antenna.

Returns:: an unsigned int.

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

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

Returns the number of (sub) integrations.

Returns:: an unsigned int.

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

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

Returns the number of (sub) integrations.

Returns:: an unsigned int.

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

void asdmbinaries::SDMDataObject::owns ( ) [private]

Declares itself as the owner of all its parts.

void asdmbinaries::SDMDataObject::owns ( ) [private]

Declares itself as the owner of all its parts.

ProcessorType asdmbinaries::SDMDataObject::processorType ( ) const

Returns the processor type.

Returns:: a value from the enumeration ProcessorType.

ProcessorType asdmbinaries::SDMDataObject::processorType ( ) const

Returns the processor type.

Returns:: a value from the enumeration ProcessorType.

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>"

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.

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::scanNum ( ) const

Returns the number of the scan.

Returns:: an unsigned int.

void asdmbinaries::SDMDataObject::scanNum ( 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 )

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.

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.

OptionalSpectralResolutionType asdmbinaries::SDMDataObject::spectralResolutionType ( ) const

Returns the spectral resolution.

Due to this optional nature, the spectral resolution type is not returned directly as a literal of the enumeration SpectralResolutionType, but as an instance of the class OptionalSpectralResolutionType. This instance can be queried to check if the spectral resolution type information is present and if it is its value as an SpectralResolutionType literal.

Returns:: a value from enumeration SpectralResolutionType.

OptionalSpectralResolutionType asdmbinaries::SDMDataObject::spectralResolutionType ( ) const

Returns the spectral resolution.

Due to this optional nature, the spectral resolution type is not returned directly as a literal of the enumeration SpectralResolutionType, but as an instance of the class OptionalSpectralResolutionType. This instance can be queried to check if the spectral resolution type information is present and if it is its value as an SpectralResolutionType literal.

Returns:: a value from enumeration SpectralResolutionType.

void asdmbinaries::SDMDataObject::spectralWindowsToXML	(	const vector< Baseband > &	basebands,
		unsigned int	ibb,
		ostringstream &	oss
	)		const `[private]`

void asdmbinaries::SDMDataObject::spectralWindowsToXML	(	const vector< Baseband > &	basebands,
		unsigned int	ibb,
		ostringstream &	oss
	)		const `[private]`

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

Returns the start time.

Returns:: a long long.

void asdmbinaries::SDMDataObject::startTime ( unsigned long long 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::subscanNum ( ) const

Returns the number of the subscan.

Returns:: an unsigned int.

void asdmbinaries::SDMDataObject::subscanNum ( 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::title ( ) const

Returns the title of the SDMDataObject.

Returns:: a string.

string asdmbinaries::SDMDataObject::title ( ) const

Returns the title of the SDMDataObject.

Returns:: a string.

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

string asdmbinaries::SDMDataObject::toString ( ) const

Returns a string representation of the global header of this SDMDataObject.

Returns:: a string.

string asdmbinaries::SDMDataObject::toString ( ) const

Returns a string representation of the global header of this SDMDataObject.

Returns:: a string.

string asdmbinaries::SDMDataObject::toXML ( ) [private]

Returns an XML representation of the global header of this SDMDataObject.

Returns:: a string.

void asdmbinaries::SDMDataObject::toXML	(	const BinaryPart &	binaryPart,
		const string &	elementName,
		ostringstream &	oss
	)		const `[private]`

void asdmbinaries::SDMDataObject::toXML	(	const AutoDataBinaryPart &	autoDataBinaryPart,
		const string &	elementName,
		ostringstream &	oss
	)		const `[private]`

void asdmbinaries::SDMDataObject::toXML	(	const ZeroLagsBinaryPart &	zeroLagsBinaryPart,
		const string &	elementName,
		ostringstream &	oss
	)		const `[private]`

string asdmbinaries::SDMDataObject::toXML ( ) [private]

Returns an XML representation of the global header of this SDMDataObject.

Returns:: a string.

void asdmbinaries::SDMDataObject::toXML	(	const BinaryPart &	binaryPart,
		const string &	elementName,
		ostringstream &	oss
	)		const `[private]`

void asdmbinaries::SDMDataObject::toXML	(	const AutoDataBinaryPart &	autoDataBinaryPart,
		const string &	elementName,
		ostringstream &	oss
	)		const `[private]`

void asdmbinaries::SDMDataObject::toXML	(	const ZeroLagsBinaryPart &	zeroLagsBinaryPart,
		const string &	elementName,
		ostringstream &	oss
	)		const `[private]`