European
Southern
Observatory

ESO — Reaching New Heights in Astronomy

Countries taking part in the ESO

VLT Software Documentation

tcsCMD_HANDLER_T< StatePolicy > Class Template Reference

#include <tcsCMD_HANDLER.h>

Inheritance diagram for tcsCMD_HANDLER_T< StatePolicy >:
Inheritance graph
[legend]
Collaboration diagram for tcsCMD_HANDLER_T< StatePolicy >:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 tcsCMD_HANDLER_T (const dbSYMADDRESS dbRoot, const msgCMD cmdName, const evhCALLBACK *cb=NULL, const vltLOGICAL allowMultiple=ccsFALSE)
virtual ~tcsCMD_HANDLER_T ()
virtual ccsCOMPL_STAT Init ()
virtual ccsCOMPL_STAT Reset ()
const char * CmdName ()
vltLOGICAL IsActive ()
ccsCOMPL_STAT SendReply (const char *buffer, msgLENGTH size=0, vltLOGICAL last=ccsTRUE)
ccsCOMPL_STAT SendReply (const ccsERROR &error)
void MsgCaller (msgMESSAGE &msg)
const char * MsgCallerName ()
vltLOGICAL InternalCall ()

Protected Member Functions

evhCB_COMPL_STAT CommandCB (msgMESSAGE &msg, void *udata)
virtual vltLOGICAL ExecutionPermitted (msgMESSAGE &msg)
virtual vltLOGICAL IsOwnProcess (msgMESSAGE &msg)
virtual evhCB_COMPL_STAT Execute (msgMESSAGE &msg, void *udata)
msgMESSAGE & MsgCaller ()
void SetActive (vltLOGICAL flag=TRUE)

Private Attributes

msgCMD command
msgMESSAGE orgMsg
evhCALLBACK * userCB
vltLOGICAL cmdActive
vltLOGICAL allowMultiple

Detailed Description

template<class StatePolicy = tcsSTATE>
class tcsCMD_HANDLER_T< StatePolicy >

Definition at line 45 of file tcsCMD_HANDLER.h.

Constructor & Destructor Documentation

template<class StatePolicy >
tcsCMD_HANDLER_T< StatePolicy >::tcsCMD_HANDLER_T ( const dbSYMADDRESS  dbRoot,
const msgCMD  cmdName,
const evhCALLBACK *  cb = NULL,
const vltLOGICAL  allowMultiple = ccsFALSE 
) [inline]

Definition at line 26 of file tcsCMD_HANDLER.icc.

References tcsCMD_HANDLER_T< StatePolicy >::cmdActive, tcsCMD_HANDLER_T< StatePolicy >::command, tcsCMD_HANDLER_T< StatePolicy >::Init(), tcsERR_FATAL, tcsMOD, and tcsCMD_HANDLER_T< StatePolicy >::userCB.

template<class StatePolicy >
tcsCMD_HANDLER_T< StatePolicy >::~tcsCMD_HANDLER_T< StatePolicy > (  )  [inline, virtual]

Member Function Documentation

template<class StatePolicy >
const char * tcsCMD_HANDLER_T< StatePolicy >::CmdName (  )  [inline]

Definition at line 514 of file tcsCMD_HANDLER.icc.

References tcsCMD_HANDLER_T< StatePolicy >::command.

template<class StatePolicy >
evhCB_COMPL_STAT tcsCMD_HANDLER_T< StatePolicy >::CommandCB ( msgMESSAGE &  msg,
void *  udata 
) [inline, protected]

Definition at line 115 of file tcsCMD_HANDLER.icc.

References tcsCMD_HANDLER_T< StatePolicy >::Execute(), tcsCMD_HANDLER_T< StatePolicy >::ExecutionPermitted(), tcsCMD_HANDLER_T< StatePolicy >::MsgCaller(), and tcsCMD_HANDLER_T< StatePolicy >::SetActive().

template<class StatePolicy >
evhCB_COMPL_STAT tcsCMD_HANDLER_T< StatePolicy >::Execute ( msgMESSAGE &  msg,
void *  udata 
) [inline, protected, virtual]

Reimplemented in tcsCMD_TRANSFER.

Definition at line 296 of file tcsCMD_HANDLER.icc.

References tcsCMD_HANDLER_T< StatePolicy >::SendReply(), tcsOK_MSG, and tcsCMD_HANDLER_T< StatePolicy >::userCB.

Referenced by tcsCMD_HANDLER_T< StatePolicy >::CommandCB().

template<class StatePolicy >
vltLOGICAL tcsCMD_HANDLER_T< StatePolicy >::ExecutionPermitted ( msgMESSAGE &  msg  )  [inline, protected, virtual]

Definition at line 189 of file tcsCMD_HANDLER.icc.

References tcsCMD_HANDLER_T< StatePolicy >::allowMultiple, tcsCMD_HANDLER_T< StatePolicy >::IsActive(), tcsCMD_HANDLER_T< StatePolicy >::IsOwnProcess(), tcsCMD_HANDLER_T< StatePolicy >::MsgCaller(), tcsCMD_HANDLER_T< StatePolicy >::MsgCallerName(), tcsCMD_HANDLER_T< StatePolicy >::SetActive(), tcsERR_BUSY, tcsERR_SEND_CMD_HANDLER_REPLY, tcsERR_STATE, and tcsMOD.

Referenced by tcsCMD_HANDLER_T< StatePolicy >::CommandCB().

template<class StatePolicy >
ccsCOMPL_STAT tcsCMD_HANDLER_T< StatePolicy >::Init (  )  [inline, virtual]

Definition at line 79 of file tcsCMD_HANDLER.icc.

References tcsCMD_HANDLER_T< StatePolicy >::Reset().

Referenced by tcsCMD_TRANSFER::Init(), and tcsCMD_HANDLER_T< StatePolicy >::tcsCMD_HANDLER_T().

template<class StatePolicy >
vltLOGICAL tcsCMD_HANDLER_T< StatePolicy >::InternalCall (  )  [inline]

Definition at line 394 of file tcsCMD_HANDLER.icc.

References tcsCMD_HANDLER_T< StatePolicy >::MsgCaller().

template<class StatePolicy >
vltLOGICAL tcsCMD_HANDLER_T< StatePolicy >::IsActive (  )  [inline]

Definition at line 462 of file tcsCMD_HANDLER.icc.

References tcsCMD_HANDLER_T< StatePolicy >::cmdActive.

Referenced by tcsCMD_HANDLER_T< StatePolicy >::ExecutionPermitted(), and tcsCMD_HANDLER_T< StatePolicy >::Reset().

template<class StatePolicy >
vltLOGICAL tcsCMD_HANDLER_T< StatePolicy >::IsOwnProcess ( msgMESSAGE &  msg  )  [inline, protected, virtual]

Definition at line 145 of file tcsCMD_HANDLER.icc.

References tcsERR_READ_PROC_NAME, tcsERR_SEND_CMD_HANDLER_REPLY, tcsMOD, and TRUE.

Referenced by tcsCMD_HANDLER_T< StatePolicy >::ExecutionPermitted().

template<class StatePolicy >
msgMESSAGE & tcsCMD_HANDLER_T< StatePolicy >::MsgCaller (  )  [inline, protected]

Definition at line 488 of file tcsCMD_HANDLER.icc.

References tcsCMD_HANDLER_T< StatePolicy >::orgMsg.

Referenced by tcsCMD_HANDLER_T< StatePolicy >::CommandCB(), tcsCMD_HANDLER_T< StatePolicy >::ExecutionPermitted(), tcsCMD_HANDLER_T< StatePolicy >::InternalCall(), tcsCMD_TRANSFER::Reset(), tcsCMD_HANDLER_T< StatePolicy >::SendReply(), and tcsCMD_TRANSFER::TimeoutCB().

template<class StatePolicy >
void tcsCMD_HANDLER_T< StatePolicy >::MsgCaller ( msgMESSAGE &  msg  )  [inline]

Definition at line 475 of file tcsCMD_HANDLER.icc.

References tcsCMD_HANDLER_T< StatePolicy >::orgMsg.

template<class StatePolicy >
const char * tcsCMD_HANDLER_T< StatePolicy >::MsgCallerName (  )  [inline]

Definition at line 501 of file tcsCMD_HANDLER.icc.

References tcsCMD_HANDLER_T< StatePolicy >::orgMsg.

Referenced by tcsCMD_HANDLER_T< StatePolicy >::ExecutionPermitted(), and tcsCMD_HANDLER_T< StatePolicy >::SendReply().

template<class StatePolicy >
ccsCOMPL_STAT tcsCMD_HANDLER_T< StatePolicy >::Reset (  )  [inline, virtual]

Reimplemented in tcsCMD_TRANSFER.

Definition at line 98 of file tcsCMD_HANDLER.icc.

References tcsCMD_HANDLER_T< StatePolicy >::IsActive(), and tcsCMD_HANDLER_T< StatePolicy >::SetActive().

Referenced by tcsCMD_HANDLER_T< StatePolicy >::Init().

template<class StatePolicy >
ccsCOMPL_STAT tcsCMD_HANDLER_T< StatePolicy >::SendReply ( const ccsERROR &  error  )  [inline]

Definition at line 354 of file tcsCMD_HANDLER.icc.

References tcsCMD_HANDLER_T< StatePolicy >::MsgCaller(), tcsCMD_HANDLER_T< StatePolicy >::MsgCallerName(), tcsCMD_HANDLER_T< StatePolicy >::SetActive(), tcsERR_SEND_CMD_HANDLER_REPLY, and tcsMOD.

template<class StatePolicy >
ccsCOMPL_STAT tcsCMD_HANDLER_T< StatePolicy >::SendReply ( const char *  buffer,
msgLENGTH  size = 0,
vltLOGICAL  last = ccsTRUE 
) [inline]

Definition at line 318 of file tcsCMD_HANDLER.icc.

References tcsCMD_HANDLER_T< StatePolicy >::MsgCaller(), tcsCMD_HANDLER_T< StatePolicy >::MsgCallerName(), tcsCMD_HANDLER_T< StatePolicy >::SetActive(), tcsERR_SEND_CMD_HANDLER_REPLY, and tcsMOD.

Referenced by tcsSELF_CMD::ErrorCB(), tcsCMD_TRANSFER::ErrorCB(), tcsCMD_TRANSFER::Execute(), tcsCMD_HANDLER_T< StatePolicy >::Execute(), tcsCON_SUBSYSTEM::Init(), tcsSELF_CMD::ReplyCB(), tcsCMD_TRANSFER::ReplyCB(), tcsCMD_TRANSFER::Reset(), tcsCON_SUBSYSTEM::StopErrorCB(), tcsCON_SUBSYSTEM::StopReplyCB(), tcsCON_SUBSYSTEM::StopTimeoutCB(), and tcsCMD_TRANSFER::TimeoutCB().

template<class StatePolicy >
void tcsCMD_HANDLER_T< StatePolicy >::SetActive ( vltLOGICAL  flag = TRUE  )  [inline, protected]

Definition at line 414 of file tcsCMD_HANDLER.icc.

References tcsCMD_HANDLER_COUNT::ActiveCount(), tcsCMD_HANDLER_T< StatePolicy >::cmdActive, tcsCMD_HANDLER_COUNT::DecActiveCount(), and tcsCMD_HANDLER_COUNT::IncActiveCount().

Referenced by tcsCMD_HANDLER_T< StatePolicy >::CommandCB(), tcsCMD_HANDLER_T< StatePolicy >::ExecutionPermitted(), tcsCMD_HANDLER_T< StatePolicy >::Reset(), and tcsCMD_HANDLER_T< StatePolicy >::SendReply().

Member Data Documentation

template<class StatePolicy = tcsSTATE>
vltLOGICAL tcsCMD_HANDLER_T< StatePolicy >::allowMultiple [private]

Definition at line 75 of file tcsCMD_HANDLER.h.

Referenced by tcsCMD_HANDLER_T< StatePolicy >::ExecutionPermitted().

template<class StatePolicy = tcsSTATE>
vltLOGICAL tcsCMD_HANDLER_T< StatePolicy >::cmdActive [private]

Definition at line 74 of file tcsCMD_HANDLER.h.

Referenced by tcsCMD_HANDLER_T< StatePolicy >::IsActive(), tcsCMD_HANDLER_T< StatePolicy >::SetActive(), and tcsCMD_HANDLER_T< StatePolicy >::tcsCMD_HANDLER_T().

template<class StatePolicy = tcsSTATE>
msgCMD tcsCMD_HANDLER_T< StatePolicy >::command [private]

Reimplemented in tcsCMD_TRANSFER.

Definition at line 71 of file tcsCMD_HANDLER.h.

Referenced by tcsCMD_HANDLER_T< StatePolicy >::CmdName(), and tcsCMD_HANDLER_T< StatePolicy >::tcsCMD_HANDLER_T().

template<class StatePolicy = tcsSTATE>
msgMESSAGE tcsCMD_HANDLER_T< StatePolicy >::orgMsg [private]

Definition at line 72 of file tcsCMD_HANDLER.h.

Referenced by tcsCMD_HANDLER_T< StatePolicy >::MsgCaller(), and tcsCMD_HANDLER_T< StatePolicy >::MsgCallerName().

template<class StatePolicy = tcsSTATE>
evhCALLBACK* tcsCMD_HANDLER_T< StatePolicy >::userCB [private]

Definition at line 73 of file tcsCMD_HANDLER.h.

Referenced by tcsCMD_HANDLER_T< StatePolicy >::Execute(), and tcsCMD_HANDLER_T< StatePolicy >::tcsCMD_HANDLER_T().

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