asdm::CalGainTable Class Reference

#include <CalGainTable.h>

Inherits asdm::Representable.

List of all members.


Detailed Description

The CalGainTable class is an Alma table.

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

Attributes of CalGain
Name Type Comment

Key

calDataId Tag  

calReductionId Tag  

Value
(Mandarory)

startValidTime ArrayTime  

endValidTime ArrayTime  

gain vector<vector<float > >

gainValid vector<bool >

fit vector<vector<float > >

fitWeight vector<float >

totalGainValid bool  

totalFit float  

totalFitWeight float  


Public Member Functions

ASDMgetContainer () const
unsigned int size ()
string getName () const
Entity getEntity () const
void setEntity (Entity e)
CalGainRownewRow ()
CalGainRownewRowEmpty ()
CalGainRownewRow (Tag calDataId, Tag calReductionId, ArrayTime startValidTime, ArrayTime endValidTime, vector< vector< float > > gain, vector< bool > gainValid, vector< vector< float > > fit, vector< float > fitWeight, bool totalGainValid, float totalFit, float totalFitWeight)
CalGainRownewRowFull (Tag calDataId, Tag calReductionId, ArrayTime startValidTime, ArrayTime endValidTime, vector< vector< float > > gain, vector< bool > gainValid, vector< vector< float > > fit, vector< float > fitWeight, bool totalGainValid, float totalFit, float totalFitWeight)
CalGainRownewRow (CalGainRow *row)
CalGainRownewRowCopy (CalGainRow *row)
CalGainRowadd (CalGainRow *x)
vector< CalGainRow * > get ()
CalGainRowgetRowByKey (Tag calDataId, Tag calReductionId)
CalGainRowlookup (Tag calDataId, Tag calReductionId, ArrayTime startValidTime, ArrayTime endValidTime, vector< vector< float > > gain, vector< bool > gainValid, vector< vector< float > > fit, vector< float > fitWeight, bool totalGainValid, float totalFit, float totalFitWeight)
CalGainTableIDL * toIDL ()
void fromIDL (CalGainTableIDL 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

CalGainRow* asdm::CalGainTable::add CalGainRow x  ) 
 

Add a row.

Parameters:
x a pointer to the CalGainRow to be added.
Returns:
a pointer to a CalGainRow. If the table contains a CalGainRow whose attributes (key and mandatory values) are equal to x ones then returns a pointer on that CalGainRow, otherwise returns x.
Exceptions:
DuplicateKey { thrown when the table contains a CalGainRow with a key equal to the x one but having and a value section different from x one }

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

To be implemented

Implements asdm::Representable.

void asdm::CalGainTable::fromIDL CalGainTableIDL  x  )  throw (DuplicateKey,ConversionException)
 

Populate this table from the content of a CalGainTableIDL 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::CalGainTable::fromVOTable string  vo  )  throw (ConversionException) [virtual]
 

To be implemented

Implements asdm::Representable.

void asdm::CalGainTable::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 CalGain (CalGainTable.xsd).

Implements asdm::Representable.

vector<CalGainRow *> asdm::CalGainTable::get  ) 
 

Get all rows.

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

ASDM& asdm::CalGainTable::getContainer  )  const
 

Return the container to which this table belongs.

Returns:
the ASDM containing this table.

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

Return this table's Entity.

Implements asdm::Representable.

vector<string> asdm::CalGainTable::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::CalGainTable::getName  )  const [virtual]
 

Return the name of this table.

Returns:
the name of this table in a string.

Implements asdm::Representable.

CalGainRow* asdm::CalGainTable::getRowByKey Tag  calDataId,
Tag  calReductionId
 

Returns a CalGainRow* 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:
calDataId. 
calReductionId. 

CalGainRow* asdm::CalGainTable::lookup Tag  calDataId,
Tag  calReductionId,
ArrayTime  startValidTime,
ArrayTime  endValidTime,
vector< vector< float > >  gain,
vector< bool >  gainValid,
vector< vector< float > >  fit,
vector< float >  fitWeight,
bool  totalGainValid,
float  totalFit,
float  totalFitWeight
 

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:
calDataId. 
calReductionId. 
startValidTime. 
endValidTime. 
gain. 
gainValid. 
fit. 
fitWeight. 
totalGainValid. 
totalFit. 
totalFitWeight. 

CalGainRow* asdm::CalGainTable::newRow CalGainRow row  ) 
 

Create a new row using a copy constructor mechanism.

The method creates a new CalGainRow 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 CalGainRow with default values for its attributes.

Parameters:
row the row which is to be copied.

CalGainRow* asdm::CalGainTable::newRow Tag  calDataId,
Tag  calReductionId,
ArrayTime  startValidTime,
ArrayTime  endValidTime,
vector< vector< float > >  gain,
vector< bool >  gainValid,
vector< vector< float > >  fit,
vector< float >  fitWeight,
bool  totalGainValid,
float  totalFit,
float  totalFitWeight
 

Create a new row initialized to the specified values.

Returns:
a pointer on the created and initialized row.
Parameters:
calDataId. 
calReductionId. 
startValidTime. 
endValidTime. 
gain. 
gainValid. 
fit. 
fitWeight. 
totalGainValid. 
totalFit. 
totalFitWeight. 

CalGainRow* asdm::CalGainTable::newRow  ) 
 

Create a new row with default values.

Returns:
a pointer on a CalGainRow

CalGainRow* asdm::CalGainTable::newRowCopy CalGainRow 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.

CalGainRow* asdm::CalGainTable::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.

CalGainRow* asdm::CalGainTable::newRowFull Tag  calDataId,
Tag  calReductionId,
ArrayTime  startValidTime,
ArrayTime  endValidTime,
vector< vector< float > >  gain,
vector< bool >  gainValid,
vector< vector< float > >  fit,
vector< float >  fitWeight,
bool  totalGainValid,
float  totalFit,
float  totalFitWeight
 

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::CalGainTable::setEntity Entity  e  )  [virtual]
 

Set this table's Entity.

Parameters:
e An entity.

Implements asdm::Representable.

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

Reads and parses a file containing a representation of a CalGainTable 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::CalGainTable::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::CalGainTable::size  )  [virtual]
 

Return the number of rows in the table.

Returns:
the number of rows in an unsigned int.

Implements asdm::Representable.

void asdm::CalGainTable::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 "CalGain.bin" or an XML representation (fileAsBin==false) will be saved in a file "CalGain.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::CalGainTable::toFITS  )  const throw (ConversionException) [virtual]
 

To be implemented

Implements asdm::Representable.

CalGainTableIDL* asdm::CalGainTable::toIDL  ) 
 

Convert this table into a CalGainTableIDL CORBA structure.

Returns:
a pointer to a CalGainTableIDL

string asdm::CalGainTable::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::CalGainTable::toVOTable  )  const throw (ConversionException) [virtual]
 

To be implemented

Implements asdm::Representable.

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

Translate this table to an XML representation conform to the schema defined for CalGain (CalGainTable.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:43 2008 for ASDM C++ Implementation by doxygen 1.3.8