asdm::CalDeviceRow Class Reference

#include <CalDeviceRow.h>

Collaboration diagram for asdm::CalDeviceRow:

Collaboration graph
[legend]
List of all members.

Detailed Description

The CalDeviceRow class is a row of a CalDeviceTable.

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

Definition at line 140 of file CalDeviceRow.h.

Public Member Functions

virtual ~CalDeviceRow ()
CalDeviceTablegetTable () const
 Return the table to which this row belongs.
CalDeviceRowIDL * toIDL () const
 Return this row in the form of an IDL struct.
void setFromIDL (CalDeviceRowIDL x) throw (ConversionException)
 Fill the values of this row from the IDL struct CalDeviceRowIDL.
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 setTimeInterval (ArrayTimeInterval timeInterval)
 Set timeInterval with the specified ArrayTimeInterval.
int getNumCalload () const
 Get numCalload.
void setNumCalload (int numCalload)
 Set numCalload with the specified int.
bool isNoiseCalExists () const
 The attribute noiseCal is optional.
vector< double > getNoiseCal () const throw (IllegalAccessException)
 Get noiseCal, which is optional.
void setNoiseCal (vector< double > noiseCal)
 Set noiseCal with the specified vector<double >.
void clearNoiseCal ()
 Mark noiseCal, which is an optional field, as non-existent.
bool isTemperatureLoadExists () const
 The attribute temperatureLoad is optional.
vector< TemperaturegetTemperatureLoad () const throw (IllegalAccessException)
 Get temperatureLoad, which is optional.
void setTemperatureLoad (vector< Temperature > temperatureLoad)
 Set temperatureLoad with the specified vector<Temperature >.
void clearTemperatureLoad ()
 Mark temperatureLoad, which is an optional field, as non-existent.
bool isCalEffExists () const
 The attribute calEff is optional.
vector< vector< float > > getCalEff () const throw (IllegalAccessException)
 Get calEff, which is optional.
void setCalEff (vector< vector< float > > calEff)
 Set calEff with the specified vector<vector<float > >.
void clearCalEff ()
 Mark calEff, which is an optional field, as non-existent.
vector< CalibrationDeviceMod::CalibrationDevice > getCalLoadName () const
 Get calLoadName.
void setCalLoadName (vector< CalibrationDeviceMod::CalibrationDevice > calLoadName)
 Set calLoadName with the specified vector<CalibrationDeviceMod::CalibrationDevice >.
void setAntennaId (Tag antennaId)
 Set antennaId with the specified Tag.
int getFeedId () const
 Get feedId.
void setFeedId (int feedId)
 Set feedId with the specified int.
Tag getSpectralWindowId () const
 Get spectralWindowId.
void setSpectralWindowId (Tag spectralWindowId)
 Set spectralWindowId with the specified Tag.
Links *AntennaRowgetAntennaUsingAntennaId ()
 antennaId pointer to the row in the Antenna table having Antenna.antennaId == antennaId
SpectralWindowRowgetSpectralWindowUsingSpectralWindowId ()
 spectralWindowId pointer to the row in the SpectralWindow table having SpectralWindow.spectralWindowId == spectralWindowId
vector< FeedRow * > getFeeds ()
 Get the collection of row in the Feed table having feedId == this.feedId.
bool compareNoAutoInc (Tag antennaId, int feedId, Tag spectralWindowId, ArrayTimeInterval timeInterval, int numCalload, vector< CalibrationDeviceMod::CalibrationDevice > calLoadName)
 Compare each mandatory attribute except the autoincrementable one of this CalDeviceRow with the corresponding parameters and return true if there is a match and false otherwise.
bool compareRequiredValue (int numCalload, vector< CalibrationDeviceMod::CalibrationDevice > calLoadName)
bool equalByRequiredValue (CalDeviceRow *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.
 CalDeviceRow (CalDeviceTable &table)
 Create a CalDeviceRow.
 CalDeviceRow (CalDeviceTable &table, CalDeviceRow &row)
 Create a CalDeviceRow using a copy constructor mechanism.

Private Attributes

CalDeviceTabletable
 The table to which this row belongs.
bool hasBeenAdded
 Whether this row has been added to the table or not.
int numCalload
 ===> Attribute numCalload
bool noiseCalExists
 ===> Attribute noiseCal, which is optional
vector< double > noiseCal
bool temperatureLoadExists
 ===> Attribute temperatureLoad, which is optional
vector< TemperaturetemperatureLoad
bool calEffExists
 ===> Attribute calEff, which is optional
vector< vector< float > > calEff
vector< CalibrationDeviceMod::CalibrationDevice > calLoadName
 ===> Attribute calLoadName
int feedId
 ===> Attribute feedId
Tag spectralWindowId
 ===> Attribute spectralWindowId

Friends

class asdm::CalDeviceTable


Constructor & Destructor Documentation

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

asdm::CalDeviceRow::CalDeviceRow ( CalDeviceTable table  )  [private]

Create a CalDeviceRow.

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

Create a CalDeviceRow using a copy constructor mechanism.

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

CalDeviceTable& asdm::CalDeviceRow::getTable (  )  const

Return the table to which this row belongs.

CalDeviceRowIDL* asdm::CalDeviceRow::toIDL (  )  const

Return this row in the form of an IDL struct.

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

void asdm::CalDeviceRow::setFromIDL ( CalDeviceRowIDL  x  )  throw (ConversionException)

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

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

string asdm::CalDeviceRow::toXML (  )  const

Return this row in the form of an XML string.

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

void asdm::CalDeviceRow::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::CalDeviceRow::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.

int asdm::CalDeviceRow::getNumCalload (  )  const

Get numCalload.

Returns:
numCalload as int

void asdm::CalDeviceRow::setNumCalload ( int  numCalload  ) 

Set numCalload with the specified int.

Parameters:
numCalload The int value to which numCalload is to be set.

bool asdm::CalDeviceRow::isNoiseCalExists (  )  const

The attribute noiseCal is optional.

Return true if this attribute exists.

Returns:
true if and only if the noiseCal attribute exists.

vector<double > asdm::CalDeviceRow::getNoiseCal (  )  const throw (IllegalAccessException)

Get noiseCal, which is optional.

Returns:
noiseCal as vector<double >
Exceptions:
IllegalAccessException If noiseCal does not exist.

void asdm::CalDeviceRow::setNoiseCal ( vector< double >  noiseCal  ) 

Set noiseCal with the specified vector<double >.

Parameters:
noiseCal The vector<double > value to which noiseCal is to be set.

void asdm::CalDeviceRow::clearNoiseCal (  ) 

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

bool asdm::CalDeviceRow::isTemperatureLoadExists (  )  const

The attribute temperatureLoad is optional.

Return true if this attribute exists.

Returns:
true if and only if the temperatureLoad attribute exists.

vector<Temperature > asdm::CalDeviceRow::getTemperatureLoad (  )  const throw (IllegalAccessException)

Get temperatureLoad, which is optional.

Returns:
temperatureLoad as vector<Temperature >
Exceptions:
IllegalAccessException If temperatureLoad does not exist.

void asdm::CalDeviceRow::setTemperatureLoad ( vector< Temperature temperatureLoad  ) 

Set temperatureLoad with the specified vector<Temperature >.

Parameters:
temperatureLoad The vector<Temperature > value to which temperatureLoad is to be set.

void asdm::CalDeviceRow::clearTemperatureLoad (  ) 

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

bool asdm::CalDeviceRow::isCalEffExists (  )  const

The attribute calEff is optional.

Return true if this attribute exists.

Returns:
true if and only if the calEff attribute exists.

vector<vector<float > > asdm::CalDeviceRow::getCalEff (  )  const throw (IllegalAccessException)

Get calEff, which is optional.

Returns:
calEff as vector<vector<float > >
Exceptions:
IllegalAccessException If calEff does not exist.

void asdm::CalDeviceRow::setCalEff ( vector< vector< float > >  calEff  ) 

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

Parameters:
calEff The vector<vector<float > > value to which calEff is to be set.

void asdm::CalDeviceRow::clearCalEff (  ) 

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

vector<CalibrationDeviceMod::CalibrationDevice > asdm::CalDeviceRow::getCalLoadName (  )  const

Get calLoadName.

Returns:
calLoadName as vector<CalibrationDeviceMod::CalibrationDevice >

void asdm::CalDeviceRow::setCalLoadName ( vector< CalibrationDeviceMod::CalibrationDevice >  calLoadName  ) 

Set calLoadName with the specified vector<CalibrationDeviceMod::CalibrationDevice >.

Parameters:
calLoadName The vector<CalibrationDeviceMod::CalibrationDevice > value to which calLoadName is to be set.

void asdm::CalDeviceRow::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.

int asdm::CalDeviceRow::getFeedId (  )  const

Get feedId.

Returns:
feedId as int

void asdm::CalDeviceRow::setFeedId ( int  feedId  ) 

Set feedId with the specified int.

Parameters:
feedId The int value to which feedId 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::CalDeviceRow::getSpectralWindowId (  )  const

Get spectralWindowId.

Returns:
spectralWindowId as Tag

void asdm::CalDeviceRow::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.

Links* AntennaRow* asdm::CalDeviceRow::getAntennaUsingAntennaId (  ) 

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

Returns:
a AntennaRow*

SpectralWindowRow* asdm::CalDeviceRow::getSpectralWindowUsingSpectralWindowId (  ) 

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

Returns:
a SpectralWindowRow*

vector<FeedRow *> asdm::CalDeviceRow::getFeeds (  ) 

Get the collection of row in the Feed table having feedId == this.feedId.

Returns:
a vector of FeedRow *

bool asdm::CalDeviceRow::compareNoAutoInc ( Tag  antennaId,
int  feedId,
Tag  spectralWindowId,
ArrayTimeInterval  timeInterval,
int  numCalload,
vector< CalibrationDeviceMod::CalibrationDevice >  calLoadName 
)

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

bool asdm::CalDeviceRow::compareRequiredValue ( int  numCalload,
vector< CalibrationDeviceMod::CalibrationDevice >  calLoadName 
)

bool asdm::CalDeviceRow::equalByRequiredValue ( CalDeviceRow 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 CalDeviceRow whose required attributes of the value part will be compared with those of this.
Returns:
a boolean.

void asdm::CalDeviceRow::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::CalDeviceTable [friend]

Definition at line 141 of file CalDeviceRow.h.


Member Data Documentation

Extrinsic Table asdm::CalDeviceRow::Attributes

Definition at line 186 of file CalDeviceRow.h.

Extrinsic Table asdm::CalDeviceRow::Attributes

Definition at line 405 of file CalDeviceRow.h.

CalDeviceTable& asdm::CalDeviceRow::table [private]

The table to which this row belongs.

Definition at line 580 of file CalDeviceRow.h.

bool asdm::CalDeviceRow::hasBeenAdded [private]

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

Definition at line 584 of file CalDeviceRow.h.

int asdm::CalDeviceRow::numCalload [private]

===> Attribute numCalload

Definition at line 639 of file CalDeviceRow.h.

bool asdm::CalDeviceRow::noiseCalExists [private]

===> Attribute noiseCal, which is optional

Definition at line 649 of file CalDeviceRow.h.

vector<double > asdm::CalDeviceRow::noiseCal [private]

Definition at line 652 of file CalDeviceRow.h.

bool asdm::CalDeviceRow::temperatureLoadExists [private]

===> Attribute temperatureLoad, which is optional

Definition at line 662 of file CalDeviceRow.h.

vector<Temperature > asdm::CalDeviceRow::temperatureLoad [private]

Definition at line 665 of file CalDeviceRow.h.

bool asdm::CalDeviceRow::calEffExists [private]

===> Attribute calEff, which is optional

Definition at line 675 of file CalDeviceRow.h.

vector<vector<float > > asdm::CalDeviceRow::calEff [private]

Definition at line 678 of file CalDeviceRow.h.

vector<CalibrationDeviceMod::CalibrationDevice > asdm::CalDeviceRow::calLoadName [private]

===> Attribute calLoadName

Definition at line 689 of file CalDeviceRow.h.

int asdm::CalDeviceRow::feedId [private]

===> Attribute feedId

Definition at line 715 of file CalDeviceRow.h.

Tag asdm::CalDeviceRow::spectralWindowId [private]

===> Attribute spectralWindowId

Definition at line 726 of file CalDeviceRow.h.


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