CARMA C++
Public Types | Public Member Functions | Public Attributes | List of all members
sza::util::GenericTaskMsg Class Reference

A class to encapsulate message types for a generic task. More...

#include <carma/szautil/GenericTaskMsg.h>

Inheritance diagram for sza::util::GenericTaskMsg:
sza::antenna::control::AntennaDriveMsg sza::antenna::control::AntennaMonitorMsg sza::antenna::control::AntennaRxMsg sza::util::GenericMasterTaskMsg sza::antenna::control::AntennaMasterMsg

Public Types

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 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

unsigned long carmaSeqNo_
 
CarmaSeqNoType carmaSeqNoType_
 
GenericMsgType genericMsgType_
 A type for this message. More...
 

Detailed Description

A class to encapsulate message types for a generic task.

Classes which extend from this class should simply add whatever members are required to process additional task-specific messages, for instance a union of task-specific messages.

NB: There is no explicit constructor for this class, since the compiler won't allow classes with constructors to be included as members of unions. This means that we cannot construct unions using objects which inherit from GenericTaskMsg unless they also don't have constructors.

Definition at line 31 of file GenericTaskMsg.h.

Member Enumeration Documentation

enum sza::util::GenericTaskMsg::GenericMsgType

Enumerate supported generic message types.

Definition at line 38 of file GenericTaskMsg.h.

Member Data Documentation

GenericMsgType sza::util::GenericTaskMsg::genericMsgType_

A type for this message.

Definition at line 50 of file GenericTaskMsg.h.

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