CARMA C++
carma::control::LOrefHandle Class Reference

Manages LO reference control DO connections. More...

#include <carma/control/LOrefHandle.h>

Inheritance diagram for carma::control::LOrefHandle:
carma::control::RemoteObjHandleT< T > carma::control::RemoteObjHandleBase

Public Member Functions

void assignSynth (const int synthIndex)
 Assign the synthesizer for this subarray. More...
 
 LOrefHandle (carma::monitor::MonitorSystem &carmaMonitor, carma::monitor::ControlSubsystemBase::Reachable &reachable)
 Constructor. More...
 
void setFrequency (double frequency)
 Set a synthesizer frequency. More...
 
void setFrequencyPower (double frequency, double power)
 Set a synthesizer frequency and power. More...
 
void setPower (double power)
 Set a synthesizer power. 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 LO reference control DO connections.

Definition at line 30 of file LOrefHandle.h.

Constructor & Destructor Documentation

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

Constructor.

Parameters
carmaMonitorcarma::monitor::MonitorSystem& monitor system, which allows LOref handle to get a reference to its own monitor stream.
subarrayMonitorconst carma::monitor::ControlSubsystemBase:Subarray& monitor system, which allows LOref handle to set monitor points for the subarray within control monitor subsystem .

Member Function Documentation

void carma::control::LOrefHandle::assignSynth ( const int  synthIndex)

Assign the synthesizer for this subarray.

Parameters
synthIndex[1-3]
Returns
none.
void carma::control::LOrefHandle::setFrequency ( double  frequency)

Set a synthesizer frequency.

Parameters
doublefrequency Frequency to set (Hertz)
Returns
none.
void carma::control::LOrefHandle::setFrequencyPower ( double  frequency,
double  power 
)

Set a synthesizer frequency and power.

Parameters
doublefrequency Frequency to set (Hertz)
doublepower Power to set (dBm)
Returns
none.
void carma::control::LOrefHandle::setPower ( double  power)

Set a synthesizer power.

Parameters
doublepower Power to set (dBm)
Returns
none.

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