SampleThread (leJOS EV3 API documentation)

java.lang.Object
- lejos.robotics.filter.AbstractFilter
- - lejos.robotics.filter.SampleThread

All Implemented Interfaces:: SampleProvider

public class SampleThread
extends AbstractFilter

Field Summary
- Fields inherited from class lejos.robotics.filter.AbstractFilter
  sampleSize, source

Constructor Summary

Constructors
Constructor Description

SampleThread(SampleProvider source, float sampleRate)
Create an instance and run at sampleRate.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`fetchSample(float[] dst, int off)`	Fetches a sample from a sensor or filter.
`float`	`getSampleRate()`
`boolean`	`isNewSampleAvailable()`
`void`	`setSampleRate(float rate)`
`void`	`start()`	Start the sampling (Default at instantiation)
`void`	`stop()`	Stop the sampling

Methods inherited from class lejos.robotics.filter.AbstractFilter
sampleSize

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SampleThread
```
public SampleThread(SampleProvider source,
                    float sampleRate)
```
    Create an instance and run at sampleRate.
    
    Parameters:
    
    source - A SampleProvider
    
    sampleRate - The sample rate expressed in Hertz (Samples / second)
- Method Detail
  - isNewSampleAvailable
```
public boolean isNewSampleAvailable()
```
  - fetchSample
```
public void fetchSample(float[] dst,
                        int off)
```
    Description copied from interface: SampleProvider
    
    Fetches a sample from a sensor or filter.
    
    Specified by:
    
    fetchSample in interface SampleProvider
    
    Overrides:
    
    fetchSample in class AbstractFilter
    
    Parameters:
    
    dst - The array to store the sample in.
    
    off - The elements of the sample are stored in the array starting at the offset position.
  - getSampleRate
```
public float getSampleRate()
```
    Returns:
    
    rate in Hz
  - setSampleRate
```
public void setSampleRate(float rate)
```
    Parameters:
    
    rate - in Hz
  - start
```
public void start()
```
    Start the sampling (Default at instantiation)
  - stop
```
public void stop()
```
    Stop the sampling