asdm::FocusRow Class Reference

#include <FocusRow.h>

List of all members.

Detailed Description

The FocusRow class is a row of a FocusTable.

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


Public Member Functions

FocusTable & getTable () const
FocusRowIDL * toIDL () const
void setFromIDL (FocusRowIDL x) throw (ConversionException)
string toXML () const
void setFromXML (string rowDoc) throw (ConversionException)
ArrayTimeInterval getTimeInterval () const
void setTimeInterval (ArrayTimeInterval timeInterval)
Length getXFocusPosition () const
void setXFocusPosition (Length xFocusPosition)
Length getYFocusPosition () const
void setYFocusPosition (Length yFocusPosition)
Length getZFocusPosition () const
void setZFocusPosition (Length zFocusPosition)
bool getFocusTracking () const
void setFocusTracking (bool focusTracking)
Length getXFocusOffset () const
void setXFocusOffset (Length xFocusOffset)
Length getYFocusOffset () const
void setYFocusOffset (Length yFocusOffset)
Length getZFocusOffset () const
void setZFocusOffset (Length zFocusOffset)
Tag getAntennaId () const
void setAntennaId (Tag antennaId)
int getFeedId () const
void setFeedId (int feedId)
Tag getFocusModelId () const
void setFocusModelId (Tag focusModelId)
FocusModelRow * getFocusModelUsingFocusModelId ()
vector< FeedRow * > getFeeds ()
AntennaRow * getAntennaUsingAntennaId ()
bool compareNoAutoInc (Tag antennaId, int feedId, ArrayTimeInterval timeInterval, Tag focusModelId, Length xFocusPosition, Length yFocusPosition, Length zFocusPosition, bool focusTracking, Length xFocusOffset, Length yFocusOffset, Length zFocusOffset)
bool compareRequiredValue (Tag focusModelId, Length xFocusPosition, Length yFocusPosition, Length zFocusPosition, bool focusTracking, Length xFocusOffset, Length yFocusOffset, Length zFocusOffset)
bool equalByRequiredValue (FocusRow *x)

Member Function Documentation

bool asdm::FocusRow::compareNoAutoInc (  Tag  antennaId,
int  feedId,
ArrayTimeInterval  timeInterval,
Tag  focusModelId,
Length  xFocusPosition,
Length  yFocusPosition,
Length  zFocusPosition,
bool  focusTracking,
Length  xFocusOffset,
Length  yFocusOffset,
Length  zFocusOffset
) 
 

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

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

Tag asdm::FocusRow::getAntennaId (   )  const
 

Get antennaId.

Returns:
antennaId as Tag

AntennaRow* asdm::FocusRow::getAntennaUsingAntennaId (   ) 
 

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

Returns:
a AntennaRow*

int asdm::FocusRow::getFeedId (   )  const
 

Get feedId.

Returns:
feedId as int

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

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

Returns:
a vector of FeedRow *

Tag asdm::FocusRow::getFocusModelId (   )  const
 

Get focusModelId.

Returns:
focusModelId as Tag

FocusModelRow* asdm::FocusRow::getFocusModelUsingFocusModelId (   ) 
 

focusModelId pointer to the row in the FocusModel table having FocusModel.focusModelId == focusModelId

Returns:
a FocusModelRow*

bool asdm::FocusRow::getFocusTracking (   )  const
 

Get focusTracking.

Returns:
focusTracking as bool

FocusTable& asdm::FocusRow::getTable (   )  const
 

Return the table to which this row belongs.

ArrayTimeInterval asdm::FocusRow::getTimeInterval (   )  const
 

Get timeInterval.

Returns:
timeInterval as ArrayTimeInterval

Length asdm::FocusRow::getXFocusOffset (   )  const
 

Get xFocusOffset.

Returns:
xFocusOffset as Length

Length asdm::FocusRow::getXFocusPosition (   )  const
 

Get xFocusPosition.

Returns:
xFocusPosition as Length

Length asdm::FocusRow::getYFocusOffset (   )  const
 

Get yFocusOffset.

Returns:
yFocusOffset as Length

Length asdm::FocusRow::getYFocusPosition (   )  const
 

Get yFocusPosition.

Returns:
yFocusPosition as Length

Length asdm::FocusRow::getZFocusOffset (   )  const
 

Get zFocusOffset.

Returns:
zFocusOffset as Length

Length asdm::FocusRow::getZFocusPosition (   )  const
 

Get zFocusPosition.

Returns:
zFocusPosition as Length

void asdm::FocusRow::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::FocusRow::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::FocusRow::setFocusModelId (  Tag  focusModelId  ) 
 

Set focusModelId with the specified Tag.

Parameters:
focusModelId The Tag value to which focusModelId is to be set.

void asdm::FocusRow::setFocusTracking (  bool  focusTracking  ) 
 

Set focusTracking with the specified bool.

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

void asdm::FocusRow::setFromIDL (  FocusRowIDL  x  )  throw (ConversionException)
 

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

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

void asdm::FocusRow::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::FocusRow::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::FocusRow::setXFocusOffset (  Length  xFocusOffset  ) 
 

Set xFocusOffset with the specified Length.

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

void asdm::FocusRow::setXFocusPosition (  Length  xFocusPosition  ) 
 

Set xFocusPosition with the specified Length.

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

void asdm::FocusRow::setYFocusOffset (  Length  yFocusOffset  ) 
 

Set yFocusOffset with the specified Length.

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

void asdm::FocusRow::setYFocusPosition (  Length  yFocusPosition  ) 
 

Set yFocusPosition with the specified Length.

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

void asdm::FocusRow::setZFocusOffset (  Length  zFocusOffset  ) 
 

Set zFocusOffset with the specified Length.

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

void asdm::FocusRow::setZFocusPosition (  Length  zFocusPosition  ) 
 

Set zFocusPosition with the specified Length.

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

FocusRowIDL* asdm::FocusRow::toIDL (   )  const
 

Return this row in the form of an IDL struct.

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

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