ot::BasicServiceInformation Class Reference

The BasicServiceInformation class is used to hold a service name and type. The BasicServiceInformation can be used as a key in a map. More...

#include "BasicServiceInformation.h"

Inheritance diagram for ot::BasicServiceInformation:

Public Member Functions
	BasicServiceInformation ()
	BasicServiceInformation (const std::string &_serviceNameAndType)
	BasicServiceInformation (const std::string &_serviceName, const std::string &_serviceType)
	BasicServiceInformation (const BasicServiceInformation &_other)
virtual	~BasicServiceInformation ()
BasicServiceInformation &	operator= (const BasicServiceInformation &_other)
bool	operator== (const BasicServiceInformation &_other) const
bool	operator!= (const BasicServiceInformation &_other) const
bool	operator< (const BasicServiceInformation &_other) const
virtual void	addToJsonObject (JsonValue &_object, JsonAllocator &_allocator) const override
	Add the object contents to the provided JSON object.
virtual void	setFromJsonObject (const ConstJsonObject &_object) override
	Will set the object contents from the provided JSON object.
void	setServiceName (const std::string &_serviceName)
const std::string &	serviceName (void) const
void	setServiceType (const std::string &_serviceType)
const std::string &	serviceType (void) const
Public Member Functions inherited from ot::Serializable
	Serializable ()
virtual	~Serializable ()
virtual void	addToJsonObject (ot::JsonValue &_object, ot::JsonAllocator &_allocator) const =0
	Add the object contents to the provided JSON object.

Detailed Description

The BasicServiceInformation class is used to hold a service name and type. The BasicServiceInformation can be used as a key in a map.

Constructor & Destructor Documentation

BasicServiceInformation() [1/4]

ot::BasicServiceInformation::BasicServiceInformation

(

)

BasicServiceInformation() [2/4]

ot::BasicServiceInformation::BasicServiceInformation

(

const std::string &

_serviceNameAndType

)

BasicServiceInformation() [3/4]

ot::BasicServiceInformation::BasicServiceInformation	(	const std::string &	_serviceName,
		const std::string &	_serviceType )

BasicServiceInformation() [4/4]

ot::BasicServiceInformation::BasicServiceInformation

(

const BasicServiceInformation &

_other

)

~BasicServiceInformation()

ot::BasicServiceInformation::~BasicServiceInformation ( )

virtual

Member Function Documentation

addToJsonObject()

void ot::BasicServiceInformation::addToJsonObject ( JsonValue & _object, JsonAllocator & _allocator ) const

overridevirtual

Add the object contents to the provided JSON object.

Parameters

_object	Json object reference
_allocator	Allocator

operator!=()

bool ot::BasicServiceInformation::operator!=

(

const BasicServiceInformation &

_other

)

const

operator<()

bool ot::BasicServiceInformation::operator<

(

const BasicServiceInformation &

_other

)

const

operator=()

ot::BasicServiceInformation & ot::BasicServiceInformation::operator=

(

const BasicServiceInformation &

_other

)

operator==()

bool ot::BasicServiceInformation::operator==

(

const BasicServiceInformation &

_other

)

const

serviceName()

const std::string & ot::BasicServiceInformation::serviceName ( void ) const

inline

serviceType()

const std::string & ot::BasicServiceInformation::serviceType ( void ) const

inline

setFromJsonObject()

void ot::BasicServiceInformation::setFromJsonObject ( const ConstJsonObject & _object )

overridevirtual

Will set the object contents from the provided JSON object.

Parameters

_object

The JSON object containing the information

Exceptions

Will	throw an exception if the provided object is not valid (members missing or invalid types)

Implements ot::Serializable.

setServiceName()

void ot::BasicServiceInformation::setServiceName ( const std::string & _serviceName )

inline

setServiceType()

void ot::BasicServiceInformation::setServiceType ( const std::string & _serviceType )

inline

---

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

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