alma.asdm.CorrelatorModeRow Class Reference

Inherits alma.asdm.ASDMRow.

List of all members.


Detailed Description

The CorrelatorModeRow class is a row of a CorrelatorModeTable.

Generated from model's revision 1.46, branch HEAD


Public Member Functions

CorrelatorModeTable getTable ()
 Return the table to which this row belongs.
CorrelatorModeRowIDL toIDL ()
 Return this row in the form of an IDL struct.
void setFromIDL (CorrelatorModeRowIDL x) throws ConversionException
 Fill the values of this row from the IDL struct CorrelatorModeRowIDL.
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 getAlmaCorrelatorModeId ()
 Get almaCorrelatorModeId.
int getNumBaseband ()
 Get numBaseband.
void setNumBaseband (int numBaseband) throws IllegalAccessException
 Set numBaseband with the specified int value.
BasebandName[] getBasebandNames ()
 Get basebandNames.
void setBasebandNames (BasebandName[] basebandNames) throws IllegalAccessException
 Set basebandNames with the specified BasebandName[] value.
int[] getBasebandConfig ()
 Get basebandConfig.
void setBasebandConfig (int[] basebandConfig) throws IllegalAccessException
 Set basebandConfig with the specified int[] value.
AccumMode getAccumMode ()
 Get accumMode.
void setAccumMode (AccumMode accumMode) throws IllegalAccessException
 Set accumMode with the specified AccumMode value.
int getBinMode ()
 Get binMode.
void setBinMode (int binMode) throws IllegalAccessException
 Set binMode with the specified int value.
AxisName[] getAxesOrderArray ()
 Get axesOrderArray.
void setAxesOrderArray (AxisName[] axesOrderArray) throws IllegalAccessException
 Set axesOrderArray with the specified AxisName[] value.
FilterMode[] getFilterMode ()
 Get filterMode.
void setFilterMode (FilterMode[] filterMode) throws IllegalAccessException
 Set filterMode with the specified FilterMode[] value.
CorrelatorName getCorrelatorName ()
 Get correlatorName.
void setCorrelatorName (CorrelatorName correlatorName) throws IllegalAccessException
 Set correlatorName with the specified CorrelatorName value.
boolean compareNoAutoInc (int numBaseband, BasebandName[] basebandNames, int[] basebandConfig, AccumMode accumMode, int binMode, AxisName[] axesOrderArray, FilterMode[] filterMode, CorrelatorName correlatorName)
 Compare each attribute except the autoincrementable one of this CorrelatorModeRow with the corresponding parameters and return true if there is a match and false otherwise.
boolean equalByRequiredValue (CorrelatorModeRow x)
 Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
boolean compareRequiredValue (int numBaseband, BasebandName[] basebandNames, int[] basebandConfig, AccumMode accumMode, int binMode, AxisName[] axesOrderArray, FilterMode[] filterMode, CorrelatorName correlatorName)

Protected Member Functions

void setAlmaCorrelatorModeId (Tag almaCorrelatorModeId) throws IllegalAccessException
 Set almaCorrelatorModeId with the specified Tag value.

Package Functions

 CorrelatorModeRow (CorrelatorModeTable table)
 Create a CorrelatorModeRow.
 CorrelatorModeRow (CorrelatorModeTable table, CorrelatorModeRow row)
 Creates a CorrelatorModeRow 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.CorrelatorModeRow.CorrelatorModeRow CorrelatorModeTable  table  )  [package]
 

Create a CorrelatorModeRow.

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.CorrelatorModeRow.CorrelatorModeRow CorrelatorModeTable  table,
CorrelatorModeRow  row
[package]
 

Creates a CorrelatorModeRow using a copy constructor mechanism.

Given a CorrelatorModeRow row and a CorrelatorModeTable table, the method creates a new CorrelatorModeRow 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.CorrelatorModeRow.compareNoAutoInc int  numBaseband,
BasebandName[]  basebandNames,
int[]  basebandConfig,
AccumMode  accumMode,
int  binMode,
AxisName[]  axesOrderArray,
FilterMode[]  filterMode,
CorrelatorName  correlatorName
 

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

boolean alma.asdm.CorrelatorModeRow.equalByRequiredValue CorrelatorModeRow  x  ) 
 

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

Parameters:
x the CorrelatorModeRow whose required attributes of the value part will be compared with those of this.
Returns:
a boolean.

AccumMode alma.asdm.CorrelatorModeRow.getAccumMode  ) 
 

Get accumMode.

Returns:
accumMode as AccumMode

Tag alma.asdm.CorrelatorModeRow.getAlmaCorrelatorModeId  ) 
 

Get almaCorrelatorModeId.

Returns:
almaCorrelatorModeId as Tag

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

AxisName [] alma.asdm.CorrelatorModeRow.getAxesOrderArray  ) 
 

Get axesOrderArray.

Returns:
axesOrderArray as AxisName[]

int [] alma.asdm.CorrelatorModeRow.getBasebandConfig  ) 
 

Get basebandConfig.

Returns:
basebandConfig as int[]

BasebandName [] alma.asdm.CorrelatorModeRow.getBasebandNames  ) 
 

Get basebandNames.

Returns:
basebandNames as BasebandName[]

int alma.asdm.CorrelatorModeRow.getBinMode  ) 
 

Get binMode.

Returns:
binMode as int

CorrelatorName alma.asdm.CorrelatorModeRow.getCorrelatorName  ) 
 

Get correlatorName.

Returns:
correlatorName as CorrelatorName

FilterMode [] alma.asdm.CorrelatorModeRow.getFilterMode  ) 
 

Get filterMode.

Returns:
filterMode as FilterMode[]

int alma.asdm.CorrelatorModeRow.getNumBaseband  ) 
 

Get numBaseband.

Returns:
numBaseband as int

CorrelatorModeTable alma.asdm.CorrelatorModeRow.getTable  ) 
 

Return the table to which this row belongs.

void alma.asdm.CorrelatorModeRow.setAccumMode AccumMode  accumMode  )  throws IllegalAccessException
 

Set accumMode with the specified AccumMode value.

Parameters:
accumMode The AccumMode value to which accumMode 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.CorrelatorModeRow.setAlmaCorrelatorModeId Tag  almaCorrelatorModeId  )  throws IllegalAccessException [protected]
 

Set almaCorrelatorModeId with the specified Tag value.

Parameters:
almaCorrelatorModeId The Tag value to which almaCorrelatorModeId 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.CorrelatorModeRow.setAxesOrderArray AxisName[]  axesOrderArray  )  throws IllegalAccessException
 

Set axesOrderArray with the specified AxisName[] value.

Parameters:
axesOrderArray The AxisName[] value to which axesOrderArray 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.CorrelatorModeRow.setBasebandConfig int[]  basebandConfig  )  throws IllegalAccessException
 

Set basebandConfig with the specified int[] value.

Parameters:
basebandConfig The int[] value to which basebandConfig 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.CorrelatorModeRow.setBasebandNames BasebandName[]  basebandNames  )  throws IllegalAccessException
 

Set basebandNames with the specified BasebandName[] value.

Parameters:
basebandNames The BasebandName[] value to which basebandNames 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.CorrelatorModeRow.setBinMode int  binMode  )  throws IllegalAccessException
 

Set binMode with the specified int value.

Parameters:
binMode The int value to which binMode 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.CorrelatorModeRow.setCorrelatorName CorrelatorName  correlatorName  )  throws IllegalAccessException
 

Set correlatorName with the specified CorrelatorName value.

Parameters:
correlatorName The CorrelatorName value to which correlatorName 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.CorrelatorModeRow.setFilterMode FilterMode[]  filterMode  )  throws IllegalAccessException
 

Set filterMode with the specified FilterMode[] value.

Parameters:
filterMode The FilterMode[] value to which filterMode 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.CorrelatorModeRow.setFromIDL CorrelatorModeRowIDL  x  )  throws ConversionException
 

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

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

void alma.asdm.CorrelatorModeRow.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.CorrelatorModeRow.setNumBaseband int  numBaseband  )  throws IllegalAccessException
 

Set numBaseband with the specified int value.

Parameters:
numBaseband The int value to which numBaseband is to be set.
Exceptions:
IllegalAccessException If an attempt is made to change this field after is has been added to the table.

CorrelatorModeRowIDL alma.asdm.CorrelatorModeRow.toIDL  ) 
 

Return this row in the form of an IDL struct.

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

String alma.asdm.CorrelatorModeRow.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:
Generated on Tue Nov 18 17:46:46 2008 for ASDM Java Implementation by doxygen 1.3.8