Click or drag to resize

Coordinate Class

Class for handling all location based information. This is the main class of CoordinateSharp. It will contain all coordinate conversions and celestial information once populated. Most everything you need in the library will be contained in the Coordinate class.
Inheritance Hierarchy
SystemObject
  CoordinateSharpCoordinate

Namespace:  CoordinateSharp
Assembly:  CoordinateSharp (in CoordinateSharp.dll) Version: 2.3.1.1
Syntax
C#
[SerializableAttribute]
public class Coordinate : INotifyPropertyChanged

The Coordinate type exposes the following members.

Constructors
  NameDescription
Public methodCode exampleCoordinate
Creates a Coordinate object with default values.
Public methodCode exampleCoordinate(EagerLoad)
Creates an empty Coordinates object with specified eager loading options.
Public methodCode exampleCoordinate(Double, Double)
Creates a populated Coordinate based on signed degrees formated latitude and longitude.
Public methodCode exampleCoordinate(Double, Double, EagerLoad)
Creates a populated Coordinate object with specified eager loading options.
Public methodCode exampleCoordinate(Double, Double, DateTime)
Creates a populated Coordinate object with an assigned GeoDate.
Public methodCode exampleCoordinate(Double, Double, DateTime, EagerLoad)
Creates a populated Coordinate object with specified eager load options and an assigned GeoDate.
Top
Properties
  NameDescription
Public propertyCartesian
Cartesian (based on spherical earth).
Public propertyCelestialInfo
Celestial information based on the objects location and geographic UTC date.
Public propertyCode exampleDisplay
Bindable formatted coordinate string.
Public propertyEagerLoadSettings
Eagerloading settings.
Public propertyECEF
Earth Centered Earth Fixed Coordinate. Uses Ellipsoidal height with no geoid model included.
Remarks
GeoHeight at 0 = Mean Sea Level based on the provided Datum.
Public propertyFormatOptions
Coordinate string formatting options.
Public propertyGeoDate
Date at coordinate used to calculate celestial information.
Public propertyLatitude
Latitudinal Coordinate Part.
Public propertyLongitude
Longitudinal Coordinate Part.
Public propertyMGRS
Military Grid Reference System (NATO UTM) values.
Public propertyOffset
GeoDate UTC Offset. This must be set if working / eager loading in local time.
Public propertyParse_Format
Used to determine what format the coordinate was parsed from. Will equal "None" if Coordinate was not initialized via a TryParse() method.
Public propertyUTM
Universal Transverse Mercator values.
Top
Methods
  NameDescription
Public methodCode exampleCelestial_LocalTime
Returns a new Celestial object in local time, based on the Coordinate objects values.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodCode exampleGet_Distance_From_Coordinate(Coordinate)
Returns the distance from a target coordinate using spherical earth calculations. Use overload if ellipsoidal calculations are desired.
Public methodCode exampleGet_Distance_From_Coordinate(Coordinate, Shape)
Returns the distance from a target coordinate.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodCode exampleLoadCartesianInfo
Load Cartesian information (required if eager loading is turned off).
Public methodCode exampleLoadCelestialInfo
Load celestial information (required if eager loading is turned off).
Public methodCode exampleLoadECEFInfo
Load ECEF information (required if eager loading is turned off).
Public methodCode exampleLoadUTM_MGRS_Info
Load UTM and MGRS information (required if eager loading is turned off).
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodCode exampleMove(Double, Double, Shape)
Move coordinate based on provided bearing and distance (in meters).
Public methodCode exampleMove(Coordinate, Distance, Shape)
Move a coordinate a specified distance towards a target coordinate.
Public methodCode exampleMove(Coordinate, Double, Shape)
Move a coordinate a specified distance (in meters) towards a target coordinate.
Public methodCode exampleMove(Distance, Double, Shape)
Move coordinate based on provided bearing and distance (in meters).
Public methodNotifyPropertyChanged
Notify property changed
Public methodCode exampleSet_Datum(Double, Double)
Set a custom datum for coordinate conversions and distance calculation. Objects must be loaded prior to setting if EagerLoading is turned off or else the items Datum won't be set. Use overload if EagerLoading options are used.
Public methodCode exampleSet_Datum(Double, Double, Coordinate_Datum)
Set a custom datum for coordinate conversions and distance calculation for specified coordinate formats only. Objects must be loaded prior to setting if EagerLoading is turned off.
Public methodCode exampleToString
A string formatted and represented coordinate.
(Overrides ObjectToString.)
Public methodCode exampleToString(CoordinateFormatOptions)
A string formatted and represented coordinate.
Public methodStatic memberCode exampleTryParse(String, Coordinate)
Attempts to parse a string into a Coordinate.
Public methodStatic memberCode exampleTryParse(String, CartesianType, Coordinate)
Attempts to parse a string into a Coordinate.
Public methodStatic memberCode exampleTryParse(String, DateTime, Coordinate)
Attempts to parse a string into a Coordinate with specified DateTime
Public methodStatic memberCode exampleTryParse(String, DateTime, CartesianType, Coordinate)
Attempts to parse a string into a Coordinate with specified DateTime
Top
Events
  NameDescription
Public eventPropertyChanged
Property changed event
Top
See Also