Bond::DataViewIndex Class Reference

An immutable object that encapsulates an array of named constant DataView objects. More...

#include <bond/types/dataview.h>

Public Member Functions
	DataViewIndex (const StringView *dataViewNames, const DataView *dataViews, size_t numDataViews)
	Constructs a DataViewIndex over the given array of DataViews. dataViewNames and dataViews must both point to arrays of numDataView elements. More...
const StringView *	GetDataViewNames () const
	Returns the array of StringViews representing the names of the DataViews in the index. More...
const DataView *	GetDataViews () const
	Returns the array of DataViews over which the index has been created. More...
const size_t	GetNumDataViews () const
	Returns the number of DataViews in the index. More...

Detailed Description

An immutable object that encapsulates an array of named constant DataView objects.

DataViewIndex does not perform any allocations; it contains a pointer to an existing array of DataView objects and an existing array of StringView objects whose lifetimes must supersede that of the DataView.

Constructor & Destructor Documentation

DataViewIndex()

Bond::DataViewIndex::DataViewIndex ( const StringView *  dataViewNames, const DataView *  dataViews, size_t  numDataViews  )

inline

Constructs a DataViewIndex over the given array of DataViews. dataViewNames and dataViews must both point to arrays of numDataView elements.

Parameters

dataViewNames	The array of names for the DataViews in the index.
dataViews	The array of DataViews over which the index is created.
numDataViews	The number of DataViews in the index.

Member Function Documentation

GetDataViewNames()

const StringView * Bond::DataViewIndex::GetDataViewNames ( ) const

inline

Returns the array of StringViews representing the names of the DataViews in the index.

GetDataViews()

const DataView * Bond::DataViewIndex::GetDataViews ( ) const

inline

Returns the array of DataViews over which the index has been created.

GetNumDataViews()

const size_t Bond::DataViewIndex::GetNumDataViews ( ) const

inline

Returns the number of DataViews in the index.

---

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

• include/bond/types/dataview.h