olp::dataservice::read::model::IndexDefinition Class Reference

A model that represents a definition of an index field. More...

#include <Catalog.h>

Public Member Functions
	IndexDefinition (const IndexDefinition &)=default
	IndexDefinition (IndexDefinition &&)=default
IndexDefinition &	operator= (const IndexDefinition &)=default
IndexDefinition &	operator= (IndexDefinition &&)=default
const std::string &	GetName () const
	Gets the short name of the index field. More...
std::string &	GetMutableName ()
	Gets a mutable reference to the short name of the index field. More...
void	SetName (const std::string &value)
	Sets the short name of the index field. More...
const std::string &	GetType () const
	Gets the type of data availability that this layer provides. More...
std::string &	GetMutableType ()
	Gets a mutable reference to the type of data availability that this layer provides. More...
void	SetType (const std::string &value)
	Sets the data availability type. More...
const int64_t &	GetDuration () const
	Gets the duration of the time window in milliseconds. More...
int64_t &	GetMutableDuration ()
	Gets a mutable reference to the duration of the time window in milliseconds. More...
void	SetDuration (const int64_t &value)
	Sets the duration of the time window. More...
const int64_t &	GetZoomLevel () const
	Gets the tile size. More...
int64_t &	GetMutableZoomLevel ()
	Gets a mutable reference to the tile size. More...
void	SetZoomLevel (const int64_t &value)
	Sets the tile size. More...

Detailed Description

A model that represents a definition of an index field.

Member Function Documentation

GetDuration()

const int64_t& olp::dataservice::read::model::IndexDefinition::GetDuration ( ) const

inline

Gets the duration of the time window in milliseconds.

The time window represents the time slice and denotes the finest time granularity at which the data will be indexed and later queried. The duration is between 10 minutes and 1 day in milliseconds.

Returns

The duration of the time window in milliseconds.

GetMutableDuration()

int64_t& olp::dataservice::read::model::IndexDefinition::GetMutableDuration ( )

inline

Gets a mutable reference to the duration of the time window in milliseconds.

See also

GetDuration for information on the duration of the time window.

Returns

The mutable reference to the duration of the time window in milliseconds.

GetMutableName()

std::string& olp::dataservice::read::model::IndexDefinition::GetMutableName ( )

inline

Gets a mutable reference to the short name of the index field.

Returns

The mutable reference to the short name of the index field.

GetMutableType()

std::string& olp::dataservice::read::model::IndexDefinition::GetMutableType ( )

inline

Gets a mutable reference to the type of data availability that this layer provides.

Returns

The mutable reference to the data availability type.

GetMutableZoomLevel()

int64_t& olp::dataservice::read::model::IndexDefinition::GetMutableZoomLevel ( )

inline

Gets a mutable reference to the tile size.

Returns

The mutable reference to the tile size.

GetName()

const std::string& olp::dataservice::read::model::IndexDefinition::GetName ( ) const

inline

Gets the short name of the index field.

Returns

The short name of the index field.

GetType()

const std::string& olp::dataservice::read::model::IndexDefinition::GetType ( ) const

inline

Gets the type of data availability that this layer provides.

Returns

The data availability type.

GetZoomLevel()

const int64_t& olp::dataservice::read::model::IndexDefinition::GetZoomLevel ( ) const

inline

Gets the tile size.

Returns

The tile size.

SetDuration()

void olp::dataservice::read::model::IndexDefinition::SetDuration ( const int64_t &  value )

inline

Sets the duration of the time window.

See also

GetDuration for information on the duration of the time window.

Parameters

value

The duration of the time window in milliseconds.

SetName()

void olp::dataservice::read::model::IndexDefinition::SetName ( const std::string &  value )

inline

Sets the short name of the index field.

Parameters

value

The short name of the index field.

SetType()

void olp::dataservice::read::model::IndexDefinition::SetType ( const std::string &  value )

inline

Sets the data availability type.

Parameters

value

The data availability type.

SetZoomLevel()

void olp::dataservice::read::model::IndexDefinition::SetZoomLevel ( const int64_t &  value )

inline

Sets the tile size.

Parameters

value

The tile size.

---

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

• olp-cpp-sdk-dataservice-read/include/olp/dataservice/read/model/Catalog.h