public class Parameter
extends java.lang.Object
This class represents a Teuchos parameter. It is a simple data structure that only holds data.
Modifier and Type | Field and Description |
---|---|
java.lang.String |
name
The name of the parameter.
|
java.lang.String |
type
The type of the parameter.
|
java.lang.String |
value
The value of the parameter.
|
Constructor and Description |
---|
Parameter() |
public java.lang.String name
The name of the parameter.
public java.lang.String type
The type of the parameter.
public java.lang.String value
The value of the parameter.
public Entry toEntry()
This operation returns this parameter as an ICE Entry. The name and value are translated directly. The value of the parameter at the time of construction as the default value. The default id value is 1 and the description is undefined. The AllowedValueType of the Entry is mapped to Discrete for a parameter type of bool, Undefined for a parameter type of string and Continuous for a parameter type of int or double. The latter has bounds of Double.POSITIVE_INFINITY and Double.NEGATIVE_INFINITY. Arrays of all types have an AllowedValueType of Undefined.
The Entry.
public void fromEntry(Entry entry)
This operation loads the Parameter from an Entry. It performs the inverse of the toEntry() operation with the added restrictions that all Arrays (determined by the presence of "{" and "}) have a type of Array(string) and all floating point numbers (determined by the presence of " ." for an AllowedValueType of Continuous) have type double. All types of Discrete are consider to be bool.
entry
- The Entry.