CARMA C++
carma::control::RemoteObjHandleT< T > Class Template Reference

Typed class for managing connections to DOs. More...

#include <carma/control/RemoteObjHandleT.h>

Inheritance diagram for carma::control::RemoteObjHandleT< T >:
carma::control::RemoteObjHandleBase carma::control::AlarmHandle carma::control::AntennaHandle carma::control::CalibratorHandle carma::control::ClockHandle carma::control::CorrelatorHandle carma::control::CryoHandle carma::control::DownconverterHandle carma::control::DriveHandle carma::control::FaultHandle carma::control::FocusHandle carma::control::LineLengthHandle carma::control::LoberotatorHandle carma::control::LOrefHandle carma::control::OpticalTelHandle carma::control::PipelineHandle carma::control::ProjectDatabaseManagerHandle carma::control::RxSelectorHandle carma::control::SignalPathMapperHandle carma::control::VlbiHandle

Public Member Functions

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...
 

Protected Member Functions

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
 

Friends

class RemoteObjMethodFunctorBase< T >
 

Detailed Description

template<typename T>
class carma::control::RemoteObjHandleT< T >

Typed class for managing connections to DOs.

Definition at line 156 of file RemoteObjHandleT.h.

Constructor & Destructor Documentation

template<typename T >
carma::control::RemoteObjHandleT< T >::RemoteObjHandleT ( const ::std::string &  doName,
monitor::MonitorPointBool mpReachable,
const monitor::MonitorSubsystem subsystem,
monitor::MonitorSystem system,
bool  defaultLogIfNotReachable,
bool  defaultLogSentCommands 
)
explicit

Constructor.

Constructs reference to a DO using the name Resolves name using NameService and sets handle.

Parameters
doName,namebound to DO's IOR in NameService
monitor::MonitorPointBool* const, pointer to boolean monitor point which indicates whether DO is currently contactable.
monitor::MonitorSubsystem* const, pointer to monitor subsystem associated with this handle - used as an indicator of subsystem health.

Definition at line 248 of file RemoteObjHandleT.h.

template<typename T >
carma::control::RemoteObjHandleT< T >::~RemoteObjHandleT ( )
virtual

Destructor.

Releases all DO references.

Definition at line 267 of file RemoteObjHandleT.h.

Member Function Documentation

template<typename T >
template<typename S >
S::_var_type carma::control::RemoteObjHandleT< T >::narrowedRemoteObj ( ) const

Returns remote object handle as var.

Returns
IOR of DO as ObjVar specialized to type S.

Definition at line 201 of file RemoteObjHandleT.h.

template<typename T >
T::_var_type carma::control::RemoteObjHandleT< T >::remoteObj ( ) const

Returns remote object handle as var.

Returns
IOR of DO as ObjVar specialized to type T.

Definition at line 278 of file RemoteObjHandleT.h.


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