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, DrozinerAttractionModel, JacobiansParameterizable, MassProperty, ParamDiffFunction, RediffusedRadiativeModel, SolarRadiationWrench, StelaAeroModel, TankProperty

public class Parameterizable
extends Object
implements IParameterizable

Simple class providing a list and method for handling Parameters. These parameters should be simple Parameter and/or the Parameters used in parameterizable functions

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.
Parameterizable(IParamDiffFunction... paramDiffFunctions) Simple constructor.
Parameterizable(Parameter... params) Simple constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addParameter(Parameter param) Add a new parameter in the lit, only if it does not exist.
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.

Parameters:

params - the supported parameters

Parameterizable

public Parameterizable(ArrayList<Parameter> paramList)

Simple constructor.

Parameters:

paramList - the supported parameters

Parameterizable

public Parameterizable(IParamDiffFunction... paramDiffFunctions)

Simple constructor.

Parameters:

paramDiffFunctions - IParamDiffFunction with their parameters

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 a new parameter in the lit, only if it does not exist.

Parameters:

param - parameter