asdm::MainRow Class Reference

#include <MainRow.h>

List of all members.

Detailed Description

The MainRow class is a row of a MainTable.

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


Public Member Functions

MainTable & getTable () const
MainRowIDL * toIDL () const
void setFromIDL (MainRowIDL x) throw (ConversionException)
string toXML () const
void setFromXML (string rowDoc) throw (ConversionException)
ArrayTime getTime () const
void setTime (ArrayTime time)
int getScanNumber () const
void setScanNumber (int scanNumber)
int getSubscanNumber () const
void setSubscanNumber (int subscanNumber)
TimeSamplingMod::TimeSampling getTimeSampling () const
void setTimeSampling (TimeSamplingMod::TimeSampling timeSampling)
int getNumIntegration () const
void setNumIntegration (int numIntegration)
EntityRef getDataOid () const
void setDataOid (EntityRef dataOid)
bool getFlagRow () const
void setFlagRow (bool flagRow)
Interval getInterval () const
void setInterval (Interval interval)
Tag getConfigDescriptionId () const
void setConfigDescriptionId (Tag configDescriptionId)
Tag getExecBlockId () const
void setExecBlockId (Tag execBlockId)
Tag getFieldId () const
void setFieldId (Tag fieldId)
vector< Tag > getStateId () const
void setStateId (vector< Tag > stateId)
ConfigDescriptionRow * getConfigDescriptionUsingConfigDescriptionId ()
FieldRow * getFieldUsingFieldId ()
void setStateId (int i, Tag stateId)
void addStateId (Tag id)
void addStateId (const vector< Tag > &id)
const Tag getStateId (int i)
StateRow * getState (int i)
vector< StateRow * > getStates ()
ExecBlockRow * getExecBlockUsingExecBlockId ()
bool compareNoAutoInc (Tag configDescriptionId, Tag fieldId, ArrayTime time, Tag execBlockId, vector< Tag > stateId, int scanNumber, int subscanNumber, TimeSamplingMod::TimeSampling timeSampling, int numIntegration, EntityRef dataOid, bool flagRow, Interval interval)
bool compareRequiredValue (Tag execBlockId, vector< Tag > stateId, int scanNumber, int subscanNumber, TimeSamplingMod::TimeSampling timeSampling, int numIntegration, EntityRef dataOid, bool flagRow, Interval interval)
bool equalByRequiredValue (MainRow *x)

Member Function Documentation

void asdm::MainRow::addStateId (  const vector< Tag > &  id  ) 
 

Append a vector of Tag to stateId.

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

void asdm::MainRow::addStateId (  Tag  id  ) 
 

Append a Tag to stateId.

Parameters:
id the Tag to be appended to stateId

bool asdm::MainRow::compareNoAutoInc (  Tag  configDescriptionId,
Tag  fieldId,
ArrayTime  time,
Tag  execBlockId,
vector< Tag >  stateId,
int  scanNumber,
int  subscanNumber,
TimeSamplingMod::TimeSampling  timeSampling,
int  numIntegration,
EntityRef  dataOid,
bool  flagRow,
Interval  interval
) 
 

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

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

Tag asdm::MainRow::getConfigDescriptionId (   )  const
 

Get configDescriptionId.

Returns:
configDescriptionId as Tag

ConfigDescriptionRow* asdm::MainRow::getConfigDescriptionUsingConfigDescriptionId (   ) 
 

configDescriptionId pointer to the row in the ConfigDescription table having ConfigDescription.configDescriptionId == configDescriptionId

Returns:
a ConfigDescriptionRow*

EntityRef asdm::MainRow::getDataOid (   )  const
 

Get dataOid.

Returns:
dataOid as EntityRef

Tag asdm::MainRow::getExecBlockId (   )  const
 

Get execBlockId.

Returns:
execBlockId as Tag

ExecBlockRow* asdm::MainRow::getExecBlockUsingExecBlockId (   ) 
 

execBlockId pointer to the row in the ExecBlock table having ExecBlock.execBlockId == execBlockId

Returns:
a ExecBlockRow*

Tag asdm::MainRow::getFieldId (   )  const
 

Get fieldId.

Returns:
fieldId as Tag

FieldRow* asdm::MainRow::getFieldUsingFieldId (   ) 
 

fieldId pointer to the row in the Field table having Field.fieldId == fieldId

Returns:
a FieldRow*

bool asdm::MainRow::getFlagRow (   )  const
 

Get flagRow.

Returns:
flagRow as bool

Interval asdm::MainRow::getInterval (   )  const
 

Get interval.

Returns:
interval as Interval

int asdm::MainRow::getNumIntegration (   )  const
 

Get numIntegration.

Returns:
numIntegration as int

int asdm::MainRow::getScanNumber (   )  const
 

Get scanNumber.

Returns:
scanNumber as int

StateRow* asdm::MainRow::getState (  int  i  ) 
 

Returns the StateRow linked to this row via the tag stored in stateId at position i.

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

const Tag asdm::MainRow::getStateId (  int  i  ) 
 

Returns the Tag stored in stateId at position i.

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

vector<Tag> asdm::MainRow::getStateId (   )  const
 

Get stateId.

Returns:
stateId as vector<Tag>

vector<StateRow *> asdm::MainRow::getStates (   ) 
 

Returns the vector of StateRow* linked to this row via the Tags stored in stateId

Returns:
an array of pointers on StateRow.

int asdm::MainRow::getSubscanNumber (   )  const
 

Get subscanNumber.

Returns:
subscanNumber as int

MainTable& asdm::MainRow::getTable (   )  const
 

Return the table to which this row belongs.

ArrayTime asdm::MainRow::getTime (   )  const
 

Get time.

Returns:
time as ArrayTime

TimeSamplingMod::TimeSampling asdm::MainRow::getTimeSampling (   )  const
 

Get timeSampling.

Returns:
timeSampling as TimeSamplingMod::TimeSampling

void asdm::MainRow::setConfigDescriptionId (  Tag  configDescriptionId  ) 
 

Set configDescriptionId with the specified Tag.

Parameters:
configDescriptionId The Tag value to which configDescriptionId is to be set.
Exceptions:
IllegalAccessException If an attempt is made to change this field after is has been added to the table.

void asdm::MainRow::setDataOid (  EntityRef  dataOid  ) 
 

Set dataOid with the specified EntityRef.

Parameters:
dataOid The EntityRef value to which dataOid is to be set.

void asdm::MainRow::setExecBlockId (  Tag  execBlockId  ) 
 

Set execBlockId with the specified Tag.

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

void asdm::MainRow::setFieldId (  Tag  fieldId  ) 
 

Set fieldId with the specified Tag.

Parameters:
fieldId The Tag value to which fieldId is to be set.
Exceptions:
IllegalAccessException If an attempt is made to change this field after is has been added to the table.

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

Set flagRow with the specified bool.

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

void asdm::MainRow::setFromIDL (  MainRowIDL  x  )  throw (ConversionException)
 

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

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

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

Set interval with the specified Interval.

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

void asdm::MainRow::setNumIntegration (  int  numIntegration  ) 
 

Set numIntegration with the specified int.

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

void asdm::MainRow::setScanNumber (  int  scanNumber  ) 
 

Set scanNumber with the specified int.

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

void asdm::MainRow::setStateId (  int  i,
Tag  stateId
) 
 

Set stateId[i] with the specified Tag.

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

void asdm::MainRow::setStateId (  vector< Tag >  stateId  ) 
 

Set stateId with the specified vector<Tag> .

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

void asdm::MainRow::setSubscanNumber (  int  subscanNumber  ) 
 

Set subscanNumber with the specified int.

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

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

Set time with the specified ArrayTime.

Parameters:
time The ArrayTime value to which time is to be set.
Exceptions:
IllegalAccessException If an attempt is made to change this field after is has been added to the table.

void asdm::MainRow::setTimeSampling (  TimeSamplingMod::TimeSampling  timeSampling  ) 
 

Set timeSampling with the specified TimeSamplingMod::TimeSampling.

Parameters:
timeSampling The TimeSamplingMod::TimeSampling value to which timeSampling is to be set.

MainRowIDL* asdm::MainRow::toIDL (   )  const
 

Return this row in the form of an IDL struct.

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

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