Class GeoCircle
Handling of a geographical circle defined by a GeoCoordinate and a radius
Implements
Inherited Members
Namespace: FpAssistantCore.Geographical
Assembly: FpAssistantCoreScl.dll
Syntax
public class GeoCircle : GeoMapElement, IGeoMapElement
Constructors
View SourceGeoCircle(GeoCoordinate, LinearDistance)
Constructor to initalise the GeoCircle with a centre coordinate and radius
Declaration
public GeoCircle(GeoCoordinate centreCoordinate, LinearDistance radius)
Parameters
Type | Name | Description |
---|---|---|
GeoCoordinate | centreCoordinate | geographical coordinate of the map icon to be shown |
LinearDistance | radius | Radius of the circle |
GeoCircle(GeoCoordinate, LinearDistance, LinearDistance)
Constructor to initalise the GeoCircle with a centre coordinate, elevation and radius
Declaration
public GeoCircle(GeoCoordinate centreCoordinate, LinearDistance radius, LinearDistance elevation)
Parameters
Type | Name | Description |
---|---|---|
GeoCoordinate | centreCoordinate | geographical coordinate of the map icon to be shown |
LinearDistance | radius | Radius of the circle |
LinearDistance | elevation | Elevation to top of the circle |
Fields
View SourceResolutionMaximum
Highest resolution to draw a circle used in AsGeography()
Declaration
public const int ResolutionMaximum = null
Field Value
Type | Description |
---|---|
System.Int32 |
ResolutionMinimum
Smallest resolution to draw a circle used in AsGeography()
Declaration
public const int ResolutionMinimum = null
Field Value
Type | Description |
---|---|
System.Int32 |
Remarks
Set to 3 hence a triangle will be drawn
Properties
View SourceCentreCoordinate
Geocoordinate centre of the circle
Declaration
public GeoCoordinate CentreCoordinate { get; set; }
Property Value
Type | Description |
---|---|
GeoCoordinate | Centre coordinate of the circle |
Elevation
Elevation
Declaration
public LinearDistance Elevation { get; set; }
Property Value
Type | Description |
---|---|
LinearDistance | Elevation above MSL |
Radius
Radius (distance from centre to circumference) of circle
Declaration
public LinearDistance Radius { get; set; }
Property Value
Type | Description |
---|---|
LinearDistance | Radius of the circle |
Methods
View SourceAsGeography(Int32)
Creates a geography type LINESTRING()
Declaration
public string AsGeography(int resolution)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | resolution | Number of segments that the circle will be constructed |
Returns
Type | Description |
---|---|
System.String | String of the geography |
Remarks
Will create a LINESTRING of the circle / resolution will be set between 3 and 18
AsGmlPos(GmlDimension)
Creates a value for GML pos element
Declaration
public string AsGmlPos(GmlDimension gmlDimension)
Parameters
Type | Name | Description |
---|---|---|
GmlDimension | gmlDimension | Controls if 2D or 3D is required for GML pos |
Returns
Type | Description |
---|---|
System.String | String of the GML pos element value |
AsGmlRadius(LinearDistanceUnits)
Creates a value for GML radius element
Declaration
public string AsGmlRadius(LinearDistanceUnits linearDistanceUnits)
Parameters
Type | Name | Description |
---|---|---|
LinearDistanceUnits | linearDistanceUnits | Unit of the return radius value in the GML string |
Returns
Type | Description |
---|---|
System.String | String of the GML radius element value |
Remarks
Always return in meters