- java.lang.Object
-
- spice.basic.GFConstraint
-
public class GFConstraint extends java.lang.Object
Class GFConstraint represents relational constraints applicable to GF numeric quantity searches.Version 1.0.0 21-DEC-2009 (NJB)
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ABSOLUTE_MAXIMUM
static java.lang.String
ABSOLUTE_MINIMUM
static java.lang.String
ADJUSTED_ABSMAX
static java.lang.String
ADJUSTED_ABSMIN
private double
adjustmentValue
static java.lang.String
EQUALS
static java.lang.String
GREATER_THAN
static java.lang.String
LESS_THAN
static java.lang.String
LOCAL_MAXIMUM
static java.lang.String
LOCAL_MINIMUM
private double
referenceValue
private java.lang.String
relation
-
Constructor Summary
Constructors Modifier Constructor Description private
GFConstraint(java.lang.String relation, double referenceValue, double adjustmentValue)
-
Method Summary
Modifier and Type Method Description static GFConstraint
createExtremumConstraint(java.lang.String extremumType)
Create a GF local or absolute extremum constraint.This constructor is applicable to constraints using local or unadjusted absolute extrema relations.static GFConstraint
createExtremumConstraint(java.lang.String extremumType, double adjustmentValue)
Create a GF absolute extremum constraint with an adjustment value.static GFConstraint
createReferenceConstraint(java.lang.String relation, double referenceValue)
Create a GF relational constraint with a reference value.double
getAdjustmentValue()
Get the adjustment value from this constraint.java.lang.String
getCSPICERelation()
Get the CSPICE String representing the relation.double
getReferenceValue()
Get the reference value from this constraint.java.lang.String
getRelation()
Get the relation from this constraint.boolean
isAdjustedExtremum()
Indicate whether this constraint is an adjusted extremum constraint.boolean
isExtremum()
Indicate whether this constraint is an extremum constraint.boolean
isOrder()
Indicate whether this constraint is an order constraint: that is, an equality or inequality.boolean
isUnadjustedExtremum()
Indicate whether this constraint is an unadjusted extremum constraint.
-
-
-
Field Detail
-
ABSOLUTE_MAXIMUM
public static final java.lang.String ABSOLUTE_MAXIMUM
- See Also:
- Constant Field Values
-
ABSOLUTE_MINIMUM
public static final java.lang.String ABSOLUTE_MINIMUM
- See Also:
- Constant Field Values
-
ADJUSTED_ABSMAX
public static final java.lang.String ADJUSTED_ABSMAX
- See Also:
- Constant Field Values
-
ADJUSTED_ABSMIN
public static final java.lang.String ADJUSTED_ABSMIN
- See Also:
- Constant Field Values
-
EQUALS
public static final java.lang.String EQUALS
- See Also:
- Constant Field Values
-
GREATER_THAN
public static final java.lang.String GREATER_THAN
- See Also:
- Constant Field Values
-
LESS_THAN
public static final java.lang.String LESS_THAN
- See Also:
- Constant Field Values
-
LOCAL_MAXIMUM
public static final java.lang.String LOCAL_MAXIMUM
- See Also:
- Constant Field Values
-
LOCAL_MINIMUM
public static final java.lang.String LOCAL_MINIMUM
- See Also:
- Constant Field Values
-
relation
private java.lang.String relation
-
referenceValue
private double referenceValue
-
adjustmentValue
private double adjustmentValue
-
-
Method Detail
-
createExtremumConstraint
public static GFConstraint createExtremumConstraint(java.lang.String extremumType) throws SpiceException
Create a GF local or absolute extremum constraint.This constructor is applicable to constraints using local or unadjusted absolute extrema relations.- Parameters:
extremumType
- String- Returns:
- GFConstraint
- Throws:
SpiceException
- exception
-
createExtremumConstraint
public static GFConstraint createExtremumConstraint(java.lang.String extremumType, double adjustmentValue) throws SpiceException
Create a GF absolute extremum constraint with an adjustment value.- Parameters:
extremumType
- StringadjustmentValue
- double- Returns:
- GFConstraint
- Throws:
SpiceException
- exception
-
createReferenceConstraint
public static GFConstraint createReferenceConstraint(java.lang.String relation, double referenceValue) throws SpiceException
Create a GF relational constraint with a reference value.- Parameters:
relation
- StringreferenceValue
- double- Returns:
- GFConstraint
- Throws:
SpiceException
- exception
-
getRelation
public java.lang.String getRelation()
Get the relation from this constraint.- Returns:
- String
-
getReferenceValue
public double getReferenceValue()
Get the reference value from this constraint.- Returns:
- double
-
getAdjustmentValue
public double getAdjustmentValue()
Get the adjustment value from this constraint.- Returns:
- double
-
getCSPICERelation
public java.lang.String getCSPICERelation()
Get the CSPICE String representing the relation.- Returns:
- String
-
isOrder
public boolean isOrder()
Indicate whether this constraint is an order constraint: that is, an equality or inequality.- Returns:
- boolean
-
isExtremum
public boolean isExtremum()
Indicate whether this constraint is an extremum constraint.- Returns:
- boolean
-
isUnadjustedExtremum
public boolean isUnadjustedExtremum()
Indicate whether this constraint is an unadjusted extremum constraint.- Returns:
- boolean
-
isAdjustedExtremum
public boolean isAdjustedExtremum()
Indicate whether this constraint is an adjusted extremum constraint.- Returns:
- boolean
-
-