carma::control::FocusHandle Class Reference

Manages antenna focus control DO connections. More...

#include <carma/control/FocusHandle.h>

Inheritance diagram for carma::control::FocusHandle:

Public Member Functions
	FocusHandle (unsigned short carmaAntNo, monitor::MonitorSystem &monitorSystem, monitor::ControlSubsystemBase::Antenna &antenna)
	Constructor. More...
bool	isActionComplete (const monitor::MonitorSystem &monsys, int monDataErrorLimit)
	Compare next sequence number with one returned by the monitor system. More...
void	setX (float positionMm, int preferredSeqNo)
void	setY (float positionMm, int preferredSeqNo)
void	setZ (float positionMm, int preferredSeqNo)
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 antenna focus control DO connections.

Definition at line 30 of file FocusHandle.h.

Constructor & Destructor Documentation

carma::control::FocusHandle::FocusHandle	(	unsigned short	carmaAntNo,
		monitor::MonitorSystem &	monitorSystem,
		monitor::ControlSubsystemBase::Antenna &	antenna
	)

Constructor.

Parameters

carmaAntNo	Carma antenna number
monitorSystem	carma::monitor::MonitorSystem& monitor system, which allows Focus handle to get a reference to its own monitor stream.
antenna	Antenna control monitor system, which contains control and monitor points set by the control subsystem.

Member Function Documentation

bool carma::control::FocusHandle::isActionComplete	(	const monitor::MonitorSystem &	monsys,
		int	monDataErrorLimit
	)

Compare next sequence number with one returned by the monitor system.

If they are the same then the last focus action is complete.

Parameters

monsys	monitor system from which to retrieve completion
monitorDataErrorLimit	number of consecutive monitor data invalid limit before thowing an exception

Returns

true if last action is complete, false otherwise

Exceptions

if	number of consecutive monitor data errors is exceeed

---

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

• carma/control/FocusHandle.h