carma::alarm::AlarmControl Interface Reference

AlarmControl interface More...

import "carma/alarm/AlarmControl.idl";

Public Member Functions
void	enableAlarm (in boolean enable) raises ( carma::util::UserException )
	Globally enable or disable alarm. More...
void	turnOff () raises ( carma::util::UserException )
	Tell the alarm to turn off. More...
void	turnOn (in string alarmName, in string mp, in string reason, in boolean repeat) raises ( carma::util::UserException )
	Tell the alarm to turn on. More...
void	updateDeadMan () raises ( carma::util::UserException )
	Let the alarm system know that the acc is still alive This call is generally called only by the carmaAlarm process running on the acc, which is listening to the fault system. More...

Detailed Description

AlarmControl interface

Definition at line 49 of file AlarmControl.idl.

Member Function Documentation

void carma::alarm::AlarmControl::enableAlarm	(	in boolean	enable	)
raises	(	carma::util::UserException
	)

Globally enable or disable alarm.

Parameters

bool	enable True, enable, False, disable

Returns

none.

void carma::alarm::AlarmControl::turnOff	(		)
raises	(	carma::util::UserException
	)

Tell the alarm to turn off.

Returns

none.

void carma::alarm::AlarmControl::turnOn	(	in string	alarmName,
		in string	mp,
		in string	reason,
		in boolean	repeat
	)
raises	(	carma::util::UserException
	)

Tell the alarm to turn on.

Parameters

string	alarmName Name of alarm to sound (described in sounds.tab)
string	mp Monitor point that lead to this alarm
string	reason Further explanation about alarm
bool	repeat Have the alarm system repeat the sound over and over...

Returns

none.

void carma::alarm::AlarmControl::updateDeadMan	(		)
raises	(	carma::util::UserException
	)

Let the alarm system know that the acc is still alive This call is generally called only by the carmaAlarm process running on the acc, which is listening to the fault system.

Returns

none.

---

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

• carma/alarm/AlarmControl.idl