org.diirt.datasource.sim

Class Ramp

java.lang.Object

org.diirt.datasource.sim.Ramp

public class Ramp
extends Object

Function to simulate a signal that increases constantly within a range (saw-tooth shape). The warning limits are set at 80% of the range and the alarm at 90% the range. All values are going to have no alarm status, with the timestamp set at the moment the sample was generated.

Author:

carcassi

Constructor Summary

Constructors

Constructor and Description
Ramp() Creates a ramp shaped signal between -5 and +5, incrementing 1 every second.
Ramp(Double min, Double max, Double interval) Creates a ramp shaped signal between min and max, incrementing 1 every interval seconds.
Ramp(Double min, Double max, Double step, Double interval) Creates a ramp shaped signal between min and max, updating a step amount every interval seconds.

Method Summary

Modifier and Type	Method and Description
TimeDuration	getTimeBetweenSamples() Returns the time between each sample.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Ramp

public Ramp(Double min,
            Double max,
            Double step,
            Double interval)

Creates a ramp shaped signal between min and max, updating a step amount every interval seconds.

Parameters:

min - minimum value

max - maximum value

step - increment for each sample

interval - interval between samples in seconds

Ramp

public Ramp(Double min,
            Double max,
            Double interval)

Creates a ramp shaped signal between min and max, incrementing 1 every interval seconds.

Parameters:

min - minimum value

max - maximum value

interval - interval between samples in seconds

Ramp

public Ramp()

Creates a ramp shaped signal between -5 and +5, incrementing 1 every second.

Method Detail

getTimeBetweenSamples

public TimeDuration getTimeBetweenSamples()

Returns the time between each sample.

Returns:

a time duration