asdm::CalAmpliRow Class Reference

#include <CalAmpliRow.h>

List of all members.

---

Detailed Description

The CalAmpliRow class is a row of a CalAmpliTable.

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

Public Member Functions
CalAmpliTable &	getTable () const
CalAmpliRowIDL *	toIDL () const
void	setFromIDL (CalAmpliRowIDL x) throw (ConversionException)
string	toXML () const
void	setFromXML (string rowDoc) throw (ConversionException)
int	getNumAPC () const
void	setNumAPC (int numAPC)
int	getNumReceptor () const
void	setNumReceptor (int numReceptor)
ReceiverBand	getReceiverBand () const
void	setReceiverBand (ReceiverBand receiverBand)
string	getAntennaName () const
void	setAntennaName (string antennaName) throw (IllegalAccessException)
vector< AtmPhaseCorrection >	getAtmPhaseCorrections () const
void	setAtmPhaseCorrections (vector< AtmPhaseCorrection > atmPhaseCorrections)
vector< PolarizationType >	getPolarizationTypes () const
void	setPolarizationTypes (vector< PolarizationType > polarizationTypes)
ArrayTime	getStartValidTime () const
void	setStartValidTime (ArrayTime startValidTime)
ArrayTime	getEndValidTime () const
void	setEndValidTime (ArrayTime endValidTime)
vector< Frequency >	getFrequencyRange () const
void	setFrequencyRange (vector< Frequency > frequencyRange)
bool	isApertureEfficiencyExists () const
vector< vector< float > >	getApertureEfficiency () const throw (IllegalAccessException)
void	setApertureEfficiency (vector< vector< float > > apertureEfficiency)
void	clearApertureEfficiency ()
bool	isApertureEfficiencyErrorExists () const
vector< vector< float > >	getApertureEfficiencyError () const throw (IllegalAccessException)
void	setApertureEfficiencyError (vector< vector< float > > apertureEfficiencyError)
void	clearApertureEfficiencyError ()
bool	isCorrectionValidityExists () const
bool	getCorrectionValidity () const throw (IllegalAccessException)
void	setCorrectionValidity (bool correctionValidity)
void	clearCorrectionValidity ()
Tag	getCalDataId () const
void	setCalDataId (Tag calDataId) throw (IllegalAccessException)
Tag	getCalReductionId () const
void	setCalReductionId (Tag calReductionId) throw (IllegalAccessException)
CalDataRow *	getCalDataUsingCalDataId ()
CalReductionRow *	getCalReductionUsingCalReductionId ()
bool	compareNoAutoInc (Tag calDataId, Tag calReductionId, string antennaName, int numAPC, int numReceptor, ReceiverBand receiverBand, vector< AtmPhaseCorrection > atmPhaseCorrections, vector< PolarizationType > polarizationTypes, ArrayTime startValidTime, ArrayTime endValidTime, vector< Frequency > frequencyRange)
bool	compareRequiredValue (int numAPC, int numReceptor, ReceiverBand receiverBand, vector< AtmPhaseCorrection > atmPhaseCorrections, vector< PolarizationType > polarizationTypes, ArrayTime startValidTime, ArrayTime endValidTime, vector< Frequency > frequencyRange)
bool	equalByRequiredValue (CalAmpliRow *x)
Friends
class	asdm::CalAmpliTable

---

Member Function Documentation

CalAmpliTable& asdm::CalAmpliRow::getTable

(

)

const

Return the table to which this row belongs.

CalAmpliRowIDL* asdm::CalAmpliRow::toIDL

(

)

const

Return this row in the form of an IDL struct.

Returns:

The values of this row as a CalAmpliRowIDL struct.

void asdm::CalAmpliRow::setFromIDL

(

CalAmpliRowIDL

x

)

throw (ConversionException)

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

Parameters:

x

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

string asdm::CalAmpliRow::toXML

(

)

const

Return this row in the form of an XML string.

Returns:

The values of this row as an XML string.

void asdm::CalAmpliRow::setFromXML

(

string

rowDoc

)

throw (ConversionException)

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

Parameters:

x

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

int asdm::CalAmpliRow::getNumAPC

(

)

const

Get numAPC.

Returns:

numAPC as int

void asdm::CalAmpliRow::setNumAPC

(

int

numAPC

)

Set numAPC with the specified int.

Parameters:

numAPC

The int value to which numAPC is to be set.

int asdm::CalAmpliRow::getNumReceptor

(

)

const

Get numReceptor.

Returns:

numReceptor as int

void asdm::CalAmpliRow::setNumReceptor

(

int

numReceptor

)

Set numReceptor with the specified int.

Parameters:

numReceptor

The int value to which numReceptor is to be set.

ReceiverBand asdm::CalAmpliRow::getReceiverBand

(

)

const

Get receiverBand.

Returns:

receiverBand as ReceiverBand

void asdm::CalAmpliRow::setReceiverBand

(

ReceiverBand

receiverBand

)

Set receiverBand with the specified ReceiverBand.

Parameters:

receiverBand

The ReceiverBand value to which receiverBand is to be set.

string asdm::CalAmpliRow::getAntennaName

(

)

const

Get antennaName.

Returns:

antennaName as string

void asdm::CalAmpliRow::setAntennaName

(

string

antennaName

)

throw (IllegalAccessException)

Set antennaName with the specified string.

Parameters:

antennaName

The string value to which antennaName is to be set.

Exceptions:

IllegalAccessException

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

vector<AtmPhaseCorrection > asdm::CalAmpliRow::getAtmPhaseCorrections

(

)

const

Get atmPhaseCorrections.

Returns:

atmPhaseCorrections as vector<AtmPhaseCorrection >

void asdm::CalAmpliRow::setAtmPhaseCorrections

(

vector< AtmPhaseCorrection >

atmPhaseCorrections

)

Set atmPhaseCorrections with the specified vector<AtmPhaseCorrection >.

Parameters:

atmPhaseCorrections

The vector<AtmPhaseCorrection > value to which atmPhaseCorrections is to be set.

vector<PolarizationType > asdm::CalAmpliRow::getPolarizationTypes

(

)

const

Get polarizationTypes.

Returns:

polarizationTypes as vector<PolarizationType >

void asdm::CalAmpliRow::setPolarizationTypes

(

vector< PolarizationType >

polarizationTypes

)

Set polarizationTypes with the specified vector<PolarizationType >.

Parameters:

polarizationTypes

The vector<PolarizationType > value to which polarizationTypes is to be set.

ArrayTime asdm::CalAmpliRow::getStartValidTime

(

)

const

Get startValidTime.

Returns:

startValidTime as ArrayTime

void asdm::CalAmpliRow::setStartValidTime

(

ArrayTime

startValidTime

)

Set startValidTime with the specified ArrayTime.

Parameters:

startValidTime

The ArrayTime value to which startValidTime is to be set.

ArrayTime asdm::CalAmpliRow::getEndValidTime

(

)

const

Get endValidTime.

Returns:

endValidTime as ArrayTime

void asdm::CalAmpliRow::setEndValidTime

(

ArrayTime

endValidTime

)

Set endValidTime with the specified ArrayTime.

Parameters:

endValidTime

The ArrayTime value to which endValidTime is to be set.

vector<Frequency > asdm::CalAmpliRow::getFrequencyRange

(

)

const

Get frequencyRange.

Returns:

frequencyRange as vector<Frequency >

void asdm::CalAmpliRow::setFrequencyRange

(

vector< Frequency >

frequencyRange

)

Set frequencyRange with the specified vector<Frequency >.

Parameters:

frequencyRange

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

bool asdm::CalAmpliRow::isApertureEfficiencyExists

(

)

const

The attribute apertureEfficiency is optional. Return true if this attribute exists.

Returns:

true if and only if the apertureEfficiency attribute exists.

vector<vector<float > > asdm::CalAmpliRow::getApertureEfficiency

(

)

const throw (IllegalAccessException)

Get apertureEfficiency, which is optional.

Returns:

apertureEfficiency as vector<vector<float > >

Exceptions:

IllegalAccessException

If apertureEfficiency does not exist.

void asdm::CalAmpliRow::setApertureEfficiency

(

vector< vector< float > >

apertureEfficiency

)

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

Parameters:

apertureEfficiency

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

void asdm::CalAmpliRow::clearApertureEfficiency

(

)

Mark apertureEfficiency, which is an optional field, as non-existent.

bool asdm::CalAmpliRow::isApertureEfficiencyErrorExists

(

)

const

The attribute apertureEfficiencyError is optional. Return true if this attribute exists.

Returns:

true if and only if the apertureEfficiencyError attribute exists.

vector<vector<float > > asdm::CalAmpliRow::getApertureEfficiencyError

(

)

const throw (IllegalAccessException)

Get apertureEfficiencyError, which is optional.

Returns:

apertureEfficiencyError as vector<vector<float > >

Exceptions:

IllegalAccessException

If apertureEfficiencyError does not exist.

void asdm::CalAmpliRow::setApertureEfficiencyError

(

vector< vector< float > >

apertureEfficiencyError

)

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

Parameters:

apertureEfficiencyError

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

void asdm::CalAmpliRow::clearApertureEfficiencyError

(

)

Mark apertureEfficiencyError, which is an optional field, as non-existent.

bool asdm::CalAmpliRow::isCorrectionValidityExists

(

)

const

The attribute correctionValidity is optional. Return true if this attribute exists.

Returns:

true if and only if the correctionValidity attribute exists.

bool asdm::CalAmpliRow::getCorrectionValidity

(

)

const throw (IllegalAccessException)

Get correctionValidity, which is optional.

Returns:

correctionValidity as bool

Exceptions:

IllegalAccessException

If correctionValidity does not exist.

void asdm::CalAmpliRow::setCorrectionValidity

(

bool

correctionValidity

)

Set correctionValidity with the specified bool.

Parameters:

correctionValidity

The bool value to which correctionValidity is to be set.

void asdm::CalAmpliRow::clearCorrectionValidity

(

)

Mark correctionValidity, which is an optional field, as non-existent.

Tag asdm::CalAmpliRow::getCalDataId

(

)

const

Get calDataId.

Returns:

calDataId as Tag

void asdm::CalAmpliRow::setCalDataId

(

Tag

calDataId

)

throw (IllegalAccessException)

Set calDataId with the specified Tag.

Parameters:

calDataId

The Tag value to which calDataId is to be set.

Exceptions:

IllegalAccessException

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

Tag asdm::CalAmpliRow::getCalReductionId

(

)

const

Get calReductionId.

Returns:

calReductionId as Tag

void asdm::CalAmpliRow::setCalReductionId

(

Tag

calReductionId

)

throw (IllegalAccessException)

Set calReductionId with the specified Tag.

Parameters:

calReductionId

The Tag value to which calReductionId is to be set.

Exceptions:

IllegalAccessException

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

CalDataRow* asdm::CalAmpliRow::getCalDataUsingCalDataId

(

)

calDataId pointer to the row in the CalData table having CalData.calDataId == calDataId

Returns:

a CalDataRow*

CalReductionRow* asdm::CalAmpliRow::getCalReductionUsingCalReductionId

(

)

calReductionId pointer to the row in the CalReduction table having CalReduction.calReductionId == calReductionId

Returns:

a CalReductionRow*

bool asdm::CalAmpliRow::compareNoAutoInc	(	Tag	calDataId,
		Tag	calReductionId,
		string	antennaName,
		int	numAPC,
		int	numReceptor,
		ReceiverBand	receiverBand,
		vector< AtmPhaseCorrection >	atmPhaseCorrections,
		vector< PolarizationType >	polarizationTypes,
		ArrayTime	startValidTime,
		ArrayTime	endValidTime,
		vector< Frequency >	frequencyRange
	)

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

bool asdm::CalAmpliRow::equalByRequiredValue

(

CalAmpliRow *

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 CalAmpliRow whose required attributes of the value part will be compared with those of this.

Returns:

a boolean.

---

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

• CalAmpliRow.h

---