JNISpice
version 2.0.0

spice.basic
Class GFConstraint

java.lang.Object
  extended by 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
static java.lang.String ABSOLUTE_MAXIMUM
           
static java.lang.String ABSOLUTE_MINIMUM
           
static java.lang.String ADJUSTED_ABSMAX
           
static java.lang.String ADJUSTED_ABSMIN
           
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
           
 
Method Summary
static GFConstraint createExtremumConstraint(java.lang.String extremumType)
          Create a GF local or absolute extremum constraint.
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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

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
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.

Throws:
SpiceException

createExtremumConstraint

public static GFConstraint createExtremumConstraint(java.lang.String extremumType,
                                                    double adjustmentValue)
                                             throws SpiceException
Create a GF absolute extremum constraint with an adjustment value.

Throws:
SpiceException

createReferenceConstraint

public static GFConstraint createReferenceConstraint(java.lang.String relation,
                                                     double referenceValue)
                                              throws SpiceException
Create a GF relational constraint with a reference value.

Throws:
SpiceException

getRelation

public java.lang.String getRelation()
Get the relation from this constraint.


getReferenceValue

public double getReferenceValue()
Get the reference value from this constraint.


getAdjustmentValue

public double getAdjustmentValue()
Get the adjustment value from this constraint.


getCSPICERelation

public java.lang.String getCSPICERelation()
Get the CSPICE String representing the relation.


isOrder

public boolean isOrder()
Indicate whether this constraint is an order constraint: that is, an equality or inequality.


isExtremum

public boolean isExtremum()
Indicate whether this constraint is an extremum constraint.


isUnadjustedExtremum

public boolean isUnadjustedExtremum()
Indicate whether this constraint is an unadjusted extremum constraint.


isAdjustedExtremum

public boolean isAdjustedExtremum()
Indicate whether this constraint is an adjusted extremum constraint.


JNISpice
version 2.0.0

JNISpice Alpha Test Version 2.0.0 28-JAN-2017 (NJB)