agi.foundation.access.constraints

(agi.foundation.platforms-2024r3.jar)

Class CartographicZoneConstraint

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.access.AccessQuery

agi.foundation.access.AccessConstraint

agi.foundation.access.constraints.CartographicZoneConstraint

All Implemented Interfaces:

ISingleObjectConstraint, ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class CartographicZoneConstraint
extends AccessConstraint
implements ISingleObjectConstraint

This constraint limits access to within a certain cartographic region. Depending on parameters, either there is a list of regions which do not allow access (exclusion) or a single region which allows access (inclusion) and excludes all other regions.

This constraint requires that the ConstrainedObject (get / set) provide ILocationPointService.

This constraint obtains the longitude and latitude of the object using the evaluator returned by CentralBody.observeCartographicPoint(Point,EvaluatorGroup) and checks them against the zone definition.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CartographicZoneConstraint() Initializes a new instance with default values.
protected	CartographicZoneConstraint(CartographicZoneConstraint existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
	CartographicZoneConstraint(CentralBody centralBody, double minimumLatitude, double maximumLatitude, double minimumLongitude, double maximumLongitude, boolean isInclusion) Initializes a new instance with the specified central body and zone definition.
	CartographicZoneConstraint(IServiceProvider constrainedObject, CentralBody centralBody, double minimumLatitude, double maximumLatitude, double minimumLongitude, double maximumLongitude, boolean isInclusion) Initializes a new instance with the specified constrained object, central body, and zone definition.

Method Summary

Modifier and Type	Method and Description
void	buildQueryEvaluator(ConstraintQueryBuilder builder, EvaluatorGroup group) Builds a query evaluator from this constraint.
protected boolean	checkForSameDefinition(AccessConstraint other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(CartographicZoneConstraint other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
Object	clone(CopyContext context) Clones this object using the specified context.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
void	enumerateDependencies(DependencyEnumerator enumerator) Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon.
CentralBody	getCentralBody() Gets the central body used to define the cartographic coordinates.
IServiceProvider	getConstrainedObject() Gets the object to which this constraint applies.
boolean	getIsInclusion() Gets a value indicating whether access is satisfied inside or outside the cartographic zone represented by this constraint.
double	getMaximumLatitude() Gets the northernmost planetodetic latitude of the cartographic zone, in radians.
double	getMaximumLongitude() Gets the easternmost longitude of the cartographic zone, in radians.
double	getMinimumLatitude() Gets the southernmost planetodetic latitude of the cartographic zone, in radians.
double	getMinimumLongitude() Gets the westernmost longitude of the cartographic zone, in radians.
double	getTolerance() Gets the tolerance on the constraint value to use when computing the time when this constraint crosses its threshold.
void	setCentralBody(CentralBody value) Sets the central body used to define the cartographic coordinates.
void	setConstrainedObject(IServiceProvider value) Sets the object to which this constraint applies.
void	setIsInclusion(boolean value) Sets a value indicating whether access is satisfied inside or outside the cartographic zone represented by this constraint.
void	setMaximumLatitude(double value) Sets the northernmost planetodetic latitude of the cartographic zone, in radians.
void	setMaximumLongitude(double value) Sets the easternmost longitude of the cartographic zone, in radians.
void	setMinimumLatitude(double value) Sets the southernmost planetodetic latitude of the cartographic zone, in radians.
void	setMinimumLongitude(double value) Sets the westernmost longitude of the cartographic zone, in radians.
void	setTolerance(double value) Sets the tolerance on the constraint value to use when computing the time when this constraint crosses its threshold.
void	setZone(double minimumLatitude, double maximumLatitude, double minimumLongitude, double maximumLongitude, boolean isInclusion) Set the latitude and longitude boundaries for an inclusion zone.
String	toString() Returns a string representation of the object.

Methods inherited from class agi.foundation.access.AccessConstraint

checkForSameDefinition, freezeAggregatedObjects, getApplicability, getEvaluationOrder, getEvaluator, getSampling, setApplicability, setEvaluationOrder, toDisjunctiveNormalForm

Methods inherited from class agi.foundation.access.AccessQuery

and, and, anyPath, anyPath, anyPath, anyPath, anyPath, anyPath, atLeastN, atMostN, checkForSameDefinition, exactlyN, fromObject, fromObjectAllowNoConstraints, getDebuggingLogger, getEvaluator, getEvaluator, not, or, or, setDebuggingLogger

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozen

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CartographicZoneConstraint

public CartographicZoneConstraint()

Initializes a new instance with default values.

This constructor initializes the CentralBody (get / set) property to the Earth (get) instance that is in the CentralBodiesFacet instance in the CalculationContext.

Before evaluating this constraint using AccessComputation, the user must call CartographicZoneConstraint.setZone(double, double, double, double, boolean) or set the corresponding properties individually. Before evaluating this constraint as part of an AccessQuery, it is also necessary to set the ConstrainedObject (get / set) property.

CartographicZoneConstraint

public CartographicZoneConstraint(CentralBody centralBody,
                                  double minimumLatitude,
                                  double maximumLatitude,
                                  double minimumLongitude,
                                  double maximumLongitude,
                                  boolean isInclusion)

Initializes a new instance with the specified central body and zone definition.

This constraint is ready for use with AccessComputation after being constructed using this constructor. However, before evaluating this constraint as part of an AccessQuery, it is necessary to set the ConstrainedObject (get / set) property.

Parameters:

centralBody - The central body relative to which the cartographic zone is computed.

minimumLatitude - The south-most planetodetic latitude boundary, in radians.

maximumLatitude - The north-most planetodetic latitude boundary, in radians.

minimumLongitude - The west-most longitude boundary, in radians.

maximumLongitude - The east-most longitude boundary, in radians.

isInclusion - If true, access is only satisfied within this zone. Otherwise, access is only satisfied outside this zone.

CartographicZoneConstraint

public CartographicZoneConstraint(IServiceProvider constrainedObject,
                                  CentralBody centralBody,
                                  double minimumLatitude,
                                  double maximumLatitude,
                                  double minimumLongitude,
                                  double maximumLongitude,
                                  boolean isInclusion)

Initializes a new instance with the specified constrained object, central body, and zone definition.

This constraint is ready for use with both AccessComputation and AccessQuery after being constructed using this constructor.

Parameters:

constrainedObject - The object to which this constraint is applied.

centralBody - The central body relative to which the cartographic zone is computed.

minimumLatitude - The south-most planetodetic latitude boundary, in radians.

maximumLatitude - The north-most planetodetic latitude boundary, in radians.

minimumLongitude - The west-most longitude boundary, in radians.

maximumLongitude - The east-most longitude boundary, in radians.

isInclusion - If true, access is only satisfied within this zone. Otherwise, access is only satisfied outside this zone.

CartographicZoneConstraint

protected CartographicZoneConstraint(@Nonnull
                                     CartographicZoneConstraint existingInstance,
                                     @Nonnull
                                     CopyContext context)

Initializes a new instance as a copy of an existing instance.

See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor in a derived class.

Parameters:

existingInstance - The existing instance to copy.

context - A CopyContext that controls the depth of the copy.

Throws:

ArgumentNullException - Thrown when existingInstance or context is null.

Method Detail

clone

public Object clone(CopyContext context)

Clones this object using the specified context.

This method should be implemented to call a copy constructor on the class of the object being cloned. The copy constructor should take the CopyContext as a parameter in addition to the existing instance to copy. The copy constructor should first call CopyContext.addObjectMapping(T, T) to identify the newly constructed instance as a copy of the existing instance. It should then copy all fields, using CopyContext.updateReference(T) to copy any reference fields.

A typical implementation of ICloneWithContext:

public static class MyClass implements ICloneWithContext {
    public MyClass(MyClass existingInstance, CopyContext context) {
        context.addObjectMapping(existingInstance, this);
        someReference = context.updateReference(existingInstance.someReference);
    }

    @Override
    public final Object clone(CopyContext context) {
        return new MyClass(this, context);
    }

    private Object someReference;
}

In general, all fields that are reference types should be copied with a call to CopyContext.updateReference(T). There are a couple of exceptions:

1. Fields that are aggregate parts of the object should always be copied. A referenced object is an aggregate if properties or methods on the object being copied can modify the externally-visible value of the referenced object.
2. If the semantics of the referenced object require that it have a single parent, owner, context, etc., and the object being copied is that parent, owner, or context, then the referenced object should always be copied.

If one of these exceptions applies, the CopyContext should be given an opportunity to update the reference before the reference is copied explicitly. Use CopyContext.updateReference(T) to update the reference. If CopyContext.updateReference(T) returns the original object, indicating that the context does not have a replacement registered, then copy the object manually by invoking a Clone method, a copy constructor, or by manually constructing a new instance and copying the values.

alwaysCopy = context.updateReference(existingInstance.alwaysCopy);
if (existingInstance.alwaysCopy != null && alwaysCopy == existingInstance.alwaysCopy) {
    alwaysCopy = (AlwaysCopy) existingInstance.alwaysCopy.clone(context);
}

If you are implementing an evaluator (a class that implements IEvaluator), the IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) method shares some responsibilities with the copy context constructor. Code duplication can be avoided by doing the following:

1. For references to other evaluators ONLY, simply assign the reference in the constructor instead of calling CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to non-evaluators.
2. Call IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the same CopyContext passed to the constructor.
3. Implement IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as normal. See the reference documentation for IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) for more information on implementing that method.

public MyClass(MyClass existingInstance, CopyContext context) {
    super(existingInstance, context);
    someReference = context.updateReference(existingInstance.someReference);
    evaluatorReference = existingInstance.evaluatorReference;
    updateEvaluatorReferences(context);
}

@Override
public void updateEvaluatorReferences(CopyContext context) {
    evaluatorReference = context.updateReference(evaluatorReference);
}

@Override
public Object clone(CopyContext context) {
    return new MyClass(this, context);
}

private Object someReference;
private IEvaluator evaluatorReference;

Specified by:

clone in interface ICloneWithContext

Specified by:

clone in class DefinitionalObject

Parameters:

context - The context to use to perform the copy.

Returns:

A new instance which is a copy of this object.

checkForSameDefinition

protected final boolean checkForSameDefinition(AccessConstraint other)

Checks to determine if another instance has the same definition as this instance and returns true if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Specified by:

checkForSameDefinition in class AccessConstraint

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

checkForSameDefinition

protected boolean checkForSameDefinition(CartographicZoneConstraint other)

Checks to determine if another instance has the same definition as this instance and returns true if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

computeCurrentDefinitionHashCode

protected int computeCurrentDefinitionHashCode()

Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the CartographicZoneConstraint.checkForSameDefinition(agi.foundation.access.AccessConstraint) method.

Overrides:

computeCurrentDefinitionHashCode in class AccessConstraint

Returns:

The computed hash code.

enumerateDependencies

public void enumerateDependencies(DependencyEnumerator enumerator)

Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon. Derived classes which contain additional dependencies MUST override this method, call the base implementation, and enumerate dependencies introduced by the derived class.

Specified by:

enumerateDependencies in interface IEnumerateDependencies

Overrides:

enumerateDependencies in class AccessConstraint

Parameters:

enumerator - The enumerator that is informed of the dependencies of this object.

getMinimumLatitude

public final double getMinimumLatitude()

Gets the southernmost planetodetic latitude of the cartographic zone, in radians. The minimum latitude must be greater than -Constants.HalfPi and less than the MaximumLatitude (get / set).

setMinimumLatitude

public final void setMinimumLatitude(double value)

Sets the southernmost planetodetic latitude of the cartographic zone, in radians. The minimum latitude must be greater than -Constants.HalfPi and less than the MaximumLatitude (get / set).

getMaximumLatitude

public final double getMaximumLatitude()

Gets the northernmost planetodetic latitude of the cartographic zone, in radians. The maximum latitude must be less than Constants.HalfPi and greater than the MinimumLatitude (get / set).

setMaximumLatitude

public final void setMaximumLatitude(double value)

Sets the northernmost planetodetic latitude of the cartographic zone, in radians. The maximum latitude must be less than Constants.HalfPi and greater than the MinimumLatitude (get / set).

getMinimumLongitude

public final double getMinimumLongitude()

Gets the westernmost longitude of the cartographic zone, in radians. The minimum longitude must be greater than -Math.PI.

setMinimumLongitude

public final void setMinimumLongitude(double value)

Sets the westernmost longitude of the cartographic zone, in radians. The minimum longitude must be greater than -Math.PI.

getMaximumLongitude

public final double getMaximumLongitude()

Gets the easternmost longitude of the cartographic zone, in radians. The maximum longitude must be less than Math.PI.

setMaximumLongitude

public final void setMaximumLongitude(double value)

Sets the easternmost longitude of the cartographic zone, in radians. The maximum longitude must be less than Math.PI.

getCentralBody

public final CentralBody getCentralBody()

Gets the central body used to define the cartographic coordinates.

By default, the value of this property is the EarthCentralBody in the CentralBodiesFacet instance in the CalculationContext.

setCentralBody

public final void setCentralBody(CentralBody value)

Sets the central body used to define the cartographic coordinates.

By default, the value of this property is the EarthCentralBody in the CentralBodiesFacet instance in the CalculationContext.

getTolerance

public final double getTolerance()

Gets the tolerance on the constraint value to use when computing the time when this constraint crosses its threshold.

setTolerance

public final void setTolerance(double value)

Sets the tolerance on the constraint value to use when computing the time when this constraint crosses its threshold.

setZone

public final void setZone(double minimumLatitude,
                          double maximumLatitude,
                          double minimumLongitude,
                          double maximumLongitude,
                          boolean isInclusion)

Set the latitude and longitude boundaries for an inclusion zone. This zone will only allow access inside its boundaries.

Allowed latitude Bounds: -Constants.HalfPi to Constants.HalfPi

Allowed longitude Bounds: -Math.PI to Math.PI

The latitude and longitude bounds are validated when the user calls AccessConstraint.getEvaluator(IServiceProvider,EvaluatorGroup)

Parameters:

minimumLatitude - Southernmost planetodetic latitude boundary greater than -Constants.HalfPi.

maximumLatitude - Northernmost planetodetic latitude boundary less than Constants.HalfPi.

minimumLongitude - Westernmost longitude boundary greater than -Math.PI.

maximumLongitude - Easternmost longitude boundary less than Math.PI.

isInclusion - If true, access is only allowed within this zone. Otherwise, access is not allowed within this zone.

getIsInclusion

public final boolean getIsInclusion()

Gets a value indicating whether access is satisfied inside or outside the cartographic zone represented by this constraint.

setIsInclusion

public final void setIsInclusion(boolean value)

Sets a value indicating whether access is satisfied inside or outside the cartographic zone represented by this constraint.

getConstrainedObject

public final IServiceProvider getConstrainedObject()

Gets the object to which this constraint applies.

Specified by:

getConstrainedObject in interface ISingleObjectConstraint

setConstrainedObject

public final void setConstrainedObject(IServiceProvider value)

Sets the object to which this constraint applies.

Specified by:

setConstrainedObject in interface ISingleObjectConstraint

toString

public String toString()

Description copied from class: java.lang.Object

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:

toString in class Object

Returns:

a string representation of the object.

buildQueryEvaluator

public void buildQueryEvaluator(ConstraintQueryBuilder builder,
                                EvaluatorGroup group)

Builds a query evaluator from this constraint.

Specified by:

buildQueryEvaluator in class AccessConstraint

Parameters:

builder - The builder instance to use to build the evaluator.

group - The evaluator group in which to create individual constraint function evaluators.