alma.asdm.CalAmpliRow Class Reference

Inherits alma.asdm.ASDMRow.

List of all members.

---

Detailed Description

The CalAmpliRow class is a row of a CalAmpliTable.

Generated from model's revision 1.41, branch HEAD

Public Member Functions
CalAmpliTable	getTable ()
	Return the table to which this row belongs.
CalAmpliRowIDL	toIDL ()
	Return this row in the form of an IDL struct.
void	setFromIDL (CalAmpliRowIDL x) throws ConversionException
	Fill the values of this row from the IDL struct CalAmpliRowIDL.
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	getNumAPC ()
	Get numAPC.
void	setNumAPC (int numAPC)
	Set numAPC with the specified int value.
int	getNumReceptor ()
	Get numReceptor.
void	setNumReceptor (int numReceptor)
	Set numReceptor with the specified int value.
ReceiverBand	getReceiverBand ()
	Get receiverBand.
void	setReceiverBand (ReceiverBand receiverBand)
	Set receiverBand with the specified ReceiverBand value.
String	getAntennaName ()
	Get antennaName.
void	setAntennaName (String antennaName) throws IllegalAccessException
	Set antennaName with the specified String value.
AtmPhaseCorrection[]	getAtmPhaseCorrections ()
	Get atmPhaseCorrections.
void	setAtmPhaseCorrections (AtmPhaseCorrection[] atmPhaseCorrections)
	Set atmPhaseCorrections with the specified AtmPhaseCorrection[] value.
PolarizationType[]	getPolarizationTypes ()
	Get polarizationTypes.
void	setPolarizationTypes (PolarizationType[] polarizationTypes)
	Set polarizationTypes with the specified PolarizationType[] 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.
boolean	isApertureEfficiencyExists ()
	The attribute apertureEfficiency is optional.
float[][]	getApertureEfficiency () throws IllegalAccessException
	Get apertureEfficiency, which is optional.
void	setApertureEfficiency (float[][] apertureEfficiency)
	Set apertureEfficiency with the specified float[][] value.
void	clearApertureEfficiency ()
	Mark apertureEfficiency, which is an optional field, as non-existent.
boolean	isApertureEfficiencyErrorExists ()
	The attribute apertureEfficiencyError is optional.
float[][]	getApertureEfficiencyError () throws IllegalAccessException
	Get apertureEfficiencyError, which is optional.
void	setApertureEfficiencyError (float[][] apertureEfficiencyError)
	Set apertureEfficiencyError with the specified float[][] value.
void	clearApertureEfficiencyError ()
	Mark apertureEfficiencyError, which is an optional field, as non-existent.
boolean	isCorrectionValidityExists ()
	The attribute correctionValidity is optional.
boolean	getCorrectionValidity () throws IllegalAccessException
	Get correctionValidity, which is optional.
void	setCorrectionValidity (boolean correctionValidity)
	Set correctionValidity with the specified boolean value.
void	clearCorrectionValidity ()
	Mark correctionValidity, 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.
CalDataRow	getCalDataUsingCalDataId ()
	Returns the pointer to the row in the CalData table having CalData.calDataId == calDataId.
CalReductionRow	getCalReductionUsingCalReductionId ()
	Returns the pointer to the row in the CalReduction table having CalReduction.calReductionId == calReductionId.
boolean	compareNoAutoInc (Tag calDataId, Tag calReductionId, String antennaName, int numAPC, int numReceptor, ReceiverBand receiverBand, AtmPhaseCorrection[] atmPhaseCorrections, PolarizationType[] polarizationTypes, ArrayTime startValidTime, ArrayTime endValidTime, Frequency[] frequencyRange)
	Compare each attribute except the autoincrementable one of this CalAmpliRow with the corresponding parameters and return true if there is a match and false otherwise.
boolean	equalByRequiredValue (CalAmpliRow x)
	Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
boolean	compareRequiredValue (int numAPC, int numReceptor, ReceiverBand receiverBand, AtmPhaseCorrection[] atmPhaseCorrections, PolarizationType[] polarizationTypes, ArrayTime startValidTime, ArrayTime endValidTime, Frequency[] frequencyRange)
Package Functions
	CalAmpliRow (CalAmpliTable table)
	Create a CalAmpliRow.
	CalAmpliRow (CalAmpliTable table, CalAmpliRow row)
	Creates a CalAmpliRow 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.CalAmpliRow.CalAmpliRow

(

CalAmpliTable

table

)

[package]

Create a CalAmpliRow.

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

Creates a CalAmpliRow using a copy constructor mechanism.

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

CalAmpliRowIDL alma.asdm.CalAmpliRow.toIDL

(

)

Return this row in the form of an IDL struct.

Returns:

The values of this row as a CalAmpliRowIDL struct.

void alma.asdm.CalAmpliRow.setFromIDL

(

CalAmpliRowIDL

x

)

throws ConversionException

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

Parameters:

x

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

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

(

)

Get numAPC.

Returns:

numAPC as int

void alma.asdm.CalAmpliRow.setNumAPC

(

int

numAPC

)

Set numAPC with the specified int value.

Parameters:

numAPC

The int value to which numAPC is to be set.

int alma.asdm.CalAmpliRow.getNumReceptor

(

)

Get numReceptor.

Returns:

numReceptor as int

void alma.asdm.CalAmpliRow.setNumReceptor

(

int

numReceptor

)

Set numReceptor with the specified int value.

Parameters:

numReceptor

The int value to which numReceptor is to be set.

ReceiverBand alma.asdm.CalAmpliRow.getReceiverBand

(

)

Get receiverBand.

Returns:

receiverBand as ReceiverBand

void alma.asdm.CalAmpliRow.setReceiverBand

(

ReceiverBand

receiverBand

)

Set receiverBand with the specified ReceiverBand value.

Parameters:

receiverBand

The ReceiverBand value to which receiverBand is to be set.

String alma.asdm.CalAmpliRow.getAntennaName

(

)

Get antennaName.

Returns:

antennaName as String

void alma.asdm.CalAmpliRow.setAntennaName

(

String

antennaName

)

throws IllegalAccessException

Set antennaName with the specified String value.

Parameters:

antennaName

The String value to which antennaName is to be set.

Exceptions:

IllegalAccessException

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

AtmPhaseCorrection [] alma.asdm.CalAmpliRow.getAtmPhaseCorrections

(

)

Get atmPhaseCorrections.

Returns:

atmPhaseCorrections as AtmPhaseCorrection[]

void alma.asdm.CalAmpliRow.setAtmPhaseCorrections

(

AtmPhaseCorrection[]

atmPhaseCorrections

)

Set atmPhaseCorrections with the specified AtmPhaseCorrection[] value.

Parameters:

atmPhaseCorrections

The AtmPhaseCorrection[] value to which atmPhaseCorrections is to be set.

PolarizationType [] alma.asdm.CalAmpliRow.getPolarizationTypes

(

)

Get polarizationTypes.

Returns:

polarizationTypes as PolarizationType[]

void alma.asdm.CalAmpliRow.setPolarizationTypes

(

PolarizationType[]

polarizationTypes

)

Set polarizationTypes with the specified PolarizationType[] value.

Parameters:

polarizationTypes

The PolarizationType[] value to which polarizationTypes is to be set.

ArrayTime alma.asdm.CalAmpliRow.getStartValidTime

(

)

Get startValidTime.

Returns:

startValidTime as ArrayTime

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

(

)

Get endValidTime.

Returns:

endValidTime as ArrayTime

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

(

)

Get frequencyRange.

Returns:

frequencyRange as Frequency[]

void alma.asdm.CalAmpliRow.setFrequencyRange

(

Frequency[]

frequencyRange

)

Set frequencyRange with the specified Frequency[] value.

Parameters:

frequencyRange

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

boolean alma.asdm.CalAmpliRow.isApertureEfficiencyExists

(

)

The attribute apertureEfficiency is optional.

Return true if this attribute exists.

Returns:

true if and only if the apertureEfficiency attribute exists.

float [][] alma.asdm.CalAmpliRow.getApertureEfficiency

(

)

throws IllegalAccessException

Get apertureEfficiency, which is optional.

Returns:

apertureEfficiency as float[][]

Exceptions:

IllegalAccessException

If apertureEfficiency does not exist.

void alma.asdm.CalAmpliRow.setApertureEfficiency

(

float

apertureEfficiency[][]

)

Set apertureEfficiency with the specified float[][] value.

Parameters:

apertureEfficiency

The float[][] value to which apertureEfficiency is to be set.

boolean alma.asdm.CalAmpliRow.isApertureEfficiencyErrorExists

(

)

The attribute apertureEfficiencyError is optional.

Return true if this attribute exists.

Returns:

true if and only if the apertureEfficiencyError attribute exists.

float [][] alma.asdm.CalAmpliRow.getApertureEfficiencyError

(

)

throws IllegalAccessException

Get apertureEfficiencyError, which is optional.

Returns:

apertureEfficiencyError as float[][]

Exceptions:

IllegalAccessException

If apertureEfficiencyError does not exist.

void alma.asdm.CalAmpliRow.setApertureEfficiencyError

(

float

apertureEfficiencyError[][]

)

Set apertureEfficiencyError with the specified float[][] value.

Parameters:

apertureEfficiencyError

The float[][] value to which apertureEfficiencyError is to be set.

boolean alma.asdm.CalAmpliRow.isCorrectionValidityExists

(

)

The attribute correctionValidity is optional.

Return true if this attribute exists.

Returns:

true if and only if the correctionValidity attribute exists.

boolean alma.asdm.CalAmpliRow.getCorrectionValidity

(

)

throws IllegalAccessException

Get correctionValidity, which is optional.

Returns:

correctionValidity as boolean

Exceptions:

IllegalAccessException

If correctionValidity does not exist.

void alma.asdm.CalAmpliRow.setCorrectionValidity

(

boolean

correctionValidity

)

Set correctionValidity with the specified boolean value.

Parameters:

correctionValidity

The boolean value to which correctionValidity is to be set.

Tag alma.asdm.CalAmpliRow.getCalDataId

(

)

Get calDataId.

Returns:

calDataId as Tag

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

(

)

Get calReductionId.

Returns:

calReductionId as Tag

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

CalDataRow alma.asdm.CalAmpliRow.getCalDataUsingCalDataId

(

)

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

Returns:

a CalDataRow

CalReductionRow alma.asdm.CalAmpliRow.getCalReductionUsingCalReductionId

(

)

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

Returns:

a CalReductionRow

boolean alma.asdm.CalAmpliRow.equalByRequiredValue

(

CalAmpliRow

x

)

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

Parameters:

x

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

Returns:

a boolean.

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

• CalAmpliRow.java

---