olp-cpp-sdk  1.22.0
Public Member Functions | List of all members
olp::dataservice::write::model::BooleanIndexValue Class Referencefinal

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

#include <Index.h>

Inheritance diagram for olp::dataservice::write::model::BooleanIndexValue:
Inheritance graph
[legend]
Collaboration diagram for olp::dataservice::write::model::BooleanIndexValue:
Collaboration graph
[legend]

Public Member Functions

 BooleanIndexValue (bool booleanValue, IndexType type)
 Creates the BooleanIndexValue instance. More...
 
const bool & GetValue () const
 Gets the boolean value of the index layer. More...
 
bool & GetMutableValue ()
 Gets a mutable reference to the boolean value of the index layer. More...
 
void SetValue (const bool &value)
 Sets the boolean 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.
 
IndexValueoperator= (IndexValue &&)=default
 A default move assignment operator.
 
IndexValueoperator= (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 boolean type.

Constructor & Destructor Documentation

◆ BooleanIndexValue()

olp::dataservice::write::model::BooleanIndexValue::BooleanIndexValue ( bool  booleanValue,
IndexType  type 
)
inline

Creates the BooleanIndexValue instance.

Parameters
booleanValueThe boolean value.
typeThe IndexType instance.

Member Function Documentation

◆ GetMutableValue()

bool& olp::dataservice::write::model::BooleanIndexValue::GetMutableValue ( )
inline

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

Returns
The mutable reference to the boolean value.

◆ GetValue()

const bool& olp::dataservice::write::model::BooleanIndexValue::GetValue ( ) const
inline

Gets the boolean value of the index layer.

Returns
The boolean value.

◆ SetValue()

void olp::dataservice::write::model::BooleanIndexValue::SetValue ( const bool &  value)
inline

Sets the boolean value.

Parameters
valueThe boolean value.

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