spis.Top.Default
Class Parameter

java.lang.Object
  extended byspis.Top.Default.Parameter
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
GlobalParameter, LocalParameter

public class Parameter
extends java.lang.Object
implements java.io.Serializable

Class Name : Parameter
Project ref : SPIS project
File name : Parameter.java
File type : class
Copyright : ONERA, 2 Av. E. Belin, 31055 Toulouse cedex, France http://www.onecert.fr
Status : under development
Creation : 10 mars 2004
Modification :

Description : Control Parameter of the simulation.

Versions and anomalies correction :

Version numberAuthor (name, e-mail) Corrections/Modifications
0.1 JF Roussel, roussel@onecert.frCreation


Version:
0.1
Author:
JF Roussel
See Also:
Serialized Form

Field Summary
private  java.lang.String comment
          Comment on that parameter
private  java.lang.String name
          Name of the parameter (reserved keyword, that will be reckognized by the solvers)
private  java.lang.String type
          Type of the parameter (for now, should be limited to one of Integer, Float, or String)
private  java.lang.String unit
          Unit of that parameter
private  java.lang.Object value
          Value of the parameter
 
Constructor Summary
Parameter(java.lang.String name_, java.lang.String type_, java.lang.Object value_, java.lang.String unit_, java.lang.String comment_)
          Default constructor.
 
Method Summary
static Parameter extractParam(java.lang.String name, Parameter[] params)
          Returns the parameter of name name from the parameter array param (returns null if not found).
 java.lang.String getComment()
           
 java.lang.String getName()
           
 java.lang.String getType()
           
 java.lang.String getUnit()
           
 java.lang.Object getValue()
           
 void setComment(java.lang.String string)
           
 void setName(java.lang.String string)
           
 void setType(java.lang.String string)
           
 void setUnit(java.lang.String string)
           
 void setValue(java.lang.Object object)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

name

private java.lang.String name
Name of the parameter (reserved keyword, that will be reckognized by the solvers)


type

private java.lang.String type
Type of the parameter (for now, should be limited to one of Integer, Float, or String)


value

private java.lang.Object value
Value of the parameter


unit

private java.lang.String unit
Unit of that parameter


comment

private java.lang.String comment
Comment on that parameter

Constructor Detail

Parameter

public Parameter(java.lang.String name_,
                 java.lang.String type_,
                 java.lang.Object value_,
                 java.lang.String unit_,
                 java.lang.String comment_)
Default constructor. Supported types for value are Integer, Float, or String (enforced)

Method Detail

extractParam

public static Parameter extractParam(java.lang.String name,
                                     Parameter[] params)
Returns the parameter of name name from the parameter array param (returns null if not found).

Parameters:
name -
params -
Returns:

getComment

public java.lang.String getComment()
Returns:

getName

public java.lang.String getName()
Returns:

getType

public java.lang.String getType()
Returns:

getValue

public java.lang.Object getValue()
Returns:

setComment

public void setComment(java.lang.String string)
Parameters:
string -

setName

public void setName(java.lang.String string)
Parameters:
string -

setType

public void setType(java.lang.String string)
Parameters:
string -

setValue

public void setValue(java.lang.Object object)
Parameters:
object -

getUnit

public java.lang.String getUnit()
Returns:

setUnit

public void setUnit(java.lang.String string)
Parameters:
string -