AskGeo .NET  1.1.0
AskGeo Libraries for .NET
 All Classes Namespaces Functions Variables Enumerations Pages
Public Member Functions | Static Public Member Functions
AskGeo.Dbl.NaturalEarthCountryMap Class Reference

The CountryMap is a map of the world that returns the country or equivalent for any given latitude and longitude. More...

Inheritance diagram for AskGeo.Dbl.NaturalEarthCountryMap:
AskGeo.Dbl.GeneralMap< ResultType >

List of all members.

Public Member Functions

override NaturalEarthCountryResult FindResult (double latDeg, double lonDeg)
 Returns a results map query result. All result classes extend ResultBase but the specific subclass returned depends on what map class is being used. Each map class has a companion result class. If no shape is found at or near the query point, null is returned.
override String GetOracleName ()
 A unique identifier for this map, used in the license file and in the AskGeo Web API.
- Public Member Functions inherited from AskGeo.Dbl.GeneralMap< ResultType >
List< ResultType > GetAllResults ()
 Returns a Vector of results, each result corresponding to a shape in the map. All result classes extend ResultBase but the specific subclass depends on what map class is being used. Each map class has a companion result class.
void Authorize (String s)
 Authorizes the use of the map object by providing a license String.
void Authorize (Stream stream)
 Authorizes the use of the map object by providing a license file's input stream. The stream is closed upon completion.
double[] GetBbox ()
 Returns the bounding box for this map as a double array. The order of the array is: min latitude, min longitude, max latitude, max longitude.
DataFieldInterface GetDataField (int index)
 Each map contains metadata associated with each shape. The metadata is indexed by an Java-style enum that is defined within each map subclass. All of the Java-style enums implement the DataFieldInterface. Those Java-style enums are exposed through this common interface here.
int GetNumDataFields ()
 Returns the number of data fields associated with this map.

Static Public Member Functions

static NaturalEarthCountryMap Create (Stream dataFileStream)
 Static factory method used to construct an instance of this class.
static NaturalEarthCountryMap Create (Stream dataFileStream, double cellsPerDeg, double snapRadiusKm)
 Static factor method used to construct an instance of this class.
static String GetOracleNameStatic ()
 A unique identifier for this map, used in the license file and in the AskGeo Web API.
- Static Public Member Functions inherited from AskGeo.Dbl.GeneralMap< ResultType >
static double[] GetWorldBbox ()
 Returns a new bounding box encompassing the entire globe (for example, from -180 to +180 degrees longitude and from -90 to +90 degrees latitude). Values are stored in radians.
static double[] GetConusBbox ()
 Returns a new bounding box roughly containing the continental US, or CONUS (i.e., from -125 to -66 degrees longitude and from 24 to 50 degrees latitude).

Detailed Description

The CountryMap is a map of the world that returns the country or equivalent for any given latitude and longitude.


Member Function Documentation

static NaturalEarthCountryMap AskGeo.Dbl.NaturalEarthCountryMap.Create ( Stream  dataFileStream)
static

Static factory method used to construct an instance of this class.

Parameters:
dataFileStreama Stream of the datafield to be read to create this map.
Returns:
a instance of this class with default parameters.
static NaturalEarthCountryMap AskGeo.Dbl.NaturalEarthCountryMap.Create ( Stream  dataFileStream,
double  cellsPerDeg,
double  snapRadiusKm 
)
static

Static factor method used to construct an instance of this class.

Parameters:
dataFileStreama Stream of the datafield to be read to create this map.
cellsPerDegis the resolution of the spatial index. Testing has show that a suitable value for this parameter is 1.0, which is the default value.
snapRadiusKmis the maximum snap-to distance for query points not inside any shape on the map.
Returns:
an instance of this class with given parameters.
override NaturalEarthCountryResult AskGeo.Dbl.NaturalEarthCountryMap.FindResult ( double  latDeg,
double  lonDeg 
)
virtual

Returns a results map query result. All result classes extend ResultBase but the specific subclass returned depends on what map class is being used. Each map class has a companion result class. If no shape is found at or near the query point, null is returned.

Parameters:
latDegthe latitude of the query point, expressed in degrees.
lonDegthe longitude of the query point, expressed in degrees.
Returns:
the result for the given latitude and longitude, or null if none is found.

Implements AskGeo.Dbl.GeneralMap< ResultType >.

override String AskGeo.Dbl.NaturalEarthCountryMap.GetOracleName ( )
virtual

A unique identifier for this map, used in the license file and in the AskGeo Web API.

Returns:
the unique identifier for this map.

Implements AskGeo.Dbl.GeneralMap< ResultType >.

static String AskGeo.Dbl.NaturalEarthCountryMap.GetOracleNameStatic ( )
static

A unique identifier for this map, used in the license file and in the AskGeo Web API.

Returns:
the unique identifier for this map.

The documentation for this class was generated from the following file: