NDEVR
API Documentation
USState

Represents a US state with its abbreviation and translated display name. More...

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

Public Member Functions

 USState (const TranslatedString &name, const char(&abv)[3])
 Constructs a USState with a name and abbreviation.
virtual String name () const override
 Returns the state abbreviation as the dataset name.
virtual TranslatedString title () const override
 Returns the full translated state name.
Public Member Functions inherited from Dataset
virtual ~Dataset ()
 Destructor.
virtual Bounds< 3, fltp08bounds () const
 Returns the 3D spatial bounding box of this dataset.
virtual Datasetchild (const String &)
 Retrieves a child dataset by name.
virtual uint04 childCount () const
 Returns the number of child datasets.
virtual Buffer< Dataset * > children ()
 Returns all child datasets contained within 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 bool setupModel (Model &)
 Configures the given Model using data from this dataset.

Public Attributes

const char m_abreviation [3]
 The two-letter state abbreviation (e.g., "CA").
TranslatedString m_name
 The full translated state name.

Detailed Description

Represents a US state with its abbreviation and translated display name.


Definition at line 11 of file StateLookup.h.

Constructor & Destructor Documentation

◆ USState()

USState::USState ( const TranslatedString & name,
const char(&) abv[3] )
inline

Constructs a USState with a name and abbreviation.

Parameters
[in]nameThe translated state name.
[in]abvThe two-letter state abbreviation.

Definition at line 28 of file StateLookup.h.

References m_abreviation, m_name, and name().

Member Function Documentation

◆ name()

virtual String USState::name ( ) const
inlineoverridevirtual

Returns the state abbreviation as the dataset name.

Returns
The two-letter state abbreviation.

Implements Dataset.

Definition at line 15 of file StateLookup.h.

References m_abreviation.

Referenced by USState().

◆ title()

virtual TranslatedString USState::title ( ) const
inlineoverridevirtual

Returns the full translated state name.

Returns
The translated state name.

Reimplemented from Dataset.

Definition at line 21 of file StateLookup.h.

References m_name.


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