InstanceGeneratorWithSampleID (adams-spectral-base-pom 25.9.0-SNAPSHOT API)

All Known Implementing Classes:

AbstractFieldInstanceGenerator, AbstractFieldInstanceGeneratorWithClass, AbstractSpectrumBasedInstanceGenerator, AbstractSpectrumInstanceGenerator, AbstractSpectrumInstanceGeneratorWithClass, FieldInstanceGenerator, FieldInstanceGeneratorWithClass, SimpleInstanceGenerator, SimpleSpectralInstanceGenerator
```
public interface InstanceGeneratorWithSampleID
```
Instance generator with sample ID.

Author:

FracPete (fracpete at waikato dot ac dot nz)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`addSampleIDTipText()`	Returns the tip text for this property.
`boolean`	`getAddSampleID()`	Returns whether the sample ID is added.
`void`	`setAddSampleID(boolean value)`	Sets whether the sample ID is added to the data or not.

- Method Detail
  - setAddSampleID
```
void setAddSampleID(boolean value)
```
    Sets whether the sample ID is added to the data or not.
    
    Parameters:
    
    value - true if sample ID should be added
  - getAddSampleID
```
boolean getAddSampleID()
```
    Returns whether the sample ID is added.
    
    Returns:
    
    true if sample ID is added
  - addSampleIDTipText
```
String addSampleIDTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.