asdm::MainTable Class Reference

#include <MainTable.h>

Inherits asdm::Representable.

List of all members.


Detailed Description

The MainTable class is an Alma table.

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

Attributes of Main
Name Type Comment

Key

configDescriptionId Tag  

fieldId Tag  

time ArrayTime  

Value
(Mandarory)

execBlockId Tag  

stateId vector<Tag> ConfigDescription.numAntenna

scanNumber int  

subscanNumber int  

timeSampling TimeSamplingMod::TimeSampling  

numIntegration int  

dataOid EntityRef  

flagRow bool  

interval Interval  


Public Member Functions

ASDMgetContainer () const
unsigned int size ()
string getName () const
Entity getEntity () const
void setEntity (Entity e)
MainRownewRow ()
MainRownewRowEmpty ()
MainRownewRow (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)
MainRownewRowFull (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)
MainRownewRow (MainRow *row)
MainRownewRowCopy (MainRow *row)
MainRowadd (MainRow *x)
vector< MainRow * > get ()
vector< MainRow * > * getByContext (Tag configDescriptionId, Tag fieldId)
MainRowgetRowByKey (Tag configDescriptionId, Tag fieldId, ArrayTime time)
MainRowlookup (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)
MainTableIDL * toIDL ()
void fromIDL (MainTableIDL x) throw (DuplicateKey,ConversionException)
char * toFITS () const throw (ConversionException)
void fromFITS (char *fits) throw (ConversionException)
string toVOTable () const throw (ConversionException)
void fromVOTable (string vo) throw (ConversionException)
string toXML () throw (ConversionException)
void fromXML (string xmlDoc) throw (ConversionException)
string toMIME ()
void setFromMIME (const string &mimeMsg)
void toFile (string directory)
void setFromFile (const string &directory)

Static Public Member Functions

vector< string > getKeyName ()


Member Function Documentation

MainRow* asdm::MainTable::add MainRow x  ) 
 

Add a row.

Parameters:
x a pointer to the MainRow to be added.
Returns:
a pointer to a MainRow. If the table contains a MainRow whose attributes (key and mandatory values) are equal to x ones then returns a pointer on that MainRow, otherwise returns x.
Exceptions:
DuplicateKey { thrown when the table contains a MainRow with a key equal to the x one but having and a value section different from x one }
Note:
The row is inserted in the table in such a way that all the rows having the same value of ( configDescriptionId, fieldId ) are stored by ascending time.
See also:
method getByContext.

void asdm::MainTable::fromFITS char *  fits  )  throw (ConversionException) [virtual]
 

To be implemented

Implements asdm::Representable.

void asdm::MainTable::fromIDL MainTableIDL  x  )  throw (DuplicateKey,ConversionException)
 

Populate this table from the content of a MainTableIDL Corba structure.

Exceptions:
DuplicateKey Thrown if the method tries to add a row having a key that is already in the table.
ConversionException 

void asdm::MainTable::fromVOTable string  vo  )  throw (ConversionException) [virtual]
 

To be implemented

Implements asdm::Representable.

void asdm::MainTable::fromXML string  xmlDoc  )  throw (ConversionException) [virtual]
 

Populate this table from the content of a XML document that is required to be conform to the XML schema defined for a Main (MainTable.xsd).

Implements asdm::Representable.

vector<MainRow *> asdm::MainTable::get  ) 
 

Get all rows.

Returns:
Alls rows as a vector of pointers of MainRow. The elements of this vector are stored in the order in which they have been added to the MainTable.

vector<MainRow*>* asdm::MainTable::getByContext Tag  configDescriptionId,
Tag  fieldId
 

Returns all the rows sorted by ascending startTime for a given context. The context is defined by a value of ( configDescriptionId, fieldId ).

Returns:
a pointer on a vector<MainRow *>. A null returned value means that the table contains no MainRow for the given ( configDescriptionId, fieldId ).

ASDM& asdm::MainTable::getContainer  )  const
 

Return the container to which this table belongs.

Returns:
the ASDM containing this table.

Entity asdm::MainTable::getEntity  )  const [virtual]
 

Return this table's Entity.

Implements asdm::Representable.

vector<string> asdm::MainTable::getKeyName  )  [static]
 

Return the list of field names that make up key key as an array of strings.

Returns:
a vector of string.

string asdm::MainTable::getName  )  const [virtual]
 

Return the name of this table.

Returns:
the name of this table in a string.

Implements asdm::Representable.

MainRow* asdm::MainTable::getRowByKey Tag  configDescriptionId,
Tag  fieldId,
ArrayTime  time
 

Returns a MainRow* given a key.

Returns:
a pointer to the row having the key whose values are passed as parameters, or 0 if no row exists for that key.
Parameters:
configDescriptionId. 
fieldId. 
time. 

MainRow* asdm::MainTable::lookup 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
 

Look up the table for a row whose all attributes are equal to the corresponding parameters of the method.

Returns:
a pointer on this row if any, null otherwise.
Parameters:
configDescriptionId. 
fieldId. 
time. 
execBlockId. 
stateId. 
scanNumber. 
subscanNumber. 
timeSampling. 
numIntegration. 
dataOid. 
flagRow. 
interval. 

MainRow* asdm::MainTable::newRow MainRow row  ) 
 

Create a new row using a copy constructor mechanism.

The method creates a new MainRow owned by this. Each attribute of the created row is a (deep) copy of the corresponding attribute of row. The method does not add the created row to this, its simply parents it to this, a call to the add method has to be done in order to get the row added (very likely after having modified some of its attributes). If row is null then the method returns a new MainRow with default values for its attributes.

Parameters:
row the row which is to be copied.

MainRow* asdm::MainTable::newRow 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
 

Create a new row initialized to the specified values.

Returns:
a pointer on the created and initialized row.
Parameters:
configDescriptionId. 
fieldId. 
time. 
execBlockId. 
stateId. 
scanNumber. 
subscanNumber. 
timeSampling. 
numIntegration. 
dataOid. 
flagRow. 
interval. 

MainRow* asdm::MainTable::newRow  ) 
 

Create a new row with default values.

Returns:
a pointer on a MainRow

MainRow* asdm::MainTable::newRowCopy MainRow row  ) 
 

Has the same definition than the newRow method with the same signature. Provided to facilitate the call from Python, otherwise the newRow method will be preferred.

MainRow* asdm::MainTable::newRowEmpty  ) 
 

Has the same definition than the newRow method with the same signature. Provided to facilitate the call from Python, otherwise the newRow method will be preferred.

MainRow* asdm::MainTable::newRowFull 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
 

Has the same definition than the newRow method with the same signature. Provided to facilitate the call from Python, otherwise the newRow method will be preferred.

void asdm::MainTable::setEntity Entity  e  )  [virtual]
 

Set this table's Entity.

Parameters:
e An entity.

Implements asdm::Representable.

void asdm::MainTable::setFromFile const string &  directory  ) 
 

Reads and parses a file containing a representation of a MainTable as those produced by the toFile method. This table is populated with the result of the parsing.

Parameters:
directory The name of the directory containing the file te be read and parsed.
Exceptions:
ConversionException If any error occurs while reading the files in the directory or parsing them.

void asdm::MainTable::setFromMIME const string &  mimeMsg  ) 
 

Extracts the binary part of a MIME message and deserialize its content to fill this with the result of the deserialization.

Parameters:
mimeMsg the string containing the MIME message.
Exceptions:
ConversionException 

unsigned int asdm::MainTable::size  )  [virtual]
 

Return the number of rows in the table.

Returns:
the number of rows in an unsigned int.

Implements asdm::Representable.

void asdm::MainTable::toFile string  directory  ) 
 

Stores a representation (binary or XML) of this table into a file.

Depending on the boolean value of its private field fileAsBin a binary serialization of this (fileAsBin==true) will be saved in a file "Main.bin" or an XML representation (fileAsBin==false) will be saved in a file "Main.xml". The file is always written in a directory whose name is passed as a parameter.

Parameters:
directory The name of directory where the file containing the table's representation will be saved.

char* asdm::MainTable::toFITS  )  const throw (ConversionException) [virtual]
 

To be implemented

Implements asdm::Representable.

MainTableIDL* asdm::MainTable::toIDL  ) 
 

Convert this table into a MainTableIDL CORBA structure.

Returns:
a pointer to a MainTableIDL

string asdm::MainTable::toMIME  ) 
 

Serialize this into a stream of bytes and encapsulates that stream into a MIME message.

Returns:
a string containing the MIME message.

string asdm::MainTable::toVOTable  )  const throw (ConversionException) [virtual]
 

To be implemented

Implements asdm::Representable.

string asdm::MainTable::toXML  )  throw (ConversionException) [virtual]
 

Translate this table to an XML representation conform to the schema defined for Main (MainTable.xsd).

Returns:
a string containing the XML representation.

Implements asdm::Representable.


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