alma.asdm.TotalPowerTable Class Reference

Inherits alma.asdm.ASDMTable, and alma.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	Tag[]	ConfigDescription.numAntenna
scanNumber	int
subscanNumber	int
integrationNumber	int
uvw	Length[][]	ConfigDescription.numAntenna, 3
exposure	Interval[][]	ConfigDescription.numAntenna, AlmaCorrelatorMode.numBaseband
timeCentroid	ArrayTime[][]	ConfigDescription.numAntenna, AlmaCorrelatorMode.numBaseband
floatData	float[][][]	, ,
flagAnt	int[]	ConfigDescription.numAntenna
flagPol	int[][]	,
flagRow	boolean
interval	Interval
Value (Optional)
subintegrationNumber	int

Public Member Functions
String[]	getAttributesNames ()
	Returns the names of the attributes of the rows stored in that table.
ASDM	getContainer ()
	Return the container to which this table belongs.
int	size ()
	Return the number of rows in the table.
String	getName ()
	Return the name of this table.
String	toString ()
	Returns "TotalPowerTable" followed by the current size of the table between parenthesis.
TotalPowerRow	newRow ()
	Create a new row with default values .
TotalPowerRow	add (TotalPowerRow x) throws DuplicateKey
	Add a row.
void	add (TotalPowerRow[] x) throws DuplicateKey
	Add an array of rows.
TotalPowerRow	newRow (Tag configDescriptionId, Tag fieldId, ArrayTime time, Tag execBlockId, Tag[] stateId, int scanNumber, int subscanNumber, int integrationNumber, Length[][] uvw, Interval[][] exposure, ArrayTime[][] timeCentroid, float[][][] floatData, int[] flagAnt, int[][] flagPol, boolean flagRow, Interval interval)
	Create a new row initialized to the specified values.
TotalPowerRow	newRow (TotalPowerRow row)
	Create a new row using a copy constructor mechanism.
TotalPowerRow[]	get ()
	Get all rows.
TotalPowerRow	getRowByKey (Tag configDescriptionId, Tag fieldId, ArrayTime time)
	Returns a TotalPowerRow given a key.
TotalPowerRow[]	getByContext (Tag configDescriptionId, Tag fieldId)
	Returns all the rows sorted by ascending time for a given context.
TotalPowerRow	lookup (Tag configDescriptionId, Tag fieldId, ArrayTime time, Tag execBlockId, Tag[] stateId, int scanNumber, int subscanNumber, int integrationNumber, Length[][] uvw, Interval[][] exposure, ArrayTime[][] timeCentroid, float[][][] floatData, int[] flagAnt, int[][] flagPol, boolean flagRow, Interval interval)
	Look up the table for a row whose all attributes are equal to the corresponding parameters of the method.
ASDMRow[]	getRows ()
	Returns the rows of an ASDMTable as an array of ASDMRow.
TotalPowerTableIDL	toIDL ()
	Convert this table into a TotalPowerTableIDL CORBA structure.
void	fromIDL (TotalPowerTableIDL x) throws DuplicateKey,ConversionException
	Populate this table from the content of a TotalPowerTableIDL Corba structure.
byte[]	toFITS () throws ConversionException
	To be implemented.
void	fromFITS (byte[] fits) throws ConversionException
	To be implemented.
String	toVOTable () throws ConversionException
	To be implemented.
void	fromVOTable (String vo) throws ConversionException
	To be implemented.
String	toXML () throws ConversionException
	Translate this table to an XML representation conform to the schema defined for TotalPower (TotalPowerTable.xsd).
void	fromXML (String xmlDoc) throws ConversionException
	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).
byte[]	toMIME () throws ConversionException
	Serialize this into a stream of bytes and encapsulates that stream into a MIME message.
void	setFromMIME (byte[] data) throws ConversionException
	Extracts the binary part of a MIME message and deserialize its content to fill this with the result of the deserialization.
void	toFile (String directory) throws ConversionException
	Stores a representation (binary or XML) of this table into a file.
void	setFromFile (String directory) throws ConversionException
	Reads and parses a file containing a representation of a TotalPowerTable as those produced by the toFile method.
Entity	getEntity ()
	Returns the table's entity.
void	setEntity (Entity e)
	Set the table's entity.
void	fromArchive (Archiver ar, String UID) throws ConversionException, ArchiverException
	Retrieve this table from the archive.
Static Public Member Functions
String[]	getKeyName ()
	Return the list of field names that make up key key as an array of strings.
Package Functions
String	Key (Tag configDescriptionId, Tag fieldId)
	Returns a string built by concatenating the ascii representation of the parameters values suffixed with a "_" character.
String	Key (Tag configDescriptionId, Tag fieldId, ArrayTime time)
	Returns a string built by concatenating the ascii representation of the parameters values suffixed with a "_" character.
boolean	inKey (String s)
	TotalPowerTable (ASDM container)
	Create a TotalPowerTable.
String	toArchive (Archiver ar) throws ConversionException, ArchiverException
	Store this table into the archive.

---

Constructor & Destructor Documentation

alma.asdm.TotalPowerTable.TotalPowerTable (  ASDM  container  )  [package]

Create a TotalPowerTable. This constructor has package access because only the container can create tables. All tables must know the container to which they belong. Parameters: container  The container to which this table belongs.

---

Member Function Documentation

void alma.asdm.TotalPowerTable.add (  TotalPowerRow[]  x  )  throws DuplicateKey

Add an array of rows. Exceptions: DuplicateKey  Thrown if any new row has a key that is already in the table. Parameters: x  The array of rows to be added.

TotalPowerRow alma.asdm.TotalPowerTable.add (  TotalPowerRow  x  )  throws DuplicateKey

Add a row. Parameters: x  the TotalPowerRow to be added. Returns: 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 } 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.

void alma.asdm.TotalPowerTable.fromArchive (  Archiver  ar, String  UID )  throws ConversionException, ArchiverException

Retrieve this table from the archive. Parameters: ar  the archiver in charge of the archiving.

void alma.asdm.TotalPowerTable.fromIDL (  TotalPowerTableIDL  x  )  throws 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 alma.asdm.TotalPowerTable.fromXML (  String  xmlDoc  )  throws ConversionException

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). Exceptions: ConversionException  Implements alma.asdm.Representable.

TotalPowerRow [] alma.asdm.TotalPowerTable.get (   )

Get all rows. Returns: Alls rows as an array of TotalPowerRow

String [] alma.asdm.TotalPowerTable.getAttributesNames (   )  [virtual]

Returns the names of the attributes of the rows stored in that table. Returns: the attributes names as an array of String. Implements alma.asdm.ASDMTable.

TotalPowerRow [] alma.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: an array of TotalPowerRow. A null returned value means that the table contains no TotalPowerRow for the given ( configDescriptionId, fieldId ).

ASDM alma.asdm.TotalPowerTable.getContainer (   )

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

Entity alma.asdm.TotalPowerTable.getEntity (   )

Returns the table's entity. Implements alma.asdm.Representable.

String [] alma.asdm.TotalPowerTable.getKeyName (   )  [static]

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

String alma.asdm.TotalPowerTable.getName (   )  [virtual]

Return the name of this table. Implements alma.asdm.ASDMTable.

TotalPowerRow alma.asdm.TotalPowerTable.getRowByKey (  Tag  configDescriptionId, Tag  fieldId, ArrayTime  time )

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

ASDMRow [] alma.asdm.TotalPowerTable.getRows (   )  [virtual]

Returns the rows of an ASDMTable as an array of ASDMRow. Returns: an array of ASDMRow. Implements alma.asdm.ASDMTable.

String alma.asdm.TotalPowerTable.Key (  Tag  configDescriptionId, Tag  fieldId, ArrayTime  time )  [package]

Returns a string built by concatenating the ascii representation of the parameters values suffixed with a "_" character.

String alma.asdm.TotalPowerTable.Key (  Tag  configDescriptionId, Tag  fieldId )  [package]

Returns a string built by concatenating the ascii representation of the parameters values suffixed with a "_" character.

TotalPowerRow alma.asdm.TotalPowerTable.lookup (  Tag  configDescriptionId, Tag  fieldId, ArrayTime  time, Tag  execBlockId, Tag[]  stateId, int  scanNumber, int  subscanNumber, int  integrationNumber, Length  uvw[][], Interval  exposure[][], ArrayTime  timeCentroid[][], float  floatData[][][], int[]  flagAnt, int  flagPol[][], boolean  flagRow, Interval  interval )

Look up the table for a row whose all attributes are equal to the corresponding parameters of the method. Returns: this row if any, null otherwise. Parameters: configDescriptionId.  fieldId.  time.  execBlockId.  stateId.  scanNumber.  subscanNumber.  integrationNumber.  uvw.  exposure.  timeCentroid.  floatData.  flagAnt.  flagPol.  flagRow.  interval.

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

Create a new row initialized to the specified values. (the autoincrementable attribute if any is not in the parameter list) Returns: the new initialized row. Parameters: configDescriptionId.  fieldId.  time.  execBlockId.  stateId.  scanNumber.  subscanNumber.  integrationNumber.  uvw.  exposure.  timeCentroid.  floatData.  flagAnt.  flagPol.  flagRow.  interval.

TotalPowerRow alma.asdm.TotalPowerTable.newRow (   )

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

void alma.asdm.TotalPowerTable.setEntity (  Entity  e  )

Set the table's entity. Parameters: e  An entity. Implements alma.asdm.Representable.

void alma.asdm.TotalPowerTable.setFromFile (  String  directory  )  throws ConversionException

Reads and parses a file containing a representation of a TotalPowerTable 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 alma.asdm.TotalPowerTable.setFromMIME (  byte[]  data  )  throws ConversionException

Extracts the binary part of a MIME message and deserialize its content to fill this with the result of the deserialization. Parameters: mimeMsg  the array of bytes containing the MIME message. Exceptions: ConversionException

int alma.asdm.TotalPowerTable.size (   )  [virtual]

Return the number of rows in the table. Implements alma.asdm.ASDMTable.

String alma.asdm.TotalPowerTable.toArchive (  Archiver  ar  )  throws ConversionException, ArchiverException [package]

Store this table into the archive. Parameters: ar  the archiver in charge of the archiving. Returns: the UID assigned to the archived table.

void alma.asdm.TotalPowerTable.toFile (  String  directory  )  throws ConversionException

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 "TotalPowerTable.bin" or an XML representation (fileAsBin==false) will be saved in a file "TotalPowerTable.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. Exceptions: ConversionException

TotalPowerTableIDL alma.asdm.TotalPowerTable.toIDL (   )

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

byte [] alma.asdm.TotalPowerTable.toMIME (   )  throws ConversionException

Serialize this into a stream of bytes and encapsulates that stream into a MIME message. Returns: an array of bytes containing the MIME message.

String alma.asdm.TotalPowerTable.toString (   )

Returns "TotalPowerTable" followed by the current size of the table between parenthesis. Example : SpectralWindowTable(12) Returns: a String.

String alma.asdm.TotalPowerTable.toXML (   )  throws ConversionException

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

---

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

• TotalPowerTable.java

---