AskGeo.Base.DataFieldInterface Class Reference

The various AskGeo maps return results when queried. The results represent a shape in the map. Those shapes have metadata associated with them. Those metadata are enumerated by one or more static instances of classes that implement this interface. This pattern is based on the Java enum, from which those code was ported. More...

Inheritance diagram for AskGeo.Base.DataFieldInterface:

List of all members.

Public Member Functions
abstract FieldUnit	GetFieldUnit ()
	Specifies the FieldUnit of the field. The FieldUnit is the logical unit of the reported value, such as "people", "dollars", and "percent".
abstract String	GetDescription ()
	Returns a human-readable description of the data field.
abstract int	GetOrdinal ()
	Returns the ordinal value (i.e., index) of the enumerated value.
abstract String	GetName ()
	Returns the enum's name, exactly as written in the code.

---

Detailed Description

The various AskGeo maps return results when queried. The results represent a shape in the map. Those shapes have metadata associated with them. Those metadata are enumerated by one or more static instances of classes that implement this interface. This pattern is based on the Java enum, from which those code was ported.

---

Member Function Documentation

abstract String AskGeo.Base.DataFieldInterface.GetDescription ( )

pure virtual

Returns a human-readable description of the data field.

Returns:

the description of the data field.

Implemented in AskGeo.Base.CensusField, AskGeo.Base.AcsField, AskGeo.Base.UsPlaceHighDataField, AskGeo.Base.UsCountySubdivisionHighDataField, AskGeo.Base.UsCountyHighDataField, AskGeo.Base.UsStateHighDataField, AskGeo.Base.NaturalEarthCountryDataField, AskGeo.Base.UsBlockGroupHighDataField, AskGeo.Base.UsTractHighDataField, AskGeo.Base.UsZctaHighDataField, AskGeo.Base.UsBlockGroupLowDataField, AskGeo.Base.UsCountySubdivisionLowDataField, AskGeo.Base.UsTractLowDataField, AskGeo.Dbl.ResultField, AskGeo.Flt.ResultField, AskGeo.Base.UsCountyLowDataField, AskGeo.Base.UsPlaceLowDataField, AskGeo.Base.UsStateLowDataField, and AskGeo.Base.TimeZoneDataField.

abstract FieldUnit AskGeo.Base.DataFieldInterface.GetFieldUnit ( )

pure 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.

Implemented in AskGeo.Base.CensusField, AskGeo.Base.AcsField, AskGeo.Base.UsPlaceHighDataField, AskGeo.Base.NaturalEarthCountryDataField, AskGeo.Base.UsCountySubdivisionHighDataField, AskGeo.Base.UsCountyHighDataField, AskGeo.Base.UsStateHighDataField, AskGeo.Base.UsBlockGroupHighDataField, AskGeo.Base.UsTractHighDataField, AskGeo.Base.UsZctaHighDataField, AskGeo.Base.UsBlockGroupLowDataField, AskGeo.Base.UsCountySubdivisionLowDataField, AskGeo.Base.UsTractLowDataField, AskGeo.Dbl.ResultField, AskGeo.Flt.ResultField, AskGeo.Base.UsCountyLowDataField, AskGeo.Base.UsPlaceLowDataField, AskGeo.Base.UsStateLowDataField, and AskGeo.Base.TimeZoneDataField.

abstract String AskGeo.Base.DataFieldInterface.GetName ( )

pure virtual

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

Returns:

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

Implemented in AskGeo.Base.CensusField, AskGeo.Base.AcsField, AskGeo.Base.NaturalEarthCountryDataField, AskGeo.Base.UsPlaceHighDataField, AskGeo.Base.UsCountySubdivisionHighDataField, AskGeo.Base.UsCountyHighDataField, AskGeo.Base.UsStateHighDataField, AskGeo.Base.UsBlockGroupHighDataField, AskGeo.Base.UsTractHighDataField, AskGeo.Dbl.ResultField, AskGeo.Flt.ResultField, AskGeo.Base.UsZctaHighDataField, AskGeo.Base.UsBlockGroupLowDataField, AskGeo.Base.UsCountySubdivisionLowDataField, AskGeo.Base.UsTractLowDataField, AskGeo.Base.UsCountyLowDataField, AskGeo.Base.UsPlaceLowDataField, AskGeo.Base.UsStateLowDataField, and AskGeo.Base.TimeZoneDataField.

abstract int AskGeo.Base.DataFieldInterface.GetOrdinal ( )

pure virtual

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

Returns:

the ordinal value of the enumerated value.

Implemented in AskGeo.Base.CensusField, AskGeo.Base.AcsField, AskGeo.Base.NaturalEarthCountryDataField, AskGeo.Base.UsPlaceHighDataField, AskGeo.Base.UsCountySubdivisionHighDataField, AskGeo.Base.UsCountyHighDataField, AskGeo.Base.UsStateHighDataField, AskGeo.Base.UsBlockGroupHighDataField, AskGeo.Base.UsTractHighDataField, AskGeo.Dbl.ResultField, AskGeo.Flt.ResultField, AskGeo.Base.UsZctaHighDataField, AskGeo.Base.UsBlockGroupLowDataField, AskGeo.Base.UsCountySubdivisionLowDataField, AskGeo.Base.UsTractLowDataField, AskGeo.Base.UsCountyLowDataField, AskGeo.Base.UsPlaceLowDataField, AskGeo.Base.UsStateLowDataField, and AskGeo.Base.TimeZoneDataField.

---

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

• Source/Base/DataFieldInterface.cs