European
Southern
Observatory

ESO — Reaching New Heights in Astronomy

Countries taking part in the ESO

VLT Software Documentation

trkwsMANAGED_LCU Class Reference

See man page trkwsMANAGED_LCU(4)
More...

#include <trkwsMANAGED_LCU.h>

List of all members.

Public Member Functions

 trkwsMANAGED_LCU (const dbSYMADDRESS dbPoint)
 ~trkwsMANAGED_LCU ()
virtual const char * DbPoint ()
virtual ccsCOMPL_STAT DbPoint (const dbSYMADDRESS dbPoint)
virtual ccsCOMPL_STAT EnableEvents ()
virtual ccsCOMPL_STAT DisableEvents ()
virtual void EvtRegister (evtEVENT *evt, char *dbAttr, evhCB_METHOD DbEventCB)
virtual void EvtDetach (evtEVENT *evt, evhCB_METHOD DbEventCB)
virtual ccsCOMPL_STAT RemTrkTimeSetCB (evhCALLBACK &cb)
virtual evhCB_COMPL_STAT LimitEventCB (msgMESSAGE &msg, void *)
virtual evhCB_COMPL_STAT RemTrkTimeEventCB (msgMESSAGE &msg, void *)
virtual evhCB_COMPL_STAT StateEventCB (evtEVENT_MSG &msg, void *)

Private Attributes

dbSYMADDRESS dbPoint
evtEVENT limitEvent
evtEVENT remTrkTimeEvent
evtEVENT stateEvent
evhCALLBACK * rttCB

Detailed Description

See man page trkwsMANAGED_LCU(4)
Manpage of trkwsMANAGED_LCU

trkwsMANAGED_LCU

Section: Devices and Network Interfaces (4)
Updated: 2012-04-23 10:11
Index Return to man pages list
 

NAME

trkwsMANAGED_LCU - class to manage event setup for LCUs
                      currently involved in tracking.

 

SYNOPSIS 


#include "trkwsMANAGED_LCU.h"


 class trkwsMANAGED_LCU : public fndOBJECT, public eccsERROR_CLASS
 {
   public:
     trkwsMANAGED_LCU(const dbSYMADDRESS dbPoint);
     ~trkwsMANAGED_LCU();

     virtual const char     *DbPoint();
     virtual ccsCOMPL_STAT   DbPoint(const dbSYMADDRESS  dbPoint);

     virtual ccsCOMPL_STAT EnableEvents();
     virtual ccsCOMPL_STAT DisableEvents();
     virtual void EvtRegister(evtEVENT * evt,char * dbAttr,evhCB_METHOD DbEventCB);
     virtual void EvtDetach(evtEVENT * evt,evhCB_METHOD DbEventCB);
     virtual ccsCOMPL_STAT RemTrkTimeSetCB(evhCALLBACK &cb);
     virtual evhCB_COMPL_STAT LimitEventCB(msgMESSAGE &msg, void *);
     virtual evhCB_COMPL_STAT RemTrkTimeEventCB(msgMESSAGE &msg, void *);
     virtual evhCB_COMPL_STAT StateEventCB(evtEVENT_MSG &msg, void *);


   protected:

   private:
     dbSYMADDRESS    dbPoint;
     evtEVENT        limitEvent;
     evtEVENT        remTrkTimeEvent;
     evtEVENT        stateEvent;
     evhCALLBACK    *rttCB;
};
 

PARENT CLASS 


fndOBJECT, public eccsERROR_CLASS
 

PUBLIC METHODS 


trkwsMANAGED_LCU(const dbSYMADDRESS dbPoint)

  Thre constructor receives as parameter the symbolic address of
  the base point of the scanned up mirror of the LCU DB in the trkws DB

~trkwsMANAGED_LCU();

virtual const char     *DbPoint();
  Returns the base point of the mirror of the LCU DB in the trkws DB

virtual ccsCOMPL_STAT   DbPoint(const dbSYMADDRESS  dbPoint);
  Sets the base point of the mirror of the LCU DB in the trkws DB

virtual ccsCOMPL_STAT EnableEvents();
  Registers events for the db attributes that have to be watched

virtual ccsCOMPL_STAT DisableEvents();
  Detaches the events, e.g. if LCU no longer in the light beam

virtual void EvtRegister(evtEVENT * evt,char * dbAttr,evhCB_METHOD DbEventCB);
  Generic event register method used internally

virtual void EvtDetach(evtEVENT * evt,evhCB_METHOD DbEventCB);
  Generic event detach method used internally

virtual ccsCOMPL_STAT RemTrkTimeSetCB(evhCALLBACK &cb);
  This method is used by the object that uses a trkwsMANAGED_LCU object
  to register a callback in it's on class to be called for every occurrence
  of a RTT event. As RTT is depending on all involved LCU's the final
  computation has to occurr at this higher level.

virtual evhCB_COMPL_STAT LimitEventCB(msgMESSAGE &msg, void *);
  This is the callback to be run if an LCU reports that it ran into a limit

virtual evhCB_COMPL_STAT RemTrkTimeEventCB(msgMESSAGE &msg, void *);
  This is the callback run for a change in the remaining trk time attibute
  It calls the callback installed with  RemTrkTimeSetCB if this is set.

virtual evhCB_COMPL_STAT StateEventCB(evtEVENT_MSG &msg, void *);
  This is the callback run for a change in substate of the corresponding
  LCU. If the old substate was TRACKING, a STOP cmd is sent to all LCUs.

evhCB_COMPL_STAT  trkwsMANAGED_LCU::CompletedCB(msgMESSAGE &msg, void *);

 This method is used to return the reply of the process that the message
 went to also to the original caller.
 

PRIVATE DATA MEMBERS 


     dbSYMADDRESS    dbPoint;
         To keep base point of mirror of LCU DB
     evtEVENT        limitEvent;
         object needed for event management
     evtEVENT        remTrkTimeEvent;
         object needed for event management
     evtEVENT        stateEvent;
         object needed for event management
     evhCALLBACK    *rttCB;
         callback set with RemTrkTimeSetCB method
 

ON LINE DATABASE 


     This class uses attributes relative to the path given in dbPoint:
      .rem_track_time
      .limitFlag
      .substate
 

Index

NAME
SYNOPSIS
PARENT CLASS
PUBLIC METHODS
PRIVATE DATA MEMBERS
ON LINE DATABASE
This document was created by man2html, using the manual pages.
Time: 10:11:26 GMT, April 23, 2012

Definition at line 29 of file trkwsMANAGED_LCU.h.

Constructor & Destructor Documentation

trkwsMANAGED_LCU::trkwsMANAGED_LCU ( const dbSYMADDRESS  dbPoint  ) 

Definition at line 210 of file trkwsMANAGED_LCU.C.

References DbPoint(), EnableEvents(), and rttCB.

trkwsMANAGED_LCU::~trkwsMANAGED_LCU (  ) 

Definition at line 227 of file trkwsMANAGED_LCU.C.

References DisableEvents().

Member Function Documentation

ccsCOMPL_STAT trkwsMANAGED_LCU::DbPoint ( const dbSYMADDRESS  dbPoint  )  [virtual]

Definition at line 234 of file trkwsMANAGED_LCU.C.

References dbPoint.

const char * trkwsMANAGED_LCU::DbPoint (  )  [virtual]

Definition at line 244 of file trkwsMANAGED_LCU.C.

References dbPoint.

Referenced by trkwsMANAGE_LIST::RemTrkTimeEventCB(), and trkwsMANAGED_LCU().

ccsCOMPL_STAT trkwsMANAGED_LCU::DisableEvents (  )  [virtual]

Definition at line 291 of file trkwsMANAGED_LCU.C.

References EvtDetach(), remTrkTimeEvent, RemTrkTimeEventCB(), stateEvent, and StateEventCB().

Referenced by ~trkwsMANAGED_LCU().

ccsCOMPL_STAT trkwsMANAGED_LCU::EnableEvents (  )  [virtual]

Definition at line 273 of file trkwsMANAGED_LCU.C.

References dbPoint, EvtRegister(), remTrkTimeEvent, RemTrkTimeEventCB(), stateEvent, StateEventCB(), trkwsAXIS_REMTRKTIME_ATTRNAME, and trkwsAXIS_SUBSTATE_ATTRNAME.

Referenced by trkwsMANAGED_LCU().

void trkwsMANAGED_LCU::EvtDetach ( evtEVENT *  evt,
evhCB_METHOD  DbEventCB 
) [virtual]

Definition at line 322 of file trkwsMANAGED_LCU.C.

Referenced by DisableEvents().

void trkwsMANAGED_LCU::EvtRegister ( evtEVENT *  evt,
char *  dbAttr,
evhCB_METHOD  DbEventCB 
) [virtual]

Definition at line 306 of file trkwsMANAGED_LCU.C.

References evtNOT_EQUAL.

Referenced by EnableEvents().

evhCB_COMPL_STAT trkwsMANAGED_LCU::LimitEventCB ( msgMESSAGE &  msg,
void *   
) [virtual]

Definition at line 355 of file trkwsMANAGED_LCU.C.

References trkwsSTOP_CMD.

evhCB_COMPL_STAT trkwsMANAGED_LCU::RemTrkTimeEventCB ( msgMESSAGE &  msg,
void *   
) [virtual]

Definition at line 398 of file trkwsMANAGED_LCU.C.

References rttCB.

Referenced by DisableEvents(), and EnableEvents().

ccsCOMPL_STAT trkwsMANAGED_LCU::RemTrkTimeSetCB ( evhCALLBACK &  cb  )  [virtual]

Definition at line 252 of file trkwsMANAGED_LCU.C.

References rttCB.

Referenced by trkwsMANAGE_LIST::Init().

evhCB_COMPL_STAT trkwsMANAGED_LCU::StateEventCB ( evtEVENT_MSG &  msg,
void *   
) [virtual]

Definition at line 426 of file trkwsMANAGED_LCU.C.

References tcsLogFits, trkwsSTATE_ERROR, trkwsSTATE_TRACKING, and trkwsSTOP_CMD.

Referenced by DisableEvents(), and EnableEvents().

Member Data Documentation

dbSYMADDRESS trkwsMANAGED_LCU::dbPoint [private]

Definition at line 51 of file trkwsMANAGED_LCU.h.

Referenced by DbPoint(), and EnableEvents().

evtEVENT trkwsMANAGED_LCU::limitEvent [private]

Definition at line 52 of file trkwsMANAGED_LCU.h.

evtEVENT trkwsMANAGED_LCU::remTrkTimeEvent [private]

Definition at line 53 of file trkwsMANAGED_LCU.h.

Referenced by DisableEvents(), and EnableEvents().

evhCALLBACK* trkwsMANAGED_LCU::rttCB [private]

Definition at line 55 of file trkwsMANAGED_LCU.h.

Referenced by RemTrkTimeEventCB(), RemTrkTimeSetCB(), and trkwsMANAGED_LCU().

evtEVENT trkwsMANAGED_LCU::stateEvent [private]

Definition at line 54 of file trkwsMANAGED_LCU.h.

Referenced by DisableEvents(), and EnableEvents().

The documentation for this class was generated from the following files:
Generated on Mon Apr 23 10:12:56 2012 for INTROOT API by doxygen 1.6.3