asdm::ScanRow Class Reference

#include <ScanRow.h>

List of all members.


Detailed Description

The ScanRow class is a row of a ScanTable.

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


Public Member Functions

ScanTablegetTable () const
ScanRowIDL * toIDL () const
void setFromIDL (ScanRowIDL x) throw (ConversionException)
string toXML () const
void setFromXML (string rowDoc) throw (ConversionException)
int getScanNumber () const
void setScanNumber (int scanNumber) throw (IllegalAccessException)
ArrayTime getStartTime () const
void setStartTime (ArrayTime startTime)
ArrayTime getEndTime () const
void setEndTime (ArrayTime endTime)
int getNumSubScan () const
void setNumSubScan (int numSubScan)
int getNumIntent () const
void setNumIntent (int numIntent)
bool isNumFieldExists () const
int getNumField () const throw (IllegalAccessException)
void setNumField (int numField)
void clearNumField ()
vector< ScanIntent > getScanIntent () const
void setScanIntent (vector< ScanIntent > scanIntent)
bool isSourceNameExists () const
string getSourceName () const throw (IllegalAccessException)
void setSourceName (string sourceName)
void clearSourceName ()
bool isFieldNameExists () const
vector< string > getFieldName () const throw (IllegalAccessException)
void setFieldName (vector< string > fieldName)
void clearFieldName ()
bool getFlagRow () const
void setFlagRow (bool flagRow)
Tag getExecBlockId () const
void setExecBlockId (Tag execBlockId) throw (IllegalAccessException)
ExecBlockRowgetExecBlockUsingExecBlockId ()
bool compareNoAutoInc (Tag execBlockId, int scanNumber, ArrayTime startTime, ArrayTime endTime, int numSubScan, int numIntent, vector< ScanIntent > scanIntent, bool flagRow)
bool compareRequiredValue (ArrayTime startTime, ArrayTime endTime, int numSubScan, int numIntent, vector< ScanIntent > scanIntent, bool flagRow)
bool equalByRequiredValue (ScanRow *x)

Friends

class asdm::ScanTable


Member Function Documentation

ScanTable& asdm::ScanRow::getTable (  )  const

Return the table to which this row belongs.

ScanRowIDL* asdm::ScanRow::toIDL (  )  const

Return this row in the form of an IDL struct.

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

void asdm::ScanRow::setFromIDL ( ScanRowIDL  x  )  throw (ConversionException)

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

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

string asdm::ScanRow::toXML (  )  const

Return this row in the form of an XML string.

Returns:
The values of this row as an XML string.

void asdm::ScanRow::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.

int asdm::ScanRow::getScanNumber (  )  const

Get scanNumber.

Returns:
scanNumber as int

void asdm::ScanRow::setScanNumber ( int  scanNumber  )  throw (IllegalAccessException)

Set scanNumber with the specified int.

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

ArrayTime asdm::ScanRow::getStartTime (  )  const

Get startTime.

Returns:
startTime as ArrayTime

void asdm::ScanRow::setStartTime ( ArrayTime  startTime  ) 

Set startTime with the specified ArrayTime.

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

ArrayTime asdm::ScanRow::getEndTime (  )  const

Get endTime.

Returns:
endTime as ArrayTime

void asdm::ScanRow::setEndTime ( ArrayTime  endTime  ) 

Set endTime with the specified ArrayTime.

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

int asdm::ScanRow::getNumSubScan (  )  const

Get numSubScan.

Returns:
numSubScan as int

void asdm::ScanRow::setNumSubScan ( int  numSubScan  ) 

Set numSubScan with the specified int.

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

int asdm::ScanRow::getNumIntent (  )  const

Get numIntent.

Returns:
numIntent as int

void asdm::ScanRow::setNumIntent ( int  numIntent  ) 

Set numIntent with the specified int.

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

bool asdm::ScanRow::isNumFieldExists (  )  const

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

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

int asdm::ScanRow::getNumField (  )  const throw (IllegalAccessException)

Get numField, which is optional.

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

void asdm::ScanRow::setNumField ( int  numField  ) 

Set numField with the specified int.

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

void asdm::ScanRow::clearNumField (  ) 

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

vector<ScanIntent > asdm::ScanRow::getScanIntent (  )  const

Get scanIntent.

Returns:
scanIntent as vector<ScanIntent >

void asdm::ScanRow::setScanIntent ( vector< ScanIntent >  scanIntent  ) 

Set scanIntent with the specified vector<ScanIntent >.

Parameters:
scanIntent The vector<ScanIntent > value to which scanIntent is to be set.

bool asdm::ScanRow::isSourceNameExists (  )  const

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

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

string asdm::ScanRow::getSourceName (  )  const throw (IllegalAccessException)

Get sourceName, which is optional.

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

void asdm::ScanRow::setSourceName ( string  sourceName  ) 

Set sourceName with the specified string.

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

void asdm::ScanRow::clearSourceName (  ) 

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

bool asdm::ScanRow::isFieldNameExists (  )  const

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

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

vector<string > asdm::ScanRow::getFieldName (  )  const throw (IllegalAccessException)

Get fieldName, which is optional.

Returns:
fieldName as vector<string >
Exceptions:
IllegalAccessException If fieldName does not exist.

void asdm::ScanRow::setFieldName ( vector< string >  fieldName  ) 

Set fieldName with the specified vector<string >.

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

void asdm::ScanRow::clearFieldName (  ) 

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

bool asdm::ScanRow::getFlagRow (  )  const

Get flagRow.

Returns:
flagRow as bool

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

Set flagRow with the specified bool.

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

Tag asdm::ScanRow::getExecBlockId (  )  const

Get execBlockId.

Returns:
execBlockId as Tag

void asdm::ScanRow::setExecBlockId ( Tag  execBlockId  )  throw (IllegalAccessException)

Set execBlockId with the specified Tag.

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

ExecBlockRow* asdm::ScanRow::getExecBlockUsingExecBlockId (  ) 

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

Returns:
a ExecBlockRow*

bool asdm::ScanRow::compareNoAutoInc ( Tag  execBlockId,
int  scanNumber,
ArrayTime  startTime,
ArrayTime  endTime,
int  numSubScan,
int  numIntent,
vector< ScanIntent >  scanIntent,
bool  flagRow 
)

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

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


The documentation for this class was generated from the following file:
Generated on Thu Nov 29 16:46:51 2007 for ASDM C++ Implementation by  doxygen 1.5.1