asdm::CalGainRow Class Reference

#include <CalGainRow.h>

Collaboration diagram for asdm::CalGainRow:

Collaboration graph
[legend]
List of all members.

Detailed Description

The CalGainRow class is a row of a CalGainTable.

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

Definition at line 140 of file CalGainRow.h.

Public Member Functions

virtual ~CalGainRow ()
CalGainTablegetTable () const
 Return the table to which this row belongs.
CalGainRowIDL * toIDL () const
 Return this row in the form of an IDL struct.
void setFromIDL (CalGainRowIDL x) throw (ConversionException)
 Fill the values of this row from the IDL struct CalGainRowIDL.
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 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< vector< float > > getGain () const
 Get gain.
void setGain (vector< vector< float > > gain)
 Set gain with the specified vector<vector<float > >.
vector< bool > getGainValid () const
 Get gainValid.
void setGainValid (vector< bool > gainValid)
 Set gainValid with the specified vector<bool >.
vector< vector< float > > getFit () const
 Get fit.
void setFit (vector< vector< float > > fit)
 Set fit with the specified vector<vector<float > >.
vector< float > getFitWeight () const
 Get fitWeight.
void setFitWeight (vector< float > fitWeight)
 Set fitWeight with the specified vector<float >.
bool getTotalGainValid () const
 Get totalGainValid.
void setTotalGainValid (bool totalGainValid)
 Set totalGainValid with the specified bool.
float getTotalFit () const
 Get totalFit.
void setTotalFit (float totalFit)
 Set totalFit with the specified float.
float getTotalFitWeight () const
 Get totalFitWeight.
void setTotalFitWeight (float totalFitWeight)
 Set totalFitWeight with the specified float.
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, ArrayTime startValidTime, ArrayTime endValidTime, vector< vector< float > > gain, vector< bool > gainValid, vector< vector< float > > fit, vector< float > fitWeight, bool totalGainValid, float totalFit, float totalFitWeight)
 Compare each mandatory attribute except the autoincrementable one of this CalGainRow with the corresponding parameters and return true if there is a match and false otherwise.
bool compareRequiredValue (ArrayTime startValidTime, ArrayTime endValidTime, vector< vector< float > > gain, vector< bool > gainValid, vector< vector< float > > fit, vector< float > fitWeight, bool totalGainValid, float totalFit, float totalFitWeight)
bool equalByRequiredValue (CalGainRow *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.
 CalGainRow (CalGainTable &table)
 Create a CalGainRow.
 CalGainRow (CalGainTable &table, CalGainRow &row)
 Create a CalGainRow using a copy constructor mechanism.

Private Attributes

CalGainTabletable
 The table to which this row belongs.
bool hasBeenAdded
 Whether this row has been added to the table or not.
ArrayTime endValidTime
 ===> Attribute endValidTime
vector< vector< float > > gain
 ===> Attribute gain
vector< bool > gainValid
 ===> Attribute gainValid
vector< vector< float > > fit
 ===> Attribute fit
vector< float > fitWeight
 ===> Attribute fitWeight
bool totalGainValid
 ===> Attribute totalGainValid
float totalFit
 ===> Attribute totalFit
float totalFitWeight
 ===> Attribute totalFitWeight
Tag calReductionId
 ===> Attribute calReductionId

Friends

class asdm::CalGainTable


Constructor & Destructor Documentation

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

asdm::CalGainRow::CalGainRow ( CalGainTable table  )  [private]

Create a CalGainRow.

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

Create a CalGainRow using a copy constructor mechanism.

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

CalGainTable& asdm::CalGainRow::getTable (  )  const

Return the table to which this row belongs.

CalGainRowIDL* asdm::CalGainRow::toIDL (  )  const

Return this row in the form of an IDL struct.

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

void asdm::CalGainRow::setFromIDL ( CalGainRowIDL  x  )  throw (ConversionException)

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

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

string asdm::CalGainRow::toXML (  )  const

Return this row in the form of an XML string.

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

void asdm::CalGainRow::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::CalGainRow::setStartValidTime ( ArrayTime  startValidTime  ) 

Set startValidTime with the specified ArrayTime.

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

ArrayTime asdm::CalGainRow::getEndValidTime (  )  const

Get endValidTime.

Returns:
endValidTime as ArrayTime

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

Set endValidTime with the specified ArrayTime.

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

vector<vector<float > > asdm::CalGainRow::getGain (  )  const

Get gain.

Returns:
gain as vector<vector<float > >

void asdm::CalGainRow::setGain ( vector< vector< float > >  gain  ) 

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

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

vector<bool > asdm::CalGainRow::getGainValid (  )  const

Get gainValid.

Returns:
gainValid as vector<bool >

void asdm::CalGainRow::setGainValid ( vector< bool >  gainValid  ) 

Set gainValid with the specified vector<bool >.

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

vector<vector<float > > asdm::CalGainRow::getFit (  )  const

Get fit.

Returns:
fit as vector<vector<float > >

void asdm::CalGainRow::setFit ( vector< vector< float > >  fit  ) 

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

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

vector<float > asdm::CalGainRow::getFitWeight (  )  const

Get fitWeight.

Returns:
fitWeight as vector<float >

void asdm::CalGainRow::setFitWeight ( vector< float >  fitWeight  ) 

Set fitWeight with the specified vector<float >.

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

bool asdm::CalGainRow::getTotalGainValid (  )  const

Get totalGainValid.

Returns:
totalGainValid as bool

void asdm::CalGainRow::setTotalGainValid ( bool  totalGainValid  ) 

Set totalGainValid with the specified bool.

Parameters:
totalGainValid The bool value to which totalGainValid is to be set.

float asdm::CalGainRow::getTotalFit (  )  const

Get totalFit.

Returns:
totalFit as float

void asdm::CalGainRow::setTotalFit ( float  totalFit  ) 

Set totalFit with the specified float.

Parameters:
totalFit The float value to which totalFit is to be set.

float asdm::CalGainRow::getTotalFitWeight (  )  const

Get totalFitWeight.

Returns:
totalFitWeight as float

void asdm::CalGainRow::setTotalFitWeight ( float  totalFitWeight  ) 

Set totalFitWeight with the specified float.

Parameters:
totalFitWeight The float value to which totalFitWeight is to be set.

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

Get calReductionId.

Returns:
calReductionId as Tag

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

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

Returns:
a CalDataRow*

CalReductionRow* asdm::CalGainRow::getCalReductionUsingCalReductionId (  ) 

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

Returns:
a CalReductionRow*

bool asdm::CalGainRow::compareNoAutoInc ( Tag  calDataId,
Tag  calReductionId,
ArrayTime  startValidTime,
ArrayTime  endValidTime,
vector< vector< float > >  gain,
vector< bool >  gainValid,
vector< vector< float > >  fit,
vector< float >  fitWeight,
bool  totalGainValid,
float  totalFit,
float  totalFitWeight 
)

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

bool asdm::CalGainRow::compareRequiredValue ( ArrayTime  startValidTime,
ArrayTime  endValidTime,
vector< vector< float > >  gain,
vector< bool >  gainValid,
vector< vector< float > >  fit,
vector< float >  fitWeight,
bool  totalGainValid,
float  totalFit,
float  totalFitWeight 
)

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

void asdm::CalGainRow::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::CalGainTable [friend]

Definition at line 141 of file CalGainRow.h.


Member Data Documentation

Extrinsic Table asdm::CalGainRow::Attributes

Definition at line 186 of file CalGainRow.h.

Extrinsic Table asdm::CalGainRow::Attributes

Definition at line 460 of file CalGainRow.h.

CalGainTable& asdm::CalGainRow::table [private]

The table to which this row belongs.

Definition at line 586 of file CalGainRow.h.

bool asdm::CalGainRow::hasBeenAdded [private]

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

Definition at line 590 of file CalGainRow.h.

ArrayTime asdm::CalGainRow::endValidTime [private]

===> Attribute endValidTime

Definition at line 645 of file CalGainRow.h.

vector<vector<float > > asdm::CalGainRow::gain [private]

===> Attribute gain

Definition at line 656 of file CalGainRow.h.

vector<bool > asdm::CalGainRow::gainValid [private]

===> Attribute gainValid

Definition at line 667 of file CalGainRow.h.

vector<vector<float > > asdm::CalGainRow::fit [private]

===> Attribute fit

Definition at line 678 of file CalGainRow.h.

vector<float > asdm::CalGainRow::fitWeight [private]

===> Attribute fitWeight

Definition at line 689 of file CalGainRow.h.

bool asdm::CalGainRow::totalGainValid [private]

===> Attribute totalGainValid

Definition at line 700 of file CalGainRow.h.

float asdm::CalGainRow::totalFit [private]

===> Attribute totalFit

Definition at line 711 of file CalGainRow.h.

float asdm::CalGainRow::totalFitWeight [private]

===> Attribute totalFitWeight

Definition at line 722 of file CalGainRow.h.

Tag asdm::CalGainRow::calReductionId [private]

===> Attribute calReductionId

Definition at line 748 of file CalGainRow.h.


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