asdm::CalFocusRow Class Reference

#include <CalFocusRow.h>

Collaboration diagram for asdm::CalFocusRow:

Collaboration graph
[legend]
List of all members.

Detailed Description

The CalFocusRow class is a row of a CalFocusTable.

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

Definition at line 150 of file CalFocusRow.h.

Public Member Functions

virtual ~CalFocusRow ()
CalFocusTablegetTable () const
 Return the table to which this row belongs.
CalFocusRowIDL * toIDL () const
 Return this row in the form of an IDL struct.
void setFromIDL (CalFocusRowIDL x) throw (ConversionException)
 Fill the values of this row from the IDL struct CalFocusRowIDL.
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 setAntennaName (string antennaName)
 Set antennaName with the specified string.
vector< FrequencygetFrequencyRange () const
 Get frequencyRange.
void setFrequencyRange (vector< Frequency > frequencyRange)
 Set frequencyRange with the specified vector<Frequency >.
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.
ReceiverBandMod::ReceiverBand getReceiverBand () const
 Get receiverBand.
void setReceiverBand (ReceiverBandMod::ReceiverBand receiverBand)
 Set receiverBand with the specified ReceiverBandMod::ReceiverBand.
vector< LengthgetOffset () const
 Get offset.
void setOffset (vector< Length > offset)
 Set offset with the specified vector<Length >.
vector< LengthgetError () const
 Get error.
void setError (vector< Length > error)
 Set error with the specified vector<Length >.
FocusMethodMod::FocusMethod getFocusMethod () const
 Get focusMethod.
void setFocusMethod (FocusMethodMod::FocusMethod focusMethod)
 Set focusMethod with the specified FocusMethodMod::FocusMethod.
vector< AnglegetPointingDirection () const
 Get pointingDirection.
void setPointingDirection (vector< Angle > pointingDirection)
 Set pointingDirection with the specified vector<Angle >.
vector< bool > getWasFixed () const
 Get wasFixed.
void setWasFixed (vector< bool > wasFixed)
 Set wasFixed with the specified vector<bool >.
Temperature getAmbientTemperature () const
 Get ambientTemperature.
void setAmbientTemperature (Temperature ambientTemperature)
 Set ambientTemperature with the specified Temperature.
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, vector< Frequency > frequencyRange, ArrayTime startValidTime, ArrayTime endValidTime, ReceiverBandMod::ReceiverBand receiverBand, vector< Length > offset, vector< Length > error, FocusMethodMod::FocusMethod focusMethod, vector< Angle > pointingDirection, vector< bool > wasFixed, Temperature ambientTemperature)
 Compare each mandatory attribute except the autoincrementable one of this CalFocusRow with the corresponding parameters and return true if there is a match and false otherwise.
bool compareRequiredValue (vector< Frequency > frequencyRange, ArrayTime startValidTime, ArrayTime endValidTime, ReceiverBandMod::ReceiverBand receiverBand, vector< Length > offset, vector< Length > error, FocusMethodMod::FocusMethod focusMethod, vector< Angle > pointingDirection, vector< bool > wasFixed, Temperature ambientTemperature)
bool equalByRequiredValue (CalFocusRow *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.
 CalFocusRow (CalFocusTable &table)
 Create a CalFocusRow.
 CalFocusRow (CalFocusTable &table, CalFocusRow &row)
 Create a CalFocusRow using a copy constructor mechanism.

Private Attributes

CalFocusTabletable
 The table to which this row belongs.
bool hasBeenAdded
 Whether this row has been added to the table or not.
vector< FrequencyfrequencyRange
 ===> Attribute frequencyRange
ArrayTime startValidTime
 ===> Attribute startValidTime
ArrayTime endValidTime
 ===> Attribute endValidTime
ReceiverBandMod::ReceiverBand receiverBand
 ===> Attribute receiverBand
vector< Lengthoffset
 ===> Attribute offset
vector< Lengtherror
 ===> Attribute error
FocusMethodMod::FocusMethod focusMethod
 ===> Attribute focusMethod
vector< AnglepointingDirection
 ===> Attribute pointingDirection
vector< bool > wasFixed
 ===> Attribute wasFixed
Temperature ambientTemperature
 ===> Attribute ambientTemperature
Tag calReductionId
 ===> Attribute calReductionId

Friends

class asdm::CalFocusTable


Constructor & Destructor Documentation

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

asdm::CalFocusRow::CalFocusRow ( CalFocusTable table  )  [private]

Create a CalFocusRow.

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

Create a CalFocusRow using a copy constructor mechanism.

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

CalFocusTable& asdm::CalFocusRow::getTable (  )  const

Return the table to which this row belongs.

CalFocusRowIDL* asdm::CalFocusRow::toIDL (  )  const

Return this row in the form of an IDL struct.

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

void asdm::CalFocusRow::setFromIDL ( CalFocusRowIDL  x  )  throw (ConversionException)

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

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

string asdm::CalFocusRow::toXML (  )  const

Return this row in the form of an XML string.

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

void asdm::CalFocusRow::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::CalFocusRow::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<Frequency > asdm::CalFocusRow::getFrequencyRange (  )  const

Get frequencyRange.

Returns:
frequencyRange as vector<Frequency >

void asdm::CalFocusRow::setFrequencyRange ( vector< Frequency frequencyRange  ) 

Set frequencyRange with the specified vector<Frequency >.

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

ArrayTime asdm::CalFocusRow::getStartValidTime (  )  const

Get startValidTime.

Returns:
startValidTime as ArrayTime

void asdm::CalFocusRow::setStartValidTime ( ArrayTime  startValidTime  ) 

Set startValidTime with the specified ArrayTime.

Parameters:
startValidTime The ArrayTime value to which startValidTime is to be set.

ArrayTime asdm::CalFocusRow::getEndValidTime (  )  const

Get endValidTime.

Returns:
endValidTime as ArrayTime

void asdm::CalFocusRow::setEndValidTime ( ArrayTime  endValidTime  ) 

Set endValidTime with the specified ArrayTime.

Parameters:
endValidTime The ArrayTime value to which endValidTime is to be set.

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

Get receiverBand.

Returns:
receiverBand as ReceiverBandMod::ReceiverBand

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

Set receiverBand with the specified ReceiverBandMod::ReceiverBand.

Parameters:
receiverBand The ReceiverBandMod::ReceiverBand value to which receiverBand is to be set.

vector<Length > asdm::CalFocusRow::getOffset (  )  const

Get offset.

Returns:
offset as vector<Length >

void asdm::CalFocusRow::setOffset ( vector< Length offset  ) 

Set offset with the specified vector<Length >.

Parameters:
offset The vector<Length > value to which offset is to be set.

vector<Length > asdm::CalFocusRow::getError (  )  const

Get error.

Returns:
error as vector<Length >

void asdm::CalFocusRow::setError ( vector< Length error  ) 

Set error with the specified vector<Length >.

Parameters:
error The vector<Length > value to which error is to be set.

FocusMethodMod::FocusMethod asdm::CalFocusRow::getFocusMethod (  )  const

Get focusMethod.

Returns:
focusMethod as FocusMethodMod::FocusMethod

void asdm::CalFocusRow::setFocusMethod ( FocusMethodMod::FocusMethod  focusMethod  ) 

Set focusMethod with the specified FocusMethodMod::FocusMethod.

Parameters:
focusMethod The FocusMethodMod::FocusMethod value to which focusMethod is to be set.

vector<Angle > asdm::CalFocusRow::getPointingDirection (  )  const

Get pointingDirection.

Returns:
pointingDirection as vector<Angle >

void asdm::CalFocusRow::setPointingDirection ( vector< Angle pointingDirection  ) 

Set pointingDirection with the specified vector<Angle >.

Parameters:
pointingDirection The vector<Angle > value to which pointingDirection is to be set.

vector<bool > asdm::CalFocusRow::getWasFixed (  )  const

Get wasFixed.

Returns:
wasFixed as vector<bool >

void asdm::CalFocusRow::setWasFixed ( vector< bool >  wasFixed  ) 

Set wasFixed with the specified vector<bool >.

Parameters:
wasFixed The vector<bool > value to which wasFixed is to be set.

Temperature asdm::CalFocusRow::getAmbientTemperature (  )  const

Get ambientTemperature.

Returns:
ambientTemperature as Temperature

void asdm::CalFocusRow::setAmbientTemperature ( Temperature  ambientTemperature  ) 

Set ambientTemperature with the specified Temperature.

Parameters:
ambientTemperature The Temperature value to which ambientTemperature is to be set.

void asdm::CalFocusRow::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::CalFocusRow::getCalReductionId (  )  const

Get calReductionId.

Returns:
calReductionId as Tag

void asdm::CalFocusRow::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::CalFocusRow::getCalDataUsingCalDataId (  ) 

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

Returns:
a CalDataRow*

CalReductionRow* asdm::CalFocusRow::getCalReductionUsingCalReductionId (  ) 

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

Returns:
a CalReductionRow*

bool asdm::CalFocusRow::compareNoAutoInc ( Tag  calDataId,
Tag  calReductionId,
string  antennaName,
vector< Frequency frequencyRange,
ArrayTime  startValidTime,
ArrayTime  endValidTime,
ReceiverBandMod::ReceiverBand  receiverBand,
vector< Length offset,
vector< Length error,
FocusMethodMod::FocusMethod  focusMethod,
vector< Angle pointingDirection,
vector< bool >  wasFixed,
Temperature  ambientTemperature 
)

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

bool asdm::CalFocusRow::compareRequiredValue ( vector< Frequency frequencyRange,
ArrayTime  startValidTime,
ArrayTime  endValidTime,
ReceiverBandMod::ReceiverBand  receiverBand,
vector< Length offset,
vector< Length error,
FocusMethodMod::FocusMethod  focusMethod,
vector< Angle pointingDirection,
vector< bool >  wasFixed,
Temperature  ambientTemperature 
)

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

void asdm::CalFocusRow::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::CalFocusTable [friend]

Definition at line 151 of file CalFocusRow.h.


Member Data Documentation

Extrinsic Table asdm::CalFocusRow::Attributes

Definition at line 196 of file CalFocusRow.h.

Extrinsic Table asdm::CalFocusRow::Attributes

Definition at line 532 of file CalFocusRow.h.

CalFocusTable& asdm::CalFocusRow::table [private]

The table to which this row belongs.

Definition at line 658 of file CalFocusRow.h.

bool asdm::CalFocusRow::hasBeenAdded [private]

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

Definition at line 662 of file CalFocusRow.h.

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

===> Attribute frequencyRange

Definition at line 717 of file CalFocusRow.h.

ArrayTime asdm::CalFocusRow::startValidTime [private]

===> Attribute startValidTime

Definition at line 728 of file CalFocusRow.h.

ArrayTime asdm::CalFocusRow::endValidTime [private]

===> Attribute endValidTime

Definition at line 739 of file CalFocusRow.h.

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

===> Attribute receiverBand

Definition at line 750 of file CalFocusRow.h.

vector<Length > asdm::CalFocusRow::offset [private]

===> Attribute offset

Definition at line 761 of file CalFocusRow.h.

vector<Length > asdm::CalFocusRow::error [private]

===> Attribute error

Definition at line 772 of file CalFocusRow.h.

FocusMethodMod::FocusMethod asdm::CalFocusRow::focusMethod [private]

===> Attribute focusMethod

Definition at line 783 of file CalFocusRow.h.

vector<Angle > asdm::CalFocusRow::pointingDirection [private]

===> Attribute pointingDirection

Definition at line 794 of file CalFocusRow.h.

vector<bool > asdm::CalFocusRow::wasFixed [private]

===> Attribute wasFixed

Definition at line 805 of file CalFocusRow.h.

Temperature asdm::CalFocusRow::ambientTemperature [private]

===> Attribute ambientTemperature

Definition at line 816 of file CalFocusRow.h.

Tag asdm::CalFocusRow::calReductionId [private]

===> Attribute calReductionId

Definition at line 842 of file CalFocusRow.h.


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