AskGeo.Flt.ResultField Class Reference

The ResultField class enumerates some of the return values that are included in the subclasses of the ResultBase class as return values to a query on a subclass of the GeneralMap class. In particular, it enumerates those pertaining to the query, such as whether the query point was inside the shape, and if not the distance to the shape from the query point. More...

Inheritance diagram for AskGeo.Flt.ResultField:

List of all members.

Public Member Functions
FieldType	GetFieldType ()
	Returns the FieldType corresponding to this FieldUnit. Most units are represented by the FieldType.FLOAT type, but fields with no unit (such as a code, or a bool variable) are of FieldType.STRING, FieldType.BOOLEAN, or FieldType.int.
override FieldUnit	GetFieldUnit ()
	Specifies the FieldUnit of the field. The FieldUnit is the logical unit of the reported value, such as "people", "dollars", and "percent".
override String	GetDescription ()
	Returns a human-readable description of the data field.
override int	GetOrdinal ()
	Returns the ordinal value (i.e., index) of the enumerated value.
override String	GetName ()
	Returns the enum's name, exactly as written in the code.

Static Public Attributes
static readonly ResultField	AskGeoId = new ResultField("AskGeoId", FieldUnit.NoneInteger, "The internally-used AskGeo unique ID for the returned polygon")
	The internally-used AskGeo unique ID for the returned polygon
static readonly ResultField	IsInside = new ResultField("IsInside", FieldUnit.NoneBoolean, "Whether or not the query point is inside the returned polygon")
	Whether or not the query point is inside the returned polygon
static readonly ResultField	MinDistanceKm = new ResultField("MinDistanceKm", FieldUnit.Kilometers, "The distance from the query point to the nearest interior point of the returned polygon")
	The distance from the query point to the nearest interior point of the returned polygon

---

Detailed Description

The ResultField class enumerates some of the return values that are included in the subclasses of the ResultBase class as return values to a query on a subclass of the GeneralMap class. In particular, it enumerates those pertaining to the query, such as whether the query point was inside the shape, and if not the distance to the shape from the query point.

---

Member Function Documentation

override String AskGeo.Flt.ResultField.GetDescription ( )

virtual

Returns a human-readable description of the data field.

Returns:

the description of the data field.

Implements AskGeo.Base.DataFieldInterface.

FieldType AskGeo.Flt.ResultField.GetFieldType

(

)

Returns the FieldType corresponding to this FieldUnit. Most units are represented by the FieldType.FLOAT type, but fields with no unit (such as a code, or a bool variable) are of FieldType.STRING, FieldType.BOOLEAN, or FieldType.int.

Returns:

the FieldType of a this FieldUnit.

override FieldUnit AskGeo.Flt.ResultField.GetFieldUnit ( )

virtual

Specifies the FieldUnit of the field. The FieldUnit is the logical unit of the reported value, such as "people", "dollars", and "percent".

Returns:

the FieldUnit of the data field.

Implements AskGeo.Base.DataFieldInterface.

override String AskGeo.Flt.ResultField.GetName ( )

virtual

Returns the enum's name, exactly as written in the code.

Returns:

the name of the enum, as written in the code.

Implements AskGeo.Base.DataFieldInterface.

override int AskGeo.Flt.ResultField.GetOrdinal ( )

virtual

Returns the ordinal value (i.e., index) of the enumerated value.

Returns:

the ordinal value of the enumerated value.

Implements AskGeo.Base.DataFieldInterface.

---

Member Data Documentation

readonly ResultField AskGeo.Flt.ResultField.AskGeoId = new ResultField("AskGeoId", FieldUnit.NoneInteger, "The internally-used AskGeo unique ID for the returned polygon")

static

The internally-used AskGeo unique ID for the returned polygon

readonly ResultField AskGeo.Flt.ResultField.IsInside = new ResultField("IsInside", FieldUnit.NoneBoolean, "Whether or not the query point is inside the returned polygon")

static

Whether or not the query point is inside the returned polygon

readonly ResultField AskGeo.Flt.ResultField.MinDistanceKm = new ResultField("MinDistanceKm", FieldUnit.Kilometers, "The distance from the query point to the nearest interior point of the returned polygon")

static

The distance from the query point to the nearest interior point of the returned polygon

---

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

• Source/Flt/ResultField.cs