asdm::TotalPowerTable Class Reference

#include <TotalPowerTable.h>

Inherits asdm::Representable.

List of all members.

---

Detailed Description

The TotalPowerTable class is an Alma table.

Attributes of TotalPower

Name	Type	Comment
Key
configDescriptionId	Tag
fieldId	Tag
time	ArrayTime
Value (Mandarory)
execBlockId	Tag
stateId	vector<Tag>	ConfigDescription.numAntenna
scanNumber	int
subscanNumber	int
integrationNumber	int
uvw	vector<vector<Length > >	ConfigDescription.numAntenna, 3
exposure	vector<vector<Interval > >	ConfigDescription.numAntenna, AlmaCorrelatorMode.numBaseband
timeCentroid	vector<vector<ArrayTime > >	ConfigDescription.numAntenna, AlmaCorrelatorMode.numBaseband
floatData	vector<vector<vector<float > > >	, ,
flagAnt	vector<int >	ConfigDescription.numAntenna
flagPol	vector<vector<int > >	,
flagRow	bool
interval	Interval
Value (Optional)
subintegrationNumber	int

Public Member Functions
ASDM &	getContainer () const
unsigned int	size ()
string	getName () const
Entity	getEntity () const
void	setEntity (Entity e)
TotalPowerRow *	newRow ()
TotalPowerRow *	newRowEmpty ()
TotalPowerRow *	newRow (Tag configDescriptionId, Tag fieldId, ArrayTime time, Tag execBlockId, vector< Tag > stateId, int scanNumber, int subscanNumber, int integrationNumber, vector< vector< Length > > uvw, vector< vector< Interval > > exposure, vector< vector< ArrayTime > > timeCentroid, vector< vector< vector< float > > > floatData, vector< int > flagAnt, vector< vector< int > > flagPol, bool flagRow, Interval interval)
TotalPowerRow *	newRowFull (Tag configDescriptionId, Tag fieldId, ArrayTime time, Tag execBlockId, vector< Tag > stateId, int scanNumber, int subscanNumber, int integrationNumber, vector< vector< Length > > uvw, vector< vector< Interval > > exposure, vector< vector< ArrayTime > > timeCentroid, vector< vector< vector< float > > > floatData, vector< int > flagAnt, vector< vector< int > > flagPol, bool flagRow, Interval interval)
TotalPowerRow *	newRow (TotalPowerRow *row)
TotalPowerRow *	newRowCopy (TotalPowerRow *row)
TotalPowerRow *	add (TotalPowerRow *x)
vector< TotalPowerRow * >	get ()
vector< TotalPowerRow * > *	getByContext (Tag configDescriptionId, Tag fieldId)
TotalPowerRow *	getRowByKey (Tag configDescriptionId, Tag fieldId, ArrayTime time)
TotalPowerRow *	lookup (Tag configDescriptionId, Tag fieldId, ArrayTime time, Tag execBlockId, vector< Tag > stateId, int scanNumber, int subscanNumber, int integrationNumber, vector< vector< Length > > uvw, vector< vector< Interval > > exposure, vector< vector< ArrayTime > > timeCentroid, vector< vector< vector< float > > > floatData, vector< int > flagAnt, vector< vector< int > > flagPol, bool flagRow, Interval interval)
TotalPowerTableIDL *	toIDL ()
void	fromIDL (TotalPowerTableIDL 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

TotalPowerRow* asdm::TotalPowerTable::add (  TotalPowerRow *  x  )

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

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

To be implemented Implements asdm::Representable.

void asdm::TotalPowerTable::fromIDL (  TotalPowerTableIDL  x  )  throw (DuplicateKey,ConversionException)

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

To be implemented Implements asdm::Representable.

void asdm::TotalPowerTable::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 TotalPower (TotalPowerTable.xsd). Implements asdm::Representable.

vector<TotalPowerRow *> asdm::TotalPowerTable::get (   )

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

vector<TotalPowerRow*>* asdm::TotalPowerTable::getByContext (  Tag  configDescriptionId, Tag  fieldId )

Returns all the rows sorted by ascending time for a given context. The context is defined by a value of ( configDescriptionId, fieldId ). Returns: a pointer on a vector<TotalPowerRow *>. A null returned value means that the table contains no TotalPowerRow for the given ( configDescriptionId, fieldId ).

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

Return the container to which this table belongs. Returns: the ASDM containing this table.

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

Return this table's Entity. Implements asdm::Representable.

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

Return the name of this table. Returns: the name of this table in a string. Implements asdm::Representable.

TotalPowerRow* asdm::TotalPowerTable::getRowByKey (  Tag  configDescriptionId, Tag  fieldId, ArrayTime  time )

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

TotalPowerRow* asdm::TotalPowerTable::lookup (  Tag  configDescriptionId, Tag  fieldId, ArrayTime  time, Tag  execBlockId, vector< Tag >  stateId, int  scanNumber, int  subscanNumber, int  integrationNumber, vector< vector< Length > >  uvw, vector< vector< Interval > >  exposure, vector< vector< ArrayTime > >  timeCentroid, vector< vector< vector< float > > >  floatData, vector< int >  flagAnt, vector< vector< int > >  flagPol, 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.  integrationNumber.  uvw.  exposure.  timeCentroid.  floatData.  flagAnt.  flagPol.  flagRow.  interval.

TotalPowerRow* asdm::TotalPowerTable::newRow (  TotalPowerRow *  row  )

Create a new row using a copy constructor mechanism. The method creates a new TotalPowerRow 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 TotalPowerRow with default values for its attributes. Parameters: row  the row which is to be copied.

TotalPowerRow* asdm::TotalPowerTable::newRow (  Tag  configDescriptionId, Tag  fieldId, ArrayTime  time, Tag  execBlockId, vector< Tag >  stateId, int  scanNumber, int  subscanNumber, int  integrationNumber, vector< vector< Length > >  uvw, vector< vector< Interval > >  exposure, vector< vector< ArrayTime > >  timeCentroid, vector< vector< vector< float > > >  floatData, vector< int >  flagAnt, vector< vector< int > >  flagPol, 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.  integrationNumber.  uvw.  exposure.  timeCentroid.  floatData.  flagAnt.  flagPol.  flagRow.  interval.

TotalPowerRow* asdm::TotalPowerTable::newRow (   )

Create a new row with default values. Returns: a pointer on a TotalPowerRow

TotalPowerRow* asdm::TotalPowerTable::newRowCopy (  TotalPowerRow *  row  )

Same as the newRow method with the same signature. Defined to facilitate the call from Python.

TotalPowerRow* asdm::TotalPowerTable::newRowEmpty (   )

Same as the newRow method with the same signature. Defined to facilitate the call from Python.

TotalPowerRow* asdm::TotalPowerTable::newRowFull (  Tag  configDescriptionId, Tag  fieldId, ArrayTime  time, Tag  execBlockId, vector< Tag >  stateId, int  scanNumber, int  subscanNumber, int  integrationNumber, vector< vector< Length > >  uvw, vector< vector< Interval > >  exposure, vector< vector< ArrayTime > >  timeCentroid, vector< vector< vector< float > > >  floatData, vector< int >  flagAnt, vector< vector< int > >  flagPol, bool  flagRow, Interval  interval )

Same as the newRow method with the same signature. Defined to facilitate the call from Python.

void asdm::TotalPowerTable::setEntity (  Entity  e  )  [virtual]

Set this table's Entity. Parameters: e  An entity. Implements asdm::Representable.

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

Reads and parses a collection of files 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 files. Exceptions: ConversionException  If any error occurs while reading the files in the directory or parsing them.

void asdm::TotalPowerTable::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::TotalPowerTable::size (   )  [virtual]

Return the number of rows in the table. Returns: the number of rows in an unsigned int. Implements asdm::Representable.

void asdm::TotalPowerTable::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 "TotalPower.bin" or an XML representation (fileAsBin==false) will be saved in a file "TotalPower.xml". The file is always written in a directory whose name is passed as a parameter.

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

To be implemented Implements asdm::Representable.

TotalPowerTableIDL* asdm::TotalPowerTable::toIDL (   )

Convert this table into a TotalPowerTableIDL CORBA structure. Returns: a pointer to a TotalPowerTableIDL

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

To be implemented Implements asdm::Representable.

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

Translate this table to an XML representation conform to the schema defined for TotalPower (TotalPowerTable.xsd). Returns: a string containing the XML representation. Implements asdm::Representable.

---

The documentation for this class was generated from the following file:

• TotalPowerTable.h

---