alma.asdm.ReceiverRow Class Reference

Inherits alma.asdm.ASDMRow.

List of all members.

---

Detailed Description

The ReceiverRow class is a row of a ReceiverTable.

Generated from model's revision 1.41, branch HEAD

Public Member Functions
ReceiverTable	getTable ()
	Return the table to which this row belongs.
ReceiverRowIDL	toIDL ()
	Return this row in the form of an IDL struct.
void	setFromIDL (ReceiverRowIDL x) throws ConversionException
	Fill the values of this row from the IDL struct ReceiverRowIDL.
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.
ArrayTimeInterval	getTimeInterval ()
	Get timeInterval.
void	setTimeInterval (ArrayTimeInterval timeInterval) throws IllegalAccessException
	Set timeInterval with the specified ArrayTimeInterval value.
int	getNumLo ()
	Get numLo.
void	setNumLo (int numLo)
	Set numLo with the specified int value.
String	getName ()
	Get name.
void	setName (String name)
	Set name with the specified String value.
ReceiverBand	getFrequencyBand ()
	Get frequencyBand.
void	setFrequencyBand (ReceiverBand frequencyBand)
	Set frequencyBand with the specified ReceiverBand value.
Frequency[]	getFreqLo ()
	Get freqLo.
void	setFreqLo (Frequency[] freqLo)
	Set freqLo with the specified Frequency[] value.
ReceiverSideband	getReceiverSideband ()
	Get receiverSideband.
void	setReceiverSideband (ReceiverSideband receiverSideband)
	Set receiverSideband with the specified ReceiverSideband value.
int[]	getSidebandLo ()
	Get sidebandLo.
void	setSidebandLo (int[] sidebandLo)
	Set sidebandLo with the specified int[] value.
boolean	isDewarNameExists ()
	The attribute dewarName is optional.
String	getDewarName () throws IllegalAccessException
	Get dewarName, which is optional.
void	setDewarName (String dewarName)
	Set dewarName with the specified String value.
void	clearDewarName ()
	Mark dewarName, which is an optional field, as non-existent.
Temperature	getTDewar ()
	Get tDewar.
void	setTDewar (Temperature tDewar)
	Set tDewar with the specified Temperature value.
Interval	getStabilityDuration ()
	Get stabilityDuration.
void	setStabilityDuration (Interval stabilityDuration)
	Set stabilityDuration with the specified Interval value.
double	getStability ()
	Get stability.
void	setStability (double stability)
	Set stability with the specified double value.
boolean	isStabilityflagExists ()
	The attribute stabilityflag is optional.
boolean	getStabilityflag () throws IllegalAccessException
	Get stabilityflag, which is optional.
void	setStabilityflag (boolean stabilityflag)
	Set stabilityflag with the specified boolean value.
void	clearStabilityflag ()
	Mark stabilityflag, which is an optional field, as non-existent.
int	getReceiverId ()
	Get receiverId.
Tag	getSpectralWindowId ()
	Get spectralWindowId.
void	setSpectralWindowId (Tag spectralWindowId) throws IllegalAccessException
	Set spectralWindowId with the specified Tag value.
SpectralWindowRow	getSpectralWindowUsingSpectralWindowId ()
	Returns the pointer to the row in the SpectralWindow table having SpectralWindow.spectralWindowId == spectralWindowId.
boolean	compareNoAutoInc (Tag spectralWindowId, ArrayTimeInterval timeInterval, int numLo, String name, ReceiverBand frequencyBand, Frequency[] freqLo, ReceiverSideband receiverSideband, int[] sidebandLo, Temperature tDewar, Interval stabilityDuration, double stability)
	Compare each attribute except the autoincrementable one of this ReceiverRow with the corresponding parameters and return true if there is a match and false otherwise.
boolean	equalByRequiredValue (ReceiverRow x)
	Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
boolean	compareRequiredValue (int numLo, String name, ReceiverBand frequencyBand, Frequency[] freqLo, ReceiverSideband receiverSideband, int[] sidebandLo, Temperature tDewar, Interval stabilityDuration, double stability)
Protected Member Functions
void	setReceiverId (int receiverId) throws IllegalAccessException
	Set receiverId with the specified int value.
Package Functions
	ReceiverRow (ReceiverTable table)
	Create a ReceiverRow.
	ReceiverRow (ReceiverTable table, ReceiverRow row)
	Creates a ReceiverRow 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.ReceiverRow.ReceiverRow

(

ReceiverTable

table

)

[package]

Create a ReceiverRow.

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

Creates a ReceiverRow using a copy constructor mechanism.

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

ReceiverRowIDL alma.asdm.ReceiverRow.toIDL

(

)

Return this row in the form of an IDL struct.

Returns:

The values of this row as a ReceiverRowIDL struct.

void alma.asdm.ReceiverRow.setFromIDL

(

ReceiverRowIDL

x

)

throws ConversionException

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

Parameters:

x

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

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

ArrayTimeInterval alma.asdm.ReceiverRow.getTimeInterval

(

)

Get timeInterval.

Returns:

timeInterval as ArrayTimeInterval

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

int alma.asdm.ReceiverRow.getNumLo

(

)

Get numLo.

Returns:

numLo as int

void alma.asdm.ReceiverRow.setNumLo

(

int

numLo

)

Set numLo with the specified int value.

Parameters:

numLo

The int value to which numLo is to be set.

String alma.asdm.ReceiverRow.getName

(

)

Get name.

Returns:

name as String

void alma.asdm.ReceiverRow.setName

(

String

name

)

Set name with the specified String value.

Parameters:

name

The String value to which name is to be set.

ReceiverBand alma.asdm.ReceiverRow.getFrequencyBand

(

)

Get frequencyBand.

Returns:

frequencyBand as ReceiverBand

void alma.asdm.ReceiverRow.setFrequencyBand

(

ReceiverBand

frequencyBand

)

Set frequencyBand with the specified ReceiverBand value.

Parameters:

frequencyBand

The ReceiverBand value to which frequencyBand is to be set.

Frequency [] alma.asdm.ReceiverRow.getFreqLo

(

)

Get freqLo.

Returns:

freqLo as Frequency[]

void alma.asdm.ReceiverRow.setFreqLo

(

Frequency[]

freqLo

)

Set freqLo with the specified Frequency[] value.

Parameters:

freqLo

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

ReceiverSideband alma.asdm.ReceiverRow.getReceiverSideband

(

)

Get receiverSideband.

Returns:

receiverSideband as ReceiverSideband

void alma.asdm.ReceiverRow.setReceiverSideband

(

ReceiverSideband

receiverSideband

)

Set receiverSideband with the specified ReceiverSideband value.

Parameters:

receiverSideband

The ReceiverSideband value to which receiverSideband is to be set.

int [] alma.asdm.ReceiverRow.getSidebandLo

(

)

Get sidebandLo.

Returns:

sidebandLo as int[]

void alma.asdm.ReceiverRow.setSidebandLo

(

int[]

sidebandLo

)

Set sidebandLo with the specified int[] value.

Parameters:

sidebandLo

The int[] value to which sidebandLo is to be set.

boolean alma.asdm.ReceiverRow.isDewarNameExists

(

)

The attribute dewarName is optional.

Return true if this attribute exists.

Returns:

true if and only if the dewarName attribute exists.

String alma.asdm.ReceiverRow.getDewarName

(

)

throws IllegalAccessException

Get dewarName, which is optional.

Returns:

dewarName as String

Exceptions:

IllegalAccessException

If dewarName does not exist.

void alma.asdm.ReceiverRow.setDewarName

(

String

dewarName

)

Set dewarName with the specified String value.

Parameters:

dewarName

The String value to which dewarName is to be set.

Temperature alma.asdm.ReceiverRow.getTDewar

(

)

Get tDewar.

Returns:

tDewar as Temperature

void alma.asdm.ReceiverRow.setTDewar

(

Temperature

tDewar

)

Set tDewar with the specified Temperature value.

Parameters:

tDewar

The Temperature value to which tDewar is to be set.

Interval alma.asdm.ReceiverRow.getStabilityDuration

(

)

Get stabilityDuration.

Returns:

stabilityDuration as Interval

void alma.asdm.ReceiverRow.setStabilityDuration

(

Interval

stabilityDuration

)

Set stabilityDuration with the specified Interval value.

Parameters:

stabilityDuration

The Interval value to which stabilityDuration is to be set.

double alma.asdm.ReceiverRow.getStability

(

)

Get stability.

Returns:

stability as double

void alma.asdm.ReceiverRow.setStability

(

double

stability

)

Set stability with the specified double value.

Parameters:

stability

The double value to which stability is to be set.

boolean alma.asdm.ReceiverRow.isStabilityflagExists

(

)

The attribute stabilityflag is optional.

Return true if this attribute exists.

Returns:

true if and only if the stabilityflag attribute exists.

boolean alma.asdm.ReceiverRow.getStabilityflag

(

)

throws IllegalAccessException

Get stabilityflag, which is optional.

Returns:

stabilityflag as boolean

Exceptions:

IllegalAccessException

If stabilityflag does not exist.

void alma.asdm.ReceiverRow.setStabilityflag

(

boolean

stabilityflag

)

Set stabilityflag with the specified boolean value.

Parameters:

stabilityflag

The boolean value to which stabilityflag is to be set.

int alma.asdm.ReceiverRow.getReceiverId

(

)

Get receiverId.

Returns:

receiverId as int

void alma.asdm.ReceiverRow.setReceiverId

(

int

receiverId

)

throws IllegalAccessException [protected]

Set receiverId with the specified int value.

Parameters:

receiverId

The int value to which receiverId 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.ReceiverRow.getSpectralWindowId

(

)

Get spectralWindowId.

Returns:

spectralWindowId as Tag

void alma.asdm.ReceiverRow.setSpectralWindowId

(

Tag

spectralWindowId

)

throws IllegalAccessException

Set spectralWindowId with the specified Tag value.

Parameters:

spectralWindowId

The Tag value to which spectralWindowId is to be set.

Exceptions:

IllegalAccessException

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

SpectralWindowRow alma.asdm.ReceiverRow.getSpectralWindowUsingSpectralWindowId

(

)

Returns the pointer to the row in the SpectralWindow table having SpectralWindow.spectralWindowId == spectralWindowId.

Returns:

a SpectralWindowRow

boolean alma.asdm.ReceiverRow.equalByRequiredValue

(

ReceiverRow

x

)

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

Parameters:

x

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

Returns:

a boolean.

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

• ReceiverRow.java

---