asdm::AntennaRow Class Reference

#include <AntennaRow.h>

List of all members.

Detailed Description

The AntennaRow class is a row of a AntennaTable.

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


Public Member Functions

AntennaTable & getTable () const
AntennaRowIDL * toIDL () const
void setFromIDL (AntennaRowIDL x) throw (ConversionException)
string toXML () const
void setFromXML (string rowDoc) throw (ConversionException)
Tag getAntennaId () const
string getName () const
void setName (string name)
AntennaMakeMod::AntennaMake getAntennaMake () const
void setAntennaMake (AntennaMakeMod::AntennaMake antennaMake)
AntennaTypeMod::AntennaType getAntennaType () const
void setAntennaType (AntennaTypeMod::AntennaType antennaType)
Length getXPosition () const
void setXPosition (Length xPosition)
Length getYPosition () const
void setYPosition (Length yPosition)
Length getZPosition () const
void setZPosition (Length zPosition)
ArrayTime getTime () const
void setTime (ArrayTime time)
Length getXOffset () const
void setXOffset (Length xOffset)
Length getYOffset () const
void setYOffset (Length yOffset)
Length getZOffset () const
void setZOffset (Length zOffset)
Length getDishDiameter () const
void setDishDiameter (Length dishDiameter)
bool getFlagRow () const
void setFlagRow (bool flagRow)
bool isAssocAntennaIdExists () const
Tag getAssocAntennaId () const throw (IllegalAccessException)
void setAssocAntennaId (Tag assocAntennaId)
void clearAssocAntennaId ()
Tag getStationId () const
void setStationId (Tag stationId)
bool isAssociatedAntennaExists () const
AntennaRow * getAssociatedAntenna () const throw (NoSuchRow)
void setAssociatedAntennaLink (Tag assocAntennaId)
StationRow * getStationUsingStationId ()
bool compareNoAutoInc (Tag stationId, string name, AntennaMakeMod::AntennaMake antennaMake, AntennaTypeMod::AntennaType antennaType, Length xPosition, Length yPosition, Length zPosition, ArrayTime time, Length xOffset, Length yOffset, Length zOffset, Length dishDiameter, bool flagRow)
bool compareRequiredValue (Tag stationId, string name, AntennaMakeMod::AntennaMake antennaMake, AntennaTypeMod::AntennaType antennaType, Length xPosition, Length yPosition, Length zPosition, ArrayTime time, Length xOffset, Length yOffset, Length zOffset, Length dishDiameter, bool flagRow)
bool equalByRequiredValue (AntennaRow *x)

Member Function Documentation

void asdm::AntennaRow::clearAssocAntennaId (   ) 
 

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

bool asdm::AntennaRow::compareNoAutoInc (  Tag  stationId,
string  name,
AntennaMakeMod::AntennaMake  antennaMake,
AntennaTypeMod::AntennaType  antennaType,
Length  xPosition,
Length  yPosition,
Length  zPosition,
ArrayTime  time,
Length  xOffset,
Length  yOffset,
Length  zOffset,
Length  dishDiameter,
bool  flagRow
) 
 

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

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

Tag asdm::AntennaRow::getAntennaId (   )  const
 

Get antennaId.

Returns:
antennaId as Tag

AntennaMakeMod::AntennaMake asdm::AntennaRow::getAntennaMake (   )  const
 

Get antennaMake.

Returns:
antennaMake as AntennaMakeMod::AntennaMake

AntennaTypeMod::AntennaType asdm::AntennaRow::getAntennaType (   )  const
 

Get antennaType.

Returns:
antennaType as AntennaTypeMod::AntennaType

Tag asdm::AntennaRow::getAssocAntennaId (   )  const throw (IllegalAccessException)
 

Get assocAntennaId, which is optional.

Returns:
assocAntennaId as Tag
Exceptions:
IllegalAccessException If assocAntennaId does not exist.

AntennaRow* asdm::AntennaRow::getAssociatedAntenna (   )  const throw (NoSuchRow)
 

Get the optional row in table Antenna by traversing the defined link to that table.

Returns:
A row in Antenna table.
Exceptions:
NoSuchRow if there is no such row in table Antenna or the link does not exist.

Length asdm::AntennaRow::getDishDiameter (   )  const
 

Get dishDiameter.

Returns:
dishDiameter as Length

bool asdm::AntennaRow::getFlagRow (   )  const
 

Get flagRow.

Returns:
flagRow as bool

string asdm::AntennaRow::getName (   )  const
 

Get name.

Returns:
name as string

Tag asdm::AntennaRow::getStationId (   )  const
 

Get stationId.

Returns:
stationId as Tag

StationRow* asdm::AntennaRow::getStationUsingStationId (   ) 
 

stationId pointer to the row in the Station table having Station.stationId == stationId

Returns:
a StationRow*

AntennaTable& asdm::AntennaRow::getTable (   )  const
 

Return the table to which this row belongs.

ArrayTime asdm::AntennaRow::getTime (   )  const
 

Get time.

Returns:
time as ArrayTime

Length asdm::AntennaRow::getXOffset (   )  const
 

Get xOffset.

Returns:
xOffset as Length

Length asdm::AntennaRow::getXPosition (   )  const
 

Get xPosition.

Returns:
xPosition as Length

Length asdm::AntennaRow::getYOffset (   )  const
 

Get yOffset.

Returns:
yOffset as Length

Length asdm::AntennaRow::getYPosition (   )  const
 

Get yPosition.

Returns:
yPosition as Length

Length asdm::AntennaRow::getZOffset (   )  const
 

Get zOffset.

Returns:
zOffset as Length

Length asdm::AntennaRow::getZPosition (   )  const
 

Get zPosition.

Returns:
zPosition as Length

bool asdm::AntennaRow::isAssocAntennaIdExists (   )  const
 

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

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

bool asdm::AntennaRow::isAssociatedAntennaExists (   )  const
 

The link to table Antenna is optional. Return true if this link exists.

Returns:
true if and only if the Antenna link exists.

void asdm::AntennaRow::setAntennaMake (  AntennaMakeMod::AntennaMake  antennaMake  ) 
 

Set antennaMake with the specified AntennaMakeMod::AntennaMake.

Parameters:
antennaMake The AntennaMakeMod::AntennaMake value to which antennaMake is to be set.

void asdm::AntennaRow::setAntennaType (  AntennaTypeMod::AntennaType  antennaType  ) 
 

Set antennaType with the specified AntennaTypeMod::AntennaType.

Parameters:
antennaType The AntennaTypeMod::AntennaType value to which antennaType is to be set.

void asdm::AntennaRow::setAssocAntennaId (  Tag  assocAntennaId  ) 
 

Set assocAntennaId with the specified Tag.

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

void asdm::AntennaRow::setAssociatedAntennaLink (  Tag  assocAntennaId  ) 
 

Set the values of the link attributes needed to link this row to a row in table Antenna.

void asdm::AntennaRow::setDishDiameter (  Length  dishDiameter  ) 
 

Set dishDiameter with the specified Length.

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

void asdm::AntennaRow::setFlagRow (  bool  flagRow  ) 
 

Set flagRow with the specified bool.

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

void asdm::AntennaRow::setFromIDL (  AntennaRowIDL  x  )  throw (ConversionException)
 

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

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

void asdm::AntennaRow::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::AntennaRow::setName (  string  name  ) 
 

Set name with the specified string.

Parameters:
name The string value to which name is to be set.

void asdm::AntennaRow::setStationId (  Tag  stationId  ) 
 

Set stationId with the specified Tag.

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

void asdm::AntennaRow::setTime (  ArrayTime  time  ) 
 

Set time with the specified ArrayTime.

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

void asdm::AntennaRow::setXOffset (  Length  xOffset  ) 
 

Set xOffset with the specified Length.

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

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

Set xPosition with the specified Length.

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

void asdm::AntennaRow::setYOffset (  Length  yOffset  ) 
 

Set yOffset with the specified Length.

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

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

Set yPosition with the specified Length.

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

void asdm::AntennaRow::setZOffset (  Length  zOffset  ) 
 

Set zOffset with the specified Length.

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

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

Set zPosition with the specified Length.

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

AntennaRowIDL* asdm::AntennaRow::toIDL (   )  const
 

Return this row in the form of an IDL struct.

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

string asdm::AntennaRow::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:42 2008 for ASDM C++ Implementation by doxygen 1.3.8