Public Member Functions | Protected Attributes

wosh::building::DoorBell Class Reference

#include <H:/WOSH/win32_vc2010/src/framework/building/interior/DoorBell.h>

List of all members.

Public Member Functions

 DoorBell ()
 Empty constructor.
 DoorBell (const DoorBell &m)
 Copy constructor.
virtual ~DoorBell ()
 Empty destructor.
DoorBell Interface
virtual WRESULT enable (const SecurityToken *security=NULL)
virtual WRESULT disable (const SecurityToken *security=NULL)
virtual WRESULT stop (const SecurityToken *security=NULL)
virtual WRESULT test (const SecurityToken *security=NULL)
DoorBell Interface - Getters
virtual
wosh::interfaces::building::DOORBELL_STATE 
getDoorBellState () const
 Get last known doorbell state (opened, closed, unknown)
virtual const
wosh::interfaces::building::Switch
getSwitch () const
virtual
wosh::interfaces::building::Switch
getSwitch ()
wosh::interfaces::building::DoorBellListener * getDoorBellListener ()
DoorBell Interface - Setters
WRESULT setSwitch (wosh::interfaces::building::Switch *ptr)
WRESULT setDoorBellListener (wosh::interfaces::building::DoorBellListener *ptr)
SwitchListener interface
virtual void switch_state (const wosh::interfaces::building::SwitchStateChanged *switch_event, const SecurityToken *token, wosh::interfaces::building::Switch *switch_source)
IPropertiesProviderListener interface
virtual bool updatingProperty (bool &do_update, const Variant &value_proposed, Property &property_current, const PropertiesProvider *source)

Protected Attributes

wosh::interfaces::building::DOORBELL_STATE state
 state of door bell
bool reverse_mapping
 reverse switch event mapping (on/off intepreted as off/on )
long ringing_time_min
 i

Private Member Functions

Hosted mehods
WRESULT mmDoEnable (const SecurityToken *security)
WRESULT mmDoDisable (const SecurityToken *security)
WRESULT mmDoTest (const SecurityToken *security)

Internal mehods

void initDoorBell ()
virtual void childrenChanged_ ()

Detailed Description

See also:
wosh::bundles::BuildingManagerBundle
Version:
Id:
DoorBell.h 3775 2011-01-01 16:38:17Z alex
Author:
Alessandro Polo

Definition at line 49 of file framework/building/interior/DoorBell.h.


Constructor & Destructor Documentation

wosh::building::DoorBell::DoorBell (  )

Empty constructor.

Definition at line 58 of file DoorBell.cpp.

wosh::building::DoorBell::DoorBell ( const DoorBell m )

Copy constructor.

Parameters:
m[in] the source object to be copied

Definition at line 65 of file DoorBell.cpp.

wosh::building::DoorBell::~DoorBell (  ) [virtual]

Empty destructor.

Reimplemented from wosh::interfaces::building::DoorBell.

Definition at line 70 of file DoorBell.cpp.

References wosh::building::BuildingBlock::Log, and wosh::LOG_DEBUG.


Member Function Documentation

virtual wosh::interfaces::building::DOORBELL_STATE wosh::building::DoorBell::getDoorBellState (  ) const [inline, virtual]

Get last known doorbell state (opened, closed, unknown)

Returns:
current doorbell state (enum)

Implements wosh::interfaces::building::DoorBell.

Definition at line 104 of file framework/building/interior/DoorBell.h.

References state.


Member Data Documentation

reverse switch event mapping (on/off intepreted as off/on )

Definition at line 161 of file framework/building/interior/DoorBell.h.

i

Definition at line 163 of file framework/building/interior/DoorBell.h.

wosh::interfaces::building::DOORBELL_STATE wosh::building::DoorBell::state [protected]

state of door bell

Definition at line 160 of file framework/building/interior/DoorBell.h.

Referenced by getDoorBellState().


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

Generated on Tue Feb 8 2011 09:33:33 for WOSH system 0.8.888 [wolf] by Alessandro Polo, using DoxyGen 1.7.2 hosted by WOSH Framework