fesa::NotificationID Class Reference

This class provides an unique notification identifier. The ID is generated from the className, the devices specified by the selection criterion, and the properties that will be notified. More...

#include <NotificationID.h>

Public Member Functions
	NotificationID (uint32_t idKey, const std::set< std::string > &deviceCol, const std::set< std::string > &notifiedPropertyCol)
	Constructor. More...
	~NotificationID ()
const std::set< std::string > &	getNotifiedPropertyCol ()
	returns the set of properties corresponding to this notification ID More...
const std::set< std::string > &	getDeviceCol ()
	returns the set of devices corresponding to this NotificationID More...
uint32_t	getIDKey ()
	returns the unique ID key, which identifies the notification ID and is the same for the server and the real-time side More...
bool	contains (const std::string &propName, const std::string &deviceName)
	This method checks whether the notification ID contains the given combination of property and device. More...
void	addDevice (const std::string &deviceName)
	Adds a new device name to be notified. More...
void	addProperty (const std::string &propertyName)
	This method adds a new class/property combination to be notified. More...

Detailed Description

This class provides an unique notification identifier. The ID is generated from the className, the devices specified by the selection criterion, and the properties that will be notified.

Constructor & Destructor Documentation

fesa::NotificationID::NotificationID	(	uint32_t	idKey,
		const std::set< std::string > &	deviceCol,
		const std::set< std::string > &	notifiedPropertyCol
	)

Constructor.

Parameters

idKey	the identifier of the notification
deviceCol	names of the devices that will be notified
notifiedPropertyCol	names of the properties that will be notified

fesa::NotificationID::~NotificationID

(

)

Destructor

Member Function Documentation

void fesa::NotificationID::addDevice ( const std::string &  deviceName )

inline

Adds a new device name to be notified.

Parameters

deviceName

the name of the device

void fesa::NotificationID::addProperty ( const std::string &  propertyName )

inline

This method adds a new class/property combination to be notified.

Parameters

className	the name of the class to be notified
propertyName	the name of the property to be notified

bool fesa::NotificationID::contains	(	const std::string &	propName,
		const std::string &	deviceName
	)

This method checks whether the notification ID contains the given combination of property and device.

Parameters

propName	the name of the property
deviceName	the name of the device

Returns

true if the pair is contained, otherwise false

const std::set< std::string > & fesa::NotificationID::getDeviceCol ( )

inline

returns the set of devices corresponding to this NotificationID

Returns

const ref to the property collection

uint32_t fesa::NotificationID::getIDKey ( )

inline

returns the unique ID key, which identifies the notification ID and is the same for the server and the real-time side

Returns

the key

const std::set< std::string > & fesa::NotificationID::getNotifiedPropertyCol ( )

inline

returns the set of properties corresponding to this notification ID

Returns

const ref to the property collection

---

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

• NotificationID.h
• NotificationID.cpp