LOW_compToggleSwitch Class Reference

#include <LOW_compToggleSwitch.h>

Inheritance diagram for LOW_compToggleSwitch:

[legend]Collaboration diagram for LOW_compToggleSwitch:

[legend]List of all members.

Public Types
typedef std::vector< LOW_compToggleSwitch * >	compToggleSwitchPtrVec_t
typedef LOW_compTwinSwitch::actionReceiver	actionReceiver
typedef std::vector< LOW_compTwinSwitch * >	compTwinSwitchPtrVec_t
Public Member Functions
	class_DERIVE_FROM_EXCEPTION (compToggleSwitch_error, component_error)
	LOW_compToggleSwitch (const LOW_devDS2406 &inPIODevice, actionReceiver &inActionRcv, const bool inDetectShortClicks)
virtual	~LOW_compToggleSwitch ()
	class_DERIVE_FROM_EXCEPTION (compTwinSwitch_error, component_error)
virtual void	handleAlarm ()
void	alarmPollLoop ()
bool	getDetectShortClicks ()
const LOW_devDS2406 &	getPioDevice () const
Private Types
enum	tgSwState_t { noLock_state = 0, locked_state }
Private Member Functions
void	switchAction (LOW_compTwinSwitch *inCaller, const unsigned int inSwitchNum, const bool inValue)
void	shortSwitchAction (LOW_compTwinSwitch *inCaller, const unsigned int inSwitchNum)
Private Attributes
actionReceiver &	toggleActionRcv
tgSwState_t	toggleState
unsigned int	lockedSwitch

---

Detailed Description

Todo:

Documentation of class.

Author:

Harald Roelle

Definition at line 30 of file LOW_compToggleSwitch.h.

---

Member Typedef Documentation

typedef LOW_compTwinSwitch::actionReceiver LOW_compToggleSwitch::actionReceiver

Definition at line 51 of file LOW_compToggleSwitch.h.

typedef std::vector<LOW_compToggleSwitch*> LOW_compToggleSwitch::compToggleSwitchPtrVec_t

Definition at line 49 of file LOW_compToggleSwitch.h.

typedef std::vector<LOW_compTwinSwitch*> LOW_compTwinSwitch::compTwinSwitchPtrVec_t [inherited]

Definition at line 50 of file LOW_compTwinSwitch.h.

---

Member Enumeration Documentation

enum LOW_compToggleSwitch::tgSwState_t [private]

Enumeration values: noLock_state  locked_state  Definition at line 75 of file LOW_compToggleSwitch.h.

---

Constructor & Destructor Documentation

LOW_compToggleSwitch::LOW_compToggleSwitch (  const LOW_devDS2406 &  inPIODevice, actionReceiver &  inActionRcv, const bool  inDetectShortClicks )

Definition at line 27 of file LOW_compToggleSwitch.cpp. References noLock_state, and toggleState.

LOW_compToggleSwitch::~LOW_compToggleSwitch (   )  [virtual]

Definition at line 36 of file LOW_compToggleSwitch.cpp.

---

Member Function Documentation

void LOW_compTwinSwitch::alarmPollLoop (   )  [inherited]

Definition at line 83 of file LOW_compTwinSwitch.cpp. References LOW_compTwinSwitch::pioDevice, and LOW_device::verifyDevice().

LOW_compTwinSwitch::class_DERIVE_FROM_EXCEPTION (  compTwinSwitch_error  , component_error  )  [inherited]

LOW_compToggleSwitch::class_DERIVE_FROM_EXCEPTION (  compToggleSwitch_error  , component_error  )

bool LOW_compTwinSwitch::getDetectShortClicks (   )  [inherited]

Definition at line 89 of file LOW_compTwinSwitch.cpp. References LOW_compTwinSwitch::detectShortClicks.

const LOW_devDS2406 & LOW_compTwinSwitch::getPioDevice (   )  const [inherited]

Definition at line 94 of file LOW_compTwinSwitch.cpp. References LOW_compTwinSwitch::pioDevice.

void LOW_compTwinSwitch::handleAlarm (   )  [virtual, inherited]

Definition at line 61 of file LOW_compTwinSwitch.cpp. References LOW_devDS2406::cmd_ChannelAccess::channelInfo_t::activityLatch_pioA, LOW_devDS2406::cmd_ChannelAccess::channelInfo_t::activityLatch_pioB, LOW_compTwinSwitch::doSwitchAction(), LOW_devDS2406::getHasPioB(), LOW_compTwinSwitch::pioDevice, LOW_compTwinSwitch::readStatus(), LOW_compTwinSwitch::resetLatches(), LOW_devDS2406::cmd_ChannelAccess::channelInfo_t::sensedLevel_pioA, and LOW_devDS2406::cmd_ChannelAccess::channelInfo_t::sensedLevel_pioB.

void LOW_compToggleSwitch::shortSwitchAction (  LOW_compTwinSwitch *  inCaller, const unsigned int  inSwitchNum )  [private, virtual]

Implements LOW_compTwinSwitch::actionReceiver. Definition at line 78 of file LOW_compToggleSwitch.cpp. References noLock_state, LOW_compTwinSwitch::actionReceiver::shortSwitchAction(), toggleActionRcv, and toggleState.

void LOW_compToggleSwitch::switchAction (  LOW_compTwinSwitch *  inCaller, const unsigned int  inSwitchNum, const bool  inValue )  [private, virtual]

Implements LOW_compTwinSwitch::actionReceiver. Definition at line 47 of file LOW_compToggleSwitch.cpp. References locked_state, lockedSwitch, noLock_state, LOW_compTwinSwitch::actionReceiver::switchAction(), toggleActionRcv, and toggleState.

---

Member Data Documentation

unsigned int LOW_compToggleSwitch::lockedSwitch [private]

Definition at line 86 of file LOW_compToggleSwitch.h. Referenced by switchAction().

actionReceiver& LOW_compToggleSwitch::toggleActionRcv [private]

Definition at line 84 of file LOW_compToggleSwitch.h. Referenced by shortSwitchAction(), and switchAction().

tgSwState_t LOW_compToggleSwitch::toggleState [private]

Definition at line 85 of file LOW_compToggleSwitch.h. Referenced by LOW_compToggleSwitch(), shortSwitchAction(), and switchAction().

---

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

• LOW_compToggleSwitch.h
• LOW_compToggleSwitch.cpp

---