ContinuousProperty (Open Traffic Sim base classes 1.00.02 API)

java.lang.Object
- org.opentrafficsim.base.modelproperties.AbstractProperty<Double>
- - org.opentrafficsim.base.modelproperties.ContinuousProperty

All Implemented Interfaces:

Serializable, Iterable<Property<?>>, Property<Double>
```
public class ContinuousProperty
extends AbstractProperty<Double>
implements Serializable
```
Continuous property.
Copyright (c) 2013-2018 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.
$LastChangedDate: 2016-05-28 11:33:31 +0200 (Sat, 28 May 2016) $, @version $Revision: 2051 $, by $Author: averbraeck $, initial version 30 dec. 2014

Author:

Peter Knoppers

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`ContinuousProperty(String key, String shortName, String description, Double initialValue, Double minimumValue, Double maximumValue, boolean includesLowerBound, boolean includesUpperBound, String formatString, boolean readOnly, int displayPriority)` Construct a ContinousProperty.
`ContinuousProperty(String key, String shortName, String description, Double initialValue, Double minimumValue, Double maximumValue, String formatString, boolean readOnly, int displayPriority)` Construct a ContinousProperty that is inclusive of lowerBound and upperBound.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AbstractProperty<Double>`	`deepCopy()` Construct a deep copy of this property (duplicates everything except immutable fields).
`String`	`getFormatString()`
`Double`	`getMaximumValue()`
`Double`	`getMinimumValue()`
`Double`	`getValue()` Retrieve the current value of the property.
`String`	`htmlStateDescription()` Generate a description of the state of this property in HTML (excluding the <html> at the start and the </html> at the end.
`boolean`	`includesLowerBound()` Is the range inclusive of the minimumValue?
`boolean`	`includesUpperBound()` Is the range inclusive of the maximumValue?
`void`	`setValue(Double newValue)` Change the value of the property.

Methods inherited from class org.opentrafficsim.base.modelproperties.AbstractProperty
findByKey, getDescription, getDisplayPriority, getKey, getParent, getShortName, isReadOnly, iterator, setParent, setReadOnly, toString

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - ContinuousProperty
```
public ContinuousProperty(String key,
                          String shortName,
                          String description,
                          Double initialValue,
                          Double minimumValue,
                          Double maximumValue,
                          String formatString,
                          boolean readOnly,
                          int displayPriority)
```
    Construct a ContinousProperty that is inclusive of lowerBound and upperBound.
    
    Parameters:
    
    key - String; the unique key of the new property
    
    shortName - String; the short name of the new ContinuousProperty
    
    description - String; description of the new ContinuousProperty (may use HTML mark up)
    
    initialValue - Double; the initial value of the new ContinuousProperty (may be out of range)
    
    minimumValue - Double; the minimum value of the new ContinuousProperty
    
    maximumValue - Double; the maximumValue of the new ContinuousProperty
    
    formatString - String; format string to display the value
    
    readOnly - boolean; if true this ContinuousProperty can not be altered
    
    displayPriority - int; the displayPriority of the new ContinuousProperty
  - ContinuousProperty
```
public ContinuousProperty(String key,
                          String shortName,
                          String description,
                          Double initialValue,
                          Double minimumValue,
                          Double maximumValue,
                          boolean includesLowerBound,
                          boolean includesUpperBound,
                          String formatString,
                          boolean readOnly,
                          int displayPriority)
```
    Construct a ContinousProperty.
    
    Parameters:
    
    key - String; the unique key of the new property
    
    shortName - String; the short name of the new ContinuousProperty
    
    description - String; description of the new ContinuousProperty (may use HTML mark up)
    
    initialValue - Double; the initial value of the new ContinuousProperty (may be out of range)
    
    minimumValue - Double; the minimum value of the new ContinuousProperty
    
    maximumValue - Double; the maximumValue of the new ContinuousProperty
    
    includesLowerBound - boolean; if true, the minimumValue is valid; if false, the minimumValue is not valid
    
    includesUpperBound - boolean; if true, the maximumValue is valid; if false, the maximumValue is not valid
    
    formatString - String; format string to display the value
    
    readOnly - boolean; if true this ContinuousProperty can not be altered
    
    displayPriority - int; the displayPriority of the new ContinuousProperty
- Method Detail
  - getValue
```
public final Double getValue()
```
    Retrieve the current value of the property.
    
    Specified by:
    
    getValue in interface Property<Double>
    
    Returns:
    
    T; the current value of the property
  - getMinimumValue
```
public final Double getMinimumValue()
```
    Returns:
    
    the minimum value
  - getMaximumValue
```
public final Double getMaximumValue()
```
    Returns:
    
    the minimum value
  - setValue
```
public final void setValue(Double newValue)
                    throws PropertyException
```
    Change the value of the property.
    
    Specified by:
    
    setValue in interface Property<Double>
    
    Parameters:
    
    newValue - T; the new value for the property
    
    Throws:
    
    PropertyException - when this Property is read-only, or newValue is not valid
  - getFormatString
```
public final String getFormatString()
```
    Returns:
    
    String; the format string to display the value
  - htmlStateDescription
```
public final String htmlStateDescription()
```
    Generate a description of the state of this property in HTML (excluding the <html> at the start and the </html> at the end. The result can be embedded in a cell of a html-table.
    
    Specified by:
    
    htmlStateDescription in interface Property<Double>
    
    Specified by:
    
    htmlStateDescription in class AbstractProperty<Double>
    
    Returns:
    
    String; the description of this property and the current state in HTML
  - deepCopy
```
public final AbstractProperty<Double> deepCopy()
```
    Construct a deep copy of this property (duplicates everything except immutable fields).
    
    Specified by:
    
    deepCopy in interface Property<Double>
    
    Returns:
    
    AbstractProperty<T>; a deep copy of this AbstractProperty
  - includesLowerBound
```
public final boolean includesLowerBound()
```
    Is the range inclusive of the minimumValue?
    
    Returns:
    
    boolean; true if the range is inclusive of the minimumValue
  - includesUpperBound
```
public final boolean includesUpperBound()
```
    Is the range inclusive of the maximumValue?
    
    Returns:
    
    boolean; true if the range is inclusive of the maximumValue

Class ContinuousProperty

Constructor Summary

Method Summary

Methods inherited from class org.opentrafficsim.base.modelproperties.AbstractProperty

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

ContinuousProperty

ContinuousProperty

Method Detail

getValue

getMinimumValue

getMaximumValue

setValue

getFormatString

htmlStateDescription

deepCopy

includesLowerBound

includesUpperBound