org.opentrafficsim.simulationengine

Class ProbabilityDistributionProperty

java.lang.Object

org.opentrafficsim.simulationengine.AbstractProperty<Double[]>

org.opentrafficsim.simulationengine.ProbabilityDistributionProperty

All Implemented Interfaces:

Iterable<AbstractProperty<Double[]>>

public class ProbabilityDistributionProperty
extends AbstractProperty<Double[]>

Property that describes a probability distribution.

Copyright (c) 2013-2014 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

18 dec. 2014

Author:

Peter Knoppers

Constructor Summary

Constructors

Constructor and Description
ProbabilityDistributionProperty(String shortName, String description, String[] elementNames, Double[] initialValue, boolean readOnly, int displayPriority) Construct a new ProbabilityDistributionProperty.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Return a description of the property (may use HTML markup).
String[]	getElementNames() Return the names of the elements of this ProbabilityDistributionProperty.
String	getShortName() Return a short description of the property.
Double[]	getValue() Retrieve the current value of the property.
boolean	isReadOnly() Return true if the property can not be altered.
void	setValue(Double[] newValue) Change the value of the property.

Methods inherited from class org.opentrafficsim.simulationengine.AbstractProperty

getDisplayPriority, iterator, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ProbabilityDistributionProperty

public ProbabilityDistributionProperty(String shortName,
                               String description,
                               String[] elementNames,
                               Double[] initialValue,
                               boolean readOnly,
                               int displayPriority)
                                throws PropertyException

Construct a new ProbabilityDistributionProperty.

Parameters:

shortName - String; the short name of the new ProbabilityDistributionProperty

description - String; the description of the new ProbabilityDistributionProperty (may use HTML markup)

elementNames - String[]; names of the elements that, together, add up to probability 1.0

initialValue - Double[]; array of Double values

readOnly - boolean; if true this ProbabilityDistributionProperty can not be altered

displayPriority - int; the display priority of the new ProbabilityDistributionProperty

Throws:

PropertyException - when the array is empty, any value is outside the range 0.0 .. 1.0, or when the sum of the values is not equal to 1.0 within a small error margin

Method Detail

getValue

public final Double[] getValue()

Retrieve the current value of the property.

Specified by:

getValue in class AbstractProperty<Double[]>

Returns:

T; the current value of the property

getShortName

public final String getShortName()

Return a short description of the property.

Specified by:

getShortName in class AbstractProperty<Double[]>

Returns:

String; a short description of the property

getDescription

public final String getDescription()

Return a description of the property (may use HTML markup).

Specified by:

getDescription in class AbstractProperty<Double[]>

Returns:

String; the description of the property

setValue

public final void setValue(Double[] newValue)
                    throws PropertyException

Change the value of the property.

Specified by:

setValue in class AbstractProperty<Double[]>

Parameters:

newValue - T; the new value for the property

Throws:

PropertyException - when this Property is read-only, or newValue is not valid

getElementNames

public final String[] getElementNames()

Return the names of the elements of this ProbabilityDistributionProperty.

Returns:

String[]; the names of the elements of this ProbabilityDistributionProperty

isReadOnly

public final boolean isReadOnly()

Return true if the property can not be altered.

Specified by:

isReadOnly in class AbstractProperty<Double[]>

Returns:

boolean; true if this property can not be altered, false if this property can be altered