agi.foundation.coverage

(agi.foundation.spatial-2024r2.jar)

Class MaterializedSpatiallyPartitionedCoverageDefinition

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.coverage.BaseCoverageDefinition

agi.foundation.coverage.ContinuousCoverageDefinition

agi.foundation.coverage.MaterializedSpatiallyPartitionedCoverageDefinition

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class MaterializedSpatiallyPartitionedCoverageDefinition
extends ContinuousCoverageDefinition

A coverage definition that uses a delegate to define properties for the grid points. The delegate will be used at runtime to define the properties of the GridPoints. Once given properties via the delegate, these properties persist for the duration of the calculation. This type of coverage definition splits the coverage calculation up spatially, creating threads to process a group of grid points based upon logical division of available cores or user specified thread count.

Note that, in general, delegate based coverage definitions are not recommended. This is due to the limitations of the CopyContext which copies the fully realized grid point to the GridPointPlaceholder (get) in access calculations. In some cases, in particular with scalar constraints, the copy context will fail to copy everything correctly. Unless persistent properties unique to each grid point are required (a very infrequent need) use ParameterizedSpatiallyPartitionedCoverageDefinition instead.

See Also:

ParameterizedSpatiallyPartitionedCoverageDefinition, ParameterizedTemporallyPartitionedCoverageDefinition

Constructor Summary

Constructors

Modifier	Constructor and Description
	MaterializedSpatiallyPartitionedCoverageDefinition() Initializes a new instance.
	MaterializedSpatiallyPartitionedCoverageDefinition(CoverageGridPointCreationCallback gridPointCreationCallback) Initializes a new instance.
	MaterializedSpatiallyPartitionedCoverageDefinition(ICoverageGrid grid, boolean useDefaultGridPointPlatform) Creates an instance of this type of coverage definition with the specified grid and a boolean indicating if a simple platform should be used to define grid point properties.
protected	MaterializedSpatiallyPartitionedCoverageDefinition(MaterializedSpatiallyPartitionedCoverageDefinition existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(ContinuousCoverageDefinition other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(MaterializedSpatiallyPartitionedCoverageDefinition 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.
CoverageGridPointWithResults	createGridPoint(CoverageGridPoint coverageGridPoint) Creates a CoverageGridPointWithResults suitable for computing coverage.
CoverageGridPointCreationCallback	getGridPointCreationCallback() Gets a delegate that is used to create properties for each grid point used in an access calculation.
IServiceProvider	getGridPointPlaceholder() Gets the IServiceProvider representing a generic grid point on the grid.
void	setGridPointCreationCallback(CoverageGridPointCreationCallback value) Sets a delegate that is used to create properties for each grid point used in an access calculation.
protected void	validateProperties() Validates all of the properties of the coverage definition.

Methods inherited from class agi.foundation.coverage.ContinuousCoverageDefinition

checkForSameDefinition, computeCoverageOverTheGrid, computeCoverageOverTheGrid, computeCoverageOverTheGrid, computeCoverageOverTheGrid

Methods inherited from class agi.foundation.coverage.BaseCoverageDefinition

addAsset, addAsset, addAssetRange, checkForSameDefinition, enumerateDependencies, freezeAggregatedObjects, getAssetDefinitions, getAssets, getFilter, getGrid, getGridPointService, getMultithreadCoverage, removeAllAssets, removeAsset, removeAsset, setAssetDefinitions, setFilter, setGrid, setGridPointService, setMultithreadCoverage

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, toString, wait, wait, wait

Constructor Detail

MaterializedSpatiallyPartitionedCoverageDefinition

public MaterializedSpatiallyPartitionedCoverageDefinition()

Initializes a new instance. GridPointCreationCallback (get / set) must be set before use.

MaterializedSpatiallyPartitionedCoverageDefinition

public MaterializedSpatiallyPartitionedCoverageDefinition(@Nonnull
                                                          ICoverageGrid grid,
                                                          boolean useDefaultGridPointPlatform)

Creates an instance of this type of coverage definition with the specified grid and a boolean indicating if a simple platform should be used to define grid point properties. GridPointCreationCallback (get / set) will need to be set before use if the default is not selected.

If the type of ICoverageGrid supplied is CentralBodyCoverageGrid and the CentralBody is set, then the default grid point platform will be a point with AxesEastNorthUp. Otherwise, the default grid platform will have axes that are the grid's reference frame's axes. In both cases the following services are provided: ILocationPointService, IOrientationAxesService, IKinematicStateService.

Parameters:

grid - The ICoverageGrid to be used in this coverage calculation.

useDefaultGridPointPlatform - If this is set to true, then a default platform will be set on the grid points. See below for more details.

Throws:

ArgumentNullException - Thrown if grid is null.

MaterializedSpatiallyPartitionedCoverageDefinition

public MaterializedSpatiallyPartitionedCoverageDefinition(CoverageGridPointCreationCallback gridPointCreationCallback)

Initializes a new instance. gridPointCreationCallback as the delegate to create grid points.

Parameters:

gridPointCreationCallback - A delegate to create properties for each grid point used in an access calculation.

MaterializedSpatiallyPartitionedCoverageDefinition

protected MaterializedSpatiallyPartitionedCoverageDefinition(MaterializedSpatiallyPartitionedCoverageDefinition existingInstance,
                                                             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(ContinuousCoverageDefinition 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 ContinuousCoverageDefinition

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(MaterializedSpatiallyPartitionedCoverageDefinition 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 MaterializedSpatiallyPartitionedCoverageDefinition.checkForSameDefinition(agi.foundation.coverage.ContinuousCoverageDefinition) method.

Overrides:

computeCurrentDefinitionHashCode in class ContinuousCoverageDefinition

Returns:

The computed hash code.

getGridPointPlaceholder

public final IServiceProvider getGridPointPlaceholder()

Gets the IServiceProvider representing a generic grid point on the grid. This service should be used when linking the grid to assets, for example.

getGridPointCreationCallback

public final CoverageGridPointCreationCallback getGridPointCreationCallback()

Gets a delegate that is used to create properties for each grid point used in an access calculation.

setGridPointCreationCallback

public final void setGridPointCreationCallback(CoverageGridPointCreationCallback value)

Sets a delegate that is used to create properties for each grid point used in an access calculation.

validateProperties

protected void validateProperties()

Validates all of the properties of the coverage definition.

This should be called in any derived coverage definition types before computing coverage.

Overrides:

validateProperties in class BaseCoverageDefinition

Throws:

PropertyInvalidException - Thrown if GridPointCreationCallback (get / set) is null.

PropertyInvalidException - Thrown when Grid (get / set), GridPointService (get / set), or Filter (get / set) is null.

IllegalStateException -

Thrown when any of the following conditions are met:

• No Assets (get) were specified.
• Duplicate Assets (get) were specified.
• No grid points were generated with the supplied definition of Grid (get / set).

createGridPoint

public CoverageGridPointWithResults createGridPoint(@Nonnull
                                                    CoverageGridPoint coverageGridPoint)

Creates a CoverageGridPointWithResults suitable for computing coverage.

Specified by:

createGridPoint in class BaseCoverageDefinition

Parameters:

coverageGridPoint - The geometric grid point produced by the gridding algorithm.

Returns:

A properly setup CoverageGridPointWithResults.