asdm::DataDescriptionRow Class Reference

#include <DataDescriptionRow.h>

List of all members.


Detailed Description

The DataDescriptionRow class is a row of a DataDescriptionTable.


Public Member Functions

DataDescriptionTablegetTable () const
DataDescriptionRowIDL * toIDL () const
void setFromIDL (DataDescriptionRowIDL x) throw (ConversionException)
string toXML () const
void setFromXML (string rowDoc) throw (ConversionException)
Tag getDataDescriptionId () const
bool isFlagRowExists () const
bool getFlagRow () const throw (IllegalAccessException)
void setFlagRow (bool flagRow)
void clearFlagRow ()
Tag getPolOrHoloId () const
void setPolOrHoloId (Tag polOrHoloId)
Tag getSpectralWindowId () const
void setSpectralWindowId (Tag spectralWindowId)
PolarizationRowgetPolarizationUsingPolOrHoloId ()
HolographyRowgetHolographyUsingPolOrHoloId ()
SpectralWindowRowgetSpectralWindowUsingSpectralWindowId ()
bool compareNoAutoInc (Tag polOrHoloId, Tag spectralWindowId)
bool compareRequiredValue (Tag polOrHoloId, Tag spectralWindowId)
bool equalByRequiredValue (DataDescriptionRow *x)


Member Function Documentation

void asdm::DataDescriptionRow::clearFlagRow  ) 
 

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

bool asdm::DataDescriptionRow::compareNoAutoInc Tag  polOrHoloId,
Tag  spectralWindowId
 

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

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

Tag asdm::DataDescriptionRow::getDataDescriptionId  )  const
 

Get dataDescriptionId.

Returns:
dataDescriptionId as Tag

bool asdm::DataDescriptionRow::getFlagRow  )  const throw (IllegalAccessException)
 

Get flagRow, which is optional.

Returns:
flagRow as bool
Exceptions:
IllegalAccessException If flagRow does not exist.

HolographyRow* asdm::DataDescriptionRow::getHolographyUsingPolOrHoloId  ) 
 

Returns pointer to the row in the Holograpy table having Holography.holographyId == polOrHoloId

Returns:
a HolographyRow* or 0 if polOrHoloId is an Polarization Tag.

PolarizationRow* asdm::DataDescriptionRow::getPolarizationUsingPolOrHoloId  ) 
 

Returns pointer to the row in the Polarization table having Polarization.polarizationId == polOrHoloId

Returns:
a PolarizationRow* or 0 if polOrHoloId is an Holography Tag.

Tag asdm::DataDescriptionRow::getPolOrHoloId  )  const
 

Get polOrHoloId.

Returns:
polOrHoloId as Tag

Tag asdm::DataDescriptionRow::getSpectralWindowId  )  const
 

Get spectralWindowId.

Returns:
spectralWindowId as Tag

SpectralWindowRow* asdm::DataDescriptionRow::getSpectralWindowUsingSpectralWindowId  ) 
 

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

Returns:
a SpectralWindowRow*

DataDescriptionTable& asdm::DataDescriptionRow::getTable  )  const
 

Return the table to which this row belongs.

bool asdm::DataDescriptionRow::isFlagRowExists  )  const
 

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

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

void asdm::DataDescriptionRow::setFlagRow bool  flagRow  ) 
 

Set flagRow with the specified bool.

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

void asdm::DataDescriptionRow::setFromIDL DataDescriptionRowIDL  x  )  throw (ConversionException)
 

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

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

void asdm::DataDescriptionRow::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::DataDescriptionRow::setPolOrHoloId Tag  polOrHoloId  ) 
 

Set polOrHoloId with the specified Tag.

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

void asdm::DataDescriptionRow::setSpectralWindowId Tag  spectralWindowId  ) 
 

Set spectralWindowId with the specified Tag.

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

DataDescriptionRowIDL* asdm::DataDescriptionRow::toIDL  )  const
 

Return this row in the form of an IDL struct.

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

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