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

Class to encapsulate messages send to the Rx task. More...

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

Inheritance diagram for sza::antenna::control::AntennaRxMsg:
sza::util::GenericTaskMsg

Public Types

enum  MsgType {
  FLAG_BOARD, FREQ, LO, OFFSET,
  TOTALPOWER, SET_INPUT_VOLTAGE, SET_DRAIN_CURRENT, TOGGLE_FAST_SAMPLING,
  CALTERT, INTMOD, SET_BIAS, IFMOD,
  THERMAL, TILTMETER, SELECT_RX, RESET,
  EXECUTE_NEXT_CAN_INSTRUCTION
}
 Enumerate supported AntennaRx messages. 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

void packCalTertMsg (sza::array::CalTertMsg msgId, sza::util::Rx::Id rxId, short tertPosition, sza::util::CalPos::Pos calPosition, bool enable, sza::util::CalTertTypes::OwDevice device, sza::util::CalTertTypes::OwCommand command, unsigned long seq)
 
void packExecuteNextCanInstructionMsg (MsgType commandType)
 
void packFlagBoardMsg (unsigned short board, bool flag)
 
void packIFModMsg (sza::array::IFModMsg msgId, sza::util::Rx::Id band, float level, sza::util::IFAtten::Type attenSet, float total, float input, float output, unsigned seq, sza::util::CalPos::Pos pos)
 
void packIntModMsg (sza::array::IntModMsg msgId, unsigned char atten=0)
 
void packLoMsg (sza::array::LoMsgId msgId, sza::util::LoOsc::Osc oscs, sza::util::LoStage::Stage stages, sza::util::Rx::Id rxId, bool on, unsigned short dampGain, unsigned short frequency, unsigned short loopGain, unsigned short voltage, unsigned char id, unsigned char day, unsigned char month, unsigned char year, unsigned char npt, float coeff, int tunerPos, int backshortPos, int attenPos, int position)
 
void packNewCalTertMsg (sza::array::CalTertMsg msgId, sza::util::CalPos::Pos calPosition, sza::util::Rx::Id rxId, double tertPosDegrees, unsigned long seq)
 
void packOffsetMsg (double az, double el)
 
void packResetMsg (sza::util::CanModule::Id modules, bool hard)
 
void packSelectRxMsg (sza::util::Rx::Id rxBand, unsigned seq)
 
void packSetBiasMsg (unsigned amp, short bias, sza::array::BiasType biasType, sza::util::Rx::Id rxId, unsigned seq, bool isDefault)
 
void packSetDrainCurrentMsg (sza::util::Rx::Id rx, sza::util::Amp::Type amp, sza::util::Amp::Stage stage, float current)
 
void packSetInputVoltageMsg (sza::util::Rx::Id rx, sza::util::Amp::Type amp, sza::util::Amp::Stage stage, sza::util::Amp::Bias biasType, short bias)
 
void packThermalMsg (sza::array::ThermalMsg msgId, sza::util::Thermal::Target target, float value, sza::util::Thermal::BoxMode mode, bool eqState)
 
void packTiltmeterMsg (sza::array::TiltmeterMsg msgId, sza::array::TiltmeterMode mode, float value, float afZero=0.0, float lrZero=0.0)
 
void packToggleFastSamplingMsg (unsigned int channel, bool start)
 
- 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 {
      sza::util::CalPos::Pos   calPosition
 
      bool   enable
 
      sza::array::CalTertMsg   msgId
 
      sza::util::CalTertTypes::OwCommand   owCommand
 
      sza::util::CalTertTypes::OwDevice   owDevice
 
      sza::util::Rx::Id   rxId
 
      unsigned long   seq
 
      double   tertPosDegrees
 
      short   tertPosition
 
   }   calTert
 

Control the Calibrator/Tertiary CAN module More...

 
   struct {
      MsgType   type
 
   }   canCommand
 
   struct {
      sza::util::Amp::Type   amp
 
      float   current
 
      sza::util::Rx::Id   rx
 
      sza::util::Amp::Stage   stage
 
   }   drainCurrent
 

Set a drain current More...

 
   struct {
      unsigned int   channel
 
      bool   start
 
   }   fastSampling
 

Toggle fast sampling More...

 
   struct {
      unsigned short   board
 
      bool   flag
 
   }   flagBoard
 

Flag a board. More...

 
   struct {
      sza::util::IFAtten::Type   attenSet
 
      sza::util::Rx::Id   band
 
      float   input
 
      float   level
 
      sza::array::IFModMsg   msgId
 
      float   output
 
      sza::util::CalPos::Pos   pos
 
      unsigned   seq
 
      float   total
 
   }   IFMod
 

Control the Antenna IF module More...

 
   struct {
      sza::util::Amp::Type   amp
 
      short   bias
 
      sza::util::Amp::Bias   biasType
 
      sza::util::Rx::Id   rx
 
      sza::util::Amp::Stage   stage
 
   }   inputVoltage
 

Set a input voltage More...

 
   struct {
      unsigned char   atten
 
      sza::array::IntModMsg   msgId
 
   }   intMod
 

Control the Berkeley interface module More...

 
   struct {
      int   attenPos
 
      int   backshortPos
 
      float   coeff
 
      unsigned short   dampGain
 
      unsigned char   day
 
      unsigned short   frequency
 
      unsigned char   id
 
      unsigned short   loopGain
 
      unsigned char   month
 
      sza::array::LoMsgId   msgId
 
      unsigned char   npt
 
      bool   on
 
      sza::util::LoOsc::Osc   oscs
 
      int   position
 
      sza::util::Rx::Id   rxId
 
      sza::util::LoStage::Stage   stages
 
      int   tunerPos
 
      unsigned short   voltage
 
      unsigned char   year
 
   }   lo
 

Control the LO chain More...

 
   struct {
      double   az
 
      double   el
 
   }   offset
 

Install offsets needed to bring this receiver on-axis More...

 
   struct {
      bool   hardwareReset
 
      sza::util::CanModule::Id   modules
 
   }   reset
 
   struct {
      sza::util::Rx::Id   rxBand
 
      unsigned   seq
 
   }   selectRx
 
   struct {
      unsigned   amp
 
      short   bias
 
      sza::array::BiasType   biasType
 
      bool   isDefault
 
      sza::util::Rx::Id   rxId
 
      unsigned   seq
 
   }   setBias
 

Set a bias More...

 
   struct {
      bool   eqState
 
      sza::util::Thermal::BoxMode   mode
 
      sza::array::ThermalMsg   msgId
 
      sza::util::Thermal::Target   target
 
      float   value
 
   }   thermal
 

Control the Thermal Module More...

 
   struct {
      float   afZero
 
      float   lrZero
 
      sza::array::TiltmeterMode   mode
 
      sza::array::TiltmeterMsg   msgId
 
      float   value
 
   }   tiltmeter
 

Control the Tiltmeter Module More...

 
body
 Define a Message container. More...
 
MsgType type
 The type of this message. More...
 
- Public Attributes inherited from sza::util::GenericTaskMsg
unsigned long carmaSeqNo_
 
CarmaSeqNoType carmaSeqNoType_
 
GenericMsgType genericMsgType_
 A type for this message. More...
 

Friends

std::ostream & operator<< (std::ostream &os, AntennaRxMsg *msg)
 Allows cout << AntennaRxMsg. More...
 

Detailed Description

Class to encapsulate messages send to the Rx task.

Definition at line 40 of file AntennaRxMsg.h.

Member Enumeration Documentation

Enumerate supported AntennaRx messages.

Definition at line 48 of file AntennaRxMsg.h.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os,
AntennaRxMsg msg 
)
friend

Allows cout << AntennaRxMsg.

Member Data Documentation

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

Define a Message container.

struct { ... } sza::antenna::control::AntennaRxMsg::calTert


Control the Calibrator/Tertiary CAN module

struct { ... } sza::antenna::control::AntennaRxMsg::drainCurrent


Set a drain current

struct { ... } sza::antenna::control::AntennaRxMsg::fastSampling


Toggle fast sampling

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


Flag a board.

struct { ... } sza::antenna::control::AntennaRxMsg::IFMod


Control the Antenna IF module

struct { ... } sza::antenna::control::AntennaRxMsg::inputVoltage


Set a input voltage

struct { ... } sza::antenna::control::AntennaRxMsg::intMod


Control the Berkeley interface module

struct { ... } sza::antenna::control::AntennaRxMsg::lo


Control the LO chain

struct { ... } sza::antenna::control::AntennaRxMsg::offset


Install offsets needed to bring this receiver on-axis

struct { ... } sza::antenna::control::AntennaRxMsg::setBias


Set a bias

struct { ... } sza::antenna::control::AntennaRxMsg::thermal


Control the Thermal Module

struct { ... } sza::antenna::control::AntennaRxMsg::tiltmeter


Control the Tiltmeter Module

MsgType sza::antenna::control::AntennaRxMsg::type

The type of this message.

Definition at line 71 of file AntennaRxMsg.h.


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