alma.asdm.CalSeeingRow Class Reference

Inherits alma.asdm.ASDMRow.

List of all members.

---

Detailed Description

The CalSeeingRow class is a row of a CalSeeingTable.

Generated from model's revision 1.41, branch HEAD

Public Member Functions
CalSeeingTable	getTable ()
	Return the table to which this row belongs.
CalSeeingRowIDL	toIDL ()
	Return this row in the form of an IDL struct.
void	setFromIDL (CalSeeingRowIDL x) throws ConversionException
	Fill the values of this row from the IDL struct CalSeeingRowIDL.
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.
int	getNumBaseLength ()
	Get numBaseLength.
void	setNumBaseLength (int numBaseLength)
	Set numBaseLength with the specified int value.
ArrayTime	getStartValidTime ()
	Get startValidTime.
void	setStartValidTime (ArrayTime startValidTime)
	Set startValidTime with the specified ArrayTime value.
ArrayTime	getEndValidTime ()
	Get endValidTime.
void	setEndValidTime (ArrayTime endValidTime)
	Set endValidTime with the specified ArrayTime value.
Frequency[]	getFrequencyRange ()
	Get frequencyRange.
void	setFrequencyRange (Frequency[] frequencyRange)
	Set frequencyRange with the specified Frequency[] value.
Length[]	getBaseLength ()
	Get baseLength.
void	setBaseLength (Length[] baseLength)
	Set baseLength with the specified Length[] value.
Angle[]	getCorrPhaseRms ()
	Get corrPhaseRms.
void	setCorrPhaseRms (Angle[] corrPhaseRms)
	Set corrPhaseRms with the specified Angle[] value.
Angle[]	getUncorrPhaseRms ()
	Get uncorrPhaseRms.
void	setUncorrPhaseRms (Angle[] uncorrPhaseRms)
	Set uncorrPhaseRms with the specified Angle[] value.
Angle	getSeeing ()
	Get seeing.
void	setSeeing (Angle seeing)
	Set seeing with the specified Angle value.
Frequency	getSeeingFrequency ()
	Get seeingFrequency.
void	setSeeingFrequency (Frequency seeingFrequency)
	Set seeingFrequency with the specified Frequency value.
Frequency	getSeeingFreqBandwidth ()
	Get seeingFreqBandwidth.
void	setSeeingFreqBandwidth (Frequency seeingFreqBandwidth)
	Set seeingFreqBandwidth with the specified Frequency value.
boolean	isExponentExists ()
	The attribute exponent is optional.
float	getExponent () throws IllegalAccessException
	Get exponent, which is optional.
void	setExponent (float exponent)
	Set exponent with the specified float value.
void	clearExponent ()
	Mark exponent, which is an optional field, as non-existent.
Tag	getCalDataId ()
	Get calDataId.
void	setCalDataId (Tag calDataId) throws IllegalAccessException
	Set calDataId with the specified Tag value.
Tag	getCalReductionId ()
	Get calReductionId.
void	setCalReductionId (Tag calReductionId) throws IllegalAccessException
	Set calReductionId with the specified Tag value.
CalReductionRow	getCalReductionUsingCalReductionId ()
	Returns the pointer to the row in the CalReduction table having CalReduction.calReductionId == calReductionId.
CalDataRow	getCalDataUsingCalDataId ()
	Returns the pointer to the row in the CalData table having CalData.calDataId == calDataId.
boolean	compareNoAutoInc (Tag calDataId, Tag calReductionId, int numBaseLength, ArrayTime startValidTime, ArrayTime endValidTime, Frequency[] frequencyRange, Length[] baseLength, Angle[] corrPhaseRms, Angle[] uncorrPhaseRms, Angle seeing, Frequency seeingFrequency, Frequency seeingFreqBandwidth)
	Compare each attribute except the autoincrementable one of this CalSeeingRow with the corresponding parameters and return true if there is a match and false otherwise.
boolean	equalByRequiredValue (CalSeeingRow x)
	Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
boolean	compareRequiredValue (int numBaseLength, ArrayTime startValidTime, ArrayTime endValidTime, Frequency[] frequencyRange, Length[] baseLength, Angle[] corrPhaseRms, Angle[] uncorrPhaseRms, Angle seeing, Frequency seeingFrequency, Frequency seeingFreqBandwidth)
Package Functions
	CalSeeingRow (CalSeeingTable table)
	Create a CalSeeingRow.
	CalSeeingRow (CalSeeingTable table, CalSeeingRow row)
	Creates a CalSeeingRow 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.

---

Constructor & Destructor Documentation

alma.asdm.CalSeeingRow.CalSeeingRow

(

CalSeeingTable

table

)

[package]

Create a CalSeeingRow.

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.CalSeeingRow.CalSeeingRow	(	CalSeeingTable	table,
		CalSeeingRow	row
	)			[package]

Creates a CalSeeingRow using a copy constructor mechanism.

Given a CalSeeingRow row and a CalSeeingTable table, the method creates a new CalSeeingRow 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

CalSeeingRowIDL alma.asdm.CalSeeingRow.toIDL

(

)

Return this row in the form of an IDL struct.

Returns:

The values of this row as a CalSeeingRowIDL struct.

void alma.asdm.CalSeeingRow.setFromIDL

(

CalSeeingRowIDL

x

)

throws ConversionException

Fill the values of this row from the IDL struct CalSeeingRowIDL.

Parameters:

x

The IDL struct containing the values used to fill this row.

String alma.asdm.CalSeeingRow.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.

void alma.asdm.CalSeeingRow.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.

int alma.asdm.CalSeeingRow.getNumBaseLength

(

)

Get numBaseLength.

Returns:

numBaseLength as int

void alma.asdm.CalSeeingRow.setNumBaseLength

(

int

numBaseLength

)

Set numBaseLength with the specified int value.

Parameters:

numBaseLength

The int value to which numBaseLength is to be set.

ArrayTime alma.asdm.CalSeeingRow.getStartValidTime

(

)

Get startValidTime.

Returns:

startValidTime as ArrayTime

void alma.asdm.CalSeeingRow.setStartValidTime

(

ArrayTime

startValidTime

)

Set startValidTime with the specified ArrayTime value.

Parameters:

startValidTime

The ArrayTime value to which startValidTime is to be set.

ArrayTime alma.asdm.CalSeeingRow.getEndValidTime

(

)

Get endValidTime.

Returns:

endValidTime as ArrayTime

void alma.asdm.CalSeeingRow.setEndValidTime

(

ArrayTime

endValidTime

)

Set endValidTime with the specified ArrayTime value.

Parameters:

endValidTime

The ArrayTime value to which endValidTime is to be set.

Frequency [] alma.asdm.CalSeeingRow.getFrequencyRange

(

)

Get frequencyRange.

Returns:

frequencyRange as Frequency[]

void alma.asdm.CalSeeingRow.setFrequencyRange

(

Frequency[]

frequencyRange

)

Set frequencyRange with the specified Frequency[] value.

Parameters:

frequencyRange

The Frequency[] value to which frequencyRange is to be set.

Length [] alma.asdm.CalSeeingRow.getBaseLength

(

)

Get baseLength.

Returns:

baseLength as Length[]

void alma.asdm.CalSeeingRow.setBaseLength

(

Length[]

baseLength

)

Set baseLength with the specified Length[] value.

Parameters:

baseLength

The Length[] value to which baseLength is to be set.

Angle [] alma.asdm.CalSeeingRow.getCorrPhaseRms

(

)

Get corrPhaseRms.

Returns:

corrPhaseRms as Angle[]

void alma.asdm.CalSeeingRow.setCorrPhaseRms

(

Angle[]

corrPhaseRms

)

Set corrPhaseRms with the specified Angle[] value.

Parameters:

corrPhaseRms

The Angle[] value to which corrPhaseRms is to be set.

Angle [] alma.asdm.CalSeeingRow.getUncorrPhaseRms

(

)

Get uncorrPhaseRms.

Returns:

uncorrPhaseRms as Angle[]

void alma.asdm.CalSeeingRow.setUncorrPhaseRms

(

Angle[]

uncorrPhaseRms

)

Set uncorrPhaseRms with the specified Angle[] value.

Parameters:

uncorrPhaseRms

The Angle[] value to which uncorrPhaseRms is to be set.

Angle alma.asdm.CalSeeingRow.getSeeing

(

)

Get seeing.

Returns:

seeing as Angle

void alma.asdm.CalSeeingRow.setSeeing

(

Angle

seeing

)

Set seeing with the specified Angle value.

Parameters:

seeing

The Angle value to which seeing is to be set.

Frequency alma.asdm.CalSeeingRow.getSeeingFrequency

(

)

Get seeingFrequency.

Returns:

seeingFrequency as Frequency

void alma.asdm.CalSeeingRow.setSeeingFrequency

(

Frequency

seeingFrequency

)

Set seeingFrequency with the specified Frequency value.

Parameters:

seeingFrequency

The Frequency value to which seeingFrequency is to be set.

Frequency alma.asdm.CalSeeingRow.getSeeingFreqBandwidth

(

)

Get seeingFreqBandwidth.

Returns:

seeingFreqBandwidth as Frequency

void alma.asdm.CalSeeingRow.setSeeingFreqBandwidth

(

Frequency

seeingFreqBandwidth

)

Set seeingFreqBandwidth with the specified Frequency value.

Parameters:

seeingFreqBandwidth

The Frequency value to which seeingFreqBandwidth is to be set.

boolean alma.asdm.CalSeeingRow.isExponentExists

(

)

The attribute exponent is optional.

Return true if this attribute exists.

Returns:

true if and only if the exponent attribute exists.

float alma.asdm.CalSeeingRow.getExponent

(

)

throws IllegalAccessException

Get exponent, which is optional.

Returns:

exponent as float

Exceptions:

IllegalAccessException

If exponent does not exist.

void alma.asdm.CalSeeingRow.setExponent

(

float

exponent

)

Set exponent with the specified float value.

Parameters:

exponent

The float value to which exponent is to be set.

Tag alma.asdm.CalSeeingRow.getCalDataId

(

)

Get calDataId.

Returns:

calDataId as Tag

void alma.asdm.CalSeeingRow.setCalDataId

(

Tag

calDataId

)

throws IllegalAccessException

Set calDataId with the specified Tag value.

Parameters:

calDataId

The Tag value to which calDataId is to be set.

Exceptions:

IllegalAccessException

If an attempt is made to change this field after is has been added to the table.

Tag alma.asdm.CalSeeingRow.getCalReductionId

(

)

Get calReductionId.

Returns:

calReductionId as Tag

void alma.asdm.CalSeeingRow.setCalReductionId

(

Tag

calReductionId

)

throws IllegalAccessException

Set calReductionId with the specified Tag value.

Parameters:

calReductionId

The Tag value to which calReductionId is to be set.

Exceptions:

IllegalAccessException

If an attempt is made to change this field after is has been added to the table.

CalReductionRow alma.asdm.CalSeeingRow.getCalReductionUsingCalReductionId

(

)

Returns the pointer to the row in the CalReduction table having CalReduction.calReductionId == calReductionId.

Returns:

a CalReductionRow

CalDataRow alma.asdm.CalSeeingRow.getCalDataUsingCalDataId

(

)

Returns the pointer to the row in the CalData table having CalData.calDataId == calDataId.

Returns:

a CalDataRow

boolean alma.asdm.CalSeeingRow.equalByRequiredValue

(

CalSeeingRow

x

)

Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.

Parameters:

x

the CalSeeingRow whose required attributes of the value part will be compared with those of this.

Returns:

a boolean.

Object [] alma.asdm.CalSeeingRow.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.

---

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

• CalSeeingRow.java

---