DisplacementDeviation (singa-simulation 0.7.0 API)

java.lang.Object
- bio.singa.simulation.model.simulation.error.DisplacementDeviation

public class DisplacementDeviation
extends Object

Author:: cl

Field Summary

Fields
Modifier and Type	Field	Description
`static DisplacementDeviation`	`MAXIMAL_NEGATIVE_DEVIATION`	If reference value is larger then current displacement, the deviation is small (below zero).
`static DisplacementDeviation`	`MAXIMAL_POSITIVE_DEVIATION`	If reference value is smaller then current displacement, the deviation is large (above zero).
`static DisplacementDeviation`	`MINIMAL_DEVIATION`	If reference value is equal to the current displacement, the deviation is zero.

Constructor Summary

Constructors
Constructor Description

DisplacementDeviation(Vesicle vesicle, double value)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

double getValue()

Vesicle getVesicle()

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

- Field Detail
  - MAXIMAL_POSITIVE_DEVIATION
```
public static final DisplacementDeviation MAXIMAL_POSITIVE_DEVIATION
```
    If reference value is smaller then current displacement, the deviation is large (above zero).
  - MINIMAL_DEVIATION
```
public static final DisplacementDeviation MINIMAL_DEVIATION
```
    If reference value is equal to the current displacement, the deviation is zero.
  - MAXIMAL_NEGATIVE_DEVIATION
```
public static final DisplacementDeviation MAXIMAL_NEGATIVE_DEVIATION
```
    If reference value is larger then current displacement, the deviation is small (below zero).
- Constructor Detail
  - DisplacementDeviation
```
public DisplacementDeviation(Vesicle vesicle,
                             double value)
```
- Method Detail
  - getVesicle
```
public Vesicle getVesicle()
```
  - getValue
```
public double getValue()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object