ot::ServiceBase Class Reference

General service information. The ServiceBase class is used to store the general service information. More...

#include "ServiceBase.h"

Inheritance diagram for ot::ServiceBase:

Public Member Functions
	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
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

General service information. The ServiceBase class is used to store the general service information.

Constructor & Destructor Documentation

ServiceBase() [1/4]

ServiceBase::ServiceBase

(

)

Constructor.

ServiceBase() [2/4]

ServiceBase::ServiceBase	(	const std::string &	_name,
		const std::string &	_type )

Constructor.

Parameters

_name	The name of the service
_type	The type of the service

ServiceBase() [3/4]

ServiceBase::ServiceBase	(	const std::string &	_name,
		const std::string &	_type,
		const std::string &	_url,
		serviceID_t	_id,
		const std::string &	_siteId = std::string() )

Constructor.

Parameters

_name	The name of the service
_type	The type of the service
_url	The URL of the service
_id	The ID of the service

ServiceBase() [4/4]

ServiceBase::ServiceBase

(

const ServiceBase &

_other

)

Copy constructor.

Parameters

_other

The other service

~ServiceBase()

virtual ot::ServiceBase::~ServiceBase ( )

inlinevirtual

Deconstructor.

Member Function Documentation

getBasicServiceInformation()

BasicServiceInformation ot::ServiceBase::getBasicServiceInformation ( void ) const

inline

getServiceID()

serviceID_t ot::ServiceBase::getServiceID ( void ) const

inline

Return the service ID.

getServiceIDAsInt()

int ServiceBase::getServiceIDAsInt

(

void

)

const

Return the service ID as an Integer (The service ID is an Integer stored as a String)

getServiceName()

std::string ot::ServiceBase::getServiceName ( void ) const

inline

Return the service name.

getServiceType()

std::string ot::ServiceBase::getServiceType ( void ) const

inline

Return the service type.

getServiceURL()

const std::string & ot::ServiceBase::getServiceURL ( void ) const

inline

Return the service URL.

getSessionCount()

int ot::ServiceBase::getSessionCount ( void ) const

inline

Return the session count.

getSiteId()

std::string ot::ServiceBase::getSiteId ( void ) const

inline

Return the site ID.

operator!=()

bool ServiceBase::operator!=

(

const ServiceBase &

_other

)

const

operator=()

ot::ServiceBase & ServiceBase::operator=

(

const ServiceBase &

_other

)

operator==()

bool ServiceBase::operator==

(

const ServiceBase &

_other

)

const

setServiceID()

void ot::ServiceBase::setServiceID ( serviceID_t _id )

inline

Set the service ID.

Parameters

_id	The ID to set

setServiceName()

void ot::ServiceBase::setServiceName ( const std::string & _name )

inline

Set the service name.

Parameters

_name

The name to set

setServiceType()

void ot::ServiceBase::setServiceType ( const std::string & _type )

inline

Set the service type.

Parameters

_type

The type to set

setServiceURL()

void ot::ServiceBase::setServiceURL ( const std::string & _url )

inline

Set the service URL.

Parameters

_url	The URL to set

setSessionCount()

void ot::ServiceBase::setSessionCount ( int _count )

inline

Set the session count.

Parameters

_count

Count to set

setSiteId()

void ot::ServiceBase::setSiteId ( const std::string & _id )

inline

Set the site ID.

Parameters

_id	The site ID to set

Member Data Documentation

m_serviceID

serviceID_t ot::ServiceBase::m_serviceID

protected

m_serviceName

std::string ot::ServiceBase::m_serviceName

protected

Service URL.

m_serviceType

std::string ot::ServiceBase::m_serviceType

protected

Service name.

m_serviceURL

std::string ot::ServiceBase::m_serviceURL

protected

Service ID.

m_sessionCount

int ot::ServiceBase::m_sessionCount

protected

Site ID.

m_siteId

std::string ot::ServiceBase::m_siteId

protected

Service type.

---

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

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