Package org.opentrafficsim.core.parameters

Class ParameterFactoryOneShot

java.lang.Object

org.opentrafficsim.core.parameters.ParameterFactoryByType

org.opentrafficsim.core.parameters.ParameterFactoryOneShot

All Implemented Interfaces:

ParameterFactory

public class ParameterFactoryOneShot
extends ParameterFactoryByType

Extends ParameterFactoryByType with a one-shot mode. By calling setOneShotMode() all parameters and correlations added between a call to said method and to setValues() are removed from the factory after the call to setValues().

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

Author:

Wouter Schakel

Nested Class Summary

Nested classes/interfaces inherited from class org.opentrafficsim.core.parameters.ParameterFactoryByType

ParameterFactoryByType.Correlation<C,T>

Constructor Summary

Constructors

Constructor	Description
ParameterFactoryOneShot()	Constructor.

Method Summary

Modifier and Type	Method	Description
<C, V> void	addCorrelation(ParameterType<C> first, ParameterType<V> then, ParameterFactoryByType.Correlation<C,V> correlation)	Correlates one parameter to another for all GTU types.
<C, V> void	addCorrelation(GtuType gtuType, ParameterType<C> first, ParameterType<V> then, ParameterFactoryByType.Correlation<C,V> correlation)	Correlates one parameter to another.
<V> void	addParameter(ParameterType<V> parameterType, V value)	Add parameter for all GTU types.
void	addParameter(ParameterTypeDouble parameterType, double value)	Add parameter for all GTU types.
void	addParameter(ParameterTypeDouble parameterType, DistContinuous distribution)	Add parameter for all GTU types.
<U extends Unit<U>, V extends org.djunits.value.vdouble.scalar.base.DoubleScalarRel<U, V>> void	addParameter(ParameterTypeNumeric<V> parameterType, ContinuousDistDoubleScalar.Rel<V,U> distribution)	Add parameter for all GTU types.
void	addParameter(GtuType gtuType, ParameterType<Double> parameterType, DistContinuous distribution)	Add parameter.
void	addParameter(GtuType gtuType, ParameterType<Integer> parameterType, DistDiscrete distribution)	Add parameter.
<V> void	addParameter(GtuType gtuType, ParameterType<V> parameterType, V value)	Add parameter.
<U extends Unit<U>, V extends org.djunits.value.vdouble.scalar.base.DoubleScalarRel<U, V>> void	addParameter(GtuType gtuType, ParameterTypeNumeric<V> parameterType, ContinuousDistDoubleScalar.Rel<V,U> distribution)	Add parameter.
void	setOneShotMode()	Sets the factory to one-shot mode.
void	setValues(Parameters parameters, GtuType gtuType)	Creates a set of parameters for the provided GTU type.

Methods inherited from class org.opentrafficsim.core.parameters.ParameterFactoryByType

applyCorrelationsAndSetValues, correlateValue, getBaseValues, getCorrelations, setParameterValue, setValues, toString

Methods inherited from class java.lang.Object

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

Constructor Details

ParameterFactoryOneShot

public ParameterFactoryOneShot()

Constructor.

Method Details

setOneShotMode

public void setOneShotMode()

Sets the factory to one-shot mode. All parameters and correlations added between a call to this method and to setValues() are removed from the factory after the call to setValues().

setValues

public void setValues(Parameters parameters,
 GtuType gtuType)
               throws ParameterException

Creates a set of parameters for the provided GTU type. Removes any parameters or correlations that were set in one-shot mode. One-shot mode is disabled.

Specified by:

setValues in interface ParameterFactory

Overrides:

setValues in class ParameterFactoryByType

Parameters:

parameters - parameters

gtuType - GTU type

Throws:

ParameterException - when illegal parameter value is set

addParameter

public <V> void addParameter(GtuType gtuType,
 ParameterType<V> parameterType,
 V value)

Description copied from class: ParameterFactoryByType

Add parameter.

Overrides:

addParameter in class ParameterFactoryByType

Type Parameters:

V - parameter value type

Parameters:

gtuType - the gtu type

parameterType - the parameter type

value - the value of the parameter

addParameter

public <U extends Unit<U>,
V extends org.djunits.value.vdouble.scalar.base.DoubleScalarRel<U,
V>>
void addParameter(GtuType gtuType,
 ParameterTypeNumeric<V> parameterType,
 ContinuousDistDoubleScalar.Rel<V,U> distribution)

Description copied from class: ParameterFactoryByType

Add parameter.

Overrides:

addParameter in class ParameterFactoryByType

Type Parameters:

U - unit type

V - parameter value type

Parameters:

gtuType - the gtu type

parameterType - the parameter type

distribution - ContinuousDistDoubleScalar.Rel<T,U>; the distribution of the parameter

addParameter

public void addParameter(GtuType gtuType,
 ParameterType<Integer> parameterType,
 DistDiscrete distribution)

Description copied from class: ParameterFactoryByType

Add parameter.

Overrides:

addParameter in class ParameterFactoryByType

Parameters:

gtuType - the gtu type

parameterType - the parameter type

distribution - the distribution of the parameter

addParameter

public void addParameter(GtuType gtuType,
 ParameterType<Double> parameterType,
 DistContinuous distribution)

Description copied from class: ParameterFactoryByType

Add parameter.

Overrides:

addParameter in class ParameterFactoryByType

Parameters:

gtuType - the gtu type

parameterType - the parameter type

distribution - the distribution of the parameter

addParameter

public <V> void addParameter(ParameterType<V> parameterType,
 V value)

Description copied from class: ParameterFactoryByType

Add parameter for all GTU types.

Overrides:

addParameter in class ParameterFactoryByType

Type Parameters:

V - type

Parameters:

parameterType - the parameter type

value - the value of the parameter

addParameter

public void addParameter(ParameterTypeDouble parameterType,
 double value)

Description copied from class: ParameterFactoryByType

Add parameter for all GTU types.

Overrides:

addParameter in class ParameterFactoryByType

Parameters:

parameterType - the parameter type

value - the value of the parameter

addParameter

public <U extends Unit<U>,
V extends org.djunits.value.vdouble.scalar.base.DoubleScalarRel<U,
V>>
void addParameter(ParameterTypeNumeric<V> parameterType,
 ContinuousDistDoubleScalar.Rel<V,U> distribution)

Description copied from class: ParameterFactoryByType

Add parameter for all GTU types.

Overrides:

addParameter in class ParameterFactoryByType

Type Parameters:

U - unit type

V - parameter value type

Parameters:

parameterType - the parameter type

distribution - ContinuousDistDoubleScalar.Rel<T,U>; the distribution of the parameter

addParameter

public void addParameter(ParameterTypeDouble parameterType,
 DistContinuous distribution)

Description copied from class: ParameterFactoryByType

Add parameter for all GTU types.

Overrides:

addParameter in class ParameterFactoryByType

Parameters:

parameterType - the parameter type

distribution - the distribution of the parameter

addCorrelation

public <C,
V> void addCorrelation(GtuType gtuType,
 ParameterType<C> first,
 ParameterType<V> then,
 ParameterFactoryByType.Correlation<C,V> correlation)

Description copied from class: ParameterFactoryByType

Correlates one parameter to another. The parameter 'first' may also be null, in which case the parameter can be correlated to an external source.

Overrides:

addCorrelation in class ParameterFactoryByType

Type Parameters:

C - parameter value type of first parameter

V - parameter value type of then parameter

Parameters:

gtuType - GTU type

first - independent parameter

then - dependent parameter

correlation - correlation

addCorrelation

public <C,
V> void addCorrelation(ParameterType<C> first,
 ParameterType<V> then,
 ParameterFactoryByType.Correlation<C,V> correlation)

Description copied from class: ParameterFactoryByType

Correlates one parameter to another for all GTU types.

Overrides:

addCorrelation in class ParameterFactoryByType

Type Parameters:

C - parameter value type of first parameter

V - parameter value type of then parameter

Parameters:

first - independent parameter

then - dependent parameter

correlation - correlation