de.jstacs.algorithms.optimization.termination
Class IterationCondition.IterationConditionParameterSet
java.lang.Object
de.jstacs.parameters.ParameterSet
de.jstacs.parameters.InstanceParameterSet<AbstractTerminationCondition>
de.jstacs.algorithms.optimization.termination.AbstractTerminationCondition.AbstractTerminationConditionParameterSet
de.jstacs.algorithms.optimization.termination.IterationCondition.IterationConditionParameterSet
- All Implemented Interfaces:
- GalaxyConvertible, Storable, Cloneable
- Enclosing class:
- IterationCondition
public static class IterationCondition.IterationConditionParameterSet
- extends AbstractTerminationCondition.AbstractTerminationConditionParameterSet
This class implements the parameter set for a IterationCondition
.
- Author:
- Jens Keilwagen
Methods inherited from class de.jstacs.parameters.ParameterSet |
fromGalaxy, getAllParameterNames, getComment, getComment, getErrorMessage, getIndex, getName, getName, getNumberOfParameters, getParameterAt, getParameterForName, getParent, hasDefaultOrIsSet, initParameterList, initParameterList, isAtomic, isComparable, parametersLoaded, reset, setParent, toGalaxy |
IterationCondition.IterationConditionParameterSet
public IterationCondition.IterationConditionParameterSet()
throws SimpleParameter.DatatypeNotValidException
- This constructor creates an empty parameter set.
- Throws:
SimpleParameter.DatatypeNotValidException
IterationCondition.IterationConditionParameterSet
public IterationCondition.IterationConditionParameterSet(StringBuffer xml)
throws NonParsableException
- The standard constructor for the interface
Storable
.
Constructs an IterationCondition.IterationConditionParameterSet
out of an XML representation.
- Parameters:
xml
- the XML representation as StringBuffer
- Throws:
NonParsableException
- if the IterationCondition.IterationConditionParameterSet
could not be
reconstructed out of the StringBuffer
representation
IterationCondition.IterationConditionParameterSet
public IterationCondition.IterationConditionParameterSet(int maxIter)
throws IllegalArgumentException,
SimpleParameter.IllegalValueException,
SimpleParameter.DatatypeNotValidException
- This constructor creates a filled instance of a parameters set.
- Parameters:
maxIter
- the maximal number of iterations of the algorithm
- Throws:
IllegalArgumentException
- if parameter can not be set
SimpleParameter.IllegalValueException
- if parameter can not be set
SimpleParameter.DatatypeNotValidException
getInstanceComment
public String getInstanceComment()
- Description copied from class:
InstanceParameterSet
- Returns a comment (a textual description) of the class that can be
constructed using this
ParameterSet
.
- Specified by:
getInstanceComment
in class InstanceParameterSet<AbstractTerminationCondition>
- Returns:
- the comment of the class
getInstanceName
public String getInstanceName()
- Description copied from class:
InstanceParameterSet
- Returns the name of an instance of the class that can be constructed
using this
ParameterSet
.
- Specified by:
getInstanceName
in class InstanceParameterSet<AbstractTerminationCondition>
- Returns:
- the name of the class