AbstractTarget.ConstraintAdapter

java.lang.Object
- target.AbstractTarget.ConstraintAdapter

All Implemented Interfaces:

Serializable, Appointable.Constraint

Direct Known Subclasses:

PointingScheduler.HeightConstraint, PointingScheduler.SolarConstraint, SporeTarget.Constraint

Enclosing class:

AbstractTarget
```
public static class AbstractTarget.ConstraintAdapter
extends Object
implements Appointable.Constraint, Serializable
```
An adapter class for Appointable.Constraints.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`private Number`	`above` The above value in a above-below constraint.
`private Number`	`below` The below value in a above-below constraint.
`private Number`	`from` The from value in a from-to constraint.
`private Number`	`max` The maximum if specified.
`private Number`	`min` The minimum if specified.
`private static long`	`serialVersionUID`
`private Number`	`to` The to value in a from-to constraint.
`private String`	`valuename` The name of the parameter to test.

Constructor Summary

Constructors
Constructor and Description
`ConstraintAdapter(String val)` Constructs a new constraints object giving the parameter name and specifying one parameter constraint.
`ConstraintAdapter(String val, Number cmin, Number cmax, Number cfrom, Number cto, Number cbelow, Number cabove)` Constructs a new constraints object giving the parameter name and specifying one parameter constraint.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Number`	`getAbove()` Returns the upper bound of the forbiddn parameter space.
`Number`	`getBelow()` Returns the lower bound of the forbiddn parameter space.
`Number`	`getFrom()` Returns the lower bound of the allowed parameter space.
`Number`	`getMax()` Returns the maximum of the allowed parameter space.
`Number`	`getMin()` Returns the minimum of the allowed parameter space.
`long`	`getTimeForConstraint(GlobalGrouping set, TargetDefinition target)` Returns the time remaining for this constraint.
`Number`	`getTo()` Returns the upper bound of the allowed parameter space.
`String`	`getValueName()` Returns the value name asociated with this constraint.
`boolean`	`isSatisfied(GlobalGrouping set, TargetDefinition target)` Implements the `stella.Scheduling.Constraint` method and diverts it to calculating the remaining time.
`String`	`toString()` Returns the name of the variable plus the apllied constraint.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
  - valuename
```
private final String valuename
```
    The name of the parameter to test.
  - min
```
private final Number min
```
    The minimum if specified.
  - max
```
private final Number max
```
    The maximum if specified.
  - from
```
private final Number from
```
    The from value in a from-to constraint.
  - to
```
private final Number to
```
    The to value in a from-to constraint.
  - below
```
private final Number below
```
    The below value in a above-below constraint.
  - above
```
private final Number above
```
    The above value in a above-below constraint.
- Constructor Detail
  - ConstraintAdapter
```
public ConstraintAdapter(String val)
```
    Constructs a new constraints object giving the parameter name and specifying one parameter constraint. Note that all other possible constraint values should be null. It is the users responsibility to ensure this.
  - ConstraintAdapter
```
public ConstraintAdapter(String val,
                         Number cmin,
                         Number cmax,
                         Number cfrom,
                         Number cto,
                         Number cbelow,
                         Number cabove)
```
    Constructs a new constraints object giving the parameter name and specifying one parameter constraint. Note that all other possible constraint values should be null. It is the users responsibility to ensure this.
- Method Detail
  - getValueName
```
public String getValueName()
```
    Returns the value name asociated with this constraint.
    
    Specified by:
    
    getValueName in interface Appointable.Constraint
  - getMin
```
public Number getMin()
```
    Returns the minimum of the allowed parameter space. If the contraint is no minimum-constraint, this returns null.
    
    Specified by:
    
    getMin in interface Appointable.Constraint
  - getMax
```
public Number getMax()
```
    Returns the maximum of the allowed parameter space. If the contraint is no maximum-constraint, this returns null.
    
    Specified by:
    
    getMax in interface Appointable.Constraint
  - getFrom
```
public Number getFrom()
```
    Returns the lower bound of the allowed parameter space. If the contraint is no from-to-constraint, this returns null.
    
    Specified by:
    
    getFrom in interface Appointable.Constraint
  - getTo
```
public Number getTo()
```
    Returns the upper bound of the allowed parameter space. If the contraint is no from-to-constraint, this returns null.
    
    Specified by:
    
    getTo in interface Appointable.Constraint
  - getBelow
```
public Number getBelow()
```
    Returns the lower bound of the forbiddn parameter space. If the contraint is no below-above-constraint, this returns null.
    
    Specified by:
    
    getBelow in interface Appointable.Constraint
  - getAbove
```
public Number getAbove()
```
    Returns the upper bound of the forbiddn parameter space. If the contraint is no below-above-constraint, this returns null.
    
    Specified by:
    
    getAbove in interface Appointable.Constraint
  - isSatisfied
```
public boolean isSatisfied(GlobalGrouping set,
                           TargetDefinition target)
```
    Implements the stella.Scheduling.Constraint method and diverts it to calculating the remaining time. If no time is remaining, false is returned.
    
    Specified by:
    
    isSatisfied in interface Appointable.Constraint
  - getTimeForConstraint
```
public long getTimeForConstraint(GlobalGrouping set,
                                 TargetDefinition target)
```
    Returns the time remaining for this constraint. First, the parameter cluster is queried for the parameter with the name valuename . Then, the type of constraint is checked and the current value of the parameter is checked against the constraints. If the parameter is out of bounds, zero is returned. Otherwise, the parameter is checked for being Increasing or Decreasing. Depending on the constraint type, this property of the parameter is used to fetch a remaining time. If the parameter does not supply a Increasing or Decreasing information, the maximum time is returned.
    
    Specified by:
    
    getTimeForConstraint in interface Appointable.Constraint
  - toString
```
public String toString()
```
    Returns the name of the variable plus the apllied constraint.
    
    Overrides:
    
    toString in class Object

Class AbstractTarget.ConstraintAdapter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

valuename

min

max

from

to

below

above

Constructor Detail

ConstraintAdapter

ConstraintAdapter

Method Detail

getValueName

getMin

getMax

getFrom

getTo

getBelow

getAbove

isSatisfied

getTimeForConstraint

toString