alma.asdm.SysCalTable Class Reference

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

List of all members.

---

Detailed Description

The SysCalTable class is an Alma table.

Generated from model's revision 1.46, branch HEAD

Attributes of SysCal

Name	Type	Comment
Key
antennaId	Tag
feedId	int
spectralWindowId	Tag
timeInterval	ArrayTimeInterval
Value (Optional)
numLoad	int
calLoad	int[]	numLoad
feff	float[]
aeff	float[]
phaseDiff	Angle
sbgain	float
tau	Temperature[]
tcal	Temperature[]
trx	Temperature[]
tsky	Temperature[]
tsys	Temperature[]
tant	Temperature[]
tantTsys	float[]
pwvPath	Length[]
dpwvPath	float[]
feffSpectrum	float[][]	,
sbgainSpectrum	float[][]	,
tauSpectrum	Temperature[][]	,
tcalSpectrum	Temperature[][]	,
trxSpectrum	Temperature[]
tskySpectrum	Temperature[][]	,
tsysSpectrum	Temperature[][]	,
tantSpectrum	Temperature[][]	,
tantTsysSpectrum	float[][]	,
pwvPathSpectrum	Length[]
dpwvPathSpectrum	float[]
numPoly	int
numPolyFreq	int
timeOrigin	ArrayTime
freqOrigin	Frequency
phaseCurve	Angle[][]	numPoly,
delayCurve	Interval[][]	numPoly,
ampliCurve	float[][]	numPoly,
bandpassCurve	float[][]	numPolyFreq,
phasediffFlag	boolean
sbgainFlag	boolean
tauFlag	boolean
tcalFlag	boolean
trxFlag	boolean
tskyFlag	boolean
tsysFlag	boolean
tantFlag	boolean
tantTsysFlag	boolean
pwvPathFlag	boolean

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 "SysCalTable" followed by the current size of the table between parenthesis.
SysCalRow	newRow ()
	Create a new row with default values .
SysCalRow	add (SysCalRow x) throws DuplicateKey
	Add a row.
SysCalRow	newRow (Tag antennaId, int feedId, Tag spectralWindowId, ArrayTimeInterval timeInterval)
	Create a new row initialized to the specified values.
SysCalRow	newRow (SysCalRow row)
	Create a new row using a copy constructor mechanism.
SysCalRow[]	get ()
	Get all rows.
SysCalRow[]	getByContext (Tag antennaId, int feedId, Tag spectralWindowId)
	Returns all the rows sorted by ascending startTime for a given context.
SysCalRow	getRowByKey (Tag antennaId, int feedId, Tag spectralWindowId, ArrayTimeInterval timeInterval)
	Returns a SysCalRow given a key.
ASDMRow[]	getRows ()
	Returns the rows of an ASDMTable as an array of ASDMRow.
SysCalTableIDL	toIDL ()
	Convert this table into a SysCalTableIDL CORBA structure.
void	fromIDL (SysCalTableIDL x) throws DuplicateKey,ConversionException
	Populate this table from the content of a SysCalTableIDL 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 SysCal (SysCalTable.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 SysCal (SysCalTable.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 SysCalTable 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 antennaId, int feedId, Tag spectralWindowId)
	Returns a string built by concatenating the ascii representation of the parameters values suffixed with a "_" character.
boolean	inKey (String s)
	SysCalTable (ASDM container)
	Create a SysCalTable.
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.SysCalTable.SysCalTable (  ASDM  container  )  [package]

Create a SysCalTable. 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

SysCalRow alma.asdm.SysCalTable.add (  SysCalRow  x  )  throws DuplicateKey

Add a row. Parameters: x  a pointer to the SysCalRow to be added. Returns: a SysCalRow. If the table contains a SysCalRow whose attributes (key and mandatory values) are equal to x ones then returns a pointer on that SysCalRow, otherwise returns x. Exceptions: DuplicateKey  { thrown when the table contains a SysCalRow 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 ( antennaId, feedId, spectralWindowId ) are stored by ascending time.

void alma.asdm.SysCalTable.fromIDL (  SysCalTableIDL  x  )  throws DuplicateKey,ConversionException

Populate this table from the content of a SysCalTableIDL 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.SysCalTable.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 SysCal (SysCalTable.xsd). Exceptions: ConversionException  Implements alma.asdm.Representable.

SysCalRow [] alma.asdm.SysCalTable.get (   )

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

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

SysCalRow [] alma.asdm.SysCalTable.getByContext (  Tag  antennaId, int  feedId, Tag  spectralWindowId )

Returns all the rows sorted by ascending startTime for a given context. The context is defined by a value of ( antennaId, feedId, spectralWindowId ). Returns: an array of SysCalRow. A null returned value means that the table contains no SysCalRow for the given ( antennaId, feedId, spectralWindowId ).

ASDM alma.asdm.SysCalTable.getContainer (   )

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

Entity alma.asdm.SysCalTable.getEntity (   )

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

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

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

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

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

SysCalRow alma.asdm.SysCalTable.getRowByKey (  Tag  antennaId, int  feedId, Tag  spectralWindowId, ArrayTimeInterval  timeInterval )

Returns a SysCalRow 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.

ASDMRow [] alma.asdm.SysCalTable.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.SysCalTable.Key (  Tag  antennaId, int  feedId, Tag  spectralWindowId )  [package]

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

SysCalRow alma.asdm.SysCalTable.newRow (  SysCalRow  row  )

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

SysCalRow alma.asdm.SysCalTable.newRow (  Tag  antennaId, int  feedId, Tag  spectralWindowId, ArrayTimeInterval  timeInterval )

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: antennaId.  feedId.  spectralWindowId.  timeInterval.

SysCalRow alma.asdm.SysCalTable.newRow (   )

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

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

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

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

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

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

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

SysCalTableIDL alma.asdm.SysCalTable.toIDL (   )

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

byte [] alma.asdm.SysCalTable.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.SysCalTable.toString (   )

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

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

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

---

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

• SysCalTable.java

---