asdm::ConfigDescriptionRow Class Reference

#include <ConfigDescriptionRow.h>

List of all members.

Detailed Description

The ConfigDescriptionRow class is a row of a ConfigDescriptionTable.

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


Public Member Functions

ConfigDescriptionTable & getTable () const
ConfigDescriptionRowIDL * toIDL () const
void setFromIDL (ConfigDescriptionRowIDL x) throw (ConversionException)
string toXML () const
void setFromXML (string rowDoc) throw (ConversionException)
int getNumAntenna () const
void setNumAntenna (int numAntenna)
int getNumFeed () const
void setNumFeed (int numFeed)
vector< int > getNumSubBand () const
void setNumSubBand (vector< int > numSubBand)
bool isPhasedArrayListExists () const
vector< int > getPhasedArrayList () const throw (IllegalAccessException)
void setPhasedArrayList (vector< int > phasedArrayList)
void clearPhasedArrayList ()
CorrelationModeMod::CorrelationMode getCorrelationMode () const
void setCorrelationMode (CorrelationModeMod::CorrelationMode correlationMode)
bool isFlagAntExists () const
vector< bool > getFlagAnt () const throw (IllegalAccessException)
void setFlagAnt (vector< bool > flagAnt)
void clearFlagAnt ()
Tag getConfigDescriptionId () const
vector< AtmPhaseCorrectionMod::AtmPhaseCorrection > getAtmPhaseCorrection () const
void setAtmPhaseCorrection (vector< AtmPhaseCorrectionMod::AtmPhaseCorrection > atmPhaseCorrection)
bool isAssocNatureExists () const
vector< SpectralResolutionTypeMod::SpectralResolutionType > getAssocNature () const throw (IllegalAccessException)
void setAssocNature (vector< SpectralResolutionTypeMod::SpectralResolutionType > assocNature)
void clearAssocNature ()
vector< Tag > getAntennaId () const
void setAntennaId (vector< Tag > antennaId)
bool isAssocConfigDescriptionIdExists () const
vector< Tag > getAssocConfigDescriptionId () const throw (IllegalAccessException)
void setAssocConfigDescriptionId (vector< Tag > assocConfigDescriptionId)
void clearAssocConfigDescriptionId ()
vector< Tag > getDataDescriptionId () const
void setDataDescriptionId (vector< Tag > dataDescriptionId)
vector< int > getFeedId () const
void setFeedId (vector< int > feedId)
Tag getProcessorId () const
void setProcessorId (Tag processorId)
vector< Tag > getSwitchCycleId () const
void setSwitchCycleId (vector< Tag > switchCycleId)
ProcessorRow * getProcessorUsingProcessorId ()
void setAntennaId (int i, Tag antennaId)
void addAntennaId (Tag id)
void addAntennaId (const vector< Tag > &id)
const Tag getAntennaId (int i)
AntennaRow * getAntenna (int i)
vector< AntennaRow * > getAntennas ()
void setDataDescriptionId (int i, Tag dataDescriptionId)
void addDataDescriptionId (Tag id)
void addDataDescriptionId (const vector< Tag > &id)
const Tag getDataDescriptionId (int i)
DataDescriptionRow * getDataDescription (int i)
vector< DataDescriptionRow * > getDataDescriptions ()
void setSwitchCycleId (int i, Tag switchCycleId)
void addSwitchCycleId (Tag id)
void addSwitchCycleId (const vector< Tag > &id)
const Tag getSwitchCycleId (int i)
SwitchCycleRow * getSwitchCycle (int i)
vector< SwitchCycleRow * > getSwitchCycles ()
void setFeedId (int i, int feedId)
void addFeedId (int id)
void addFeedId (vector< int > id)
const vector< FeedRow * > getFeeds (int i)
const vector< FeedRow * > getFeeds ()
void setAssocConfigDescriptionId (int i, Tag assocConfigDescriptionId)
void addAssocConfigDescriptionId (Tag id)
void addAssocConfigDescriptionId (const vector< Tag > &id)
const Tag getAssocConfigDescriptionId (int i)
ConfigDescriptionRow * getConfigDescription (int i)
vector< ConfigDescriptionRow * > getConfigDescriptions ()
bool compareNoAutoInc (vector< Tag > antennaId, vector< Tag > dataDescriptionId, vector< int > feedId, Tag processorId, vector< Tag > switchCycleId, int numAntenna, int numFeed, vector< int > numSubBand, CorrelationModeMod::CorrelationMode correlationMode, vector< AtmPhaseCorrectionMod::AtmPhaseCorrection > atmPhaseCorrection)
bool compareRequiredValue (vector< Tag > antennaId, vector< Tag > dataDescriptionId, vector< int > feedId, Tag processorId, vector< Tag > switchCycleId, int numAntenna, int numFeed, vector< int > numSubBand, CorrelationModeMod::CorrelationMode correlationMode, vector< AtmPhaseCorrectionMod::AtmPhaseCorrection > atmPhaseCorrection)
bool equalByRequiredValue (ConfigDescriptionRow *x)

Member Function Documentation

void asdm::ConfigDescriptionRow::addAntennaId (  const vector< Tag > &  id  ) 
 

Append a vector of Tag to antennaId.

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

void asdm::ConfigDescriptionRow::addAntennaId (  Tag  id  ) 
 

Append a Tag to antennaId.

Parameters:
id the Tag to be appended to antennaId

void asdm::ConfigDescriptionRow::addAssocConfigDescriptionId (  const vector< Tag > &  id  ) 
 

Append a vector of Tag to assocConfigDescriptionId.

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

void asdm::ConfigDescriptionRow::addAssocConfigDescriptionId (  Tag  id  ) 
 

Append a Tag to assocConfigDescriptionId.

Parameters:
id the Tag to be appended to assocConfigDescriptionId

void asdm::ConfigDescriptionRow::addDataDescriptionId (  const vector< Tag > &  id  ) 
 

Append a vector of Tag to dataDescriptionId.

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

void asdm::ConfigDescriptionRow::addDataDescriptionId (  Tag  id  ) 
 

Append a Tag to dataDescriptionId.

Parameters:
id the Tag to be appended to dataDescriptionId

void asdm::ConfigDescriptionRow::addFeedId (  vector< int >  id  ) 
 

Append an array of ids to feedId

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

void asdm::ConfigDescriptionRow::addFeedId (  int  id  ) 
 

Append a new id to feedId

Parameters:
id the int value to be appended to feedId

void asdm::ConfigDescriptionRow::addSwitchCycleId (  const vector< Tag > &  id  ) 
 

Append a vector of Tag to switchCycleId.

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

void asdm::ConfigDescriptionRow::addSwitchCycleId (  Tag  id  ) 
 

Append a Tag to switchCycleId.

Parameters:
id the Tag to be appended to switchCycleId

void asdm::ConfigDescriptionRow::clearAssocConfigDescriptionId (   ) 
 

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

void asdm::ConfigDescriptionRow::clearAssocNature (   ) 
 

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

void asdm::ConfigDescriptionRow::clearFlagAnt (   ) 
 

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

void asdm::ConfigDescriptionRow::clearPhasedArrayList (   ) 
 

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

bool asdm::ConfigDescriptionRow::compareNoAutoInc (  vector< Tag >  antennaId,
vector< Tag >  dataDescriptionId,
vector< int >  feedId,
Tag  processorId,
vector< Tag >  switchCycleId,
int  numAntenna,
int  numFeed,
vector< int >  numSubBand,
CorrelationModeMod::CorrelationMode  correlationMode,
vector< AtmPhaseCorrectionMod::AtmPhaseCorrection >  atmPhaseCorrection
) 
 

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

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

AntennaRow* asdm::ConfigDescriptionRow::getAntenna (  int  i  ) 
 

Returns the AntennaRow linked to this row via the tag stored in antennaId at position i.

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

const Tag asdm::ConfigDescriptionRow::getAntennaId (  int  i  ) 
 

Returns the Tag stored in antennaId at position i.

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

vector<Tag> asdm::ConfigDescriptionRow::getAntennaId (   )  const
 

Get antennaId.

Returns:
antennaId as vector<Tag>

vector<AntennaRow *> asdm::ConfigDescriptionRow::getAntennas (   ) 
 

Returns the vector of AntennaRow* linked to this row via the Tags stored in antennaId

Returns:
an array of pointers on AntennaRow.

const Tag asdm::ConfigDescriptionRow::getAssocConfigDescriptionId (  int  i  ) 
 

Returns the Tag stored in assocConfigDescriptionId at position i.

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

vector<Tag> asdm::ConfigDescriptionRow::getAssocConfigDescriptionId (   )  const throw (IllegalAccessException)
 

Get assocConfigDescriptionId, which is optional.

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

vector<SpectralResolutionTypeMod::SpectralResolutionType > asdm::ConfigDescriptionRow::getAssocNature (   )  const throw (IllegalAccessException)
 

Get assocNature, which is optional.

Returns:
assocNature as vector<SpectralResolutionTypeMod::SpectralResolutionType >
Exceptions:
IllegalAccessException If assocNature does not exist.

vector<AtmPhaseCorrectionMod::AtmPhaseCorrection > asdm::ConfigDescriptionRow::getAtmPhaseCorrection (   )  const
 

Get atmPhaseCorrection.

Returns:
atmPhaseCorrection as vector<AtmPhaseCorrectionMod::AtmPhaseCorrection >

ConfigDescriptionRow* asdm::ConfigDescriptionRow::getConfigDescription (  int  i  ) 
 

Returns the ConfigDescriptionRow linked to this row via the tag stored in assocConfigDescriptionId at position i.

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

Tag asdm::ConfigDescriptionRow::getConfigDescriptionId (   )  const
 

Get configDescriptionId.

Returns:
configDescriptionId as Tag

vector<ConfigDescriptionRow *> asdm::ConfigDescriptionRow::getConfigDescriptions (   ) 
 

Returns the vector of ConfigDescriptionRow* linked to this row via the Tags stored in assocConfigDescriptionId

Returns:
an array of pointers on ConfigDescriptionRow.

CorrelationModeMod::CorrelationMode asdm::ConfigDescriptionRow::getCorrelationMode (   )  const
 

Get correlationMode.

Returns:
correlationMode as CorrelationModeMod::CorrelationMode

DataDescriptionRow* asdm::ConfigDescriptionRow::getDataDescription (  int  i  ) 
 

Returns the DataDescriptionRow linked to this row via the tag stored in dataDescriptionId at position i.

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

const Tag asdm::ConfigDescriptionRow::getDataDescriptionId (  int  i  ) 
 

Returns the Tag stored in dataDescriptionId at position i.

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

vector<Tag> asdm::ConfigDescriptionRow::getDataDescriptionId (   )  const
 

Get dataDescriptionId.

Returns:
dataDescriptionId as vector<Tag>

vector<DataDescriptionRow *> asdm::ConfigDescriptionRow::getDataDescriptions (   ) 
 

Returns the vector of DataDescriptionRow* linked to this row via the Tags stored in dataDescriptionId

Returns:
an array of pointers on DataDescriptionRow.

vector<int> asdm::ConfigDescriptionRow::getFeedId (   )  const
 

Get feedId.

Returns:
feedId as vector<int>

const vector<FeedRow *> asdm::ConfigDescriptionRow::getFeeds (   ) 
 

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

Returns:
a vector of FeedRow *.

const vector<FeedRow *> asdm::ConfigDescriptionRow::getFeeds (  int  i  ) 
 

Get the collection of rows in the Feed table having feedId == feedId[i]

Returns:
a vector of FeedRow *.

vector<bool > asdm::ConfigDescriptionRow::getFlagAnt (   )  const throw (IllegalAccessException)
 

Get flagAnt, which is optional.

Returns:
flagAnt as vector<bool >
Exceptions:
IllegalAccessException If flagAnt does not exist.

int asdm::ConfigDescriptionRow::getNumAntenna (   )  const
 

Get numAntenna.

Returns:
numAntenna as int

int asdm::ConfigDescriptionRow::getNumFeed (   )  const
 

Get numFeed.

Returns:
numFeed as int

vector<int > asdm::ConfigDescriptionRow::getNumSubBand (   )  const
 

Get numSubBand.

Returns:
numSubBand as vector<int >

vector<int > asdm::ConfigDescriptionRow::getPhasedArrayList (   )  const throw (IllegalAccessException)
 

Get phasedArrayList, which is optional.

Returns:
phasedArrayList as vector<int >
Exceptions:
IllegalAccessException If phasedArrayList does not exist.

Tag asdm::ConfigDescriptionRow::getProcessorId (   )  const
 

Get processorId.

Returns:
processorId as Tag

ProcessorRow* asdm::ConfigDescriptionRow::getProcessorUsingProcessorId (   ) 
 

processorId pointer to the row in the Processor table having Processor.processorId == processorId

Returns:
a ProcessorRow*

SwitchCycleRow* asdm::ConfigDescriptionRow::getSwitchCycle (  int  i  ) 
 

Returns the SwitchCycleRow linked to this row via the tag stored in switchCycleId at position i.

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

const Tag asdm::ConfigDescriptionRow::getSwitchCycleId (  int  i  ) 
 

Returns the Tag stored in switchCycleId at position i.

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

vector<Tag> asdm::ConfigDescriptionRow::getSwitchCycleId (   )  const
 

Get switchCycleId.

Returns:
switchCycleId as vector<Tag>

vector<SwitchCycleRow *> asdm::ConfigDescriptionRow::getSwitchCycles (   ) 
 

Returns the vector of SwitchCycleRow* linked to this row via the Tags stored in switchCycleId

Returns:
an array of pointers on SwitchCycleRow.

ConfigDescriptionTable& asdm::ConfigDescriptionRow::getTable (   )  const
 

Return the table to which this row belongs.

bool asdm::ConfigDescriptionRow::isAssocConfigDescriptionIdExists (   )  const
 

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

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

bool asdm::ConfigDescriptionRow::isAssocNatureExists (   )  const
 

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

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

bool asdm::ConfigDescriptionRow::isFlagAntExists (   )  const
 

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

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

bool asdm::ConfigDescriptionRow::isPhasedArrayListExists (   )  const
 

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

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

void asdm::ConfigDescriptionRow::setAntennaId (  int  i,
Tag  antennaId
) 
 

Set antennaId[i] with the specified Tag.

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

void asdm::ConfigDescriptionRow::setAntennaId (  vector< Tag >  antennaId  ) 
 

Set antennaId with the specified vector<Tag> .

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

void asdm::ConfigDescriptionRow::setAssocConfigDescriptionId (  int  i,
Tag  assocConfigDescriptionId
) 
 

Set assocConfigDescriptionId[i] with the specified Tag.

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

void asdm::ConfigDescriptionRow::setAssocConfigDescriptionId (  vector< Tag >  assocConfigDescriptionId  ) 
 

Set assocConfigDescriptionId with the specified vector<Tag> .

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

void asdm::ConfigDescriptionRow::setAssocNature (  vector< SpectralResolutionTypeMod::SpectralResolutionType >  assocNature  ) 
 

Set assocNature with the specified vector<SpectralResolutionTypeMod::SpectralResolutionType >.

Parameters:
assocNature The vector<SpectralResolutionTypeMod::SpectralResolutionType > value to which assocNature is to be set.

void asdm::ConfigDescriptionRow::setAtmPhaseCorrection (  vector< AtmPhaseCorrectionMod::AtmPhaseCorrection >  atmPhaseCorrection  ) 
 

Set atmPhaseCorrection with the specified vector<AtmPhaseCorrectionMod::AtmPhaseCorrection >.

Parameters:
atmPhaseCorrection The vector<AtmPhaseCorrectionMod::AtmPhaseCorrection > value to which atmPhaseCorrection is to be set.

void asdm::ConfigDescriptionRow::setCorrelationMode (  CorrelationModeMod::CorrelationMode  correlationMode  ) 
 

Set correlationMode with the specified CorrelationModeMod::CorrelationMode.

Parameters:
correlationMode The CorrelationModeMod::CorrelationMode value to which correlationMode is to be set.

void asdm::ConfigDescriptionRow::setDataDescriptionId (  int  i,
Tag  dataDescriptionId
) 
 

Set dataDescriptionId[i] with the specified Tag.

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

void asdm::ConfigDescriptionRow::setDataDescriptionId (  vector< Tag >  dataDescriptionId  ) 
 

Set dataDescriptionId with the specified vector<Tag> .

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

void asdm::ConfigDescriptionRow::setFeedId (  int  i,
int  feedId
) 
 

Set feedId[i] with the specified int.

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

void asdm::ConfigDescriptionRow::setFeedId (  vector< int >  feedId  ) 
 

Set feedId with the specified vector<int> .

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

void asdm::ConfigDescriptionRow::setFlagAnt (  vector< bool >  flagAnt  ) 
 

Set flagAnt with the specified vector<bool >.

Parameters:
flagAnt The vector<bool > value to which flagAnt is to be set.

void asdm::ConfigDescriptionRow::setFromIDL (  ConfigDescriptionRowIDL  x  )  throw (ConversionException)
 

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

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

void asdm::ConfigDescriptionRow::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::ConfigDescriptionRow::setNumAntenna (  int  numAntenna  ) 
 

Set numAntenna with the specified int.

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

void asdm::ConfigDescriptionRow::setNumFeed (  int  numFeed  ) 
 

Set numFeed with the specified int.

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

void asdm::ConfigDescriptionRow::setNumSubBand (  vector< int >  numSubBand  ) 
 

Set numSubBand with the specified vector<int >.

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

void asdm::ConfigDescriptionRow::setPhasedArrayList (  vector< int >  phasedArrayList  ) 
 

Set phasedArrayList with the specified vector<int >.

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

void asdm::ConfigDescriptionRow::setProcessorId (  Tag  processorId  ) 
 

Set processorId with the specified Tag.

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

void asdm::ConfigDescriptionRow::setSwitchCycleId (  int  i,
Tag  switchCycleId
) 
 

Set switchCycleId[i] with the specified Tag.

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

void asdm::ConfigDescriptionRow::setSwitchCycleId (  vector< Tag >  switchCycleId  ) 
 

Set switchCycleId with the specified vector<Tag> .

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

ConfigDescriptionRowIDL* asdm::ConfigDescriptionRow::toIDL (   )  const
 

Return this row in the form of an IDL struct.

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

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