asdm::CalFocusTable Class Reference

#include <CalFocusTable.h>

Inherits asdm::Representable.

List of all members.

Detailed Description

The CalFocusTable class is an Alma table.

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

Attributes of CalFocus
Name Type Comment

Key

calDataId Tag  

calReductionId Tag  

antennaName string  

Value
(Mandarory)

frequencyRange vector<Frequency > 2

startValidTime ArrayTime  

endValidTime ArrayTime  

receiverBand ReceiverBandMod::ReceiverBand  

offset vector<Length > 3

error vector<Length > 3

focusMethod FocusMethodMod::FocusMethod  

pointingDirection vector<Angle > 2

wasFixed vector<bool > 3

ambientTemperature Temperature  


Public Member Functions

ASDM & getContainer () const
unsigned int size ()
string getName () const
Entity getEntity () const
void setEntity (Entity e)
CalFocusRow * newRow ()
CalFocusRow * newRowEmpty ()
CalFocusRow * newRow (Tag calDataId, Tag calReductionId, string antennaName, vector< Frequency > frequencyRange, ArrayTime startValidTime, ArrayTime endValidTime, ReceiverBandMod::ReceiverBand receiverBand, vector< Length > offset, vector< Length > error, FocusMethodMod::FocusMethod focusMethod, vector< Angle > pointingDirection, vector< bool > wasFixed, Temperature ambientTemperature)
CalFocusRow * newRowFull (Tag calDataId, Tag calReductionId, string antennaName, vector< Frequency > frequencyRange, ArrayTime startValidTime, ArrayTime endValidTime, ReceiverBandMod::ReceiverBand receiverBand, vector< Length > offset, vector< Length > error, FocusMethodMod::FocusMethod focusMethod, vector< Angle > pointingDirection, vector< bool > wasFixed, Temperature ambientTemperature)
CalFocusRow * newRow (CalFocusRow *row)
CalFocusRow * newRowCopy (CalFocusRow *row)
CalFocusRow * add (CalFocusRow *x)
vector< CalFocusRow * > get ()
CalFocusRow * getRowByKey (Tag calDataId, Tag calReductionId, string antennaName)
CalFocusRow * lookup (Tag calDataId, Tag calReductionId, string antennaName, vector< Frequency > frequencyRange, ArrayTime startValidTime, ArrayTime endValidTime, ReceiverBandMod::ReceiverBand receiverBand, vector< Length > offset, vector< Length > error, FocusMethodMod::FocusMethod focusMethod, vector< Angle > pointingDirection, vector< bool > wasFixed, Temperature ambientTemperature)
CalFocusTableIDL * toIDL ()
void fromIDL (CalFocusTableIDL 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

CalFocusRow* asdm::CalFocusTable::add (  CalFocusRow *  x  ) 
 

Add a row.

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

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

To be implemented

Implements asdm::Representable.

void asdm::CalFocusTable::fromIDL (  CalFocusTableIDL  x  )  throw (DuplicateKey,ConversionException)
 

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

To be implemented

Implements asdm::Representable.

void asdm::CalFocusTable::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 CalFocus (CalFocusTable.xsd).

Implements asdm::Representable.

vector<CalFocusRow *> asdm::CalFocusTable::get (   ) 
 

Get all rows.

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

ASDM& asdm::CalFocusTable::getContainer (   )  const
 

Return the container to which this table belongs.

Returns:
the ASDM containing this table.

Entity asdm::CalFocusTable::getEntity (   )  const [virtual]
 

Return this table's Entity.

Implements asdm::Representable.

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

Return the name of this table.

Returns:
the name of this table in a string.

Implements asdm::Representable.

CalFocusRow* asdm::CalFocusTable::getRowByKey (  Tag  calDataId,
Tag  calReductionId,
string  antennaName
) 
 

Returns a CalFocusRow* 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. 
antennaName. 

CalFocusRow* asdm::CalFocusTable::lookup (  Tag  calDataId,
Tag  calReductionId,
string  antennaName,
vector< Frequency >  frequencyRange,
ArrayTime  startValidTime,
ArrayTime  endValidTime,
ReceiverBandMod::ReceiverBand  receiverBand,
vector< Length >  offset,
vector< Length >  error,
FocusMethodMod::FocusMethod  focusMethod,
vector< Angle >  pointingDirection,
vector< bool >  wasFixed,
Temperature  ambientTemperature
) 
 

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. 
antennaName. 
frequencyRange. 
startValidTime. 
endValidTime. 
receiverBand. 
offset. 
error. 
focusMethod. 
pointingDirection. 
wasFixed. 
ambientTemperature. 

CalFocusRow* asdm::CalFocusTable::newRow (  CalFocusRow *  row  ) 
 

Create a new row using a copy constructor mechanism.

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

Parameters:
row the row which is to be copied.

CalFocusRow* asdm::CalFocusTable::newRow (  Tag  calDataId,
Tag  calReductionId,
string  antennaName,
vector< Frequency >  frequencyRange,
ArrayTime  startValidTime,
ArrayTime  endValidTime,
ReceiverBandMod::ReceiverBand  receiverBand,
vector< Length >  offset,
vector< Length >  error,
FocusMethodMod::FocusMethod  focusMethod,
vector< Angle >  pointingDirection,
vector< bool >  wasFixed,
Temperature  ambientTemperature
) 
 

Create a new row initialized to the specified values.

Returns:
a pointer on the created and initialized row.
Parameters:
calDataId. 
calReductionId. 
antennaName. 
frequencyRange. 
startValidTime. 
endValidTime. 
receiverBand. 
offset. 
error. 
focusMethod. 
pointingDirection. 
wasFixed. 
ambientTemperature. 

CalFocusRow* asdm::CalFocusTable::newRow (   ) 
 

Create a new row with default values.

Returns:
a pointer on a CalFocusRow

CalFocusRow* asdm::CalFocusTable::newRowCopy (  CalFocusRow *  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.

CalFocusRow* asdm::CalFocusTable::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.

CalFocusRow* asdm::CalFocusTable::newRowFull (  Tag  calDataId,
Tag  calReductionId,
string  antennaName,
vector< Frequency >  frequencyRange,
ArrayTime  startValidTime,
ArrayTime  endValidTime,
ReceiverBandMod::ReceiverBand  receiverBand,
vector< Length >  offset,
vector< Length >  error,
FocusMethodMod::FocusMethod  focusMethod,
vector< Angle >  pointingDirection,
vector< bool >  wasFixed,
Temperature  ambientTemperature
) 
 

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

Set this table's Entity.

Parameters:
e An entity.

Implements asdm::Representable.

void asdm::CalFocusTable::setFromFile (  const string &  directory  ) 
 

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

Return the number of rows in the table.

Returns:
the number of rows in an unsigned int.

Implements asdm::Representable.

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

To be implemented

Implements asdm::Representable.

CalFocusTableIDL* asdm::CalFocusTable::toIDL (   ) 
 

Convert this table into a CalFocusTableIDL CORBA structure.

Returns:
a pointer to a CalFocusTableIDL

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

To be implemented

Implements asdm::Representable.

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

Translate this table to an XML representation conform to the schema defined for CalFocus (CalFocusTable.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