|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.keridwen.modelling.global.parameters.GlobalParameter
public class GlobalParameter
Generic setting parameter class
Nested Class Summary | |
---|---|
static class |
GlobalParameter.VerbosityLevel
|
Field Summary | |
---|---|
static String |
BOOLEAN
|
static String |
DOUBLE
|
static String |
FLOAT
|
static String |
INT
|
static String |
OBJECT
|
static String |
STRING
|
Constructor Summary | |
---|---|
GlobalParameter()
Default construtor. |
|
GlobalParameter(String keyName,
String category,
boolean value,
String unit,
String description)
Constructor for boolean based value. |
|
GlobalParameter(String keyName,
String category,
double value,
String unit,
String description)
Constructor for double based value. |
|
GlobalParameter(String keyName,
String category,
float value,
String unit,
String description)
Constructor for float based value. |
|
GlobalParameter(String keyName,
String category,
int value,
String unit,
String description)
Constructor for int based value. |
|
GlobalParameter(String keyName,
String category,
Object value,
String unit,
String description)
Constructor for Object based value. |
|
GlobalParameter(String keyName,
String category,
String value,
String unit,
String description)
Constructor for string based value. |
Method Summary | |
---|---|
void |
addGlobalParameterListener(GlobalParameterListener l)
Register a listener for groups related change state events |
boolean |
equals(Object obj)
|
String |
getCategory()
Get the category of the present parameter. |
String |
getDescription()
Get the free description of the parameters. |
String |
getKeyName()
Get the name of the present parameter. |
String |
getTypeAString()
Get the type of the present parameter on the form of a simple String. |
String |
getUnit()
Get the unit as String of the present parameter. |
Object |
getValue()
Get the stored value. |
boolean |
getValueAsBoolean()
|
double |
getValueAsDouble()
|
float |
getValueAsFloat()
|
int |
getValueAsInt()
|
Object |
getValueAsObject()
|
String |
getValueAsString()
|
GlobalParameter.VerbosityLevel |
getVerbosityLevel()
|
int |
hashCode()
|
void |
removeGlobalParameterListener(GlobalParameterListener l)
Remove a listener for groups related events |
void |
setCategory(String category)
This field is optional, but can be useful to organised Parameters into several sub-categories (in the table based editor for instance). |
void |
setDescription(String description)
Set the free description of the parameters. |
void |
setKeyName(String keyName)
Set the name of the present parameter. |
void |
setTypeAString(String typeAString)
Set the type of the present parameter on the form of a simple String. |
void |
setUnit(String unit)
Set the unit as String of the present parameter. |
void |
setValueAsBoolean(boolean valueAsBoolean)
|
void |
setValueAsDouble(double valueAsDouble)
|
void |
setValueAsFloat(float valueAsFloat)
|
void |
setValueAsInt(int valueAsInt)
|
void |
setValueAsObject(Object valueAsObject)
|
void |
setValueAsString(String valueAsString)
|
void |
setVerbosityLevel(GlobalParameter.VerbosityLevel verbosityLevel)
|
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String OBJECT
public static final String FLOAT
public static final String DOUBLE
public static final String INT
public static final String STRING
public static final String BOOLEAN
Constructor Detail |
---|
public GlobalParameter()
public GlobalParameter(String keyName, String category, Object value, String unit, String description)
keyName
- - name of the parameter.category
- - Category of the parameter.value
- - Value as Object of the parameter.unit
- - Unit as String of the parameter.description
- - Description of the parameter.public GlobalParameter(String keyName, String category, float value, String unit, String description)
keyName
- - name of the parameter.category
- - Category of the parameter.value
- - Value as float of the parameter.unit
- - Unit as String of the parameter.description
- - Description of the parameter.public GlobalParameter(String keyName, String category, int value, String unit, String description)
keyName
- - name of the parameter.category
- - Category of the parameter.value
- - Value as int of the parameter.unit
- - Unit as String of the parameter.description
- - Description of the parameter.public GlobalParameter(String keyName, String category, double value, String unit, String description)
keyName
- - name of the parameter.category
- - Category of the parameter.value
- - Value as double of the parameter.unit
- - Unit as String of the parameter.description
- - Description of the parameter.public GlobalParameter(String keyName, String category, String value, String unit, String description)
keyName
- - name of the parameter.category
- - Category of the parameter.value
- - Value as String of the parameter.unit
- - Unit as String of the parameter.description
- - Description of the parameter.public GlobalParameter(String keyName, String category, boolean value, String unit, String description)
keyName
- - name of the parameter.category
- - Category of the parameter.value
- - Value as boolean of the parameter.unit
- - Unit as String of the parameter.description
- - Description of the parameter.Method Detail |
---|
public Object getValue()
public String getKeyName()
public void setKeyName(String keyName)
keyName
- - KeyName of the present parameter.public String getCategory()
public void setCategory(String category)
category
- - Category as String (e.g. External Boundary Conditions)public String getUnit()
public void setUnit(String unit)
unit
- - String based representation of the unit.public String getDescription()
public void setDescription(String description)
description
- public String getTypeAString()
public void setTypeAString(String typeAString)
typeAString
- public Object getValueAsObject()
public void setValueAsObject(Object valueAsObject)
public float getValueAsFloat()
public void setValueAsFloat(float valueAsFloat)
public double getValueAsDouble()
public void setValueAsDouble(double valueAsDouble)
public int getValueAsInt()
public void setValueAsInt(int valueAsInt)
public String getValueAsString()
public void setValueAsString(String valueAsString)
public int hashCode()
hashCode
in class Object
public boolean equals(Object obj)
equals
in class Object
public void setValueAsBoolean(boolean valueAsBoolean)
public boolean getValueAsBoolean()
public GlobalParameter.VerbosityLevel getVerbosityLevel()
public void setVerbosityLevel(GlobalParameter.VerbosityLevel verbosityLevel)
public void addGlobalParameterListener(GlobalParameterListener l)
public void removeGlobalParameterListener(GlobalParameterListener l)
public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |