ot::ThisService Class Reference

The central service information class of a service. The ThisService is a singleton that should be used by every class to retreive or set the current service information. More...

#include "ThisService.h"

Inheritance diagram for ot::ThisService:

Static Public Member Functions
static ThisService &	instance (void)
	Returns global instance.
static void	addIdToJsonDocument (JsonDocument &_document)
	Adds the current service id to the provided JSON document.
static serviceID_t	getIdFromJsonDocument (const JsonDocument &_document)
	Sets the current service id from the provided JSON document.

Additional Inherited Members
Public Member Functions inherited from ot::ServiceBase
	ServiceBase ()
	Constructor.
	ServiceBase (const std::string &_name, const std::string &_type)
	Constructor.
	ServiceBase (const std::string &_name, const std::string &_type, const std::string &_url, serviceID_t _id, const std::string &_siteId=std::string())
	Constructor.
	ServiceBase (const ServiceBase &_other)
	Copy constructor.
ServiceBase &	operator= (const ServiceBase &_other)
bool	operator== (const ServiceBase &_other) const
bool	operator!= (const ServiceBase &_other) const
virtual	~ServiceBase ()
	Deconstructor.
void	setServiceID (serviceID_t _id)
	Set the service ID.
void	setServiceURL (const std::string &_url)
	Set the service URL.
void	setServiceName (const std::string &_name)
	Set the service name.
void	setServiceType (const std::string &_type)
	Set the service type.
void	setSiteId (const std::string &_id)
	Set the site ID.
void	setSessionCount (int _count)
	Set the session count.
serviceID_t	getServiceID (void) const
	Return the service ID.
int	getServiceIDAsInt (void) const
	Return the service ID as an Integer (The service ID is an Integer stored as a String)
int	getSessionCount (void) const
	Return the session count.
const std::string &	getServiceURL (void) const
	Return the service URL.
std::string	getServiceName (void) const
	Return the service name.
std::string	getServiceType (void) const
	Return the service type.
std::string	getSiteId (void) const
	Return the site ID.
BasicServiceInformation	getBasicServiceInformation (void) const
Protected Attributes inherited from ot::ServiceBase
serviceID_t	m_serviceID
std::string	m_serviceURL
	Service ID.
std::string	m_serviceName
	Service URL.
std::string	m_serviceType
	Service name.
std::string	m_siteId
	Service type.
int	m_sessionCount
	Site ID.

Detailed Description

The central service information class of a service. The ThisService is a singleton that should be used by every class to retreive or set the current service information.

Member Function Documentation

addIdToJsonDocument()

void ot::ThisService::addIdToJsonDocument ( JsonDocument & _document )

static

Adds the current service id to the provided JSON document.

getIdFromJsonDocument()

ot::serviceID_t ot::ThisService::getIdFromJsonDocument ( const JsonDocument & _document )

static

Sets the current service id from the provided JSON document.

instance()

ot::ThisService & ot::ThisService::instance ( void )

static

Returns global instance.

---

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

• Libraries/OTCore/include/OTCore/ThisService.h
• Libraries/OTCore/src/ThisService.cpp