asdm::AnnotationRow Class Reference

#include <AnnotationRow.h>

List of all members.

Detailed Description

The AnnotationRow class is a row of a AnnotationTable.

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


Public Member Functions

AnnotationTable & getTable () const
AnnotationRowIDL * toIDL () const
void setFromIDL (AnnotationRowIDL x) throw (ConversionException)
string toXML () const
void setFromXML (string rowDoc) throw (ConversionException)
ArrayTime getTime () const
void setTime (ArrayTime time)
string getIssue () const
void setIssue (string issue)
string getDetails () const
void setDetails (string details)
bool isIntervalExists () const
Interval getInterval () const throw (IllegalAccessException)
void setInterval (Interval interval)
void clearInterval ()
bool isNumAntennaExists () const
int getNumAntenna () const throw (IllegalAccessException)
void setNumAntenna (int numAntenna)
void clearNumAntenna ()
bool isNumBasebandExists () const
int getNumBaseband () const throw (IllegalAccessException)
void setNumBaseband (int numBaseband)
void clearNumBaseband ()
bool isBasebandNameExists () const
vector< BasebandNameMod::BasebandName > getBasebandName () const throw (IllegalAccessException)
void setBasebandName (vector< BasebandNameMod::BasebandName > basebandName)
void clearBasebandName ()
bool isDValueExists () const
double getDValue () const throw (IllegalAccessException)
void setDValue (double dValue)
void clearDValue ()
bool isVdValueExists () const
vector< double > getVdValue () const throw (IllegalAccessException)
void setVdValue (vector< double > vdValue)
void clearVdValue ()
bool isVvdValuesExists () const
vector< vector< double > > getVvdValues () const throw (IllegalAccessException)
void setVvdValues (vector< vector< double > > vvdValues)
void clearVvdValues ()
bool isLlValueExists () const
long long getLlValue () const throw (IllegalAccessException)
void setLlValue (long long llValue)
void clearLlValue ()
bool isVllValueExists () const
vector< long long > getVllValue () const throw (IllegalAccessException)
void setVllValue (vector< long long > vllValue)
void clearVllValue ()
bool isVvllValueExists () const
vector< vector< long long > > getVvllValue () const throw (IllegalAccessException)
void setVvllValue (vector< vector< long long > > vvllValue)
void clearVvllValue ()
Tag getAnnotationId () const
bool isAntennaIdExists () const
vector< Tag > getAntennaId () const throw (IllegalAccessException)
void setAntennaId (vector< Tag > antennaId)
void clearAntennaId ()
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 ()
bool compareNoAutoInc (ArrayTime time, string issue, string details)
bool compareRequiredValue (ArrayTime time, string issue, string details)
bool equalByRequiredValue (AnnotationRow *x)

Member Function Documentation

void asdm::AnnotationRow::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::AnnotationRow::addAntennaId (  Tag  id  ) 
 

Append a Tag to antennaId.

Parameters:
id the Tag to be appended to antennaId

void asdm::AnnotationRow::clearAntennaId (   ) 
 

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

void asdm::AnnotationRow::clearBasebandName (   ) 
 

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

void asdm::AnnotationRow::clearDValue (   ) 
 

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

void asdm::AnnotationRow::clearInterval (   ) 
 

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

void asdm::AnnotationRow::clearLlValue (   ) 
 

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

void asdm::AnnotationRow::clearNumAntenna (   ) 
 

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

void asdm::AnnotationRow::clearNumBaseband (   ) 
 

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

void asdm::AnnotationRow::clearVdValue (   ) 
 

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

void asdm::AnnotationRow::clearVllValue (   ) 
 

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

void asdm::AnnotationRow::clearVvdValues (   ) 
 

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

void asdm::AnnotationRow::clearVvllValue (   ) 
 

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

bool asdm::AnnotationRow::compareNoAutoInc (  ArrayTime  time,
string  issue,
string  details
) 
 

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

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

Tag asdm::AnnotationRow::getAnnotationId (   )  const
 

Get annotationId.

Returns:
annotationId as Tag

AntennaRow* asdm::AnnotationRow::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::AnnotationRow::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::AnnotationRow::getAntennaId (   )  const throw (IllegalAccessException)
 

Get antennaId, which is optional.

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

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

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

Returns:
an array of pointers on AntennaRow.

vector<BasebandNameMod::BasebandName > asdm::AnnotationRow::getBasebandName (   )  const throw (IllegalAccessException)
 

Get basebandName, which is optional.

Returns:
basebandName as vector<BasebandNameMod::BasebandName >
Exceptions:
IllegalAccessException If basebandName does not exist.

string asdm::AnnotationRow::getDetails (   )  const
 

Get details.

Returns:
details as string

double asdm::AnnotationRow::getDValue (   )  const throw (IllegalAccessException)
 

Get dValue, which is optional.

Returns:
dValue as double
Exceptions:
IllegalAccessException If dValue does not exist.

Interval asdm::AnnotationRow::getInterval (   )  const throw (IllegalAccessException)
 

Get interval, which is optional.

Returns:
interval as Interval
Exceptions:
IllegalAccessException If interval does not exist.

string asdm::AnnotationRow::getIssue (   )  const
 

Get issue.

Returns:
issue as string

long long asdm::AnnotationRow::getLlValue (   )  const throw (IllegalAccessException)
 

Get llValue, which is optional.

Returns:
llValue as long long
Exceptions:
IllegalAccessException If llValue does not exist.

int asdm::AnnotationRow::getNumAntenna (   )  const throw (IllegalAccessException)
 

Get numAntenna, which is optional.

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

int asdm::AnnotationRow::getNumBaseband (   )  const throw (IllegalAccessException)
 

Get numBaseband, which is optional.

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

AnnotationTable& asdm::AnnotationRow::getTable (   )  const
 

Return the table to which this row belongs.

ArrayTime asdm::AnnotationRow::getTime (   )  const
 

Get time.

Returns:
time as ArrayTime

vector<double > asdm::AnnotationRow::getVdValue (   )  const throw (IllegalAccessException)
 

Get vdValue, which is optional.

Returns:
vdValue as vector<double >
Exceptions:
IllegalAccessException If vdValue does not exist.

vector<long long > asdm::AnnotationRow::getVllValue (   )  const throw (IllegalAccessException)
 

Get vllValue, which is optional.

Returns:
vllValue as vector<long long >
Exceptions:
IllegalAccessException If vllValue does not exist.

vector<vector<double > > asdm::AnnotationRow::getVvdValues (   )  const throw (IllegalAccessException)
 

Get vvdValues, which is optional.

Returns:
vvdValues as vector<vector<double > >
Exceptions:
IllegalAccessException If vvdValues does not exist.

vector<vector<long long > > asdm::AnnotationRow::getVvllValue (   )  const throw (IllegalAccessException)
 

Get vvllValue, which is optional.

Returns:
vvllValue as vector<vector<long long > >
Exceptions:
IllegalAccessException If vvllValue does not exist.

bool asdm::AnnotationRow::isAntennaIdExists (   )  const
 

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

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

bool asdm::AnnotationRow::isBasebandNameExists (   )  const
 

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

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

bool asdm::AnnotationRow::isDValueExists (   )  const
 

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

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

bool asdm::AnnotationRow::isIntervalExists (   )  const
 

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

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

bool asdm::AnnotationRow::isLlValueExists (   )  const
 

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

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

bool asdm::AnnotationRow::isNumAntennaExists (   )  const
 

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

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

bool asdm::AnnotationRow::isNumBasebandExists (   )  const
 

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

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

bool asdm::AnnotationRow::isVdValueExists (   )  const
 

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

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

bool asdm::AnnotationRow::isVllValueExists (   )  const
 

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

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

bool asdm::AnnotationRow::isVvdValuesExists (   )  const
 

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

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

bool asdm::AnnotationRow::isVvllValueExists (   )  const
 

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

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

void asdm::AnnotationRow::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:
OutOfBoundsException 

void asdm::AnnotationRow::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::AnnotationRow::setBasebandName (  vector< BasebandNameMod::BasebandName >  basebandName  ) 
 

Set basebandName with the specified vector<BasebandNameMod::BasebandName >.

Parameters:
basebandName The vector<BasebandNameMod::BasebandName > value to which basebandName is to be set.

void asdm::AnnotationRow::setDetails (  string  details  ) 
 

Set details with the specified string.

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

void asdm::AnnotationRow::setDValue (  double  dValue  ) 
 

Set dValue with the specified double.

Parameters:
dValue The double value to which dValue is to be set.

void asdm::AnnotationRow::setFromIDL (  AnnotationRowIDL  x  )  throw (ConversionException)
 

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

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

void asdm::AnnotationRow::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::AnnotationRow::setInterval (  Interval  interval  ) 
 

Set interval with the specified Interval.

Parameters:
interval The Interval value to which interval is to be set.

void asdm::AnnotationRow::setIssue (  string  issue  ) 
 

Set issue with the specified string.

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

void asdm::AnnotationRow::setLlValue (  long long  llValue  ) 
 

Set llValue with the specified long long.

Parameters:
llValue The long long value to which llValue is to be set.

void asdm::AnnotationRow::setNumAntenna (  int  numAntenna  ) 
 

Set numAntenna with the specified int.

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

void asdm::AnnotationRow::setNumBaseband (  int  numBaseband  ) 
 

Set numBaseband with the specified int.

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

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

Set time with the specified ArrayTime.

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

void asdm::AnnotationRow::setVdValue (  vector< double >  vdValue  ) 
 

Set vdValue with the specified vector<double >.

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

void asdm::AnnotationRow::setVllValue (  vector< long long >  vllValue  ) 
 

Set vllValue with the specified vector<long long >.

Parameters:
vllValue The vector<long long > value to which vllValue is to be set.

void asdm::AnnotationRow::setVvdValues (  vector< vector< double > >  vvdValues  ) 
 

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

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

void asdm::AnnotationRow::setVvllValue (  vector< vector< long long > >  vvllValue  ) 
 

Set vvllValue with the specified vector<vector<long long > >.

Parameters:
vvllValue The vector<vector<long long > > value to which vvllValue is to be set.

AnnotationRowIDL* asdm::AnnotationRow::toIDL (   )  const
 

Return this row in the form of an IDL struct.

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

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