fr.cnes.sirius.patrius.math.parameter

Class Parameterizable

java.lang.Object

fr.cnes.sirius.patrius.math.parameter.Parameterizable

All Implemented Interfaces:

IParameterizable, Serializable

Direct Known Subclasses:

AeroCrossSectionProperty, AeroFacetProperty, AeroGlobalProperty, AeroModel, DirectRadiativeModel, DragLiftModel, IntervalsFunction, JacobiansParameterizable, MassProperty, RediffusedRadiativeModel, SolarRadiationWrench, StelaAeroModel, TankProperty

public class Parameterizable
extends Object
implements IParameterizable

Simple class providing a list and method for handling parameters.

Since:

2.3

Version:

$Id: Parameterizable.java 18069 2017-10-02 16:45:28Z bignon $

Author:

auguief

See Also:

Serialized Form

Concurrency :

not thread-safe, uses internal mutable attributes

Constructor Summary

Constructors

Constructor and Description
Parameterizable() Simple constructor.
Parameterizable(ArrayList<Parameter> paramList) Simple constructor to add in the internal list the parameters contained in the given list.
Parameterizable(IParamDiffFunction... paramDiffFunctions) Simple constructor to add in the internal list the parameters contained in the given function list.
Parameterizable(Parameter... params) Simple constructor to add in the internal list the given parameters.

Method Summary

Modifier and Type	Method and Description
protected void	addAllParameters(Collection<Parameter> params) Add the given parameters in the internal list.
protected void	addAllParameters(Parameter... params) Add the given parameters in the internal list.
protected void	addParameter(Parameter param) Add the given parameter in the internal list.
ArrayList<Parameter>	getParameters() Get the supported parameters.
boolean	supportsParameter(Parameter param) Check if a parameter is supported.

Methods inherited from class java.lang.Object

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

Constructor Detail

Parameterizable

public Parameterizable()

Simple constructor.

Parameterizable

public Parameterizable(Parameter... params)

Simple constructor to add in the internal list the given parameters.

Note: Only one instance of each parameter is allowed in the list.

Parameters:

params - the parameters to add in the internal list

Parameterizable

public Parameterizable(ArrayList<Parameter> paramList)

Simple constructor to add in the internal list the parameters contained in the given list.

Note: Only one instance of each parameter is allowed in the list.

Parameters:

paramList - the list of parameters to add in the internal list

Parameterizable

public Parameterizable(IParamDiffFunction... paramDiffFunctions)

Simple constructor to add in the internal list the parameters contained in the given function list.

Note: Only one instance of each parameter is allowed in the list.

Parameters:

paramDiffFunctions - the list of functions containing the parameters to add in the internal list

Method Detail

supportsParameter

public boolean supportsParameter(Parameter param)

Check if a parameter is supported.

Specified by:

supportsParameter in interface IParameterizable

Parameters:

param - parameter to check

Returns:

true if the parameter is supported

getParameters

public ArrayList<Parameter> getParameters()

Get the supported parameters.

Specified by:

getParameters in interface IParameterizable

Returns:

list of supported parameters

addParameter

protected void addParameter(Parameter param)

Add the given parameter in the internal list.

Note: Only one instance of the parameter is allowed in the list.

Parameters:

param - parameter to add

addAllParameters

protected final void addAllParameters(Parameter... params)

Add the given parameters in the internal list.

Note: Only one instance of each parameter is allowed in the list.

Parameters:

params - parameters to add

addAllParameters

protected final void addAllParameters(Collection<Parameter> params)

Add the given parameters in the internal list.

Note: Only one instance of each parameter is allowed in the list.

Parameters:

params - parameters to add