asdm::SubscanRow Class Reference

#include <SubscanRow.h>

List of all members.

Detailed Description

The SubscanRow class is a row of a SubscanTable.

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


Public Member Functions

SubscanTable & getTable () const
SubscanRowIDL * toIDL () const
void setFromIDL (SubscanRowIDL x) throw (ConversionException)
string toXML () const
void setFromXML (string rowDoc) throw (ConversionException)
int getSubscanNumber () const
void setSubscanNumber (int subscanNumber)
ArrayTime getStartTime () const
void setStartTime (ArrayTime startTime)
ArrayTime getEndTime () const
void setEndTime (ArrayTime endTime)
SubscanIntentMod::SubscanIntent getSubscanIntent () const
void setSubscanIntent (SubscanIntentMod::SubscanIntent subscanIntent)
bool isSubscanModeExists () const
SwitchingModeMod::SwitchingMode getSubscanMode () const throw (IllegalAccessException)
void setSubscanMode (SwitchingModeMod::SwitchingMode subscanMode)
void clearSubscanMode ()
int getNumberIntegration () const
void setNumberIntegration (int numberIntegration)
vector< int > getNumberSubintegration () const
void setNumberSubintegration (vector< int > numberSubintegration)
bool getFlagRow () const
void setFlagRow (bool flagRow)
string getFieldName () const
void setFieldName (string fieldName)
bool isCorrelatorCalibrationExists () const
CorrelatorCalibrationMod::CorrelatorCalibration getCorrelatorCalibration () const throw (IllegalAccessException)
void setCorrelatorCalibration (CorrelatorCalibrationMod::CorrelatorCalibration correlatorCalibration)
void clearCorrelatorCalibration ()
Tag getExecBlockId () const
void setExecBlockId (Tag execBlockId)
int getScanNumber () const
void setScanNumber (int scanNumber)
ExecBlockRow * getExecBlockUsingExecBlockId ()
bool compareNoAutoInc (Tag execBlockId, int scanNumber, int subscanNumber, ArrayTime startTime, ArrayTime endTime, SubscanIntentMod::SubscanIntent subscanIntent, int numberIntegration, vector< int > numberSubintegration, bool flagRow, string fieldName)
bool compareRequiredValue (ArrayTime startTime, ArrayTime endTime, SubscanIntentMod::SubscanIntent subscanIntent, int numberIntegration, vector< int > numberSubintegration, bool flagRow, string fieldName)
bool equalByRequiredValue (SubscanRow *x)

Member Function Documentation

void asdm::SubscanRow::clearCorrelatorCalibration (   ) 
 

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

void asdm::SubscanRow::clearSubscanMode (   ) 
 

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

bool asdm::SubscanRow::compareNoAutoInc (  Tag  execBlockId,
int  scanNumber,
int  subscanNumber,
ArrayTime  startTime,
ArrayTime  endTime,
SubscanIntentMod::SubscanIntent  subscanIntent,
int  numberIntegration,
vector< int >  numberSubintegration,
bool  flagRow,
string  fieldName
) 
 

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

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

CorrelatorCalibrationMod::CorrelatorCalibration asdm::SubscanRow::getCorrelatorCalibration (   )  const throw (IllegalAccessException)
 

Get correlatorCalibration, which is optional.

Returns:
correlatorCalibration as CorrelatorCalibrationMod::CorrelatorCalibration
Exceptions:
IllegalAccessException If correlatorCalibration does not exist.

ArrayTime asdm::SubscanRow::getEndTime (   )  const
 

Get endTime.

Returns:
endTime as ArrayTime

Tag asdm::SubscanRow::getExecBlockId (   )  const
 

Get execBlockId.

Returns:
execBlockId as Tag

ExecBlockRow* asdm::SubscanRow::getExecBlockUsingExecBlockId (   ) 
 

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

Returns:
a ExecBlockRow*

string asdm::SubscanRow::getFieldName (   )  const
 

Get fieldName.

Returns:
fieldName as string

bool asdm::SubscanRow::getFlagRow (   )  const
 

Get flagRow.

Returns:
flagRow as bool

int asdm::SubscanRow::getNumberIntegration (   )  const
 

Get numberIntegration.

Returns:
numberIntegration as int

vector<int > asdm::SubscanRow::getNumberSubintegration (   )  const
 

Get numberSubintegration.

Returns:
numberSubintegration as vector<int >

int asdm::SubscanRow::getScanNumber (   )  const
 

Get scanNumber.

Returns:
scanNumber as int

ArrayTime asdm::SubscanRow::getStartTime (   )  const
 

Get startTime.

Returns:
startTime as ArrayTime

SubscanIntentMod::SubscanIntent asdm::SubscanRow::getSubscanIntent (   )  const
 

Get subscanIntent.

Returns:
subscanIntent as SubscanIntentMod::SubscanIntent

SwitchingModeMod::SwitchingMode asdm::SubscanRow::getSubscanMode (   )  const throw (IllegalAccessException)
 

Get subscanMode, which is optional.

Returns:
subscanMode as SwitchingModeMod::SwitchingMode
Exceptions:
IllegalAccessException If subscanMode does not exist.

int asdm::SubscanRow::getSubscanNumber (   )  const
 

Get subscanNumber.

Returns:
subscanNumber as int

SubscanTable& asdm::SubscanRow::getTable (   )  const
 

Return the table to which this row belongs.

bool asdm::SubscanRow::isCorrelatorCalibrationExists (   )  const
 

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

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

bool asdm::SubscanRow::isSubscanModeExists (   )  const
 

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

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

void asdm::SubscanRow::setCorrelatorCalibration (  CorrelatorCalibrationMod::CorrelatorCalibration  correlatorCalibration  ) 
 

Set correlatorCalibration with the specified CorrelatorCalibrationMod::CorrelatorCalibration.

Parameters:
correlatorCalibration The CorrelatorCalibrationMod::CorrelatorCalibration value to which correlatorCalibration is to be set.

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

Set endTime with the specified ArrayTime.

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

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

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.

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

Set fieldName with the specified string.

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

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

Set flagRow with the specified bool.

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

void asdm::SubscanRow::setFromIDL (  SubscanRowIDL  x  )  throw (ConversionException)
 

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

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

void asdm::SubscanRow::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::SubscanRow::setNumberIntegration (  int  numberIntegration  ) 
 

Set numberIntegration with the specified int.

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

void asdm::SubscanRow::setNumberSubintegration (  vector< int >  numberSubintegration  ) 
 

Set numberSubintegration with the specified vector<int >.

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

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

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.

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

Set startTime with the specified ArrayTime.

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

void asdm::SubscanRow::setSubscanIntent (  SubscanIntentMod::SubscanIntent  subscanIntent  ) 
 

Set subscanIntent with the specified SubscanIntentMod::SubscanIntent.

Parameters:
subscanIntent The SubscanIntentMod::SubscanIntent value to which subscanIntent is to be set.

void asdm::SubscanRow::setSubscanMode (  SwitchingModeMod::SwitchingMode  subscanMode  ) 
 

Set subscanMode with the specified SwitchingModeMod::SwitchingMode.

Parameters:
subscanMode The SwitchingModeMod::SwitchingMode value to which subscanMode is to be set.

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

Set subscanNumber with the specified int.

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

SubscanRowIDL* asdm::SubscanRow::toIDL (   )  const
 

Return this row in the form of an IDL struct.

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

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