asdm::FieldRow Class Reference

#include <FieldRow.h>

List of all members.

Detailed Description

The FieldRow class is a row of a FieldTable.

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


Public Member Functions

FieldTable & getTable () const
FieldRowIDL * toIDL () const
void setFromIDL (FieldRowIDL x) throw (ConversionException)
string toXML () const
void setFromXML (string rowDoc) throw (ConversionException)
Tag getFieldId () const
string getFieldName () const
void setFieldName (string fieldName)
string getCode () const
void setCode (string code)
ArrayTime getTime () const
void setTime (ArrayTime time)
int getNumPoly () const
void setNumPoly (int numPoly)
vector< vector< Angle > > getDelayDir () const
void setDelayDir (vector< vector< Angle > > delayDir)
vector< vector< Angle > > getPhaseDir () const
void setPhaseDir (vector< vector< Angle > > phaseDir)
vector< vector< Angle > > getReferenceDir () const
void setReferenceDir (vector< vector< Angle > > referenceDir)
bool isAssocNatureExists () const
string getAssocNature () const throw (IllegalAccessException)
void setAssocNature (string assocNature)
void clearAssocNature ()
bool getFlagRow () const
void setFlagRow (bool flagRow)
bool isAssocFieldIdExists () const
vector< Tag > getAssocFieldId () const throw (IllegalAccessException)
void setAssocFieldId (vector< Tag > assocFieldId)
void clearAssocFieldId ()
bool isEphemerisIdExists () const
Tag getEphemerisId () const throw (IllegalAccessException)
void setEphemerisId (Tag ephemerisId)
void clearEphemerisId ()
bool isSourceIdExists () const
int getSourceId () const throw (IllegalAccessException)
void setSourceId (int sourceId)
void clearSourceId ()
void setAssocFieldId (int i, Tag assocFieldId)
void addAssocFieldId (Tag id)
void addAssocFieldId (const vector< Tag > &id)
const Tag getAssocFieldId (int i)
FieldRow * getField (int i)
vector< FieldRow * > getFields ()
EphemerisRow * getEphemerisUsingEphemerisId ()
vector< SourceRow * > getSources ()
bool compareNoAutoInc (string fieldName, string code, ArrayTime time, int numPoly, vector< vector< Angle > > delayDir, vector< vector< Angle > > phaseDir, vector< vector< Angle > > referenceDir, bool flagRow)
bool compareRequiredValue (string fieldName, string code, ArrayTime time, int numPoly, vector< vector< Angle > > delayDir, vector< vector< Angle > > phaseDir, vector< vector< Angle > > referenceDir, bool flagRow)
bool equalByRequiredValue (FieldRow *x)

Member Function Documentation

void asdm::FieldRow::addAssocFieldId (  const vector< Tag > &  id  ) 
 

Append a vector of Tag to assocFieldId.

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

void asdm::FieldRow::addAssocFieldId (  Tag  id  ) 
 

Append a Tag to assocFieldId.

Parameters:
id the Tag to be appended to assocFieldId

void asdm::FieldRow::clearAssocFieldId (   ) 
 

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

void asdm::FieldRow::clearAssocNature (   ) 
 

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

void asdm::FieldRow::clearEphemerisId (   ) 
 

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

void asdm::FieldRow::clearSourceId (   ) 
 

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

bool asdm::FieldRow::compareNoAutoInc (  string  fieldName,
string  code,
ArrayTime  time,
int  numPoly,
vector< vector< Angle > >  delayDir,
vector< vector< Angle > >  phaseDir,
vector< vector< Angle > >  referenceDir,
bool  flagRow
) 
 

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

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

const Tag asdm::FieldRow::getAssocFieldId (  int  i  ) 
 

Returns the Tag stored in assocFieldId at position i.

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

vector<Tag> asdm::FieldRow::getAssocFieldId (   )  const throw (IllegalAccessException)
 

Get assocFieldId, which is optional.

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

string asdm::FieldRow::getAssocNature (   )  const throw (IllegalAccessException)
 

Get assocNature, which is optional.

Returns:
assocNature as string
Exceptions:
IllegalAccessException If assocNature does not exist.

string asdm::FieldRow::getCode (   )  const
 

Get code.

Returns:
code as string

vector<vector<Angle > > asdm::FieldRow::getDelayDir (   )  const
 

Get delayDir.

Returns:
delayDir as vector<vector<Angle > >

Tag asdm::FieldRow::getEphemerisId (   )  const throw (IllegalAccessException)
 

Get ephemerisId, which is optional.

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

EphemerisRow* asdm::FieldRow::getEphemerisUsingEphemerisId (   ) 
 

ephemerisId pointer to the row in the Ephemeris table having Ephemeris.ephemerisId == ephemerisId

Returns:
a EphemerisRow*
throws IllegalAccessException

FieldRow* asdm::FieldRow::getField (  int  i  ) 
 

Returns the FieldRow linked to this row via the tag stored in assocFieldId at position i.

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

Tag asdm::FieldRow::getFieldId (   )  const
 

Get fieldId.

Returns:
fieldId as Tag

string asdm::FieldRow::getFieldName (   )  const
 

Get fieldName.

Returns:
fieldName as string

vector<FieldRow *> asdm::FieldRow::getFields (   ) 
 

Returns the vector of FieldRow* linked to this row via the Tags stored in assocFieldId

Returns:
an array of pointers on FieldRow.

bool asdm::FieldRow::getFlagRow (   )  const
 

Get flagRow.

Returns:
flagRow as bool

int asdm::FieldRow::getNumPoly (   )  const
 

Get numPoly.

Returns:
numPoly as int

vector<vector<Angle > > asdm::FieldRow::getPhaseDir (   )  const
 

Get phaseDir.

Returns:
phaseDir as vector<vector<Angle > >

vector<vector<Angle > > asdm::FieldRow::getReferenceDir (   )  const
 

Get referenceDir.

Returns:
referenceDir as vector<vector<Angle > >

int asdm::FieldRow::getSourceId (   )  const throw (IllegalAccessException)
 

Get sourceId, which is optional.

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

vector<SourceRow *> asdm::FieldRow::getSources (   ) 
 

Get the collection of row in the Source table having sourceId == this.sourceId

Returns:
a vector of SourceRow *

FieldTable& asdm::FieldRow::getTable (   )  const
 

Return the table to which this row belongs.

ArrayTime asdm::FieldRow::getTime (   )  const
 

Get time.

Returns:
time as ArrayTime

bool asdm::FieldRow::isAssocFieldIdExists (   )  const
 

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

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

bool asdm::FieldRow::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::FieldRow::isEphemerisIdExists (   )  const
 

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

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

bool asdm::FieldRow::isSourceIdExists (   )  const
 

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

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

void asdm::FieldRow::setAssocFieldId (  int  i,
Tag  assocFieldId
) 
 

Set assocFieldId[i] with the specified Tag.

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

void asdm::FieldRow::setAssocFieldId (  vector< Tag >  assocFieldId  ) 
 

Set assocFieldId with the specified vector<Tag> .

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

void asdm::FieldRow::setAssocNature (  string  assocNature  ) 
 

Set assocNature with the specified string.

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

void asdm::FieldRow::setCode (  string  code  ) 
 

Set code with the specified string.

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

void asdm::FieldRow::setDelayDir (  vector< vector< Angle > >  delayDir  ) 
 

Set delayDir with the specified vector<vector<Angle > >.

Parameters:
delayDir The vector<vector<Angle > > value to which delayDir is to be set.

void asdm::FieldRow::setEphemerisId (  Tag  ephemerisId  ) 
 

Set ephemerisId with the specified Tag.

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

void asdm::FieldRow::setFieldName (  string  fieldName  ) 
 

Set fieldName with the specified string.

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

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

Set flagRow with the specified bool.

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

void asdm::FieldRow::setFromIDL (  FieldRowIDL  x  )  throw (ConversionException)
 

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

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

void asdm::FieldRow::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::FieldRow::setNumPoly (  int  numPoly  ) 
 

Set numPoly with the specified int.

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

void asdm::FieldRow::setPhaseDir (  vector< vector< Angle > >  phaseDir  ) 
 

Set phaseDir with the specified vector<vector<Angle > >.

Parameters:
phaseDir The vector<vector<Angle > > value to which phaseDir is to be set.

void asdm::FieldRow::setReferenceDir (  vector< vector< Angle > >  referenceDir  ) 
 

Set referenceDir with the specified vector<vector<Angle > >.

Parameters:
referenceDir The vector<vector<Angle > > value to which referenceDir is to be set.

void asdm::FieldRow::setSourceId (  int  sourceId  ) 
 

Set sourceId with the specified int.

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

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

Set time with the specified ArrayTime.

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

FieldRowIDL* asdm::FieldRow::toIDL (   )  const
 

Return this row in the form of an IDL struct.

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

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