Dataset

Forward declaration of the Model class. More...

Inheritance diagram for Dataset:

Public Member Functions
virtual	~Dataset ()
	Destructor.
virtual Bounds< 3, fltp08 >	bounds () const
	Returns the 3D spatial bounding box of this dataset.
virtual Dataset *	child (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 String	name () const =0
	Returns the unique name identifier for this dataset.
virtual bool	setupModel (Model &)
	Configures the given Model using data from this dataset.
virtual TranslatedString	title () const
	Returns the user-facing translated title of this dataset.

Detailed Description

Forward declaration of the Model class.

---

A dataset is a basic grouping of data (DEPRECIATED)

Definition at line 12 of file DatasetManager.h.

Member Function Documentation

bounds()

virtual Bounds< 3, fltp08 > Dataset::bounds ( ) const

inlinevirtual

Returns the 3D spatial bounding box of this dataset.

Returns

The bounding box, or an invalid bounds if not applicable.

Definition at line 43 of file DatasetManager.h.

child()

virtual Dataset * Dataset::child ( const String & )

inlinevirtual

Retrieves a child dataset by name.

Parameters

[in]

name

The name of the child dataset to find.

Returns

A pointer to the child Dataset, or nullptr if not found.

Reimplemented in USStateLookup, and ZipCodeLookup.

Definition at line 60 of file DatasetManager.h.

childCount()

virtual uint04 Dataset::childCount ( ) const

inlinevirtual

Returns the number of child datasets.

Returns

The child count.

Reimplemented in USStateLookup, and ZipCodeLookup.

Definition at line 65 of file DatasetManager.h.

children()

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

inlinevirtual

Returns all child datasets contained within this dataset.

Returns

A Buffer of pointers to child Dataset objects.

Reimplemented in USStateLookup, and ZipCodeLookup.

Definition at line 54 of file DatasetManager.h.

description()

virtual TranslatedString Dataset::description ( ) const

inlinevirtual

Returns a translated description of this dataset.

Returns

The translated description, or an empty TranslatedString if none is set.

Definition at line 38 of file DatasetManager.h.

icon()

virtual String Dataset::icon ( ) const

inlinevirtual

Returns the icon resource name associated with this dataset.

Returns

The icon name as a String, or an empty String if none is set.

Definition at line 28 of file DatasetManager.h.

name()

virtual String Dataset::name ( ) const

pure virtual

Returns the unique name identifier for this dataset.

Returns

The dataset name as a String.

Implemented in USState, USStateLookup, and ZipCodeLookup.

setupModel()

virtual bool Dataset::setupModel ( Model & )

inlinevirtual

Configures the given Model using data from this dataset.

Parameters

[in]

model

The Model to populate or configure.

Returns

True if the model was successfully set up, false otherwise.

Reimplemented in ZipCodeLookup.

Definition at line 49 of file DatasetManager.h.

title()

virtual TranslatedString Dataset::title ( ) const

inlinevirtual

Returns the user-facing translated title of this dataset.

Returns

The translated title, or an empty TranslatedString if none is set.

Reimplemented in USState.

Definition at line 33 of file DatasetManager.h.

---

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

• Design/Headers/DatasetManager.h