Manages fault system control DO connections. More...

#include <carma/control/FaultHandle.h>

Inheritance diagram for carma::control::FaultHandle:

Public Member Functions
void	disableAlarms (::std::vector< ::std::string > mpNames)
	Disable fault system alarms for the given monitor points. More...

	FaultHandle (monitor::MonitorSystem &monitorSys, monitor::ControlSubsystemBase::Reachable &reachable)
	Constructor. More...

void	restoreAlarms (::std::vector< ::std::string > mpNames)
	Restore fault system alarms to their default enable states for the given monitor points. More...

void	setAlarmEnable (int subarrayNo, bool on)
	Set the alarm enable state for the given subarray. 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 fault system control DO connections.

Definition at line 28 of file FaultHandle.h.

Constructor & Destructor Documentation

carma::control::FaultHandle::FaultHandle	(	monitor::MonitorSystem &	monitorSys,
		monitor::ControlSubsystemBase::Reachable &	reachable
	)

Constructor.

Parameters

monitorSystem monitor system reference which allows this handle to get a reference to its own monitor stream.

Member Function Documentation

void carma::control::FaultHandle::disableAlarms ( ::std::vector< ::std::string > mpNames )

Disable fault system alarms for the given monitor points.

Parameters

mpNames vector of monitor point names. Passed by value to safely cross the thread boundary without issues if the invoker completes before this call itself actually completes

void carma::control::FaultHandle::restoreAlarms ( ::std::vector< ::std::string > mpNames )

Restore fault system alarms to their default enable states for the given monitor points.

Parameters

mpNames vector of monitor point names. Passed by value to safely cross the thread boundary without issues if the invoker completes before this call itself actually completes

void carma::control::FaultHandle::setAlarmEnable	(	int	subarrayNo,
		bool	on
	)

Set the alarm enable state for the given subarray.

Parameters

subarrayNo	the subarray number
on	true if the alarm is enabled

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

carma/control/FaultHandle.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation