asdm::AnnotationTable Class Reference

#include <AnnotationTable.h>

Inherits asdm::Representable.

List of all members.


Detailed Description

The AnnotationTable class is an Alma table.

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

Attributes of Annotation
Name Type Comment

Key

annotationId Tag  

Value
(Mandarory)

time ArrayTime  

issue string  

details string  

Value
(Optional)

antennaId vector<Tag>

interval Interval  

numAntenna int  

numBaseband int  

basebandName vector<BasebandNameMod::BasebandName > numBaseband

dValue double  

vdValue vector<double >

vvdValues vector<vector<double > > ,

llValue long long  

vllValue vector<long long >

vvllValue vector<vector<long long > > ,


Public Member Functions

ASDMgetContainer () const
unsigned int size ()
string getName () const
Entity getEntity () const
void setEntity (Entity e)
AnnotationRownewRow ()
AnnotationRownewRowEmpty ()
AnnotationRownewRow (ArrayTime time, string issue, string details)
AnnotationRownewRowFull (ArrayTime time, string issue, string details)
AnnotationRownewRow (AnnotationRow *row)
AnnotationRownewRowCopy (AnnotationRow *row)
AnnotationRowadd (AnnotationRow *x)
vector< AnnotationRow * > get ()
AnnotationRowgetRowByKey (Tag annotationId)
AnnotationRowlookup (ArrayTime time, string issue, string details)
AnnotationTableIDL * toIDL ()
void fromIDL (AnnotationTableIDL 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

AnnotationRow* asdm::AnnotationTable::add AnnotationRow x  ) 
 

Add a row. If there table contains a row whose key's fields are equal to x's ones then return a pointer on this row (i.e. no actual insertion is performed) otherwise add x to the table and return x.

Parameters:
x. A pointer on the row to be added.
Returns:
a AnnotationRow pointer.

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

To be implemented

Implements asdm::Representable.

void asdm::AnnotationTable::fromIDL AnnotationTableIDL  x  )  throw (DuplicateKey,ConversionException)
 

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

To be implemented

Implements asdm::Representable.

void asdm::AnnotationTable::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 Annotation (AnnotationTable.xsd).

Implements asdm::Representable.

vector<AnnotationRow *> asdm::AnnotationTable::get  ) 
 

Get all rows.

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

ASDM& asdm::AnnotationTable::getContainer  )  const
 

Return the container to which this table belongs.

Returns:
the ASDM containing this table.

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

Return this table's Entity.

Implements asdm::Representable.

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

Return the name of this table.

Returns:
the name of this table in a string.

Implements asdm::Representable.

AnnotationRow* asdm::AnnotationTable::getRowByKey Tag  annotationId  ) 
 

Returns a AnnotationRow* 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:
annotationId. 

AnnotationRow* asdm::AnnotationTable::lookup ArrayTime  time,
string  issue,
string  details
 

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

Returns:
a pointer on this row if any, null otherwise.
Parameters:
time. 
issue. 
details. 

AnnotationRow* asdm::AnnotationTable::newRow AnnotationRow row  ) 
 

Create a new row using a copy constructor mechanism.

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

Parameters:
row the row which is to be copied.

AnnotationRow* asdm::AnnotationTable::newRow ArrayTime  time,
string  issue,
string  details
 

Create a new row initialized to the specified values.

Returns:
a pointer on the created and initialized row.
Parameters:
time. 
issue. 
details. 

AnnotationRow* asdm::AnnotationTable::newRow  ) 
 

Create a new row with default values.

Returns:
a pointer on a AnnotationRow

AnnotationRow* asdm::AnnotationTable::newRowCopy AnnotationRow 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.

AnnotationRow* asdm::AnnotationTable::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.

AnnotationRow* asdm::AnnotationTable::newRowFull ArrayTime  time,
string  issue,
string  details
 

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

Set this table's Entity.

Parameters:
e An entity.

Implements asdm::Representable.

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

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

Return the number of rows in the table.

Returns:
the number of rows in an unsigned int.

Implements asdm::Representable.

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

To be implemented

Implements asdm::Representable.

AnnotationTableIDL* asdm::AnnotationTable::toIDL  ) 
 

Convert this table into a AnnotationTableIDL CORBA structure.

Returns:
a pointer to a AnnotationTableIDL

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

To be implemented

Implements asdm::Representable.

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

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