Maps SDK for C++ 1.0.0
Loading...
Searching...
No Matches
gem::GateKeeper Class Reference

GateKeeper object. More...

Inheritance diagram for gem::GateKeeper:
Collaboration diagram for gem::GateKeeper:

Public Member Functions

 GateKeeper (const GateKeeper &)=delete
 GateKeeper (GateKeeper &&)=default
 Default move constructor noexcept is deduced.
GateKeeper & operator= (const GateKeeper &)=delete
 Copy assignment operator is deleted to prevent copying of this service.
GateKeeper & operator= (GateKeeper &&)=default
 Default move assignment operator.
void refresh ()
 Refreshes the states of the gates.
bool has (EGate gate) const
 Checks whether or not the SDK has the gate and is available.
GateStatus getStatus (EGate gate) const
 Get a more detailed status of the gate.

Detailed Description

GateKeeper object.

Used to check the status of gates.

Implements share-read / write Api object over IGateKeeper.

This behaves like a singleton, i.e. all instances are shared behind the same API interface

Member Function Documentation

◆ getStatus()

GateStatus gem::GateKeeper::getStatus ( EGate gate) const
inline

Get a more detailed status of the gate.

Parameters
[in]gateThe gate to be checked.
Returns
The GateStatus.

◆ has()

bool gem::GateKeeper::has ( EGate gate) const
inline

Checks whether or not the SDK has the gate and is available.

Parameters
[in]gateThe gate to be checked.
Returns
The status. If it is true, the functionality behind this gate must be enabled, if it is false the functionality must be disabled.

◆ operator=() [1/2]

GateKeeper & gem::GateKeeper::operator= ( const GateKeeper & )
delete

Copy assignment operator is deleted to prevent copying of this service.

Returns
GateKeeper& reference to this instance

◆ operator=() [2/2]

GateKeeper & gem::GateKeeper::operator= ( GateKeeper && )
default

Default move assignment operator.

Uses the compiler-generated default implementation for move assignment.

Note
noexcept is deduced.
Returns
GateKeeper& reference to this instance

◆ refresh()

void gem::GateKeeper::refresh ( )
inline

Refreshes the states of the gates.

Called internally by the SDK when changes are performed using the gem::ActivationService.