MatlabArrayIndexSupporter (adams-pom 24.12.0-SNAPSHOT API)

All Superinterfaces:

Destroyable, OptionHandler

All Known Implementing Classes:

Mat5ArraySubset, Mat5GetMatrixElement, Mat5SetMatrixElement, Mat5StructToMap
```
public interface MatlabArrayIndexSupporter
extends OptionHandler
```
Interface for classes that use an array index.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Mat5ArrayElementIndex`	`getIndex()`	Returns the index to obtain.
`boolean`	`getZeroBasedIndex()`	Returns whether the index is 0-based or 1-based.
`String`	`indexTipText()`	Returns the tip text for this property.
`void`	`setIndex(Mat5ArrayElementIndex value)`	Sets the index to obtain.
`void`	`setZeroBasedIndex(boolean value)`	Sets whether the index is 0-based or 1-based.
`String`	`zeroBasedIndexTipText()`	Returns the tip text for this property.

Methods inherited from interface adams.core.Destroyable
destroy

Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, defineOptions, getOptionManager, toCommandLine

- Method Detail
  - setIndex
```
void setIndex(Mat5ArrayElementIndex value)
```
    Sets the index to obtain.
    
    Parameters:
    
    value - the index
  - getIndex
```
Mat5ArrayElementIndex getIndex()
```
    Returns the index to obtain.
    
    Returns:
    
    the index
  - indexTipText
```
String indexTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setZeroBasedIndex
```
void setZeroBasedIndex(boolean value)
```
    Sets whether the index is 0-based or 1-based.
    
    Parameters:
    
    value - true if 0-based
  - getZeroBasedIndex
```
boolean getZeroBasedIndex()
```
    Returns whether the index is 0-based or 1-based.
    
    Returns:
    
    true if 0-based
  - zeroBasedIndexTipText
```
String zeroBasedIndexTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.