alma.asdm.PointingRow Class Reference

Inherits alma.asdm.ASDMRow.

List of all members.

---

Detailed Description

The PointingRow class is a row of a PointingTable.

Public Member Functions
PointingTable	getTable ()
	Return the table to which this row belongs.
PointingRowIDL	toIDL ()
	Return this row in the form of an IDL struct.
void	setFromIDL (PointingRowIDL x) throws ConversionException
	Fill the values of this row from the IDL struct PointingRowIDL.
String	toXML () throws ConversionException
	Return this row in the form of an XML string.
void	setFromXML (String rowDoc) throws ConversionException
	Fill the values of this row from an XML string that was produced by the toXML() method.
void	toBin (DataOutputStream dos) throws IOException
	Serialize this into a stream of bytes written to a DataOutputStream.
ArrayTimeInterval	getTimeInterval ()
	Get timeInterval.
void	setTimeInterval (ArrayTimeInterval timeInterval) throws IllegalAccessException
	Set timeInterval with the specified ArrayTimeInterval value.
boolean	isNameExists ()
	The attribute name is optional.
String	getName () throws IllegalAccessException
	Get name, which is optional.
void	setName (String name)
	Set name with the specified String value.
void	clearName ()
	Mark name, which is an optional field, as non-existent.
int	getNumPoly ()
	Get numPoly.
void	setNumPoly (int numPoly)
	Set numPoly with the specified int value.
ArrayTime	getTimeOrigin ()
	Get timeOrigin.
void	setTimeOrigin (ArrayTime timeOrigin)
	Set timeOrigin with the specified ArrayTime value.
Angle[][]	getPointingDirection ()
	Get pointingDirection.
void	setPointingDirection (Angle[][] pointingDirection)
	Set pointingDirection with the specified Angle[][] value.
Angle[][]	getTarget ()
	Get target.
void	setTarget (Angle[][] target)
	Set target with the specified Angle[][] value.
Angle[][]	getOffset ()
	Get offset.
void	setOffset (Angle[][] offset)
	Set offset with the specified Angle[][] value.
boolean	isSourceOffsetExists ()
	The attribute sourceOffset is optional.
Angle[][]	getSourceOffset () throws IllegalAccessException
	Get sourceOffset, which is optional.
void	setSourceOffset (Angle[][] sourceOffset)
	Set sourceOffset with the specified Angle[][] value.
void	clearSourceOffset ()
	Mark sourceOffset, which is an optional field, as non-existent.
Angle[]	getEncoder ()
	Get encoder.
void	setEncoder (Angle[] encoder)
	Set encoder with the specified Angle[] value.
boolean	getPointingTracking ()
	Get pointingTracking.
void	setPointingTracking (boolean pointingTracking)
	Set pointingTracking with the specified boolean value.
boolean	isPhaseTrackingExists ()
	The attribute phaseTracking is optional.
boolean	getPhaseTracking () throws IllegalAccessException
	Get phaseTracking, which is optional.
void	setPhaseTracking (boolean phaseTracking)
	Set phaseTracking with the specified boolean value.
void	clearPhaseTracking ()
	Mark phaseTracking, which is an optional field, as non-existent.
boolean	isOverTheTopExists ()
	The attribute overTheTop is optional.
boolean	getOverTheTop () throws IllegalAccessException
	Get overTheTop, which is optional.
void	setOverTheTop (boolean overTheTop)
	Set overTheTop with the specified boolean value.
void	clearOverTheTop ()
	Mark overTheTop, which is an optional field, as non-existent.
Tag	getAntennaId ()
	Get antennaId.
void	setAntennaId (Tag antennaId) throws IllegalAccessException
	Set antennaId with the specified Tag value.
int	getPointingModelId ()
	Get pointingModelId.
void	setPointingModelId (int pointingModelId)
	Set pointingModelId with the specified int value.
AntennaRow	getAntennaUsingAntennaId ()
	Returns the pointer to the row in the Antenna table having Antenna.antennaId == antennaId.
boolean	compareNoAutoInc (Tag antennaId, ArrayTimeInterval timeInterval, int pointingModelId, int numPoly, ArrayTime timeOrigin, Angle[][] pointingDirection, Angle[][] target, Angle[][] offset, Angle[] encoder, boolean pointingTracking)
	Compare each attribute except the autoincrementable one of this PointingRow with the corresponding parameters and return true if there is a match and false otherwise.
boolean	equalByRequiredValue (PointingRow x)
	Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
boolean	compareRequiredValue (int pointingModelId, int numPoly, ArrayTime timeOrigin, Angle[][] pointingDirection, Angle[][] target, Angle[][] offset, Angle[] encoder, boolean pointingTracking)
Static Public Member Functions
PointingRow	fromBin (DataInputStream dis, PointingTable table) throws IOException, TagFormatException
	Deserialize a stream of bytes read from a DataInputStream to build a PointingRow.
Package Functions
	PointingRow (PointingTable table)
	Create a PointingRow.
	PointingRow (PointingTable table, PointingRow row)
	Creates a PointingRow using a copy constructor mechanism.
void	isAdded ()
Object[]	getAttributesValues ()
	Returns all the attributes of an attribute of an ASDM table as an array of Object.
Package Attributes
ArrayTimeInterval	timeInterval

---

Constructor & Destructor Documentation

alma.asdm.PointingRow.PointingRow (  PointingTable  table  )  [package]

Create a PointingRow. This constructor has package access because only the table can create rows. All rows know the table to which they belong. Parameters: table  The table to which this row belongs.

alma.asdm.PointingRow.PointingRow (  PointingTable  table, PointingRow  row )  [package]

Creates a PointingRow using a copy constructor mechanism. Given a PointingRow row and a PointingTable table, the method creates a new PointingRow owned by table. Each attribute of the created row is a copy (deep) of the corresponding attribute of row. The method does not add the created row to its table, its simply parents it to table, 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 row with default values for its attributes. This constructor has package access because only the table can create rows. All rows know the table to which they belong. Parameters: table  The table to which this row belongs. row  The row which is to be copied.

---

Member Function Documentation

void alma.asdm.PointingRow.clearName (   )

Mark name, which is an optional field, as non-existent.

void alma.asdm.PointingRow.clearOverTheTop (   )

Mark overTheTop, which is an optional field, as non-existent.

void alma.asdm.PointingRow.clearPhaseTracking (   )

Mark phaseTracking, which is an optional field, as non-existent.

void alma.asdm.PointingRow.clearSourceOffset (   )

Mark sourceOffset, which is an optional field, as non-existent.

boolean alma.asdm.PointingRow.compareNoAutoInc (  Tag  antennaId, ArrayTimeInterval  timeInterval, int  pointingModelId, int  numPoly, ArrayTime  timeOrigin, Angle  pointingDirection[][], Angle  target[][], Angle  offset[][], Angle[]  encoder, boolean  pointingTracking )

Compare each attribute except the autoincrementable one of this PointingRow with the corresponding parameters and return true if there is a match and false otherwise.

boolean alma.asdm.PointingRow.equalByRequiredValue (  PointingRow  x  )

Return true if all required attributes of the value part are equal to their homologues in x and false otherwise. Parameters: x  the PointingRow whose required attributes of the value part will be compared with those of this. Returns: a boolean.

PointingRow alma.asdm.PointingRow.fromBin (  DataInputStream  dis, PointingTable  table )  throws IOException, TagFormatException [static]

Deserialize a stream of bytes read from a DataInputStream to build a PointingRow. Parameters: dis  the DataInputStream to be read. the PointingTable to which the row built by deserialization will be parented.

Tag alma.asdm.PointingRow.getAntennaId (   )

Get antennaId. Returns: antennaId as Tag

AntennaRow alma.asdm.PointingRow.getAntennaUsingAntennaId (   )

Returns the pointer to the row in the Antenna table having Antenna.antennaId == antennaId. Returns: a AntennaRow

Object [] alma.asdm.PointingRow.getAttributesValues (   )  [package, virtual]

Returns all the attributes of an attribute of an ASDM table as an array of Object. Returns: an array of Object. Implements alma.asdm.ASDMRow.

Angle [] alma.asdm.PointingRow.getEncoder (   )

Get encoder. Returns: encoder as Angle[]

String alma.asdm.PointingRow.getName (   )  throws IllegalAccessException

Get name, which is optional. Returns: name as String Exceptions: IllegalAccessException  If name does not exist.

int alma.asdm.PointingRow.getNumPoly (   )

Get numPoly. Returns: numPoly as int

Angle [][] alma.asdm.PointingRow.getOffset (   )

Get offset. Returns: offset as Angle[][]

boolean alma.asdm.PointingRow.getOverTheTop (   )  throws IllegalAccessException

Get overTheTop, which is optional. Returns: overTheTop as boolean Exceptions: IllegalAccessException  If overTheTop does not exist.

boolean alma.asdm.PointingRow.getPhaseTracking (   )  throws IllegalAccessException

Get phaseTracking, which is optional. Returns: phaseTracking as boolean Exceptions: IllegalAccessException  If phaseTracking does not exist.

Angle [][] alma.asdm.PointingRow.getPointingDirection (   )

Get pointingDirection. Returns: pointingDirection as Angle[][]

int alma.asdm.PointingRow.getPointingModelId (   )

Get pointingModelId. Returns: pointingModelId as int

boolean alma.asdm.PointingRow.getPointingTracking (   )

Get pointingTracking. Returns: pointingTracking as boolean

Angle [][] alma.asdm.PointingRow.getSourceOffset (   )  throws IllegalAccessException

Get sourceOffset, which is optional. Returns: sourceOffset as Angle[][] Exceptions: IllegalAccessException  If sourceOffset does not exist.

PointingTable alma.asdm.PointingRow.getTable (   )

Return the table to which this row belongs.

Angle [][] alma.asdm.PointingRow.getTarget (   )

Get target. Returns: target as Angle[][]

ArrayTimeInterval alma.asdm.PointingRow.getTimeInterval (   )

Get timeInterval. Returns: timeInterval as ArrayTimeInterval

ArrayTime alma.asdm.PointingRow.getTimeOrigin (   )

Get timeOrigin. Returns: timeOrigin as ArrayTime

boolean alma.asdm.PointingRow.isNameExists (   )

The attribute name is optional. Return true if this attribute exists. Returns: true if and only if the name attribute exists.

boolean alma.asdm.PointingRow.isOverTheTopExists (   )

The attribute overTheTop is optional. Return true if this attribute exists. Returns: true if and only if the overTheTop attribute exists.

boolean alma.asdm.PointingRow.isPhaseTrackingExists (   )

The attribute phaseTracking is optional. Return true if this attribute exists. Returns: true if and only if the phaseTracking attribute exists.

boolean alma.asdm.PointingRow.isSourceOffsetExists (   )

The attribute sourceOffset is optional. Return true if this attribute exists. Returns: true if and only if the sourceOffset attribute exists.

void alma.asdm.PointingRow.setAntennaId (  Tag  antennaId  )  throws IllegalAccessException

Set antennaId with the specified Tag value. Parameters: antennaId  The Tag value to which antennaId is to be set. Exceptions: IllegalAccessException  If an attempt is made to change this field after is has been added to the table.

void alma.asdm.PointingRow.setEncoder (  Angle[]  encoder  )

Set encoder with the specified Angle[] value. Parameters: encoder  The Angle[] value to which encoder is to be set.

void alma.asdm.PointingRow.setFromIDL (  PointingRowIDL  x  )  throws ConversionException

Fill the values of this row from the IDL struct PointingRowIDL. Parameters: x  The IDL struct containing the values used to fill this row.

void alma.asdm.PointingRow.setFromXML (  String  rowDoc  )  throws ConversionException

Fill the values of this row from an XML string that was produced by the toXML() method. Parameters: x  The XML string being used to set the values of this row. Exceptions: ConversionException.

void alma.asdm.PointingRow.setName (  String  name  )

Set name with the specified String value. Parameters: name  The String value to which name is to be set.

void alma.asdm.PointingRow.setNumPoly (  int  numPoly  )

Set numPoly with the specified int value. Parameters: numPoly  The int value to which numPoly is to be set.

void alma.asdm.PointingRow.setOffset (  Angle  offset[][]  )

Set offset with the specified Angle[][] value. Parameters: offset  The Angle[][] value to which offset is to be set.

void alma.asdm.PointingRow.setOverTheTop (  boolean  overTheTop  )

Set overTheTop with the specified boolean value. Parameters: overTheTop  The boolean value to which overTheTop is to be set.

void alma.asdm.PointingRow.setPhaseTracking (  boolean  phaseTracking  )

Set phaseTracking with the specified boolean value. Parameters: phaseTracking  The boolean value to which phaseTracking is to be set.

void alma.asdm.PointingRow.setPointingDirection (  Angle  pointingDirection[][]  )

Set pointingDirection with the specified Angle[][] value. Parameters: pointingDirection  The Angle[][] value to which pointingDirection is to be set.

void alma.asdm.PointingRow.setPointingModelId (  int  pointingModelId  )

Set pointingModelId with the specified int value. Parameters: pointingModelId  The int value to which pointingModelId is to be set.

void alma.asdm.PointingRow.setPointingTracking (  boolean  pointingTracking  )

Set pointingTracking with the specified boolean value. Parameters: pointingTracking  The boolean value to which pointingTracking is to be set.

void alma.asdm.PointingRow.setSourceOffset (  Angle  sourceOffset[][]  )

Set sourceOffset with the specified Angle[][] value. Parameters: sourceOffset  The Angle[][] value to which sourceOffset is to be set.

void alma.asdm.PointingRow.setTarget (  Angle  target[][]  )

Set target with the specified Angle[][] value. Parameters: target  The Angle[][] value to which target is to be set.

void alma.asdm.PointingRow.setTimeInterval (  ArrayTimeInterval  timeInterval  )  throws IllegalAccessException

Set timeInterval with the specified ArrayTimeInterval value. Parameters: timeInterval  The ArrayTimeInterval value to which timeInterval is to be set. Exceptions: IllegalAccessException  If an attempt is made to change this field after is has been added to the table.

void alma.asdm.PointingRow.setTimeOrigin (  ArrayTime  timeOrigin  )

Set timeOrigin with the specified ArrayTime value. Parameters: timeOrigin  The ArrayTime value to which timeOrigin is to be set.

void alma.asdm.PointingRow.toBin (  DataOutputStream  dos  )  throws IOException

Serialize this into a stream of bytes written to a DataOutputStream. Parameters: dos  the DataOutStream to be written to. Exceptions: IOException

PointingRowIDL alma.asdm.PointingRow.toIDL (   )

Return this row in the form of an IDL struct. Returns: The values of this row as a PointingRowIDL struct.

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

Return this row in the form of an XML string. Returns: The values of this row as an XML string. Exceptions: ConversionException.

---

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

• PointingRow.java

---