alma.asdm.TotalPowerRow Class Reference

Inherits alma.asdm.ASDMRow.

List of all members.

---

Detailed Description

The TotalPowerRow class is a row of a TotalPowerTable.

Public Member Functions
TotalPowerTable	getTable ()
	Return the table to which this row belongs.
TotalPowerRowIDL	toIDL ()
	Return this row in the form of an IDL struct.
void	setFromIDL (TotalPowerRowIDL x) throws ConversionException
	Fill the values of this row from the IDL struct TotalPowerRowIDL.
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
	Writes the serialized binary representation of this to DataOutputStream.
ArrayTime	getTime ()
	Get time.
void	setTime (ArrayTime time) throws IllegalAccessException
	Set time with the specified ArrayTime value.
int	getScanNumber ()
	Get scanNumber.
void	setScanNumber (int scanNumber)
	Set scanNumber with the specified int value.
int	getSubscanNumber ()
	Get subscanNumber.
void	setSubscanNumber (int subscanNumber)
	Set subscanNumber with the specified int value.
int	getIntegrationNumber ()
	Get integrationNumber.
void	setIntegrationNumber (int integrationNumber)
	Set integrationNumber with the specified int value.
Length[][]	getUvw ()
	Get uvw.
void	setUvw (Length[][] uvw)
	Set uvw with the specified Length[][] value.
Interval[][]	getExposure ()
	Get exposure.
void	setExposure (Interval[][] exposure)
	Set exposure with the specified Interval[][] value.
ArrayTime[][]	getTimeCentroid ()
	Get timeCentroid.
void	setTimeCentroid (ArrayTime[][] timeCentroid)
	Set timeCentroid with the specified ArrayTime[][] value.
float[][][]	getFloatData ()
	Get floatData.
void	setFloatData (float[][][] floatData)
	Set floatData with the specified float[][][] value.
int[]	getFlagAnt ()
	Get flagAnt.
void	setFlagAnt (int[] flagAnt)
	Set flagAnt with the specified int[] value.
int[][]	getFlagPol ()
	Get flagPol.
void	setFlagPol (int[][] flagPol)
	Set flagPol with the specified int[][] value.
boolean	getFlagRow ()
	Get flagRow.
void	setFlagRow (boolean flagRow)
	Set flagRow with the specified boolean value.
Interval	getInterval ()
	Get interval.
void	setInterval (Interval interval)
	Set interval with the specified Interval value.
boolean	isSubintegrationNumberExists ()
	The attribute subintegrationNumber is optional.
int	getSubintegrationNumber () throws IllegalAccessException
	Get subintegrationNumber, which is optional.
void	setSubintegrationNumber (int subintegrationNumber)
	Set subintegrationNumber with the specified int value.
void	clearSubintegrationNumber ()
	Mark subintegrationNumber, which is an optional field, as non-existent.
Tag	getConfigDescriptionId ()
	Get configDescriptionId.
void	setConfigDescriptionId (Tag configDescriptionId) throws IllegalAccessException
	Set configDescriptionId with the specified Tag value.
Tag	getExecBlockId ()
	Get execBlockId.
void	setExecBlockId (Tag execBlockId)
	Set execBlockId with the specified Tag value.
Tag	getFieldId ()
	Get fieldId.
void	setFieldId (Tag fieldId) throws IllegalAccessException
	Set fieldId with the specified Tag value.
Tag[]	getStateId ()
	Get stateId.
void	setStateId (Tag[] stateId)
	Set stateId with the specified Tag[] value.
void	setStateId (int i, Tag stateId) throws IndexOutOfBoundsException
	Set stateId[i] with the specified Tag value.
FieldRow	getFieldUsingFieldId ()
	Returns the pointer to the row in the Field table having Field.fieldId == fieldId.
ConfigDescriptionRow	getConfigDescriptionUsingConfigDescriptionId ()
	Returns the pointer to the row in the ConfigDescription table having ConfigDescription.configDescriptionId == configDescriptionId.
ExecBlockRow	getExecBlock () throws NoSuchRow
	Get the row in table ExecBlock by traversing the defined link to that table.
boolean	compareNoAutoInc (Tag configDescriptionId, Tag fieldId, ArrayTime time, Tag execBlockId, Tag[] stateId, int scanNumber, int subscanNumber, int integrationNumber, Length[][] uvw, Interval[][] exposure, ArrayTime[][] timeCentroid, float[][][] floatData, int[] flagAnt, int[][] flagPol, boolean flagRow, Interval interval)
	Compare each attribute except the autoincrementable one of this TotalPowerRow with the corresponding parameters and return true if there is a match and false otherwise.
boolean	equalByRequiredValue (TotalPowerRow x)
	Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
boolean	compareRequiredValue (Tag execBlockId, Tag[] stateId, int scanNumber, int subscanNumber, int integrationNumber, Length[][] uvw, Interval[][] exposure, ArrayTime[][] timeCentroid, float[][][] floatData, int[] flagAnt, int[][] flagPol, boolean flagRow, Interval interval)
Static Public Member Functions
static TotalPowerRow	fromBin (DataInputStream dis, TotalPowerTable table) throws IOException, TagFormatException
Package Functions
	TotalPowerRow (TotalPowerTable table)
	Create a TotalPowerRow.
	TotalPowerRow (TotalPowerTable table, TotalPowerRow row)
	Creates a TotalPowerRow using a copy constructor mechanism.
void	isAdded ()
void	addStateId (Tag id)
	Append a Tag to stateId.
void	addStateId (Tag[] id)
	Append an array of Tag to stateId.
Tag	getStateId (int i) throws IndexOutOfBoundsException
	Returns the Tag stored in stateId at position i.
StateRow	getState (int i) throws IndexOutOfBoundsException, NoSuchRow
	Returns the StateRow linked to this row via the Tag stored in stateId at position i.
StateRow[]	getStates () throws NoSuchRow
	Returns the array of StateRow linked to this row via the Tags stored in stateId.
Object[]	getAttributesValues ()
	Returns all the attributes of an attribute of an ASDM table as an array of Object.

---

Constructor & Destructor Documentation

alma.asdm.TotalPowerRow.TotalPowerRow

(

TotalPowerTable

table

)

[package]

Create a TotalPowerRow.

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

Creates a TotalPowerRow using a copy constructor mechanism.

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

TotalPowerRowIDL alma.asdm.TotalPowerRow.toIDL

(

)

Return this row in the form of an IDL struct.

Returns:

The values of this row as a TotalPowerRowIDL struct.

void alma.asdm.TotalPowerRow.setFromIDL

(

TotalPowerRowIDL

x

)

throws ConversionException

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

Parameters:

x

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

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

(

DataOutputStream

dos

)

throws IOException

Writes the serialized binary representation of this to DataOutputStream.

Parameters:

dos

The DataOutputStream to be written to.

ArrayTime alma.asdm.TotalPowerRow.getTime

(

)

Get time.

Returns:

time as ArrayTime

void alma.asdm.TotalPowerRow.setTime

(

ArrayTime

time

)

throws IllegalAccessException

Set time with the specified ArrayTime value.

Parameters:

time

The ArrayTime value to which time 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.TotalPowerRow.getScanNumber

(

)

Get scanNumber.

Returns:

scanNumber as int

void alma.asdm.TotalPowerRow.setScanNumber

(

int

scanNumber

)

Set scanNumber with the specified int value.

Parameters:

scanNumber

The int value to which scanNumber is to be set.

int alma.asdm.TotalPowerRow.getSubscanNumber

(

)

Get subscanNumber.

Returns:

subscanNumber as int

void alma.asdm.TotalPowerRow.setSubscanNumber

(

int

subscanNumber

)

Set subscanNumber with the specified int value.

Parameters:

subscanNumber

The int value to which subscanNumber is to be set.

int alma.asdm.TotalPowerRow.getIntegrationNumber

(

)

Get integrationNumber.

Returns:

integrationNumber as int

void alma.asdm.TotalPowerRow.setIntegrationNumber

(

int

integrationNumber

)

Set integrationNumber with the specified int value.

Parameters:

integrationNumber

The int value to which integrationNumber is to be set.

Length [][] alma.asdm.TotalPowerRow.getUvw

(

)

Get uvw.

Returns:

uvw as Length[][]

void alma.asdm.TotalPowerRow.setUvw

(

Length

uvw[][]

)

Set uvw with the specified Length[][] value.

Parameters:

uvw

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

Interval [][] alma.asdm.TotalPowerRow.getExposure

(

)

Get exposure.

Returns:

exposure as Interval[][]

void alma.asdm.TotalPowerRow.setExposure

(

Interval

exposure[][]

)

Set exposure with the specified Interval[][] value.

Parameters:

exposure

The Interval[][] value to which exposure is to be set.

ArrayTime [][] alma.asdm.TotalPowerRow.getTimeCentroid

(

)

Get timeCentroid.

Returns:

timeCentroid as ArrayTime[][]

void alma.asdm.TotalPowerRow.setTimeCentroid

(

ArrayTime

timeCentroid[][]

)

Set timeCentroid with the specified ArrayTime[][] value.

Parameters:

timeCentroid

The ArrayTime[][] value to which timeCentroid is to be set.

float [][][] alma.asdm.TotalPowerRow.getFloatData

(

)

Get floatData.

Returns:

floatData as float[][][]

void alma.asdm.TotalPowerRow.setFloatData

(

float

floatData[][][]

)

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

Parameters:

floatData

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

int [] alma.asdm.TotalPowerRow.getFlagAnt

(

)

Get flagAnt.

Returns:

flagAnt as int[]

void alma.asdm.TotalPowerRow.setFlagAnt

(

int[]

flagAnt

)

Set flagAnt with the specified int[] value.

Parameters:

flagAnt

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

int [][] alma.asdm.TotalPowerRow.getFlagPol

(

)

Get flagPol.

Returns:

flagPol as int[][]

void alma.asdm.TotalPowerRow.setFlagPol

(

int

flagPol[][]

)

Set flagPol with the specified int[][] value.

Parameters:

flagPol

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

boolean alma.asdm.TotalPowerRow.getFlagRow

(

)

Get flagRow.

Returns:

flagRow as boolean

void alma.asdm.TotalPowerRow.setFlagRow

(

boolean

flagRow

)

Set flagRow with the specified boolean value.

Parameters:

flagRow

The boolean value to which flagRow is to be set.

Interval alma.asdm.TotalPowerRow.getInterval

(

)

Get interval.

Returns:

interval as Interval

void alma.asdm.TotalPowerRow.setInterval

(

Interval

interval

)

Set interval with the specified Interval value.

Parameters:

interval

The Interval value to which interval is to be set.

boolean alma.asdm.TotalPowerRow.isSubintegrationNumberExists

(

)

The attribute subintegrationNumber is optional.

Return true if this attribute exists.

Returns:

true if and only if the subintegrationNumber attribute exists.

int alma.asdm.TotalPowerRow.getSubintegrationNumber

(

)

throws IllegalAccessException

Get subintegrationNumber, which is optional.

Returns:

subintegrationNumber as int

Exceptions:

IllegalAccessException

If subintegrationNumber does not exist.

void alma.asdm.TotalPowerRow.setSubintegrationNumber

(

int

subintegrationNumber

)

Set subintegrationNumber with the specified int value.

Parameters:

subintegrationNumber

The int value to which subintegrationNumber is to be set.

Tag alma.asdm.TotalPowerRow.getConfigDescriptionId

(

)

Get configDescriptionId.

Returns:

configDescriptionId as Tag

void alma.asdm.TotalPowerRow.setConfigDescriptionId

(

Tag

configDescriptionId

)

throws IllegalAccessException

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.

Tag alma.asdm.TotalPowerRow.getExecBlockId

(

)

Get execBlockId.

Returns:

execBlockId as Tag

void alma.asdm.TotalPowerRow.setExecBlockId

(

Tag

execBlockId

)

Set execBlockId with the specified Tag value.

Parameters:

execBlockId

The Tag value to which execBlockId is to be set.

Tag alma.asdm.TotalPowerRow.getFieldId

(

)

Get fieldId.

Returns:

fieldId as Tag

void alma.asdm.TotalPowerRow.setFieldId

(

Tag

fieldId

)

throws IllegalAccessException

Set fieldId with the specified Tag value.

Parameters:

fieldId

The Tag value to which fieldId 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.TotalPowerRow.getStateId

(

)

Get stateId.

Returns:

stateId as Tag[]

void alma.asdm.TotalPowerRow.setStateId

(

Tag[]

stateId

)

Set stateId with the specified Tag[] value.

Parameters:

stateId

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

void alma.asdm.TotalPowerRow.setStateId	(	int	i,
		Tag	stateId
	)			throws IndexOutOfBoundsException

Set stateId[i] with the specified Tag value.

Parameters:

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

Exceptions:

IndexOutOfBoundsException

void alma.asdm.TotalPowerRow.addStateId

(

Tag

id

)

[package]

Append a Tag to stateId.

Parameters:

id

the Tag to be appended to stateId

void alma.asdm.TotalPowerRow.addStateId

(

Tag[]

id

)

[package]

Append an array of Tag to stateId.

Parameters:

id

an array of Tag to be appended to stateId

FieldRow alma.asdm.TotalPowerRow.getFieldUsingFieldId

(

)

Returns the pointer to the row in the Field table having Field.fieldId == fieldId.

Returns:

a FieldRow

ConfigDescriptionRow alma.asdm.TotalPowerRow.getConfigDescriptionUsingConfigDescriptionId

(

)

Returns the pointer to the row in the ConfigDescription table having ConfigDescription.configDescriptionId == configDescriptionId.

Returns:

a ConfigDescriptionRow

ExecBlockRow alma.asdm.TotalPowerRow.getExecBlock

(

)

throws NoSuchRow

Get the row in table ExecBlock by traversing the defined link to that table.

Returns:

A row in ExecBlock table.

Exceptions:

NoSuchRow

if there is no such row in table ExecBlock.

boolean alma.asdm.TotalPowerRow.equalByRequiredValue

(

TotalPowerRow

x

)

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

Parameters:

x

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

Returns:

a boolean.

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

• TotalPowerRow.java

---