olp::dataservice::write::model::StringIndexValue Class Reference

Represents the index layer of the string type. More...

#include <Index.h>

Inheritance diagram for olp::dataservice::write::model::StringIndexValue:

Collaboration diagram for olp::dataservice::write::model::StringIndexValue:

Public Member Functions
	StringIndexValue (std::string stringValue, IndexType type)
	Creates the StringIndexValue instance. More...
std::string	GetValue () const
	Gets the string value of the index layer. More...
std::string &	GetMutableValue ()
	Gets a mutable reference to the string value of the index layer. More...
void	SetValue (const std::string &value)
	Sets the string value. More...
Public Member Functions inherited from olp::dataservice::write::model::IndexValue
	IndexValue (IndexType type)
	Creates the IndexValue instance. More...
	IndexValue (const IndexValue &)=default
	A default copy constructor.
	IndexValue (IndexValue &&)=default
	A default move constructor.
IndexValue &	operator= (IndexValue &&)=default
	A default move assignment operator.
IndexValue &	operator= (const IndexValue &)=default
	A default copy assignment operator.
virtual	~IndexValue ()=default
	A default virtual destructor.
IndexType	getIndexType () const
	Gets the index value type. More...

Detailed Description

Represents the index layer of the string type.

Constructor & Destructor Documentation

StringIndexValue()

olp::dataservice::write::model::StringIndexValue::StringIndexValue ( std::string  stringValue, IndexType  type  )

inline

Creates the StringIndexValue instance.

Parameters

stringValue	The string value.
type	The IndexType instance.

Member Function Documentation

GetMutableValue()

std::string& olp::dataservice::write::model::StringIndexValue::GetMutableValue ( )

inline

Gets a mutable reference to the string value of the index layer.

Returns

The string value.

GetValue()

std::string olp::dataservice::write::model::StringIndexValue::GetValue ( ) const

inline

Gets the string value of the index layer.

Returns

The string value.

SetValue()

void olp::dataservice::write::model::StringIndexValue::SetValue ( const std::string &  value )

inline

Sets the string value.

Parameters

value

The string value.

---

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

• olp-cpp-sdk-dataservice-write/include/olp/dataservice/write/generated/model/Index.h