NDEVR
API Documentation
ZipCodeLookup

Provides lookup of US zip codes and their geographic coordinates as a dataset. More...

Inheritance diagram for ZipCodeLookup:
[legend]
Collaboration diagram for ZipCodeLookup:
[legend]

Public Member Functions

virtual Datasetchild (const String &name) override
 Returns the child dataset matching the given name.
virtual uint04 childCount () const override
 Returns the number of child datasets.
virtual Buffer< Dataset * > children () override
 Returns the list of child datasets.
virtual String name () const override
 Returns the dataset name identifier.
virtual bool setupModel (Model &model) override
 Sets up a model with zip code data.
Public Member Functions inherited from Dataset
virtual ~Dataset ()
 Destructor.
virtual Bounds< 3, fltp08bounds () const
 Returns the 3D spatial bounding box of this dataset.
virtual TranslatedString description () const
 Returns a translated description of this dataset.
virtual String icon () const
 Returns the icon resource name associated with this dataset.
virtual TranslatedString title () const
 Returns the user-facing translated title of this dataset.

Static Public Member Functions

static Vertex< 2, fltp08Coordinate (uint04 zip_code)
 Returns the geographic coordinate (latitude, longitude) for a US zip code.

Detailed Description

Provides lookup of US zip codes and their geographic coordinates as a dataset.


Definition at line 10 of file ZipCodeLookup.h.

Member Function Documentation

◆ child()

virtual Dataset * ZipCodeLookup::child ( const String & name)
overridevirtual

Returns the child dataset matching the given name.

Parameters
[in]nameThe name to look up.
Returns
The matching Dataset pointer, or nullptr if not found.

Reimplemented from Dataset.

References name().

◆ childCount()

virtual uint04 ZipCodeLookup::childCount ( ) const
overridevirtual

Returns the number of child datasets.

Returns
The child count.

Reimplemented from Dataset.

◆ children()

virtual Buffer< Dataset * > ZipCodeLookup::children ( )
overridevirtual

Returns the list of child datasets.

Returns
A buffer of Dataset pointers.

Reimplemented from Dataset.

◆ Coordinate()

Vertex< 2, fltp08 > ZipCodeLookup::Coordinate ( uint04 zip_code)
static

Returns the geographic coordinate (latitude, longitude) for a US zip code.

Parameters
[in]zip_codeThe numeric zip code.
Returns
The 2D coordinate vertex.

◆ name()

virtual String ZipCodeLookup::name ( ) const
inlineoverridevirtual

Returns the dataset name identifier.

Returns
The zip code dataset name string.

Implements Dataset.

Definition at line 15 of file ZipCodeLookup.h.

References ZIP_CODE_DATASET.

Referenced by child().

◆ setupModel()

virtual bool ZipCodeLookup::setupModel ( Model & model)
overridevirtual

Sets up a model with zip code data.

Parameters
[in]modelThe model to populate.
Returns
True on success.

Reimplemented from Dataset.


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