wosh::interfaces::building::SensorSecurity Class Reference [WOSH Interfaces]

Standard interface of a generic motion sensor (device). More...

#include <H:/WOSH/win32_vc2010/src/interfaces/building/SensorSecurity.h>

List of all members.

Public Member Functions
virtual bool	isAlertDetected () const
	Evaluate if the light state is ALERT_DETECTED. Provided for convenience.
virtual bool	isAlertNotDetected () const
	Evaluate if the light state is ALERT_CLEAR. Provided for convenience.
virtual const char *	getAlertStateAsString () const
	Get light state as a literal string.
SensorSecurity Interface
virtual WRESULT	reset (const SecurityToken *security=NULL)=0
SensorSecurity Interface - Getters
virtual ALERT_STATE	getAlertState () const =0
	Evaluate motion's state. Implemented by inherited classes.
virtual wosh::interfaces::building::SensorSecurityListener *	getSensorSecurityListener ()=0
SensorSecurity Interface - Setters
virtual WRESULT	setSensorSecurityListener (wosh::interfaces::building::SensorSecurityListener *ptr)=0

---

Detailed Description

Standard interface of a generic motion sensor (device).

Version:

0.8.558

Id:

SensorSecurity.h 3775 2011-01-01 16:38:17Z alex

Author:

Alessandro Polo

Definition at line 94 of file SensorSecurity.h.

---

Member Function Documentation

virtual ALERT_STATE wosh::interfaces::building::SensorSecurity::getAlertState

(

)

const [pure virtual]

Evaluate motion's state. Implemented by inherited classes.

Returns:

the current state of the motion

Implemented in wosh::rmi::stubs::SensorSecurity.

Referenced by getAlertStateAsString(), isAlertDetected(), and isAlertNotDetected().

virtual const char* wosh::interfaces::building::SensorSecurity::getAlertStateAsString

(

)

const [inline, virtual]

Get light state as a literal string.

Returns:

C string represeting the current state

See also:

getSwitchStateAsString

Definition at line 114 of file SensorSecurity.h.

References getAlertState().

virtual bool wosh::interfaces::building::SensorSecurity::isAlertDetected

(

)

const [inline, virtual]

Evaluate if the light state is ALERT_DETECTED. Provided for convenience.

Returns:

true if the state is wosh::interfaces::building::SensorSecurity::ALERT_DETECTED; false else

Definition at line 103 of file SensorSecurity.h.

References getAlertState().

virtual bool wosh::interfaces::building::SensorSecurity::isAlertNotDetected

(

)

const [inline, virtual]

Evaluate if the light state is ALERT_CLEAR. Provided for convenience.

Returns:

true if the state is wosh::interfaces::building::SensorSecurity::ALERT_CLEAR; false else

Definition at line 108 of file SensorSecurity.h.

References getAlertState().

---

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

• SensorSecurity.h