asdm::FeedRow Class Reference

#include <FeedRow.h>

List of all members.

Detailed Description

The FeedRow class is a row of a FeedTable.

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


Public Member Functions

FeedTable & getTable () const
FeedRowIDL * toIDL () const
void setFromIDL (FeedRowIDL x) throw (ConversionException)
string toXML () const
void setFromXML (string rowDoc) throw (ConversionException)
int getFeedId () const
ArrayTimeInterval getTimeInterval () const
void setTimeInterval (ArrayTimeInterval timeInterval)
int getNumReceptor () const
void setNumReceptor (int numReceptor)
bool isFeedNumExists () const
int getFeedNum () const throw (IllegalAccessException)
void setFeedNum (int feedNum)
void clearFeedNum ()
vector< vector< double > > getBeamOffset () const
void setBeamOffset (vector< vector< double > > beamOffset)
vector< vector< Length > > getFocusReference () const
void setFocusReference (vector< vector< Length > > focusReference)
bool isIllumOffsetExists () const
float getIllumOffset () const throw (IllegalAccessException)
void setIllumOffset (float illumOffset)
void clearIllumOffset ()
bool isIllumOffsetPaExists () const
float getIllumOffsetPa () const throw (IllegalAccessException)
void setIllumOffsetPa (float illumOffsetPa)
void clearIllumOffsetPa ()
vector< PolarizationTypeMod::PolarizationType > getPolarizationTypes () const
void setPolarizationTypes (vector< PolarizationTypeMod::PolarizationType > polarizationTypes)
vector< vector< Complex > > getPolResponse () const
void setPolResponse (vector< vector< Complex > > polResponse)
bool isXPositionExists () const
Length getXPosition () const throw (IllegalAccessException)
void setXPosition (Length xPosition)
void clearXPosition ()
bool isYPositionExists () const
Length getYPosition () const throw (IllegalAccessException)
void setYPosition (Length yPosition)
void clearYPosition ()
bool isZPositionExists () const
Length getZPosition () const throw (IllegalAccessException)
void setZPosition (Length zPosition)
void clearZPosition ()
vector< Angle > getReceptorAngle () const
void setReceptorAngle (vector< Angle > receptorAngle)
Tag getAntennaId () const
void setAntennaId (Tag antennaId)
bool isBeamIdExists () const
vector< Tag > getBeamId () const throw (IllegalAccessException)
void setBeamId (vector< Tag > beamId)
void clearBeamId ()
vector< int > getReceiverId () const
void setReceiverId (vector< int > receiverId)
Tag getSpectralWindowId () const
void setSpectralWindowId (Tag spectralWindowId)
AntennaRow * getAntennaUsingAntennaId ()
SpectralWindowRow * getSpectralWindowUsingSpectralWindowId ()
void setReceiverId (int i, int receiverId)
void addReceiverId (int id)
void addReceiverId (vector< int > id)
const vector< ReceiverRow * > getReceivers (int i)
const vector< ReceiverRow * > getReceivers ()
void setBeamId (int i, Tag beamId)
void addBeamId (Tag id)
void addBeamId (const vector< Tag > &id)
const Tag getBeamId (int i)
BeamRow * getBeam (int i)
vector< BeamRow * > getBeams ()
bool compareNoAutoInc (Tag antennaId, Tag spectralWindowId, ArrayTimeInterval timeInterval, vector< int > receiverId, int numReceptor, vector< vector< double > > beamOffset, vector< vector< Length > > focusReference, vector< PolarizationTypeMod::PolarizationType > polarizationTypes, vector< vector< Complex > > polResponse, vector< Angle > receptorAngle)
bool compareRequiredValue (vector< int > receiverId, int numReceptor, vector< vector< double > > beamOffset, vector< vector< Length > > focusReference, vector< PolarizationTypeMod::PolarizationType > polarizationTypes, vector< vector< Complex > > polResponse, vector< Angle > receptorAngle)
bool equalByRequiredValue (FeedRow *x)

Member Function Documentation

void asdm::FeedRow::addBeamId (  const vector< Tag > &  id  ) 
 

Append a vector of Tag to beamId.

Parameters:
id an array of Tag to be appended to beamId

void asdm::FeedRow::addBeamId (  Tag  id  ) 
 

Append a Tag to beamId.

Parameters:
id the Tag to be appended to beamId

void asdm::FeedRow::addReceiverId (  vector< int >  id  ) 
 

Append an array of ids to receiverId

Parameters:
id a vector of int containing the values to append to receiverId.

void asdm::FeedRow::addReceiverId (  int  id  ) 
 

Append a new id to receiverId

Parameters:
id the int value to be appended to receiverId

void asdm::FeedRow::clearBeamId (   ) 
 

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

void asdm::FeedRow::clearFeedNum (   ) 
 

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

void asdm::FeedRow::clearIllumOffset (   ) 
 

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

void asdm::FeedRow::clearIllumOffsetPa (   ) 
 

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

void asdm::FeedRow::clearXPosition (   ) 
 

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

void asdm::FeedRow::clearYPosition (   ) 
 

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

void asdm::FeedRow::clearZPosition (   ) 
 

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

bool asdm::FeedRow::compareNoAutoInc (  Tag  antennaId,
Tag  spectralWindowId,
ArrayTimeInterval  timeInterval,
vector< int >  receiverId,
int  numReceptor,
vector< vector< double > >  beamOffset,
vector< vector< Length > >  focusReference,
vector< PolarizationTypeMod::PolarizationType >  polarizationTypes,
vector< vector< Complex > >  polResponse,
vector< Angle >  receptorAngle
) 
 

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

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

Tag asdm::FeedRow::getAntennaId (   )  const
 

Get antennaId.

Returns:
antennaId as Tag

AntennaRow* asdm::FeedRow::getAntennaUsingAntennaId (   ) 
 

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

Returns:
a AntennaRow*

BeamRow* asdm::FeedRow::getBeam (  int  i  ) 
 

Returns the BeamRow linked to this row via the tag stored in beamId at position i.

Parameters:
i the position in beamId.
Returns:
a pointer on a BeamRow whose key (a Tag) is equal to the Tag stored at position i in the beamId.

const Tag asdm::FeedRow::getBeamId (  int  i  ) 
 

Returns the Tag stored in beamId at position i.

Parameters:
i the position in beamId where the Tag is retrieved.
Returns:
the Tag stored at position i in beamId.

vector<Tag> asdm::FeedRow::getBeamId (   )  const throw (IllegalAccessException)
 

Get beamId, which is optional.

Returns:
beamId as vector<Tag>
Exceptions:
IllegalAccessException If beamId does not exist.

vector<vector<double > > asdm::FeedRow::getBeamOffset (   )  const
 

Get beamOffset.

Returns:
beamOffset as vector<vector<double > >

vector<BeamRow *> asdm::FeedRow::getBeams (   ) 
 

Returns the vector of BeamRow* linked to this row via the Tags stored in beamId

Returns:
an array of pointers on BeamRow.

int asdm::FeedRow::getFeedId (   )  const
 

Get feedId.

Returns:
feedId as int

int asdm::FeedRow::getFeedNum (   )  const throw (IllegalAccessException)
 

Get feedNum, which is optional.

Returns:
feedNum as int
Exceptions:
IllegalAccessException If feedNum does not exist.

vector<vector<Length > > asdm::FeedRow::getFocusReference (   )  const
 

Get focusReference.

Returns:
focusReference as vector<vector<Length > >

float asdm::FeedRow::getIllumOffset (   )  const throw (IllegalAccessException)
 

Get illumOffset, which is optional.

Returns:
illumOffset as float
Exceptions:
IllegalAccessException If illumOffset does not exist.

float asdm::FeedRow::getIllumOffsetPa (   )  const throw (IllegalAccessException)
 

Get illumOffsetPa, which is optional.

Returns:
illumOffsetPa as float
Exceptions:
IllegalAccessException If illumOffsetPa does not exist.

int asdm::FeedRow::getNumReceptor (   )  const
 

Get numReceptor.

Returns:
numReceptor as int

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

Get polarizationTypes.

Returns:
polarizationTypes as vector<PolarizationTypeMod::PolarizationType >

vector<vector<Complex > > asdm::FeedRow::getPolResponse (   )  const
 

Get polResponse.

Returns:
polResponse as vector<vector<Complex > >

vector<int> asdm::FeedRow::getReceiverId (   )  const
 

Get receiverId.

Returns:
receiverId as vector<int>

const vector<ReceiverRow *> asdm::FeedRow::getReceivers (   ) 
 

Get the collection of rows in the Receiver table having receiverId == receiverId[i] for any i in [O..receiverId.size()-1].

Returns:
a vector of ReceiverRow *.

const vector<ReceiverRow *> asdm::FeedRow::getReceivers (  int  i  ) 
 

Get the collection of rows in the Receiver table having receiverId == receiverId[i]

Returns:
a vector of ReceiverRow *.

vector<Angle > asdm::FeedRow::getReceptorAngle (   )  const
 

Get receptorAngle.

Returns:
receptorAngle as vector<Angle >

Tag asdm::FeedRow::getSpectralWindowId (   )  const
 

Get spectralWindowId.

Returns:
spectralWindowId as Tag

SpectralWindowRow* asdm::FeedRow::getSpectralWindowUsingSpectralWindowId (   ) 
 

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

Returns:
a SpectralWindowRow*

FeedTable& asdm::FeedRow::getTable (   )  const
 

Return the table to which this row belongs.

ArrayTimeInterval asdm::FeedRow::getTimeInterval (   )  const
 

Get timeInterval.

Returns:
timeInterval as ArrayTimeInterval

Length asdm::FeedRow::getXPosition (   )  const throw (IllegalAccessException)
 

Get xPosition, which is optional.

Returns:
xPosition as Length
Exceptions:
IllegalAccessException If xPosition does not exist.

Length asdm::FeedRow::getYPosition (   )  const throw (IllegalAccessException)
 

Get yPosition, which is optional.

Returns:
yPosition as Length
Exceptions:
IllegalAccessException If yPosition does not exist.

Length asdm::FeedRow::getZPosition (   )  const throw (IllegalAccessException)
 

Get zPosition, which is optional.

Returns:
zPosition as Length
Exceptions:
IllegalAccessException If zPosition does not exist.

bool asdm::FeedRow::isBeamIdExists (   )  const
 

The attribute beamId is optional. Return true if this attribute exists.

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

bool asdm::FeedRow::isFeedNumExists (   )  const
 

The attribute feedNum is optional. Return true if this attribute exists.

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

bool asdm::FeedRow::isIllumOffsetExists (   )  const
 

The attribute illumOffset is optional. Return true if this attribute exists.

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

bool asdm::FeedRow::isIllumOffsetPaExists (   )  const
 

The attribute illumOffsetPa is optional. Return true if this attribute exists.

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

bool asdm::FeedRow::isXPositionExists (   )  const
 

The attribute xPosition is optional. Return true if this attribute exists.

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

bool asdm::FeedRow::isYPositionExists (   )  const
 

The attribute yPosition is optional. Return true if this attribute exists.

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

bool asdm::FeedRow::isZPositionExists (   )  const
 

The attribute zPosition is optional. Return true if this attribute exists.

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

void asdm::FeedRow::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::FeedRow::setBeamId (  int  i,
Tag  beamId
) 
 

Set beamId[i] with the specified Tag.

Parameters:
i The index in beamId where to set the Tag value.
beamId The Tag value to which beamId[i] is to be set.
Exceptions:
OutOfBoundsException 

void asdm::FeedRow::setBeamId (  vector< Tag >  beamId  ) 
 

Set beamId with the specified vector<Tag> .

Parameters:
beamId The vector<Tag> value to which beamId is to be set.

void asdm::FeedRow::setBeamOffset (  vector< vector< double > >  beamOffset  ) 
 

Set beamOffset with the specified vector<vector<double > >.

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

void asdm::FeedRow::setFeedNum (  int  feedNum  ) 
 

Set feedNum with the specified int.

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

void asdm::FeedRow::setFocusReference (  vector< vector< Length > >  focusReference  ) 
 

Set focusReference with the specified vector<vector<Length > >.

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

void asdm::FeedRow::setFromIDL (  FeedRowIDL  x  )  throw (ConversionException)
 

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

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

void asdm::FeedRow::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::FeedRow::setIllumOffset (  float  illumOffset  ) 
 

Set illumOffset with the specified float.

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

void asdm::FeedRow::setIllumOffsetPa (  float  illumOffsetPa  ) 
 

Set illumOffsetPa with the specified float.

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

void asdm::FeedRow::setNumReceptor (  int  numReceptor  ) 
 

Set numReceptor with the specified int.

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

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

void asdm::FeedRow::setPolResponse (  vector< vector< Complex > >  polResponse  ) 
 

Set polResponse with the specified vector<vector<Complex > >.

Parameters:
polResponse The vector<vector<Complex > > value to which polResponse is to be set.

void asdm::FeedRow::setReceiverId (  int  i,
int  receiverId
) 
 

Set receiverId[i] with the specified int.

Parameters:
i The index in receiverId where to set the int value.
receiverId The int value to which receiverId[i] is to be set.
Exceptions:
IndexOutOfBoundsException 

void asdm::FeedRow::setReceiverId (  vector< int >  receiverId  ) 
 

Set receiverId with the specified vector<int> .

Parameters:
receiverId The vector<int> value to which receiverId is to be set.

void asdm::FeedRow::setReceptorAngle (  vector< Angle >  receptorAngle  ) 
 

Set receptorAngle with the specified vector<Angle >.

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

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

void asdm::FeedRow::setXPosition (  Length  xPosition  ) 
 

Set xPosition with the specified Length.

Parameters:
xPosition The Length value to which xPosition is to be set.

void asdm::FeedRow::setYPosition (  Length  yPosition  ) 
 

Set yPosition with the specified Length.

Parameters:
yPosition The Length value to which yPosition is to be set.

void asdm::FeedRow::setZPosition (  Length  zPosition  ) 
 

Set zPosition with the specified Length.

Parameters:
zPosition The Length value to which zPosition is to be set.

FeedRowIDL* asdm::FeedRow::toIDL (   )  const
 

Return this row in the form of an IDL struct.

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

string asdm::FeedRow::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