alma.asdm.CalPointingModelTable Class Reference

Inherits alma.asdm.ASDMTable, and alma.asdm.Representable.

List of all members.


Detailed Description

The CalPointingModelTable class is an Alma table.

Generated from model's revision 1.46, branch HEAD

Attributes of CalPointingModel
Name Type Comment

Key

calDataId Tag  

calReductionId Tag  

antennaName String  

receiverBand ReceiverBand  

Value
(Mandarory)

antennaMake AntennaMake  

numObs int  

numCoeff int  

startValidTime ArrayTime  

endValidTime ArrayTime  

numFormula int  

azimuthRms Angle  

elevationRms Angle  

skyRms Angle  

coeffName String[] numCoeff

coeffVal float[] numCoeff

coeffError float[] numCoeff

coeffFixed boolean[] numCoeff

coeffFormula String[] numFormula

pointingModelMode PointingModelMode  


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 "CalPointingModelTable" followed by the current size of the table between parenthesis.
CalPointingModelRow newRow ()
 Create a new row with default values .
CalPointingModelRow add (CalPointingModelRow x) throws DuplicateKey
 Add a row.
void add (CalPointingModelRow[] x) throws DuplicateKey
 Add an array of rows.
CalPointingModelRow newRow (Tag calDataId, Tag calReductionId, String antennaName, ReceiverBand receiverBand, AntennaMake antennaMake, int numObs, int numCoeff, ArrayTime startValidTime, ArrayTime endValidTime, int numFormula, Angle azimuthRms, Angle elevationRms, Angle skyRms, String[] coeffName, float[] coeffVal, float[] coeffError, boolean[] coeffFixed, String[] coeffFormula, PointingModelMode pointingModelMode)
 Create a new row initialized to the specified values.
CalPointingModelRow newRow (CalPointingModelRow row)
 Create a new row using a copy constructor mechanism.
CalPointingModelRow[] get ()
 Get all rows.
CalPointingModelRow getRowByKey (Tag calDataId, Tag calReductionId, String antennaName, ReceiverBand receiverBand)
 Returns a CalPointingModelRow given a key.
CalPointingModelRow lookup (Tag calDataId, Tag calReductionId, String antennaName, ReceiverBand receiverBand, AntennaMake antennaMake, int numObs, int numCoeff, ArrayTime startValidTime, ArrayTime endValidTime, int numFormula, Angle azimuthRms, Angle elevationRms, Angle skyRms, String[] coeffName, float[] coeffVal, float[] coeffError, boolean[] coeffFixed, String[] coeffFormula, PointingModelMode pointingModelMode)
 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.
CalPointingModelTableIDL toIDL ()
 Convert this table into a CalPointingModelTableIDL CORBA structure.
void fromIDL (CalPointingModelTableIDL x) throws DuplicateKey,ConversionException
 Populate this table from the content of a CalPointingModelTableIDL 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 CalPointingModel (CalPointingModelTable.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 CalPointingModel (CalPointingModelTable.xsd).
byte[] toMIME () throws ConversionException
 Serialize this into a stream of bytes and encapsulates that stream into a MIME message.
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 CalPointingModelTable 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

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 calDataId, Tag calReductionId, String antennaName, ReceiverBand receiverBand)
 Returns a string built by concatenating the ascii representation of the parameters values suffixed with a "_" character.
boolean inKey (String s)
 CalPointingModelTable (ASDM container)
 Create a CalPointingModelTable.
void setFromMIME (byte[] mimeMsg) throws ConversionException
 Extracts the binary part of a MIME message and deserialize its content to fill this with the result of the deserialization.
String toArchive (Archiver ar) throws ConversionException, ArchiverException
 Store this table into the archive.


Constructor & Destructor Documentation

alma.asdm.CalPointingModelTable.CalPointingModelTable ASDM  container  )  [package]
 

Create a CalPointingModelTable.

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.CalPointingModelTable.add CalPointingModelRow[]  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.

CalPointingModelRow alma.asdm.CalPointingModelTable.add CalPointingModelRow  x  )  throws DuplicateKey
 

Add a row.

Exceptions:
DuplicateKey Thrown if the new row has a key that is already in the table.
Parameters:
x The row to be added.
Returns:
x

void alma.asdm.CalPointingModelTable.fromIDL CalPointingModelTableIDL  x  )  throws DuplicateKey,ConversionException
 

Populate this table from the content of a CalPointingModelTableIDL 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.CalPointingModelTable.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 CalPointingModel (CalPointingModelTable.xsd).

Exceptions:
ConversionException 

Implements alma.asdm.Representable.

CalPointingModelRow [] alma.asdm.CalPointingModelTable.get  ) 
 

Get all rows.

Returns:
Alls rows as an array of CalPointingModelRow

String [] alma.asdm.CalPointingModelTable.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.

ASDM alma.asdm.CalPointingModelTable.getContainer  ) 
 

Return the container to which this table belongs.

Returns:
a ASDM.

Entity alma.asdm.CalPointingModelTable.getEntity  ) 
 

Returns the table's entity.

Implements alma.asdm.Representable.

String [] alma.asdm.CalPointingModelTable.getKeyName  )  [static]
 

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

String alma.asdm.CalPointingModelTable.getName  )  [virtual]
 

Return the name of this table.

Implements alma.asdm.ASDMTable.

CalPointingModelRow alma.asdm.CalPointingModelTable.getRowByKey Tag  calDataId,
Tag  calReductionId,
String  antennaName,
ReceiverBand  receiverBand
 

Returns a CalPointingModelRow 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:
calDataId. 
calReductionId. 
antennaName. 
receiverBand. 

ASDMRow [] alma.asdm.CalPointingModelTable.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.CalPointingModelTable.Key Tag  calDataId,
Tag  calReductionId,
String  antennaName,
ReceiverBand  receiverBand
[package]
 

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

CalPointingModelRow alma.asdm.CalPointingModelTable.lookup Tag  calDataId,
Tag  calReductionId,
String  antennaName,
ReceiverBand  receiverBand,
AntennaMake  antennaMake,
int  numObs,
int  numCoeff,
ArrayTime  startValidTime,
ArrayTime  endValidTime,
int  numFormula,
Angle  azimuthRms,
Angle  elevationRms,
Angle  skyRms,
String[]  coeffName,
float[]  coeffVal,
float[]  coeffError,
boolean[]  coeffFixed,
String[]  coeffFormula,
PointingModelMode  pointingModelMode
 

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:
calDataId. 
calReductionId. 
antennaName. 
receiverBand. 
antennaMake. 
numObs. 
numCoeff. 
startValidTime. 
endValidTime. 
numFormula. 
azimuthRms. 
elevationRms. 
skyRms. 
coeffName. 
coeffVal. 
coeffError. 
coeffFixed. 
coeffFormula. 
pointingModelMode. 

CalPointingModelRow alma.asdm.CalPointingModelTable.newRow CalPointingModelRow  row  ) 
 

Create a new row using a copy constructor mechanism.

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

Parameters:
row the row which is to be copied.

CalPointingModelRow alma.asdm.CalPointingModelTable.newRow Tag  calDataId,
Tag  calReductionId,
String  antennaName,
ReceiverBand  receiverBand,
AntennaMake  antennaMake,
int  numObs,
int  numCoeff,
ArrayTime  startValidTime,
ArrayTime  endValidTime,
int  numFormula,
Angle  azimuthRms,
Angle  elevationRms,
Angle  skyRms,
String[]  coeffName,
float[]  coeffVal,
float[]  coeffError,
boolean[]  coeffFixed,
String[]  coeffFormula,
PointingModelMode  pointingModelMode
 

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:
calDataId. 
calReductionId. 
antennaName. 
receiverBand. 
antennaMake. 
numObs. 
numCoeff. 
startValidTime. 
endValidTime. 
numFormula. 
azimuthRms. 
elevationRms. 
skyRms. 
coeffName. 
coeffVal. 
coeffError. 
coeffFixed. 
coeffFormula. 
pointingModelMode. 

CalPointingModelRow alma.asdm.CalPointingModelTable.newRow  ) 
 

Create a new row with default values .

Returns:
a CalPointingModelRow

void alma.asdm.CalPointingModelTable.setEntity Entity  e  ) 
 

Set the table's entity.

Parameters:
e An entity.

Implements alma.asdm.Representable.

void alma.asdm.CalPointingModelTable.setFromFile String  directory  )  throws ConversionException
 

Reads and parses a file containing a representation of a CalPointingModelTable 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.CalPointingModelTable.setFromMIME byte[]  mimeMsg  )  throws ConversionException [package]
 

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 

int alma.asdm.CalPointingModelTable.size  )  [virtual]
 

Return the number of rows in the table.

Implements alma.asdm.ASDMTable.

String alma.asdm.CalPointingModelTable.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.CalPointingModelTable.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 "CalPointingModel.bin" or an XML representation (fileAsBin==false) will be saved in a file "CalPointingModel.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 

CalPointingModelTableIDL alma.asdm.CalPointingModelTable.toIDL  ) 
 

Convert this table into a CalPointingModelTableIDL CORBA structure.

Returns:
a CalPointingModelTableIDL

byte [] alma.asdm.CalPointingModelTable.toMIME  )  throws ConversionException
 

Serialize this into a stream of bytes and encapsulates that stream into a MIME message.

Returns:
a string containing the MIME message.

String alma.asdm.CalPointingModelTable.toString  ) 
 

Returns "CalPointingModelTable" followed by the current size of the table between parenthesis.

Example : SpectralWindowTable(12)

Returns:
a String.

String alma.asdm.CalPointingModelTable.toXML  )  throws ConversionException
 

Translate this table to an XML representation conform to the schema defined for CalPointingModel (CalPointingModelTable.xsd).

Returns:
a string containing the XML representation.

Implements alma.asdm.Representable.


The documentation for this class was generated from the following file:
Generated on Tue Nov 18 17:46:45 2008 for ASDM Java Implementation by doxygen 1.3.8