alma.asdm.ConfigDescriptionRow Class Reference

Inherits alma.asdm.ASDMRow.

List of all members.

---

Detailed Description

The ConfigDescriptionRow class is a row of a ConfigDescriptionTable.

Generated from model's revision 1.41, branch HEAD

Public Member Functions
ConfigDescriptionTable	getTable ()
	Return the table to which this row belongs.
ConfigDescriptionRowIDL	toIDL ()
	Return this row in the form of an IDL struct.
void	setFromIDL (ConfigDescriptionRowIDL x) throws ConversionException
	Fill the values of this row from the IDL struct ConfigDescriptionRowIDL.
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	getNumAntenna ()
	Get numAntenna.
void	setNumAntenna (int numAntenna)
	Set numAntenna with the specified int value.
int	getNumFeed ()
	Get numFeed.
void	setNumFeed (int numFeed)
	Set numFeed with the specified int value.
int[]	getNumSubBand ()
	Get numSubBand.
void	setNumSubBand (int[] numSubBand)
	Set numSubBand with the specified int[] value.
boolean	isPhasedArrayListExists ()
	The attribute phasedArrayList is optional.
int[]	getPhasedArrayList () throws IllegalAccessException
	Get phasedArrayList, which is optional.
void	setPhasedArrayList (int[] phasedArrayList)
	Set phasedArrayList with the specified int[] value.
void	clearPhasedArrayList ()
	Mark phasedArrayList, which is an optional field, as non-existent.
CorrelationMode	getCorrelationMode ()
	Get correlationMode.
void	setCorrelationMode (CorrelationMode correlationMode)
	Set correlationMode with the specified CorrelationMode value.
boolean	isFlagAntExists ()
	The attribute flagAnt is optional.
boolean[]	getFlagAnt () throws IllegalAccessException
	Get flagAnt, which is optional.
void	setFlagAnt (boolean[] flagAnt)
	Set flagAnt with the specified boolean[] value.
void	clearFlagAnt ()
	Mark flagAnt, which is an optional field, as non-existent.
Tag	getConfigDescriptionId ()
	Get configDescriptionId.
AtmPhaseCorrection	getAtmPhaseCorrection ()
	Get atmPhaseCorrection.
void	setAtmPhaseCorrection (AtmPhaseCorrection atmPhaseCorrection)
	Set atmPhaseCorrection with the specified AtmPhaseCorrection value.
boolean	isAssocNatureExists ()
	The attribute assocNature is optional.
SpectralResolutionType[]	getAssocNature () throws IllegalAccessException
	Get assocNature, which is optional.
void	setAssocNature (SpectralResolutionType[] assocNature)
	Set assocNature with the specified SpectralResolutionType[] value.
void	clearAssocNature ()
	Mark assocNature, which is an optional field, as non-existent.
Tag[]	getAntennaId ()
	Get antennaId.
void	setAntennaId (Tag[] antennaId)
	Set antennaId with the specified Tag[] value.
boolean	isAssocConfigDescriptionIdExists ()
	The attribute assocConfigDescriptionId is optional.
Tag[]	getAssocConfigDescriptionId () throws IllegalAccessException
	Get assocConfigDescriptionId, which is optional.
void	setAssocConfigDescriptionId (Tag[] assocConfigDescriptionId)
	Set assocConfigDescriptionId with the specified Tag[] value.
void	clearAssocConfigDescriptionId ()
	Mark assocConfigDescriptionId, which is an optional field, as non-existent.
Tag[]	getDataDescriptionId ()
	Get dataDescriptionId.
void	setDataDescriptionId (Tag[] dataDescriptionId)
	Set dataDescriptionId with the specified Tag[] value.
int[]	getFeedId ()
	Get feedId.
void	setFeedId (int[] feedId)
	Set feedId with the specified int[] value.
Tag	getProcessorId ()
	Get processorId.
void	setProcessorId (Tag processorId)
	Set processorId with the specified Tag value.
Tag[]	getSwitchCycleId ()
	Get switchCycleId.
void	setSwitchCycleId (Tag[] switchCycleId)
	Set switchCycleId with the specified Tag[] value.
ProcessorRow	getProcessorUsingProcessorId ()
	Returns the pointer to the row in the Processor table having Processor.processorId == processorId.
void	setAntennaId (int i, Tag antennaId) throws IndexOutOfBoundsException
	Set antennaId[i] with the specified Tag value.
void	setDataDescriptionId (int i, Tag dataDescriptionId) throws IndexOutOfBoundsException
	Set dataDescriptionId[i] with the specified Tag value.
void	setSwitchCycleId (int i, Tag switchCycleId) throws IndexOutOfBoundsException
	Set switchCycleId[i] with the specified Tag value.
void	setFeedId (int i, int feedId) throws IndexOutOfBoundsException
	Set feedId[i] with the specified int value.
FeedRow[]	getFeeds (int i) throws IndexOutOfBoundsException, InvalidAccessException, NoSuchRow
FeedRow[]	getFeeds () throws InvalidAccessException, NoSuchRow
void	setAssocConfigDescriptionId (int i, Tag assocConfigDescriptionId) throws IllegalAccessException, IndexOutOfBoundsException
	Set assocConfigDescriptionId[i] with the specified Tag value.
boolean	compareNoAutoInc (Tag[] antennaId, Tag[] dataDescriptionId, int[] feedId, Tag processorId, Tag[] switchCycleId, int numAntenna, int numFeed, int[] numSubBand, CorrelationMode correlationMode, AtmPhaseCorrection atmPhaseCorrection)
	Compare each attribute except the autoincrementable one of this ConfigDescriptionRow with the corresponding parameters and return true if there is a match and false otherwise.
boolean	equalByRequiredValue (ConfigDescriptionRow x)
	Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
boolean	compareRequiredValue (Tag[] antennaId, Tag[] dataDescriptionId, int[] feedId, Tag processorId, Tag[] switchCycleId, int numAntenna, int numFeed, int[] numSubBand, CorrelationMode correlationMode, AtmPhaseCorrection atmPhaseCorrection)
Protected Member Functions
void	setConfigDescriptionId (Tag configDescriptionId) throws IllegalAccessException
	Set configDescriptionId with the specified Tag value.
Package Functions
	ConfigDescriptionRow (ConfigDescriptionTable table)
	Create a ConfigDescriptionRow.
	ConfigDescriptionRow (ConfigDescriptionTable table, ConfigDescriptionRow row)
	Creates a ConfigDescriptionRow using a copy constructor mechanism.
void	isAdded ()
void	addAntennaId (Tag id)
	Append a Tag to antennaId.
void	addAntennaId (Tag[] id)
	Append an array of Tag to antennaId.
Tag	getAntennaId (int i) throws IndexOutOfBoundsException
	Returns the Tag stored in antennaId at position i.
AntennaRow	getAntenna (int i) throws IndexOutOfBoundsException, NoSuchRow
	Returns the AntennaRow linked to this row via the Tag stored in antennaId at position i.
AntennaRow[]	getAntennas () throws NoSuchRow
	Returns the array of AntennaRow linked to this row via the Tags stored in antennaId.
void	addDataDescriptionId (Tag id)
	Append a Tag to dataDescriptionId.
void	addDataDescriptionId (Tag[] id)
	Append an array of Tag to dataDescriptionId.
Tag	getDataDescriptionId (int i) throws IndexOutOfBoundsException
	Returns the Tag stored in dataDescriptionId at position i.
DataDescriptionRow	getDataDescription (int i) throws IndexOutOfBoundsException, NoSuchRow
	Returns the DataDescriptionRow linked to this row via the Tag stored in dataDescriptionId at position i.
DataDescriptionRow[]	getDataDescriptions () throws NoSuchRow
	Returns the array of DataDescriptionRow linked to this row via the Tags stored in dataDescriptionId.
void	addSwitchCycleId (Tag id)
	Append a Tag to switchCycleId.
void	addSwitchCycleId (Tag[] id)
	Append an array of Tag to switchCycleId.
Tag	getSwitchCycleId (int i) throws IndexOutOfBoundsException
	Returns the Tag stored in switchCycleId at position i.
SwitchCycleRow	getSwitchCycle (int i) throws IndexOutOfBoundsException, NoSuchRow
	Returns the SwitchCycleRow linked to this row via the Tag stored in switchCycleId at position i.
SwitchCycleRow[]	getSwitchCycles () throws NoSuchRow
	Returns the array of SwitchCycleRow linked to this row via the Tags stored in switchCycleId.
void	addFeedId (int id)
	Append a new id to feedId.
void	addFeedId (int[] id)
	Append an array of ids to feedId.
void	addAssocConfigDescriptionId (Tag id)
	Append a Tag to assocConfigDescriptionId.
void	addAssocConfigDescriptionId (Tag[] id)
	Append an array of Tag to assocConfigDescriptionId.
Tag	getAssocConfigDescriptionId (int i) throws IndexOutOfBoundsException
	Returns the Tag stored in assocConfigDescriptionId at position i.
ConfigDescriptionRow	getConfigDescription (int i) throws IndexOutOfBoundsException, NoSuchRow
	Returns the ConfigDescriptionRow linked to this row via the Tag stored in assocConfigDescriptionId at position i.
ConfigDescriptionRow[]	getConfigDescriptions () throws NoSuchRow
	Returns the array of ConfigDescriptionRow linked to this row via the Tags stored in assocConfigDescriptionId.
Object[]	getAttributesValues ()
	Returns all the attributes of an attribute of an ASDM table as an array of Object.

---

Constructor & Destructor Documentation

alma.asdm.ConfigDescriptionRow.ConfigDescriptionRow

(

ConfigDescriptionTable

table

)

[package]

Create a ConfigDescriptionRow.

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

Creates a ConfigDescriptionRow using a copy constructor mechanism.

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

ConfigDescriptionRowIDL alma.asdm.ConfigDescriptionRow.toIDL

(

)

Return this row in the form of an IDL struct.

Returns:

The values of this row as a ConfigDescriptionRowIDL struct.

void alma.asdm.ConfigDescriptionRow.setFromIDL

(

ConfigDescriptionRowIDL

x

)

throws ConversionException

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

Parameters:

x

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

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

(

)

Get numAntenna.

Returns:

numAntenna as int

void alma.asdm.ConfigDescriptionRow.setNumAntenna

(

int

numAntenna

)

Set numAntenna with the specified int value.

Parameters:

numAntenna

The int value to which numAntenna is to be set.

int alma.asdm.ConfigDescriptionRow.getNumFeed

(

)

Get numFeed.

Returns:

numFeed as int

void alma.asdm.ConfigDescriptionRow.setNumFeed

(

int

numFeed

)

Set numFeed with the specified int value.

Parameters:

numFeed

The int value to which numFeed is to be set.

int [] alma.asdm.ConfigDescriptionRow.getNumSubBand

(

)

Get numSubBand.

Returns:

numSubBand as int[]

void alma.asdm.ConfigDescriptionRow.setNumSubBand

(

int[]

numSubBand

)

Set numSubBand with the specified int[] value.

Parameters:

numSubBand

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

boolean alma.asdm.ConfigDescriptionRow.isPhasedArrayListExists

(

)

The attribute phasedArrayList is optional.

Return true if this attribute exists.

Returns:

true if and only if the phasedArrayList attribute exists.

int [] alma.asdm.ConfigDescriptionRow.getPhasedArrayList

(

)

throws IllegalAccessException

Get phasedArrayList, which is optional.

Returns:

phasedArrayList as int[]

Exceptions:

IllegalAccessException

If phasedArrayList does not exist.

void alma.asdm.ConfigDescriptionRow.setPhasedArrayList

(

int[]

phasedArrayList

)

Set phasedArrayList with the specified int[] value.

Parameters:

phasedArrayList

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

CorrelationMode alma.asdm.ConfigDescriptionRow.getCorrelationMode

(

)

Get correlationMode.

Returns:

correlationMode as CorrelationMode

void alma.asdm.ConfigDescriptionRow.setCorrelationMode

(

CorrelationMode

correlationMode

)

Set correlationMode with the specified CorrelationMode value.

Parameters:

correlationMode

The CorrelationMode value to which correlationMode is to be set.

boolean alma.asdm.ConfigDescriptionRow.isFlagAntExists

(

)

The attribute flagAnt is optional.

Return true if this attribute exists.

Returns:

true if and only if the flagAnt attribute exists.

boolean [] alma.asdm.ConfigDescriptionRow.getFlagAnt

(

)

throws IllegalAccessException

Get flagAnt, which is optional.

Returns:

flagAnt as boolean[]

Exceptions:

IllegalAccessException

If flagAnt does not exist.

void alma.asdm.ConfigDescriptionRow.setFlagAnt

(

boolean[]

flagAnt

)

Set flagAnt with the specified boolean[] value.

Parameters:

flagAnt

The boolean[] value to which flagAnt is to be set.

Tag alma.asdm.ConfigDescriptionRow.getConfigDescriptionId

(

)

Get configDescriptionId.

Returns:

configDescriptionId as Tag

void alma.asdm.ConfigDescriptionRow.setConfigDescriptionId

(

Tag

configDescriptionId

)

throws IllegalAccessException [protected]

Set configDescriptionId with the specified Tag value.

Parameters:

configDescriptionId

The Tag value to which configDescriptionId 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.ConfigDescriptionRow.getAtmPhaseCorrection

(

)

Get atmPhaseCorrection.

Returns:

atmPhaseCorrection as AtmPhaseCorrection

void alma.asdm.ConfigDescriptionRow.setAtmPhaseCorrection

(

AtmPhaseCorrection

atmPhaseCorrection

)

Set atmPhaseCorrection with the specified AtmPhaseCorrection value.

Parameters:

atmPhaseCorrection

The AtmPhaseCorrection value to which atmPhaseCorrection is to be set.

boolean alma.asdm.ConfigDescriptionRow.isAssocNatureExists

(

)

The attribute assocNature is optional.

Return true if this attribute exists.

Returns:

true if and only if the assocNature attribute exists.

SpectralResolutionType [] alma.asdm.ConfigDescriptionRow.getAssocNature

(

)

throws IllegalAccessException

Get assocNature, which is optional.

Returns:

assocNature as SpectralResolutionType[]

Exceptions:

IllegalAccessException

If assocNature does not exist.

void alma.asdm.ConfigDescriptionRow.setAssocNature

(

SpectralResolutionType[]

assocNature

)

Set assocNature with the specified SpectralResolutionType[] value.

Parameters:

assocNature

The SpectralResolutionType[] value to which assocNature is to be set.

Tag [] alma.asdm.ConfigDescriptionRow.getAntennaId

(

)

Get antennaId.

Returns:

antennaId as Tag[]

void alma.asdm.ConfigDescriptionRow.setAntennaId

(

Tag[]

antennaId

)

Set antennaId with the specified Tag[] value.

Parameters:

antennaId

The Tag[] value to which antennaId is to be set.

boolean alma.asdm.ConfigDescriptionRow.isAssocConfigDescriptionIdExists

(

)

The attribute assocConfigDescriptionId is optional.

Return true if this attribute exists.

Returns:

true if and only if the assocConfigDescriptionId attribute exists.

Tag [] alma.asdm.ConfigDescriptionRow.getAssocConfigDescriptionId

(

)

throws IllegalAccessException

Get assocConfigDescriptionId, which is optional.

Returns:

assocConfigDescriptionId as Tag[]

Exceptions:

IllegalAccessException

If assocConfigDescriptionId does not exist.

void alma.asdm.ConfigDescriptionRow.setAssocConfigDescriptionId

(

Tag[]

assocConfigDescriptionId

)

Set assocConfigDescriptionId with the specified Tag[] value.

Parameters:

assocConfigDescriptionId

The Tag[] value to which assocConfigDescriptionId is to be set.

Tag [] alma.asdm.ConfigDescriptionRow.getDataDescriptionId

(

)

Get dataDescriptionId.

Returns:

dataDescriptionId as Tag[]

void alma.asdm.ConfigDescriptionRow.setDataDescriptionId

(

Tag[]

dataDescriptionId

)

Set dataDescriptionId with the specified Tag[] value.

Parameters:

dataDescriptionId

The Tag[] value to which dataDescriptionId is to be set.

int [] alma.asdm.ConfigDescriptionRow.getFeedId

(

)

Get feedId.

Returns:

feedId as int[]

void alma.asdm.ConfigDescriptionRow.setFeedId

(

int[]

feedId

)

Set feedId with the specified int[] value.

Parameters:

feedId

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

Tag alma.asdm.ConfigDescriptionRow.getProcessorId

(

)

Get processorId.

Returns:

processorId as Tag

void alma.asdm.ConfigDescriptionRow.setProcessorId

(

Tag

processorId

)

Set processorId with the specified Tag value.

Parameters:

processorId

The Tag value to which processorId is to be set.

Tag [] alma.asdm.ConfigDescriptionRow.getSwitchCycleId

(

)

Get switchCycleId.

Returns:

switchCycleId as Tag[]

void alma.asdm.ConfigDescriptionRow.setSwitchCycleId

(

Tag[]

switchCycleId

)

Set switchCycleId with the specified Tag[] value.

Parameters:

switchCycleId

The Tag[] value to which switchCycleId is to be set.

ProcessorRow alma.asdm.ConfigDescriptionRow.getProcessorUsingProcessorId

(

)

Returns the pointer to the row in the Processor table having Processor.processorId == processorId.

Returns:

a ProcessorRow

void alma.asdm.ConfigDescriptionRow.setAntennaId	(	int	i,
		Tag	antennaId
	)			throws IndexOutOfBoundsException

Set antennaId[i] with the specified Tag value.

Parameters:

	i	The index in antennaId where to set the Tag value.
	antennaId	The Tag value to which antennaId[i] is to be set.

Exceptions:

IndexOutOfBoundsException

void alma.asdm.ConfigDescriptionRow.addAntennaId

(

Tag

id

)

[package]

Append a Tag to antennaId.

Parameters:

id

the Tag to be appended to antennaId

void alma.asdm.ConfigDescriptionRow.addAntennaId

(

Tag[]

id

)

[package]

Append an array of Tag to antennaId.

Parameters:

id

an array of Tag to be appended to antennaId

void alma.asdm.ConfigDescriptionRow.setDataDescriptionId	(	int	i,
		Tag	dataDescriptionId
	)			throws IndexOutOfBoundsException

Set dataDescriptionId[i] with the specified Tag value.

Parameters:

	i	The index in dataDescriptionId where to set the Tag value.
	dataDescriptionId	The Tag value to which dataDescriptionId[i] is to be set.

Exceptions:

IndexOutOfBoundsException

void alma.asdm.ConfigDescriptionRow.addDataDescriptionId

(

Tag

id

)

[package]

Append a Tag to dataDescriptionId.

Parameters:

id

the Tag to be appended to dataDescriptionId

void alma.asdm.ConfigDescriptionRow.addDataDescriptionId

(

Tag[]

id

)

[package]

Append an array of Tag to dataDescriptionId.

Parameters:

id

an array of Tag to be appended to dataDescriptionId

void alma.asdm.ConfigDescriptionRow.setSwitchCycleId	(	int	i,
		Tag	switchCycleId
	)			throws IndexOutOfBoundsException

Set switchCycleId[i] with the specified Tag value.

Parameters:

	i	The index in switchCycleId where to set the Tag value.
	switchCycleId	The Tag value to which switchCycleId[i] is to be set.

Exceptions:

IndexOutOfBoundsException

void alma.asdm.ConfigDescriptionRow.addSwitchCycleId

(

Tag

id

)

[package]

Append a Tag to switchCycleId.

Parameters:

id

the Tag to be appended to switchCycleId

void alma.asdm.ConfigDescriptionRow.addSwitchCycleId

(

Tag[]

id

)

[package]

Append an array of Tag to switchCycleId.

Parameters:

id

an array of Tag to be appended to switchCycleId

void alma.asdm.ConfigDescriptionRow.setFeedId	(	int	i,
		int	feedId
	)			throws IndexOutOfBoundsException

Set feedId[i] with the specified int value.

Parameters:

	i	The index in feedId where to set the int value.
	feedId	The int value to which feedId[i] is to be set.

Exceptions:

IndexOutOfBoundsException

void alma.asdm.ConfigDescriptionRow.setAssocConfigDescriptionId	(	int	i,
		Tag	assocConfigDescriptionId
	)			throws IllegalAccessException, IndexOutOfBoundsException

Set assocConfigDescriptionId[i] with the specified Tag value.

Parameters:

	i	The index in assocConfigDescriptionId where to set the Tag value.
	assocConfigDescriptionId	The Tag value to which assocConfigDescriptionId[i] is to be set.

Exceptions:

	IllegalAccessException
	IndexOutOfBoundsException

void alma.asdm.ConfigDescriptionRow.addAssocConfigDescriptionId

(

Tag

id

)

[package]

Append a Tag to assocConfigDescriptionId.

Parameters:

id

the Tag to be appended to assocConfigDescriptionId

void alma.asdm.ConfigDescriptionRow.addAssocConfigDescriptionId

(

Tag[]

id

)

[package]

Append an array of Tag to assocConfigDescriptionId.

Parameters:

id

an array of Tag to be appended to assocConfigDescriptionId

boolean alma.asdm.ConfigDescriptionRow.equalByRequiredValue

(

ConfigDescriptionRow

x

)

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

Parameters:

x

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

Returns:

a boolean.

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

• ConfigDescriptionRow.java

---