alma.asdm.SwitchCycleRow Class Reference

Detailed Description

The SwitchCycleRow class is a row of a SwitchCycleTable.

Generated from model's revision 1.46, branch HEAD

Public Member Functions

SwitchCycleTable getTable ()

Return the table to which this row belongs.

SwitchCycleRowIDL toIDL ()

Return this row in the form of an IDL struct.

void setFromIDL (SwitchCycleRowIDL x) throws ConversionException

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

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.

Tag getSwitchCycleId ()

Get switchCycleId.

int getNumStep ()

Get numStep.

void setNumStep (int numStep) throws IllegalAccessException

Set numStep with the specified int value.

float[] getWeightArray ()

Get weightArray.

void setWeightArray (float[] weightArray) throws IllegalAccessException

Set weightArray with the specified float[] value.

Angle[][] getDirOffsetArray ()

Get dirOffsetArray.

void setDirOffsetArray (Angle[][] dirOffsetArray) throws IllegalAccessException

Set dirOffsetArray with the specified Angle[][] value.

Frequency[] getFreqOffsetArray ()

Get freqOffsetArray.

void setFreqOffsetArray (Frequency[] freqOffsetArray) throws IllegalAccessException

Set freqOffsetArray with the specified Frequency[] value.

Interval[] getStepDurationArray ()

Get stepDurationArray.

void setStepDurationArray (Interval[] stepDurationArray) throws IllegalAccessException

Set stepDurationArray with the specified Interval[] value.

boolean compareNoAutoInc (int numStep, float[] weightArray, Angle[][] dirOffsetArray, Frequency[] freqOffsetArray, Interval[] stepDurationArray)

Compare each attribute except the autoincrementable one of this SwitchCycleRow with the corresponding parameters and return true if there is a match and false otherwise.

boolean equalByRequiredValue (SwitchCycleRow x)

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

boolean compareRequiredValue (int numStep, float[] weightArray, Angle[][] dirOffsetArray, Frequency[] freqOffsetArray, Interval[] stepDurationArray)

Protected Member Functions

void setSwitchCycleId (Tag switchCycleId) throws IllegalAccessException

Set switchCycleId with the specified Tag value.

Package Functions

SwitchCycleRow (SwitchCycleTable table)

Create a SwitchCycleRow.

SwitchCycleRow (SwitchCycleTable table, SwitchCycleRow row)

Creates a SwitchCycleRow 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.SwitchCycleRow.SwitchCycleRow ( SwitchCycleTable table ) [package]

Create a SwitchCycleRow.
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.SwitchCycleRow.SwitchCycleRow ( SwitchCycleTable table,

SwitchCycleRow row

) [package]

Creates a SwitchCycleRow using a copy constructor mechanism.
Given a SwitchCycleRow row and a SwitchCycleTable table, the method creates a new SwitchCycleRow 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

boolean alma.asdm.SwitchCycleRow.compareNoAutoInc ( int numStep,

float[] weightArray,

Angle dirOffsetArray[][],

Frequency[] freqOffsetArray,

Interval[] stepDurationArray

)

Compare each attribute except the autoincrementable one of this SwitchCycleRow with the corresponding parameters and return true if there is a match and false otherwise.

boolean alma.asdm.SwitchCycleRow.equalByRequiredValue ( SwitchCycleRow x )

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

Parameters:

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

Returns:
a boolean.

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

Angle [][] alma.asdm.SwitchCycleRow.getDirOffsetArray ( )

Get dirOffsetArray.

Returns:
dirOffsetArray as Angle[][]

Frequency [] alma.asdm.SwitchCycleRow.getFreqOffsetArray ( )

Get freqOffsetArray.

Returns:
freqOffsetArray as Frequency[]

int alma.asdm.SwitchCycleRow.getNumStep ( )

Get numStep.

Returns:
numStep as int

Interval [] alma.asdm.SwitchCycleRow.getStepDurationArray ( )

Get stepDurationArray.

Returns:
stepDurationArray as Interval[]

Tag alma.asdm.SwitchCycleRow.getSwitchCycleId ( )

Get switchCycleId.

Returns:
switchCycleId as Tag

SwitchCycleTable alma.asdm.SwitchCycleRow.getTable ( )

Return the table to which this row belongs.

float [] alma.asdm.SwitchCycleRow.getWeightArray ( )

Get weightArray.

Returns:
weightArray as float[]

void alma.asdm.SwitchCycleRow.setDirOffsetArray ( Angle dirOffsetArray[][] ) throws IllegalAccessException

Set dirOffsetArray with the specified Angle[][] value.

Parameters:

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

Exceptions:

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

void alma.asdm.SwitchCycleRow.setFreqOffsetArray ( Frequency[] freqOffsetArray ) throws IllegalAccessException

Set freqOffsetArray with the specified Frequency[] value.

Parameters:

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

Exceptions:

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

void alma.asdm.SwitchCycleRow.setFromIDL ( SwitchCycleRowIDL x ) throws ConversionException

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

Parameters:

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

void alma.asdm.SwitchCycleRow.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.SwitchCycleRow.setNumStep ( int numStep ) throws IllegalAccessException

Set numStep with the specified int value.

Parameters:

numStep The int value to which numStep is to be set.

Exceptions:

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

void alma.asdm.SwitchCycleRow.setStepDurationArray ( Interval[] stepDurationArray ) throws IllegalAccessException

Set stepDurationArray with the specified Interval[] value.

Parameters:

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

Exceptions:

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

void alma.asdm.SwitchCycleRow.setSwitchCycleId ( Tag switchCycleId ) throws IllegalAccessException [protected]

Set switchCycleId with the specified Tag value.

Parameters:

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

Exceptions:

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

void alma.asdm.SwitchCycleRow.setWeightArray ( float[] weightArray ) throws IllegalAccessException

Set weightArray with the specified float[] value.

Parameters:

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

Exceptions:

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

SwitchCycleRowIDL alma.asdm.SwitchCycleRow.toIDL ( )

Return this row in the form of an IDL struct.

Returns:
The values of this row as a SwitchCycleRowIDL struct.

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

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

SwitchCycleRow.java

Generated on Tue Nov 18 17:46:48 2008 for ASDM Java Implementation by

1.3.8


Public Member Functions
SwitchCycleTable	getTable ()
	Return the table to which this row belongs.
SwitchCycleRowIDL	toIDL ()
	Return this row in the form of an IDL struct.
void	setFromIDL (SwitchCycleRowIDL x) throws ConversionException
	Fill the values of this row from the IDL struct SwitchCycleRowIDL.
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.
Tag	getSwitchCycleId ()
	Get switchCycleId.
int	getNumStep ()
	Get numStep.
void	setNumStep (int numStep) throws IllegalAccessException
	Set numStep with the specified int value.
float[]	getWeightArray ()
	Get weightArray.
void	setWeightArray (float[] weightArray) throws IllegalAccessException
	Set weightArray with the specified float[] value.
Angle[][]	getDirOffsetArray ()
	Get dirOffsetArray.
void	setDirOffsetArray (Angle[][] dirOffsetArray) throws IllegalAccessException
	Set dirOffsetArray with the specified Angle[][] value.
Frequency[]	getFreqOffsetArray ()
	Get freqOffsetArray.
void	setFreqOffsetArray (Frequency[] freqOffsetArray) throws IllegalAccessException
	Set freqOffsetArray with the specified Frequency[] value.
Interval[]	getStepDurationArray ()
	Get stepDurationArray.
void	setStepDurationArray (Interval[] stepDurationArray) throws IllegalAccessException
	Set stepDurationArray with the specified Interval[] value.
boolean	compareNoAutoInc (int numStep, float[] weightArray, Angle[][] dirOffsetArray, Frequency[] freqOffsetArray, Interval[] stepDurationArray)
	Compare each attribute except the autoincrementable one of this SwitchCycleRow with the corresponding parameters and return true if there is a match and false otherwise.
boolean	equalByRequiredValue (SwitchCycleRow x)
	Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
boolean	compareRequiredValue (int numStep, float[] weightArray, Angle[][] dirOffsetArray, Frequency[] freqOffsetArray, Interval[] stepDurationArray)
Protected Member Functions
void	setSwitchCycleId (Tag switchCycleId) throws IllegalAccessException
	Set switchCycleId with the specified Tag value.
Package Functions
	SwitchCycleRow (SwitchCycleTable table)
	Create a SwitchCycleRow.
	SwitchCycleRow (SwitchCycleTable table, SwitchCycleRow row)
	Creates a SwitchCycleRow 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.