asdm::WVMCalRow Class Reference

The WVMCalRow class is a row of a WVMCalTable. More...

#include <WVMCalRow.h>

Public Member Functions
virtual	~WVMCalRow ()
	friend class asdm::TableStreamReader<WVMCalTable, WVMCalRow>;
WVMCalTable &	getTable () const
	Return the table to which this row belongs.
bool	isAdded () const
	Has this row been added to its table ?
void	setTimeInterval (ArrayTimeInterval timeInterval)
	Set timeInterval with the specified ArrayTimeInterval.
WVRMethodMod::WVRMethod	getWvrMethod () const
	===> Attribute wvrMethod
void	setWvrMethod (WVRMethodMod::WVRMethod wvrMethod)
	Set wvrMethod with the specified WVRMethodMod::WVRMethod.
vector< Frequency >	getPolyFreqLimits () const
	===> Attribute polyFreqLimits
void	setPolyFreqLimits (vector< Frequency > polyFreqLimits)
	Set polyFreqLimits with the specified vector<Frequency >.
int	getNumInputAntenna () const
	===> Attribute numInputAntenna
void	setNumInputAntenna (int numInputAntenna)
	Set numInputAntenna with the specified int.
int	getNumChan () const
	===> Attribute numChan
void	setNumChan (int numChan)
	Set numChan with the specified int.
int	getNumPoly () const
	===> Attribute numPoly
void	setNumPoly (int numPoly)
	Set numPoly with the specified int.
vector< vector< vector< float > > >	getPathCoeff () const
	===> Attribute pathCoeff
void	setPathCoeff (vector< vector< vector< float > > > pathCoeff)
	Set pathCoeff with the specified vector<vector<vector<float > > >.
vector< vector< Temperature > >	getRefTemp () const
	===> Attribute refTemp
void	setRefTemp (vector< vector< Temperature > > refTemp)
	Set refTemp with the specified vector<vector<Temperature > >.
void	setAntennaId (Tag antennaId)
	Set antennaId with the specified Tag.
vector< Tag >	getInputAntennaId () const
	===> Attribute inputAntennaId
void	setInputAntennaId (vector< Tag > inputAntennaId)
	Set inputAntennaId with the specified vector<Tag> .
Tag	getSpectralWindowId () const
	===> Attribute spectralWindowId
void	setSpectralWindowId (Tag spectralWindowId)
	Set spectralWindowId with the specified Tag.
Links SpectralWindowRow	getSpectralWindowUsingSpectralWindowId ()
	spectralWindowId pointer to the row in the SpectralWindow table having SpectralWindow.spectralWindowId == spectralWindowId
AntennaRow *	getAntennaUsingAntennaId ()
	antennaId pointer to the row in the Antenna table having Antenna.antennaId == antennaId
void	setInputAntennaId (int i, Tag inputAntennaId)
	Set inputAntennaId[i] with the specified Tag.
void	addInputAntennaId (Tag id)
	Append a Tag to inputAntennaId.
void	addInputAntennaId (const vector< Tag > &id)
	Append a vector of Tag to inputAntennaId.
const Tag	getInputAntennaId (int i)
	Returns the Tag stored in inputAntennaId at position i.
AntennaRow *	getAntennaUsingInputAntennaId (int i)
	Returns the AntennaRow linked to this row via the tag stored in inputAntennaId at position i.
vector< AntennaRow * >	getAntennasUsingInputAntennaId ()
	Returns the vector of AntennaRow* linked to this row via the Tags stored in inputAntennaId.
bool	compareNoAutoInc (Tag antennaId, Tag spectralWindowId, ArrayTimeInterval timeInterval, WVRMethodMod::WVRMethod wvrMethod, vector< Frequency > polyFreqLimits, int numInputAntenna, int numChan, int numPoly, vector< vector< vector< float > > > pathCoeff, vector< vector< Temperature > > refTemp, vector< Tag > inputAntennaId)
	Compare each mandatory attribute except the autoincrementable one of this WVMCalRow with the corresponding parameters and return true if there is a match and false otherwise.
bool	compareRequiredValue (WVRMethodMod::WVRMethod wvrMethod, vector< Frequency > polyFreqLimits, int numInputAntenna, int numChan, int numPoly, vector< vector< vector< float > > > pathCoeff, vector< vector< Temperature > > refTemp, vector< Tag > inputAntennaId)
	Compare each mandatory value (i.e.
bool	equalByRequiredValue (WVMCalRow *x)
	Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
asdmIDL::WVMCalRowIDL *	toIDL () const
	Return this row in the form of an IDL struct.
void	toIDL (asdmIDL::WVMCalRowIDL &x) const
	Define the content of a WVMCalRowIDL struct from the values found in this row.
void	setFromIDL (asdmIDL::WVMCalRowIDL x)
	Fill the values of this row from the IDL struct WVMCalRowIDL.
std::string	toXML () const
	Return this row in the form of an XML string.
void	setFromXML (std::string rowDoc)
	Fill the values of this row from an XML string that was produced by the toXML() method.
Public Attributes
Intrinsic Table	Attributes
Extrinsic Table	Attributes
Private Member Functions
void	isAdded (bool added)
	This method is used by the Table class when this row is added to the table.
	WVMCalRow (WVMCalTable &table)
	Create a WVMCalRow.
	WVMCalRow (WVMCalTable &table, WVMCalRow &row)
	Create a WVMCalRow using a copy constructor mechanism.
void	antennaIdFromBin (EndianIStream &eis)
void	spectralWindowIdFromBin (EndianIStream &eis)
void	timeIntervalFromBin (EndianIStream &eis)
void	wvrMethodFromBin (EndianIStream &eis)
void	polyFreqLimitsFromBin (EndianIStream &eis)
void	numInputAntennaFromBin (EndianIStream &eis)
void	numChanFromBin (EndianIStream &eis)
void	numPolyFromBin (EndianIStream &eis)
void	pathCoeffFromBin (EndianIStream &eis)
void	refTempFromBin (EndianIStream &eis)
void	inputAntennaIdFromBin (EndianIStream &eis)
void	antennaIdFromText (const string &s)
void	spectralWindowIdFromText (const string &s)
void	timeIntervalFromText (const string &s)
void	wvrMethodFromText (const string &s)
void	polyFreqLimitsFromText (const string &s)
void	numInputAntennaFromText (const string &s)
void	numChanFromText (const string &s)
void	numPolyFromText (const string &s)
void	pathCoeffFromText (const string &s)
void	refTempFromText (const string &s)
void	inputAntennaIdFromText (const string &s)
void	toBin (EndianOSStream &eoss)
	Serialize this into a stream of bytes written to an EndianOSStream.
Private Attributes
WVMCalTable &	table
	The table to which this row belongs.
bool	hasBeenAdded
	Whether this row has been added to the table or not.
WVRMethodMod::WVRMethod	wvrMethod
	===> Attribute wvrMethod
vector< Frequency >	polyFreqLimits
	===> Attribute polyFreqLimits
int	numInputAntenna
	===> Attribute numInputAntenna
int	numChan
	===> Attribute numChan
int	numPoly
	===> Attribute numPoly
vector< vector< vector< float > > >	pathCoeff
	===> Attribute pathCoeff
vector< vector< Temperature > >	refTemp
	===> Attribute refTemp
vector< Tag >	inputAntennaId
	===> Attribute inputAntennaId
Tag	spectralWindowId
	===> Attribute spectralWindowId
Links *binary deserialization material from an EndianIStream std::map< std::string, WVMCalAttributeFromBin >	fromBinMethods
*text deserialization material std::map< std::string, WVMCalAttributeFromText >	fromTextMethods
Friends
class	asdm::WVMCalTable
class	asdm::RowTransformer< WVMCalRow >

Detailed Description

The WVMCalRow class is a row of a WVMCalTable.

Generated from model's revision "1.64", branch "HEAD"

Definition at line 125 of file WVMCalRow.h.

Constructor & Destructor Documentation

virtual asdm::WVMCalRow::~WVMCalRow ( ) [virtual]

friend class asdm::TableStreamReader<WVMCalTable, WVMCalRow>;

asdm::WVMCalRow::WVMCalRow ( WVMCalTable & table ) [private]

Create a WVMCalRow.

This constructor is private because only the table can create rows. All rows know the table to which they belong.

Parameters:

table

The table to which this row belongs.

asdm::WVMCalRow::WVMCalRow	(	WVMCalTable &	table,
		WVMCalRow &	row
	)			`[private]`

Create a WVMCalRow using a copy constructor mechanism.

Given a WVMCalRow row and a WVMCalTable table, the method creates a new WVMCalRow owned by table. Each attribute of the created row is a copy (deep) of the corresponding attribute of row. The method does not add the created row to its table, its simply parents it to table, a call to the add method has to be done in order to get the row added (very likely after having modified some of its attributes). If row is null then the method returns a row with default values for its attributes.

This constructor is private because only the table can create rows. All rows know the table to which they belong.

Parameters:

	table	The table to which this row belongs.
	row	The row which is to be copied.

Member Function Documentation

void asdm::WVMCalRow::addInputAntennaId ( const vector< Tag > & id )

Append a vector of Tag to inputAntennaId.

Parameters:

id

an array of Tag to be appended to inputAntennaId

void asdm::WVMCalRow::addInputAntennaId ( Tag id )

Append a Tag to inputAntennaId.

Parameters:

id

the Tag to be appended to inputAntennaId

void asdm::WVMCalRow::antennaIdFromBin ( EndianIStream & eis ) [private]

void asdm::WVMCalRow::antennaIdFromText ( const string & s ) [private]

bool asdm::WVMCalRow::compareNoAutoInc	(	Tag	antennaId,
		Tag	spectralWindowId,
		ArrayTimeInterval	timeInterval,
		WVRMethodMod::WVRMethod	wvrMethod,
		vector< Frequency >	polyFreqLimits,
		int	numInputAntenna,
		int	numChan,
		int	numPoly,
		vector< vector< vector< float > > >	pathCoeff,
		vector< vector< Temperature > >	refTemp,
		vector< Tag >	inputAntennaId
	)

Compare each mandatory attribute except the autoincrementable one of this WVMCalRow with the corresponding parameters and return true if there is a match and false otherwise.

Parameters:

	antennaId
	spectralWindowId
	timeInterval
	wvrMethod
	polyFreqLimits
	numInputAntenna
	numChan
	numPoly
	pathCoeff
	refTemp
	inputAntennaId

bool asdm::WVMCalRow::compareRequiredValue	(	WVRMethodMod::WVRMethod	wvrMethod,
		vector< Frequency >	polyFreqLimits,
		int	numInputAntenna,
		int	numChan,
		int	numPoly,
		vector< vector< vector< float > > >	pathCoeff,
		vector< vector< Temperature > >	refTemp,
		vector< Tag >	inputAntennaId
	)

Compare each mandatory value (i.e.

not in the key) attribute with the corresponding parameters and return true if there is a match and false otherwise.

Parameters:

	wvrMethod
	polyFreqLimits
	numInputAntenna
	numChan
	numPoly
	pathCoeff
	refTemp
	inputAntennaId

bool asdm::WVMCalRow::equalByRequiredValue ( WVMCalRow * x )

Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.

Parameters:

x

a pointer on the WVMCalRow whose required attributes of the value part will be compared with those of this.

Returns:: a boolean.

vector<AntennaRow *> asdm::WVMCalRow::getAntennasUsingInputAntennaId ( )

Returns the vector of AntennaRow* linked to this row via the Tags stored in inputAntennaId.

Returns:: an array of pointers on AntennaRow.

AntennaRow* asdm::WVMCalRow::getAntennaUsingAntennaId ( )

antennaId pointer to the row in the Antenna table having Antenna.antennaId == antennaId

Returns:: a AntennaRow*

AntennaRow* asdm::WVMCalRow::getAntennaUsingInputAntennaId ( int i )

Returns the AntennaRow linked to this row via the tag stored in inputAntennaId at position i.

Parameters:

i

the position in inputAntennaId.

Returns:: a pointer on a AntennaRow whose key (a Tag) is equal to the Tag stored at position i in the inputAntennaId.

const Tag asdm::WVMCalRow::getInputAntennaId ( int i )

Returns the Tag stored in inputAntennaId at position i.

Parameters:

i

the position in inputAntennaId where the Tag is retrieved.

Returns:: the Tag stored at position i in inputAntennaId.

vector<Tag> asdm::WVMCalRow::getInputAntennaId ( ) const

===> Attribute inputAntennaId

Get inputAntennaId.

Returns:: inputAntennaId as vector<Tag>

int asdm::WVMCalRow::getNumChan ( ) const

===> Attribute numChan

Get numChan.

Returns:: numChan as int

int asdm::WVMCalRow::getNumInputAntenna ( ) const

===> Attribute numInputAntenna

Get numInputAntenna.

Returns:: numInputAntenna as int

int asdm::WVMCalRow::getNumPoly ( ) const

===> Attribute numPoly

Get numPoly.

Returns:: numPoly as int

vector<vector<vector<float > > > asdm::WVMCalRow::getPathCoeff ( ) const

===> Attribute pathCoeff

Get pathCoeff.

Returns:: pathCoeff as vector<vector<vector<float > > >

vector<Frequency > asdm::WVMCalRow::getPolyFreqLimits ( ) const

===> Attribute polyFreqLimits

Get polyFreqLimits.

Returns:: polyFreqLimits as vector<Frequency >

vector<vector<Temperature > > asdm::WVMCalRow::getRefTemp ( ) const

===> Attribute refTemp

Get refTemp.

Returns:: refTemp as vector<vector<Temperature > >

Tag asdm::WVMCalRow::getSpectralWindowId ( ) const

===> Attribute spectralWindowId

Get spectralWindowId.

Returns:: spectralWindowId as Tag

Links* SpectralWindowRow* asdm::WVMCalRow::getSpectralWindowUsingSpectralWindowId ( )

spectralWindowId pointer to the row in the SpectralWindow table having SpectralWindow.spectralWindowId == spectralWindowId

Returns:: a SpectralWindowRow*

WVMCalTable& asdm::WVMCalRow::getTable ( ) const

Return the table to which this row belongs.

WVRMethodMod::WVRMethod asdm::WVMCalRow::getWvrMethod ( ) const

===> Attribute wvrMethod

Get wvrMethod.

Returns:: wvrMethod as WVRMethodMod::WVRMethod

void asdm::WVMCalRow::inputAntennaIdFromBin ( EndianIStream & eis ) [private]

void asdm::WVMCalRow::inputAntennaIdFromText ( const string & s ) [private]

void asdm::WVMCalRow::isAdded ( bool added ) [private]

This method is used by the Table class when this row is added to the table.

bool asdm::WVMCalRow::isAdded ( ) const

Has this row been added to its table ?

Returns:: true if and only if it has been added.

void asdm::WVMCalRow::numChanFromBin ( EndianIStream & eis ) [private]

void asdm::WVMCalRow::numChanFromText ( const string & s ) [private]

void asdm::WVMCalRow::numInputAntennaFromBin ( EndianIStream & eis ) [private]

void asdm::WVMCalRow::numInputAntennaFromText ( const string & s ) [private]

void asdm::WVMCalRow::numPolyFromBin ( EndianIStream & eis ) [private]

void asdm::WVMCalRow::numPolyFromText ( const string & s ) [private]

void asdm::WVMCalRow::pathCoeffFromBin ( EndianIStream & eis ) [private]

void asdm::WVMCalRow::pathCoeffFromText ( const string & s ) [private]

void asdm::WVMCalRow::polyFreqLimitsFromBin ( EndianIStream & eis ) [private]

void asdm::WVMCalRow::polyFreqLimitsFromText ( const string & s ) [private]

void asdm::WVMCalRow::refTempFromBin ( EndianIStream & eis ) [private]

void asdm::WVMCalRow::refTempFromText ( const string & s ) [private]

void asdm::WVMCalRow::setAntennaId ( Tag antennaId )

Set antennaId with the specified Tag.

Parameters:

antennaId

The Tag value to which antennaId is to be set.

Exceptions:

IllegalAccessException

If an attempt is made to change this field after is has been added to the table.

void asdm::WVMCalRow::setFromIDL ( asdmIDL::WVMCalRowIDL x )

Fill the values of this row from the IDL struct WVMCalRowIDL.

Parameters:

x

The IDL struct containing the values used to fill this row.

Exceptions:

ConversionException

void asdm::WVMCalRow::setFromXML ( std::string rowDoc )

Fill the values of this row from an XML string that was produced by the toXML() method.

Parameters:

rowDoc

the XML string being used to set the values of this row.

Exceptions:

ConversionException

void asdm::WVMCalRow::setInputAntennaId	(	int	i,
		Tag	inputAntennaId
	)

Set inputAntennaId[i] with the specified Tag.

Parameters:

	i	The index in inputAntennaId where to set the Tag value.
	inputAntennaId	The Tag value to which inputAntennaId[i] is to be set.

Exceptions:

IndexOutOfBoundsException

void asdm::WVMCalRow::setInputAntennaId ( vector< Tag > inputAntennaId )

Set inputAntennaId with the specified vector<Tag> .

Parameters:

inputAntennaId

The vector<Tag> value to which inputAntennaId is to be set.

void asdm::WVMCalRow::setNumChan ( int numChan )

Set numChan with the specified int.

Parameters:

numChan

The int value to which numChan is to be set.

void asdm::WVMCalRow::setNumInputAntenna ( int numInputAntenna )

Set numInputAntenna with the specified int.

Parameters:

numInputAntenna

The int value to which numInputAntenna is to be set.

void asdm::WVMCalRow::setNumPoly ( int numPoly )

Set numPoly with the specified int.

Parameters:

numPoly

The int value to which numPoly is to be set.

void asdm::WVMCalRow::setPathCoeff ( vector< vector< vector< float > > > pathCoeff )

Set pathCoeff with the specified vector<vector<vector<float > > >.

Parameters:

pathCoeff

The vector<vector<vector<float > > > value to which pathCoeff is to be set.

void asdm::WVMCalRow::setPolyFreqLimits ( vector< Frequency > polyFreqLimits )

Set polyFreqLimits with the specified vector<Frequency >.

Parameters:

polyFreqLimits

The vector<Frequency > value to which polyFreqLimits is to be set.

void asdm::WVMCalRow::setRefTemp ( vector< vector< Temperature > > refTemp )

Set refTemp with the specified vector<vector<Temperature > >.

Parameters:

refTemp

The vector<vector<Temperature > > value to which refTemp is to be set.

void asdm::WVMCalRow::setSpectralWindowId ( Tag spectralWindowId )

Set spectralWindowId with the specified Tag.

Parameters:

spectralWindowId

The Tag value to which spectralWindowId is to be set.

Exceptions:

IllegalAccessException

If an attempt is made to change this field after is has been added to the table.

void asdm::WVMCalRow::setTimeInterval ( ArrayTimeInterval timeInterval )

Set timeInterval with the specified ArrayTimeInterval.

Parameters:

timeInterval

The ArrayTimeInterval value to which timeInterval is to be set.

Exceptions:

IllegalAccessException

If an attempt is made to change this field after is has been added to the table.

void asdm::WVMCalRow::setWvrMethod ( WVRMethodMod::WVRMethod wvrMethod )

Set wvrMethod with the specified WVRMethodMod::WVRMethod.

Parameters:

wvrMethod

The WVRMethodMod::WVRMethod value to which wvrMethod is to be set.

void asdm::WVMCalRow::spectralWindowIdFromBin ( EndianIStream & eis ) [private]

void asdm::WVMCalRow::spectralWindowIdFromText ( const string & s ) [private]

void asdm::WVMCalRow::timeIntervalFromBin ( EndianIStream & eis ) [private]

void asdm::WVMCalRow::timeIntervalFromText ( const string & s ) [private]

void asdm::WVMCalRow::toBin ( EndianOSStream & eoss ) [private]

Serialize this into a stream of bytes written to an EndianOSStream.

Parameters:

eoss

the EndianOSStream to be written to

void asdm::WVMCalRow::toIDL ( asdmIDL::WVMCalRowIDL & x ) const

Define the content of a WVMCalRowIDL struct from the values found in this row.

Parameters:

x

a reference to the WVMCalRowIDL struct to be set.

asdmIDL::WVMCalRowIDL* asdm::WVMCalRow::toIDL ( ) const

Return this row in the form of an IDL struct.

Returns:: The values of this row as a WVMCalRowIDL struct.

std::string asdm::WVMCalRow::toXML ( ) const

Return this row in the form of an XML string.

Returns:: The values of this row as an XML string.

void asdm::WVMCalRow::wvrMethodFromBin ( EndianIStream & eis ) [private]

void asdm::WVMCalRow::wvrMethodFromText ( const string & s ) [private]

Friends And Related Function Documentation

friend class asdm::RowTransformer< WVMCalRow > [friend]

Definition at line 127 of file WVMCalRow.h.

friend class asdm::WVMCalTable [friend]

Definition at line 126 of file WVMCalRow.h.

Member Data Documentation

Extrinsic Table asdm::WVMCalRow::Attributes

Definition at line 396 of file WVMCalRow.h.

Extrinsic Table asdm::WVMCalRow::Attributes

Definition at line 150 of file WVMCalRow.h.

Links* binary deserialization material from an EndianIStream std::map<std::string, WVMCalAttributeFromBin> asdm::WVMCalRow::fromBinMethods [private]

Definition at line 924 of file WVMCalRow.h.

* text deserialization material std::map<std::string, WVMCalAttributeFromText> asdm::WVMCalRow::fromTextMethods [private]

Definition at line 943 of file WVMCalRow.h.

bool asdm::WVMCalRow::hasBeenAdded [private]

Whether this row has been added to the table or not.

Definition at line 731 of file WVMCalRow.h.

vector<Tag> asdm::WVMCalRow::inputAntennaId [private]

===> Attribute inputAntennaId

Definition at line 878 of file WVMCalRow.h.

int asdm::WVMCalRow::numChan [private]

===> Attribute numChan

Definition at line 819 of file WVMCalRow.h.

int asdm::WVMCalRow::numInputAntenna [private]

===> Attribute numInputAntenna

Definition at line 808 of file WVMCalRow.h.

int asdm::WVMCalRow::numPoly [private]

===> Attribute numPoly

Definition at line 830 of file WVMCalRow.h.

vector<vector<vector<float > > > asdm::WVMCalRow::pathCoeff [private]

===> Attribute pathCoeff

Definition at line 841 of file WVMCalRow.h.

vector<Frequency > asdm::WVMCalRow::polyFreqLimits [private]

===> Attribute polyFreqLimits

Definition at line 797 of file WVMCalRow.h.

vector<vector<Temperature > > asdm::WVMCalRow::refTemp [private]

===> Attribute refTemp

Definition at line 852 of file WVMCalRow.h.

Tag asdm::WVMCalRow::spectralWindowId [private]

===> Attribute spectralWindowId

Definition at line 889 of file WVMCalRow.h.

WVMCalTable& asdm::WVMCalRow::table [private]

The table to which this row belongs.

Definition at line 727 of file WVMCalRow.h.

WVRMethodMod::WVRMethod asdm::WVMCalRow::wvrMethod [private]

===> Attribute wvrMethod

Definition at line 786 of file WVMCalRow.h.

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

code/alma/ASDM/WVMCalRow.h

asdm::WVMCalRow Class Reference

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation