asdm::FreqOffsetRow Class Reference

#include <FreqOffsetRow.h>

List of all members.

Detailed Description

The FreqOffsetRow class is a row of a FreqOffsetTable.

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


Public Member Functions

FreqOffsetTable & getTable () const
FreqOffsetRowIDL * toIDL () const
void setFromIDL (FreqOffsetRowIDL x) throw (ConversionException)
string toXML () const
void setFromXML (string rowDoc) throw (ConversionException)
ArrayTimeInterval getTimeInterval () const
void setTimeInterval (ArrayTimeInterval timeInterval)
Frequency getOffset () const
void setOffset (Frequency offset)
Tag getAntennaId () const
void setAntennaId (Tag antennaId)
int getFeedId () const
void setFeedId (int feedId)
Tag getSpectralWindowId () const
void setSpectralWindowId (Tag spectralWindowId)
vector< FeedRow * > getFeeds ()
AntennaRow * getAntennaUsingAntennaId ()
SpectralWindowRow * getSpectralWindowUsingSpectralWindowId ()
bool compareNoAutoInc (Tag antennaId, int feedId, Tag spectralWindowId, ArrayTimeInterval timeInterval, Frequency offset)
bool compareRequiredValue (Frequency offset)
bool equalByRequiredValue (FreqOffsetRow *x)

Member Function Documentation

bool asdm::FreqOffsetRow::compareNoAutoInc (  Tag  antennaId,
int  feedId,
Tag  spectralWindowId,
ArrayTimeInterval  timeInterval,
Frequency  offset
) 
 

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

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

Tag asdm::FreqOffsetRow::getAntennaId (   )  const
 

Get antennaId.

Returns:
antennaId as Tag

AntennaRow* asdm::FreqOffsetRow::getAntennaUsingAntennaId (   ) 
 

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

Returns:
a AntennaRow*

int asdm::FreqOffsetRow::getFeedId (   )  const
 

Get feedId.

Returns:
feedId as int

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

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

Returns:
a vector of FeedRow *

Frequency asdm::FreqOffsetRow::getOffset (   )  const
 

Get offset.

Returns:
offset as Frequency

Tag asdm::FreqOffsetRow::getSpectralWindowId (   )  const
 

Get spectralWindowId.

Returns:
spectralWindowId as Tag

SpectralWindowRow* asdm::FreqOffsetRow::getSpectralWindowUsingSpectralWindowId (   ) 
 

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

Returns:
a SpectralWindowRow*

FreqOffsetTable& asdm::FreqOffsetRow::getTable (   )  const
 

Return the table to which this row belongs.

ArrayTimeInterval asdm::FreqOffsetRow::getTimeInterval (   )  const
 

Get timeInterval.

Returns:
timeInterval as ArrayTimeInterval

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

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

void asdm::FreqOffsetRow::setFromIDL (  FreqOffsetRowIDL  x  )  throw (ConversionException)
 

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

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

void asdm::FreqOffsetRow::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::FreqOffsetRow::setOffset (  Frequency  offset  ) 
 

Set offset with the specified Frequency.

Parameters:
offset The Frequency value to which offset is to be set.

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

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

FreqOffsetRowIDL* asdm::FreqOffsetRow::toIDL (   )  const
 

Return this row in the form of an IDL struct.

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

string asdm::FreqOffsetRow::toXML (   )  const
 

Return this row in the form of an XML string.

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

The documentation for this class was generated from the following file:
Generated on Tue Nov 18 17:43:45 2008 for ASDM C++ Implementation by doxygen 1.3.8