asdmbinaries::SDMDataObject::DataStruct Class Reference

SDMDataObject::DataStruct:: declarations. More...

#include <SDMDataObject.h>

Public Member Functions
	DataStruct ()
	An empty constructor.
virtual	~DataStruct ()
	The destructor.
	DataStruct (const vector< AtmPhaseCorrection > &apc, const vector< Baseband > &basebands, const BinaryPart &flags, const BinaryPart &actualTimes, const BinaryPart &actualDurations, const ZeroLagsBinaryPart &zeroLags, const BinaryPart &crossData, const AutoDataBinaryPart &autoData)
	A full constructor.
const vector < AtmPhaseCorrection > &	apc () const
	Returns the radiometric atmospheric phase correction codes.
const vector< Baseband > &	basebands () const
	void apc(const vector<AtmPhaseCorrection>& value);
const BinaryPart &	flags () const
	void basebands(const vector<Baseband>& value);
const BinaryPart &	actualTimes () const
	void flags(const BinaryPart& value);
const BinaryPart &	actualDurations () const
	void actualTimes(const BinaryPart& value);
const ZeroLagsBinaryPart &	zeroLags () const
	void actualDurations(const BinaryPart& value);
const BinaryPart &	crossData () const
	void zeroLags(const BinaryPart& value);
const AutoDataBinaryPart &	autoData () const
	void crossData(const BinaryPart& value);
void	imageSPW (unsigned int ibb, unsigned int ispw1, unsigned int ispw2)
	void autoData(const BinaryPart& value);
const SpectralWindow *	imageSPW (unsigned int ibb, unsigned int ispw) const
	Returns a pointer to the spectral window image of a spectral window.
void	imageOfSPW (unsigned int ibb, unsigned int ispw1, unsigned int ispw2)
	Defines an association "spw1 is image of spw2" between two spectral windows spw1 and spw2.
const SpectralWindow *	imageOfSPW (unsigned int ibb, unsigned int ispw) const
	Returns a pointer to the spectral window whom the spectral window passed in argument is the image.
Private Member Functions
void	owner (const SDMDataObject *o)
void	checkCoordinate (unsigned int ibb, unsigned int ispw) const
bool	associatedSPW (unsigned int ibb, unsigned int ispw1, unsigned int ispw2)
void	divorceSPW (unsigned int ibb, unsigned int ispw)
Private Attributes
vector< AtmPhaseCorrection >	apc_
vector< Baseband >	basebands_
BinaryPart	flags_
BinaryPart	actualTimes_
BinaryPart	actualDurations_
ZeroLagsBinaryPart	zeroLags_
BinaryPart	crossData_
AutoDataBinaryPart	autoData_
const SDMDataObject *	owner_
map< string, string >	imageSPW_
map< string, string >	imageOfSPW_
Friends
class	SDMDataObject
class	HeaderParser
class	SDMDataObjectWriter

Detailed Description

SDMDataObject::DataStruct:: declarations.

A class to represent the structure of binary data. An instance of this class collects informations :

about atmospheric phase correction when relevant (correlationMode != AUTO_ONLY) (apc()).
about basebands (basebands()).
about binary data (flags(), actualTimes(), actualDurations(), zeroLags(), crossData(), autoData()) .

Definition at line 710 of file SDMDataObject.h.

Constructor & Destructor Documentation

asdmbinaries::SDMDataObject::DataStruct::DataStruct ( )

An empty constructor.

Note:: This constructor should never be used.

virtual asdmbinaries::SDMDataObject::DataStruct::~DataStruct ( ) [virtual]

The destructor.

asdmbinaries::SDMDataObject::DataStruct::DataStruct	(	const vector< AtmPhaseCorrection > &	apc,
		const vector< Baseband > &	basebands,
		const BinaryPart &	flags,
		const BinaryPart &	actualTimes,
		const BinaryPart &	actualDurations,
		const ZeroLagsBinaryPart &	zeroLags,
		const BinaryPart &	crossData,
		const AutoDataBinaryPart &	autoData
	)

A full constructor.

Parameters:

	apc	a vector of AtmPhaseCorrection. If apc is not relevant pass an empty vector.
	basebands	a vector of Baseband.
	flags	a BinaryPart object describing the flags. If flags is not relevant pass an empty BinaryPart object.
	actualTimes	a BinaryPart object describing the actual times. If actualTimes is not relevant pass an empty BinaryPart object.
	actualDurations	a BinaryPart object describing the actual durations. If actualDurations is not relevant pass an empty BinaryPart object.
	zeroLags	a ZeroLagsBinaryPart object describing the zero lags. If zeroLags is not relevant pass an empty ZeroLagsBinaryPart object.
	crossData	a BinaryPart object describing the cross data. If crossData is not relevant pass an empty BinaryPart object.
	autoData	an AutoDataBinaryPart object describing the auto data. If autoData is not relevant pass an empty AutoDataBinaryPart object.

Member Function Documentation

const BinaryPart& asdmbinaries::SDMDataObject::DataStruct::actualDurations ( ) const

void actualTimes(const BinaryPart& value);

Returns the description the actualDurations attachment.

Returns:: a reference to a BinaryPart value.

const BinaryPart& asdmbinaries::SDMDataObject::DataStruct::actualTimes ( ) const

void flags(const BinaryPart& value);

Returns the description the actualTimes attachment.

Returns:: a reference to a BinaryPart value.

const vector<AtmPhaseCorrection>& asdmbinaries::SDMDataObject::DataStruct::apc ( ) const

Returns the radiometric atmospheric phase correction codes.

Returns:: a vector of AtmPhaseCorrectionMod::AtmPhaseCorrection.

bool asdmbinaries::SDMDataObject::DataStruct::associatedSPW	(	unsigned int	ibb,
		unsigned int	ispw1,
		unsigned int	ispw2
	)			`[private]`

const AutoDataBinaryPart& asdmbinaries::SDMDataObject::DataStruct::autoData ( ) const

void crossData(const BinaryPart& value);

Returns the description the autoData attachment.

Returns:: a reference to an AutoDataBinaryPart value.

const vector<Baseband>& asdmbinaries::SDMDataObject::DataStruct::basebands ( ) const

void apc(const vector<AtmPhaseCorrection>& value);

Returns the vector of basebands.

Returns:: a reference to a vector of Baseband.

void asdmbinaries::SDMDataObject::DataStruct::checkCoordinate	(	unsigned int	ibb,
		unsigned int	ispw
	)			const `[private]`

const BinaryPart& asdmbinaries::SDMDataObject::DataStruct::crossData ( ) const

void zeroLags(const BinaryPart& value);

Returns the description the crossData attachment.

Returns:: a reference to a BinaryPart value.

void asdmbinaries::SDMDataObject::DataStruct::divorceSPW	(	unsigned int	ibb,
		unsigned int	ispw
	)			`[private]`

const BinaryPart& asdmbinaries::SDMDataObject::DataStruct::flags ( ) const

void basebands(const vector<Baseband>& value);

Returns the description the flags attachment.

Returns:: a reference to a BinaryPart value.

const SpectralWindow* asdmbinaries::SDMDataObject::DataStruct::imageOfSPW	(	unsigned int	ibb,
		unsigned int	ispw
	)			const

Returns a pointer to the spectral window whom the spectral window passed in argument is the image.

Assuming that a spectral window spw can be located by a pair (ibb, ispw) of integer, where ibb denotes the index of the baseband this spectral window belongs to, and ispw its index in that baseband, this method returns a pointer to the spectral window defined as the image of spw. If spw is not an image then null is returned.

Parameters:

	ibb	1st coordinate of spw
	ispw	2nd coordinate of spw

Exceptions:

SDMDataObjectException

void asdmbinaries::SDMDataObject::DataStruct::imageOfSPW	(	unsigned int	ibb,
		unsigned int	ispw1,
		unsigned int	ispw2
	)

Defines an association "spw1 is image of spw2" between two spectral windows spw1 and spw2.

Assuming that a spectral window can be located by a pair (ibb, ispw) of integer, where ibb denotes the index of the baseband this spectral window belongs to, and ispw its index in that baseband, this method declares that the spectral window with coordinates (ibb1, ispw1) is the image of the spectral window with coordinates (ibb2, ispw2).

Parameters:

	ibb	1st common coordinate of spw1
	ispw1	2nd coordinate of spw1.
	ispw2	2nd coordinate of spw2.

Exceptions:

SDMDataObjectException

const SpectralWindow* asdmbinaries::SDMDataObject::DataStruct::imageSPW	(	unsigned int	ibb,
		unsigned int	ispw
	)			const

Returns a pointer to the spectral window image of a spectral window.

Assuming that a spectral window spw can be located by a pair (ibb, ispw) of integer, where ibb denotes the index of the baseband this spectral window belongs to, and ispw its index in that baseband, this method returns a pointer to the spectral window defined as the image of spw. If spw has no image defined then null is returned.

Parameters:

	ibb	1st coordinate of spw
	ispw	2nd coordinate of spw

Exceptions:

SDMDataObjectException

void asdmbinaries::SDMDataObject::DataStruct::imageSPW	(	unsigned int	ibb,
		unsigned int	ispw1,
		unsigned int	ispw2
	)

void autoData(const BinaryPart& value);

Defines an association "spw1 has image spw2" between two spectral windows spw1 and spw2. Assuming that a spectral window can be located by a pair (ibb, ispw) of integer, where ibb denotes the index of the baseband this spectral window belongs to, and ispw its index in that baseband, this method declares that the spectral window with coordinates (ibb, ispw1) has the spectral window with coordinates (ibb, ispw2) as an image.

Parameters: