carma::control::AlarmHandle Class Reference

Manages acc Alarm reference to alarm DO. More...

#include <carma/control/AlarmHandle.h>

Inheritance diagram for carma::control::AlarmHandle:

Public Member Functions
	AlarmHandle (carma::monitor::MonitorSystem &carmaMonitor, carma::monitor::ControlSubsystemBase::Reachable &reachable)
	Constructor. More...
void	enableAlarm (bool state)
	Enable/disable the alarm system state true=enable false=disable. More...
void	turnOff ()
	turnOff the alarm More...
void	turnOn (const char *alarmName, const char *mp, const char *reason, bool repeat)
	turnOn the alarm, given a particular alarm name More...
void	updateDeadMan ()
	Let the alarm system know that the fault watching part is alive. More...
Public Member Functions inherited from carma::control::RemoteObjHandleT< T >
template<typename S >
S::_var_type	narrowedRemoteObj () const
	Returns remote object handle as var. More...
T::_var_type	remoteObj () const
	Returns remote object handle as var. More...
	RemoteObjHandleT (const ::std::string &doName, monitor::MonitorPointBool *mpReachable, const monitor::MonitorSubsystem *subsystem, monitor::MonitorSystem *system, bool defaultLogIfNotReachable, bool defaultLogSentCommands)
	Constructor. More...
virtual	~RemoteObjHandleT ()
	Destructor. More...
Public Member Functions inherited from carma::control::RemoteObjHandleBase
bool	attemptToReconnectIfNeeded ()
	Try reconnect to the DO if needed. More...
::std::string	doName () const
	get the DO name More...
void	forceFullReconnect ()
	Force a full re-lookup of the DO by name. More...
bool	isObjReachable ()
	If state is 'not reachable' and monitor system is current, tries to reconnect. More...
bool	isObjReachable (bool logIfNotReachable)
	RemoteObjHandleBase (const ::std::string &doName, monitor::MonitorPointBool *mpReachable, const monitor::MonitorSubsystem *subsystem, monitor::MonitorSystem *system, bool defaultLogIfNotReachable, bool defaultLogSentCommands)
	Constructor. More...
virtual	~RemoteObjHandleBase ()
	Destructor. More...

Additional Inherited Members
Protected Member Functions inherited from carma::control::RemoteObjHandleT< T >
virtual bool	resolveObjRef ()
Protected Member Functions inherited from carma::control::RemoteObjHandleBase
bool	getDefaultLogIfNotReachable () const
bool	getDefaultLogSentCommands () const
void	invalidateObjRef ()
void	invalidateObjRefIfNeededForCaught ()
void	logException (const ::std::string &callString, const ::std::string &exString) const
void	logSentCommand (const ::std::string &callString, const double mjd) const
void	logSentCommand (const ::std::string &callString, const double mjd, const ::std::string &subDoName) const
void	logSentCommandIfNeeded (const ::std::string &callString, const double mjd) const
void	logSentCommandIfNeeded (const ::std::string &callString, const double mjd, const ::std::string &subDoName) const
void	markObjRefValid ()
void	processException (const ::std::string &callString, const ::CORBA::Exception &corbaException)
void	throwBadRemoteObjAccess () const
void	throwIfObjRefIsNotValid () const

Detailed Description

Manages acc Alarm reference to alarm DO.

Definition at line 33 of file AlarmHandle.h.

Constructor & Destructor Documentation

carma::control::AlarmHandle::AlarmHandle	(	carma::monitor::MonitorSystem &	carmaMonitor,
		carma::monitor::ControlSubsystemBase::Reachable &	reachable
	)

Constructor.

Parameters

carmaMonitor	carma::monitor::MonitorSystem& monitor system, which allows Alarm handle to get a reference to its own monitor stream.
const	carma::monitor::ControlSubsystemBase:Reachable& reachable monitor system, which allows Alarm handle to set monitor points for the subarray within control monitor subsystem .

Member Function Documentation

void carma::control::AlarmHandle::enableAlarm

(

bool

state

)

Enable/disable the alarm system state true=enable false=disable.

Returns

none.

void carma::control::AlarmHandle::turnOff

(

)

turnOff the alarm

Returns

none.

void carma::control::AlarmHandle::turnOn	(	const char *	alarmName,
		const char *	mp,
		const char *	reason,
		bool	repeat
	)

turnOn the alarm, given a particular alarm name

Parameters

const	char* alarmName Name of alarm to invoke (comes from watch.tab, and matches an entry in sounds.tab)
const	char* mp MonitorPoint that lead to this alarm
const	char* reason Extra explanation of alarm
bool	repeat Repeat the sound file over and over (usually true)

Returns

none.

void carma::control::AlarmHandle::updateDeadMan

(

)

Let the alarm system know that the fault watching part is alive.

Returns

none.

---

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

• carma/control/AlarmHandle.h