asdm::CalAmpliRow Class Reference

#include <CalAmpliRow.h>

Collaboration diagram for asdm::CalAmpliRow:

Collaboration graph
[legend]
List of all members.

Detailed Description

The CalAmpliRow class is a row of a CalAmpliTable.

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

Definition at line 155 of file CalAmpliRow.h.

Public Member Functions

virtual ~CalAmpliRow ()
CalAmpliTablegetTable () const
 Return the table to which this row belongs.
CalAmpliRowIDL * toIDL () const
 Return this row in the form of an IDL struct.
void setFromIDL (CalAmpliRowIDL x) throw (ConversionException)
 Fill the values of this row from the IDL struct CalAmpliRowIDL.
string toXML () const
 Return this row in the form of an XML string.
void setFromXML (string rowDoc) throw (ConversionException)
 Fill the values of this row from an XML string that was produced by the toXML() method.
void setNumAPC (int numAPC)
 Set numAPC with the specified int.
int getNumReceptor () const
 Get numReceptor.
void setNumReceptor (int numReceptor)
 Set numReceptor with the specified int.
ReceiverBandMod::ReceiverBand getReceiverBand () const
 Get receiverBand.
void setReceiverBand (ReceiverBandMod::ReceiverBand receiverBand)
 Set receiverBand with the specified ReceiverBandMod::ReceiverBand.
string getAntennaName () const
 Get antennaName.
void setAntennaName (string antennaName)
 Set antennaName with the specified string.
vector< AtmPhaseCorrectionMod::AtmPhaseCorrection > getAtmPhaseCorrections () const
 Get atmPhaseCorrections.
void setAtmPhaseCorrections (vector< AtmPhaseCorrectionMod::AtmPhaseCorrection > atmPhaseCorrections)
 Set atmPhaseCorrections with the specified vector<AtmPhaseCorrectionMod::AtmPhaseCorrection >.
vector< PolarizationTypeMod::PolarizationType > getPolarizationTypes () const
 Get polarizationTypes.
void setPolarizationTypes (vector< PolarizationTypeMod::PolarizationType > polarizationTypes)
 Set polarizationTypes with the specified vector<PolarizationTypeMod::PolarizationType >.
ArrayTime getStartValidTime () const
 Get startValidTime.
void setStartValidTime (ArrayTime startValidTime)
 Set startValidTime with the specified ArrayTime.
ArrayTime getEndValidTime () const
 Get endValidTime.
void setEndValidTime (ArrayTime endValidTime)
 Set endValidTime with the specified ArrayTime.
vector< FrequencygetFrequencyRange () const
 Get frequencyRange.
void setFrequencyRange (vector< Frequency > frequencyRange)
 Set frequencyRange with the specified vector<Frequency >.
bool isApertureEfficiencyExists () const
 The attribute apertureEfficiency is optional.
vector< vector< float > > getApertureEfficiency () const throw (IllegalAccessException)
 Get apertureEfficiency, which is optional.
void setApertureEfficiency (vector< vector< float > > apertureEfficiency)
 Set apertureEfficiency with the specified vector<vector<float > >.
void clearApertureEfficiency ()
 Mark apertureEfficiency, which is an optional field, as non-existent.
bool isApertureEfficiencyErrorExists () const
 The attribute apertureEfficiencyError is optional.
vector< vector< float > > getApertureEfficiencyError () const throw (IllegalAccessException)
 Get apertureEfficiencyError, which is optional.
void setApertureEfficiencyError (vector< vector< float > > apertureEfficiencyError)
 Set apertureEfficiencyError with the specified vector<vector<float > >.
void clearApertureEfficiencyError ()
 Mark apertureEfficiencyError, which is an optional field, as non-existent.
bool isCorrectionValidityExists () const
 The attribute correctionValidity is optional.
bool getCorrectionValidity () const throw (IllegalAccessException)
 Get correctionValidity, which is optional.
void setCorrectionValidity (bool correctionValidity)
 Set correctionValidity with the specified bool.
void clearCorrectionValidity ()
 Mark correctionValidity, which is an optional field, as non-existent.
void setCalDataId (Tag calDataId)
 Set calDataId with the specified Tag.
Tag getCalReductionId () const
 Get calReductionId.
void setCalReductionId (Tag calReductionId)
 Set calReductionId with the specified Tag.
Links *CalDataRowgetCalDataUsingCalDataId ()
 calDataId pointer to the row in the CalData table having CalData.calDataId == calDataId
CalReductionRowgetCalReductionUsingCalReductionId ()
 calReductionId pointer to the row in the CalReduction table having CalReduction.calReductionId == calReductionId
bool compareNoAutoInc (Tag calDataId, Tag calReductionId, string antennaName, int numAPC, int numReceptor, ReceiverBandMod::ReceiverBand receiverBand, vector< AtmPhaseCorrectionMod::AtmPhaseCorrection > atmPhaseCorrections, vector< PolarizationTypeMod::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 compareRequiredValue (int numAPC, int numReceptor, ReceiverBandMod::ReceiverBand receiverBand, vector< AtmPhaseCorrectionMod::AtmPhaseCorrection > atmPhaseCorrections, vector< PolarizationTypeMod::PolarizationType > polarizationTypes, ArrayTime startValidTime, ArrayTime endValidTime, vector< Frequency > frequencyRange)
bool equalByRequiredValue (CalAmpliRow *x)
 Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.

Public Attributes

Intrinsic Table Attributes
Extrinsic Table Attributes

Private Member Functions

void isAdded ()
 This method is used by the Table class when this row is added to the table.
 CalAmpliRow (CalAmpliTable &table)
 Create a CalAmpliRow.
 CalAmpliRow (CalAmpliTable &table, CalAmpliRow &row)
 Create a CalAmpliRow using a copy constructor mechanism.

Private Attributes

CalAmpliTabletable
 The table to which this row belongs.
bool hasBeenAdded
 Whether this row has been added to the table or not.
int numReceptor
 ===> Attribute numReceptor
ReceiverBandMod::ReceiverBand receiverBand
 ===> Attribute receiverBand
string antennaName
 ===> Attribute antennaName
vector< AtmPhaseCorrectionMod::AtmPhaseCorrection > atmPhaseCorrections
 ===> Attribute atmPhaseCorrections
vector< PolarizationTypeMod::PolarizationType > polarizationTypes
 ===> Attribute polarizationTypes
ArrayTime startValidTime
 ===> Attribute startValidTime
ArrayTime endValidTime
 ===> Attribute endValidTime
vector< FrequencyfrequencyRange
 ===> Attribute frequencyRange
bool apertureEfficiencyExists
 ===> Attribute apertureEfficiency, which is optional
vector< vector< float > > apertureEfficiency
bool apertureEfficiencyErrorExists
 ===> Attribute apertureEfficiencyError, which is optional
vector< vector< float > > apertureEfficiencyError
bool correctionValidityExists
 ===> Attribute correctionValidity, which is optional
bool correctionValidity
Tag calReductionId
 ===> Attribute calReductionId

Friends

class asdm::CalAmpliTable


Constructor & Destructor Documentation

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

asdm::CalAmpliRow::CalAmpliRow ( CalAmpliTable table  )  [private]

Create a CalAmpliRow.

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::CalAmpliRow::CalAmpliRow ( CalAmpliTable table,
CalAmpliRow row 
) [private]

Create a CalAmpliRow using a copy constructor mechanism.

Given a CalAmpliRow row and a CalAmpliTable table, the method creates a new CalAmpliRow 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

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.

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.

ReceiverBandMod::ReceiverBand asdm::CalAmpliRow::getReceiverBand (  )  const

Get receiverBand.

Returns:
receiverBand as ReceiverBandMod::ReceiverBand

void asdm::CalAmpliRow::setReceiverBand ( ReceiverBandMod::ReceiverBand  receiverBand  ) 

Set receiverBand with the specified ReceiverBandMod::ReceiverBand.

Parameters:
receiverBand The ReceiverBandMod::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  ) 

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<AtmPhaseCorrectionMod::AtmPhaseCorrection > asdm::CalAmpliRow::getAtmPhaseCorrections (  )  const

Get atmPhaseCorrections.

Returns:
atmPhaseCorrections as vector<AtmPhaseCorrectionMod::AtmPhaseCorrection >

void asdm::CalAmpliRow::setAtmPhaseCorrections ( vector< AtmPhaseCorrectionMod::AtmPhaseCorrection >  atmPhaseCorrections  ) 

Set atmPhaseCorrections with the specified vector<AtmPhaseCorrectionMod::AtmPhaseCorrection >.

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

vector<PolarizationTypeMod::PolarizationType > asdm::CalAmpliRow::getPolarizationTypes (  )  const

Get polarizationTypes.

Returns:
polarizationTypes as vector<PolarizationTypeMod::PolarizationType >

void asdm::CalAmpliRow::setPolarizationTypes ( vector< PolarizationTypeMod::PolarizationType >  polarizationTypes  ) 

Set polarizationTypes with the specified vector<PolarizationTypeMod::PolarizationType >.

Parameters:
polarizationTypes The vector<PolarizationTypeMod::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.

void asdm::CalAmpliRow::setCalDataId ( Tag  calDataId  ) 

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  ) 

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.

Links* 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,
ReceiverBandMod::ReceiverBand  receiverBand,
vector< AtmPhaseCorrectionMod::AtmPhaseCorrection >  atmPhaseCorrections,
vector< PolarizationTypeMod::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::compareRequiredValue ( int  numAPC,
int  numReceptor,
ReceiverBandMod::ReceiverBand  receiverBand,
vector< AtmPhaseCorrectionMod::AtmPhaseCorrection >  atmPhaseCorrections,
vector< PolarizationTypeMod::PolarizationType >  polarizationTypes,
ArrayTime  startValidTime,
ArrayTime  endValidTime,
vector< Frequency frequencyRange 
)

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.

void asdm::CalAmpliRow::isAdded (  )  [private]

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


Friends And Related Function Documentation

friend class asdm::CalAmpliTable [friend]

Definition at line 156 of file CalAmpliRow.h.


Member Data Documentation

Extrinsic Table asdm::CalAmpliRow::Attributes

Definition at line 201 of file CalAmpliRow.h.

Extrinsic Table asdm::CalAmpliRow::Attributes

Definition at line 600 of file CalAmpliRow.h.

CalAmpliTable& asdm::CalAmpliRow::table [private]

The table to which this row belongs.

Definition at line 726 of file CalAmpliRow.h.

bool asdm::CalAmpliRow::hasBeenAdded [private]

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

Definition at line 730 of file CalAmpliRow.h.

int asdm::CalAmpliRow::numReceptor [private]

===> Attribute numReceptor

Definition at line 785 of file CalAmpliRow.h.

ReceiverBandMod::ReceiverBand asdm::CalAmpliRow::receiverBand [private]

===> Attribute receiverBand

Definition at line 796 of file CalAmpliRow.h.

string asdm::CalAmpliRow::antennaName [private]

===> Attribute antennaName

Definition at line 807 of file CalAmpliRow.h.

vector<AtmPhaseCorrectionMod::AtmPhaseCorrection > asdm::CalAmpliRow::atmPhaseCorrections [private]

===> Attribute atmPhaseCorrections

Definition at line 818 of file CalAmpliRow.h.

vector<PolarizationTypeMod::PolarizationType > asdm::CalAmpliRow::polarizationTypes [private]

===> Attribute polarizationTypes

Definition at line 829 of file CalAmpliRow.h.

ArrayTime asdm::CalAmpliRow::startValidTime [private]

===> Attribute startValidTime

Definition at line 840 of file CalAmpliRow.h.

ArrayTime asdm::CalAmpliRow::endValidTime [private]

===> Attribute endValidTime

Definition at line 851 of file CalAmpliRow.h.

vector<Frequency > asdm::CalAmpliRow::frequencyRange [private]

===> Attribute frequencyRange

Definition at line 862 of file CalAmpliRow.h.

bool asdm::CalAmpliRow::apertureEfficiencyExists [private]

===> Attribute apertureEfficiency, which is optional

Definition at line 872 of file CalAmpliRow.h.

vector<vector<float > > asdm::CalAmpliRow::apertureEfficiency [private]

Definition at line 875 of file CalAmpliRow.h.

bool asdm::CalAmpliRow::apertureEfficiencyErrorExists [private]

===> Attribute apertureEfficiencyError, which is optional

Definition at line 885 of file CalAmpliRow.h.

vector<vector<float > > asdm::CalAmpliRow::apertureEfficiencyError [private]

Definition at line 888 of file CalAmpliRow.h.

bool asdm::CalAmpliRow::correctionValidityExists [private]

===> Attribute correctionValidity, which is optional

Definition at line 898 of file CalAmpliRow.h.

bool asdm::CalAmpliRow::correctionValidity [private]

Definition at line 901 of file CalAmpliRow.h.

Tag asdm::CalAmpliRow::calReductionId [private]

===> Attribute calReductionId

Definition at line 927 of file CalAmpliRow.h.


The documentation for this class was generated from the following file:
Generated on Thu Aug 27 21:23:32 2009 for NRAOCASA by  doxygen 1.5.1