CARMA C++
sza::antenna::control::AntennaMasterMsg Class Reference

A class to manage messages used to communicate with an AntennaMaster thread. More...

#include <carma/antenna/sza/antenna/control/AntennaMasterMsg.h>

Inheritance diagram for sza::antenna::control::AntennaMasterMsg:
sza::util::GenericMasterTaskMsg sza::util::GenericTaskMsg

Public Types

enum  MsgType {
  ADOPT_BOARD, CONTROL_MSG, CONTROL_CONNECTED, DRIVE_MSG,
  FLAG_BOARD, SCANNER_CONNECTED, MONITOR_MSG, PMAC_CONNECTED,
  RX_MSG, STRIP_CONTROL_MSG, SEND_HEARTBEAT
}
 Enumerate supported AntennaMaster messages. More...
 
- Public Types inherited from sza::util::GenericMasterTaskMsg
enum  GenericMasterMsgType {
  ADD_HANDLER = GenericTaskMsg::LAST+1, ENABLE_TIMER, INSTALL_TIMER, INSTALL_SIGNAL,
  TASK_SPECIFIC
}
 Enumerate supported generic message types. More...
 
- Public Types inherited from sza::util::GenericTaskMsg
enum  CarmaSeqNoType {
  NONE, DRIVE, RX, CAL,
  OPTICS, OPTICALTEL
}
 
enum  GenericMsgType {
  HEARTBEAT, STOP, RESTART, TASK_SPECIFIC,
  LAST
}
 Enumerate supported generic message types. More...
 

Public Member Functions

AntennaControlMsg * getControlMsg ()
 
AntennaDriveMsggetDriveMsg ()
 
AntennaMonitorMsggetMonitorMsg ()
 
AntennaRxMsggetRxMsg ()
 
UmacControlMsg * getUmacControlMsg ()
 
void packAdoptBoardMsg (unsigned short board, AntennaTask::Id taskId)
 ............................................................ More...
 
void packControlConnectedMsg (bool connected)
 
void packFlagBoardMsg (unsigned short board, bool flag)
 
void packPmacConnectedMsg (bool connected)
 
void packScannerConnectedMsg (bool connected)
 
void packSendHeartBeatMsg ()
 ............................................................ More...
 
- Public Member Functions inherited from sza::util::GenericMasterTaskMsg
void packAddHandlerMsg (std::string name, void(*handler)(int sigNo, void *args), bool add)
 Pack a message to enable/disable a timer. More...
 
void packEnableTimerMsg (std::string name, bool enable)
 Pack a message to enable/disable a timer. More...
 
void packInstallSignalMsg (int sigNo, void(*handler)(int sigNo, void *args))
 Pack a message to install a signal. More...
 
void packInstallTimerMsg (std::string name, int sigNo, unsigned long initSec, unsigned long initNsec, unsigned long intervalSec, unsigned long intervalNsec, void(*handler)(int sigNo, void *args))
 Pack a message to install a timer. More...
 
void packInstallTimerMsg (std::string name, int sigNo, unsigned long intervalSec, unsigned long intervalNsec, void(*handler)(int sigNo, void *args))
 Pack a message to install a timer. More...
 
- Public Member Functions inherited from sza::util::GenericTaskMsg
void setCarmaCalSequenceNumber (unsigned long seq)
 
void setCarmaDriveSequenceNumber (unsigned long seq)
 
void setCarmaOpticsSequenceNumber (unsigned long seq)
 
void setCarmaRxSequenceNumber (unsigned long seq)
 
void setCarmaSequenceNumber (unsigned long seq=0, CarmaSeqNoType type=NONE)
 

Public Attributes

union {
   struct {
      unsigned short   board
 
      AntennaTask::Id   taskId
 
   }   adoptBoard
 Specify which task is responsible for flagging a board. More...
 
   struct {
      bool   connected
 
   }   controlConnected
 A message that the control task is dis/connected from the control host. More...
 
   AntennaControlMsg   controlMsg
 A message for the AntennaControl task. More...
 
   AntennaDriveMsg   driveMsg
 A message for the AntennaDrive task. More...
 
   struct {
      unsigned short   board
 
      bool   flag
 
   }   flagBoard
 Message to flag a board. More...
 
   AntennaMonitorMsg   monitorMsg
 A message for the AntennaMonitor task. More...
 
   struct {
      bool   connected
 
   }   pmacConnected
 A message that the pmac is dis/connected. More...
 
   AntennaRxMsg   rxMsg
 A message for the AntennaRx task. More...
 
   struct {
      bool   connected
 
   }   scannerConnected
 A message that the scanner is dis/connected from the archiver host. More...
 
   UmacControlMsg   umacControlMsg
 A message for the UmacControl task. More...
 
body
 A union of supported messages. More...
 
MsgType type
 The type of this message. More...
 
- Public Attributes inherited from sza::util::GenericMasterTaskMsg
union {
   struct {
      bool   add
 
      void *   args
 
      void(*   handler )(int sigNo, void *args)
 
      char   name [10+1]
 
   }   addHandler
 
   struct {
      bool   enable
 
      char   name [10+1]
 
   }   enableTimer
 
   struct {
      void *   args
 
      void(*   handler )(int sigNo, void *args)
 
      int   sigNo
 
   }   installSignal
 
   struct {
      void(*   handler )(int sigNo, void *args)
 
      unsigned long   initNsec
 
      unsigned long   initSec
 
      unsigned long   intervalNsec
 
      unsigned long   intervalSec
 
      char   name [10+1]
 
      int   sigNo
 
   }   installTimer
 
genericMasterBody
 A message body. More...
 
- Public Attributes inherited from sza::util::GenericTaskMsg
unsigned long carmaSeqNo_
 
CarmaSeqNoType carmaSeqNoType_
 
GenericMsgType genericMsgType_
 A type for this message. More...
 

Detailed Description

A class to manage messages used to communicate with an AntennaMaster thread.

Definition at line 31 of file AntennaMasterMsg.h.

Member Enumeration Documentation

Enumerate supported AntennaMaster messages.

Definition at line 39 of file AntennaMasterMsg.h.

Member Function Documentation

void sza::antenna::control::AntennaMasterMsg::packAdoptBoardMsg ( unsigned short  board,
AntennaTask::Id  taskId 
)

............................................................

Pack a message to adopt flagging operations for a board.

Definition at line 201 of file AntennaMasterMsg.h.

void sza::antenna::control::AntennaMasterMsg::packSendHeartBeatMsg ( )

............................................................

Pack a message to send a heartbeat.

Definition at line 190 of file AntennaMasterMsg.h.

Member Data Documentation

struct { ... } sza::antenna::control::AntennaMasterMsg::adoptBoard

Specify which task is responsible for flagging a board.

union { ... } sza::antenna::control::AntennaMasterMsg::body

A union of supported messages.

struct { ... } sza::antenna::control::AntennaMasterMsg::controlConnected

A message that the control task is dis/connected from the control host.

AntennaControlMsg sza::antenna::control::AntennaMasterMsg::controlMsg

A message for the AntennaControl task.

Definition at line 110 of file AntennaMasterMsg.h.

AntennaDriveMsg sza::antenna::control::AntennaMasterMsg::driveMsg

A message for the AntennaDrive task.

Definition at line 115 of file AntennaMasterMsg.h.

struct { ... } sza::antenna::control::AntennaMasterMsg::flagBoard

Message to flag a board.

AntennaMonitorMsg sza::antenna::control::AntennaMasterMsg::monitorMsg

A message for the AntennaMonitor task.

Definition at line 120 of file AntennaMasterMsg.h.

struct { ... } sza::antenna::control::AntennaMasterMsg::pmacConnected

A message that the pmac is dis/connected.

AntennaRxMsg sza::antenna::control::AntennaMasterMsg::rxMsg

A message for the AntennaRx task.

Definition at line 125 of file AntennaMasterMsg.h.

struct { ... } sza::antenna::control::AntennaMasterMsg::scannerConnected

A message that the scanner is dis/connected from the archiver host.

MsgType sza::antenna::control::AntennaMasterMsg::type

The type of this message.

Definition at line 57 of file AntennaMasterMsg.h.

UmacControlMsg sza::antenna::control::AntennaMasterMsg::umacControlMsg

A message for the UmacControl task.

Definition at line 130 of file AntennaMasterMsg.h.


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