AreaOfUse Class

Inherits from

GeoCalc.Serializable

 

Description

The AreaOfUse class represents the valid area of use for a given coordinate reference system or coordinate transformation. In prior versions of the GeoCalc library, this object was referred to as an Envelope, and contained minimum and maximum extent points defined in the WGS84 Geodetic coordinate system. With the updates to version 7.0, an optional polygon data component has been added to the class architecture. The point definitions for both the polygon and extent points are always specified in two dimensions using WGS84 Geodetic points.

Each CoordSys, and CoordTransform  type contains an AreaOfUse object that can be used to limit the availability of objects based on the geographic area of a given dataset. It is also possible to use this object to do basic contains queries using the InBounds() method. For additional information about disabling polygon and MBR area checks inside of a GeoCalc application, please see the SetIgnorePolygonAreaOfUse() and SetIgnoreAreaOfUse() methods on the Datasource.

 

Constructors

Constructor

Description

AreaOfUse

Creates a new instance of the AreaOfUse class

 

Properties

Property

Description

AlwaysAccept

Gets or sets whether the AreaOfUse should always accept point data as being within its bounds. If false, then the AreaOfUse's bounds will be used to accept or reject point data.

AOUCode

Gets the AreaOfUse's Code for use in looking up an associated polygon.

MaxPoint

Gets or sets the AreaOfUse's maximum coordinate bounds.

MaxPointAdjusted

Gets the AreaOfUse's adjusted maximum coordinate bounds.

MinPoint

Gets or sets the AreaOfUse's minimum coordinate bounds.

MinPointAdjusted

Gets the AreaOfUse's adjusted minimum coordinate bounds.

PolygonDefinition

Gets the polygon definition.

Inherited Property

Description

AlwaysSaveToCustom

Inherited from Serializable.

DeprecatedTimestamp

Inherited from Serializable.

HistoryList

Inherited from Serializable.

Identifiers

Inherited from Serializable.

IsBase

Inherited from Serializable.

IsDeprecated

Inherited from Serializable.

IsFileBased

Inherited from Serializable.

IsReadOnly

Inherited from Serializable.

IsUsable

Inherited from Serializable.

Name

Inherited from Serializable.

ObjectType

Inherited from Serializable.

ObjectTypeName

Inherited from Serializable.

Remarks

Inherited from Serializable.

RevisionTimestamp

Inherited from Serializable.

 

Methods

Method

Description

CalculateArea

Calculate the area of the rectangular bounds.

Clone

Creates a clone of this object. (Overrides the abstract Serializable.Clone()).

Equals

Value equals comparison. (Overrides Object.Equals()).

Equivalent

Comparison to see if the object obj is "nearly" equal to this. (Overrides the abstract Serializable.Equivalent()).

GetAdjustedExtents

Gets the AreaOfUse's 'adjusted' extents.

GetCenter

Gets the center of this area.

GetHashCode

Serves as a hash function for a particular type. (Overrides Object.GetHashCode()).

GetObjectDescription

Gets this object description (Overrides Serializable.GetObjectDescription()).

HasPolygonDefinition

Returns whether or not the AreaOfUse has an associated polygon

InBounds

Determines whether the specified point falls within the AreaOfUse bounds.

Intersects

Determines if two AreaOfUses intersects.

IsNearlyEqual

Comparison to see if the object obj is nearly equal to this. (Overrides Serializable.IsNearlyEqual()).

StrictlyEquals

Comparison to see if the object obj is exactly equal to this. (Overrides Serializable.StrictlyEquals()).

Inherited Method

Description

ClearSaveInfo

Inherited from Serializable.

ClearUsabilityFlags

Inherited from Serializable.

EquivalentDiffs

Inherited from Serializable.

GetType

Gets the Type of the current instance. (Inherited from Object).

IsBaseNearlyEqual

Inherited from Serializable.

IsUsabilityFlagSet

Inherited from Serializable.

SetUsabilityFlag

Inherited from Serializable.

ToString

Returns a string that represents the current object. (Inherited from Object).

TryToFixUsability

Inherited from Serializable.

UnsetUsabilityFlag

Inherited from Serializable.

 

Overloaded Operators

Operator

Description

operator=

Assigns a new value to this AreaOfUse

operator==

Compares the value of two AreaOfUse objects

operator!=

Compares the value of two AreaOfUse objects