A class for encapsulating devices for the SZA which will be attached to a CAN bus.
More...
|
| CanDevice (sza::antenna::control::SzaShare *share, std::string boardName, carma::canbus::apiType api, carma::canbus::nodeType node, carma::canbus::CanOutput &io) |
| Constructor. More...
|
|
virtual void | enableMonitorPackets (bool timeStampEnable, bool blankingFrameEnable, bool slowMonitorEnable) |
| Enable/Disable monitor packets. More...
|
|
CanMonitorPoint * | findMonitorPoint (char *name) |
|
void | postMessage (carma::canbus::Message msg) |
| Post a fully constructed message to this device. More...
|
|
std::vector
< carma::canbus::Message > | sendDummyMsg (bool send) |
|
virtual void | sendTimeStamp () |
| Send the current mjd. More...
|
|
virtual void | setRxId (sza::util::Rx::Id rxId) |
|
virtual | ~CanDevice () |
| Destructor. More...
|
|
carma::canbus::Message | createDummyMsg () const |
| Create a dummy CAN message. More...
|
|
carma::canbus::Message | createMsgToAllNodes (msgType messageId) const |
| Create a CAN message addressed to all nodes of this type. More...
|
|
carma::canbus::Message | createMsgToHost (msgType messageId) const |
| Create a CAN message addressed from this Device to the host. More...
|
|
carma::canbus::Message | createMsgToNode (msgType messageId) const |
| Create a CAN message addressed to this device from the host. More...
|
|
| Device (apiType api, nodeType node, CanOutput &io) |
| Device constructor. More...
|
|
apiType | getApi () const |
| Return api code of device. More...
|
|
char | getApiVersion () const |
| Get API Version of this Device. More...
|
|
boardType | getBoardType () const |
| Return board type id of device. More...
|
|
busIdType | getBusId () const |
| Return bus Id that node resides on. More...
|
|
virtual MsgIdInfoMap | getControls () const |
| Return a map of devices controls. More...
|
|
keyType | getKey () const |
| Create a key unique to this api and node. More...
|
|
double | getLastRxTime () const |
| Get Last RX Time for device. More...
|
|
unsigned int | getNlatePackets () const |
| Get number of late packets. More...
|
|
nodeType | getNode () const |
| Return node location code of device. More...
|
|
serialNumberType | getSerialNumber () const |
| Return serial number of device. More...
|
|
deviceStateType | getState () const |
| Status access routine. More...
|
|
void | reset () |
| Perform a software reset of module. More...
|
|
void | setBoardType (boardType bt) |
| Set board type of device. More...
|
|
void | setBusId (busIdType busId) |
| Set busId of device. More...
|
|
virtual void | setLastRxTime (double rxMjd) |
| Set latest rx time. More...
|
|
void | setSerialNumber (serialNumberType sn) |
| Set serial number of device. More...
|
|
virtual void | setState (deviceStateType state) |
| Set state of device. More...
|
|
void | startChannelOneFastSampling (unsigned short fastItem) |
| Start fast sampling the specified data item on channel 1. More...
|
|
void | startChannelTwoFastSampling (unsigned short fastItem) |
| Start fast sampling the specified data item on channel 2. More...
|
|
void | stopChannelOneFastSampling () |
| Stop fast sampling on channel 1 This routine will stop fast sampling on channel 1 regardless of whether this node is fast sampling the channel or not! In other words the request goes out globally. More...
|
|
void | stopChannelTwoFastSampling () |
| Stop fast sampling on channel 2 This routine will stop fast sampling on channel 2 regardless of whether this node is fast sampling the channel or not! In other words the request goes out globally. More...
|
|
virtual void | updateFrameData () |
| Update device or monitor data on frame timescale... More...
|
|
virtual | ~Device () |
| Device destructor. More...
|
|
| Board (SzaShare *share, std::string name) |
| Constructor looks up a board by name and stores a pointer to it in private member board_ (below). More...
|
|
| Board (SzaShare *share, sza::util::AntNum ant) |
| Constructor looks up the rx board corresponding to the requested antenna and stores a pointer to it in private member board_ (below) More...
|
|
| Board (SzaShare *share) |
| Constructor for a virtual board. More...
|
|
RegMapBlock * | findReg (char *name) |
| Return a pointer to a register of the board managed by this object. More...
|
|
int | getIndex () |
| Public function to return the index of this board in the register database. More...
|
|
bool | isReachable () |
| Verify that this board is reachable. More...
|
|
virtual void | readReg (RegMapBlock *blk, unsigned int first, unsigned int nreg, unsigned int *value) |
| Method to read a register from this board. More...
|
|
virtual void | reset () |
| Function to reset private members of a board-management object. More...
|
|
virtual void | writeReg (RegMapBlock *blk, unsigned int first, unsigned int nreg, unsigned int *value) |
| Methods to write to a register of this board. More...
|
|
virtual void | writeReg (RegMapBlock *blk, unsigned int first, unsigned int nreg, bool *value) |
| Methods to write to a register of this board. More...
|
|
virtual | ~Board () |
| Declaration of destructor as pure virtual prevents instantiation of this base class. More...
|
|
|
virtual void | clearErrorLog () |
| Clear the error log. More...
|
|
virtual std::string | controlPrefix () |
| Return an inheritor-specific prefix to use when constructing monitor points. More...
|
|
carma::canbus::idType | createDummyId () |
|
carma::canbus::idType | createEngId (bool host, carma::canbus::msgType mid) |
| Return a CAN message ID constructed from the api, node and command ID. More...
|
|
carma::canbus::idType | createId (bool host, carma::canbus::msgType mid) |
| Return a CAN message ID constructed from the api, node and command ID. More...
|
|
carma::canbus::Message | dummyMessage () |
|
carma::canbus::busIdType | getBusId () |
| Return a CAN bus ID suitable for passing to Message constructor. More...
|
|
std::map
< carma::canbus::msgType,
std::string > | getCommonControls () |
| A map of controls common to all devices. More...
|
|
std::map
< carma::canbus::msgType,
std::string > | getControls () |
| Return a map of device controls. More...
|
|
virtual std::map
< carma::canbus::msgType,
std::string > | getEngineeringMonitors () const |
| Return a map of engineering monitor points. More...
|
|
virtual std::map
< carma::canbus::msgType,
std::string > | getHalfSecMonitors () const |
| Return a map of devices half second monitor points. More...
|
|
virtual std::map
< carma::canbus::msgType,
std::string > | getSlowMonitors () const |
| Return a map of slow monitor points. More...
|
|
virtual std::map
< carma::canbus::msgType,
std::string > | getSpecificControls () const |
| Get module-specific controls. More...
|
|
virtual std::map
< carma::canbus::msgType,
std::string > | getStatusMessages () const |
| Return a map of status messages. More...
|
|
carma::canbus::Message | hostMessage (carma::canbus::msgType mid, std::vector< carma::canbus::byteType > &data) |
| Get an initialized host message. More...
|
|
carma::canbus::Message | hostMessage (carma::canbus::msgType mid) |
| Get an initialized host message with no intrinsic payload. More...
|
|
unsigned | idOfBlankingFrameMonitorMsgType (carma::canbus::msgType mid) |
| Return a standard enumerator for monitor packets. More...
|
|
unsigned | idOfStatusMessageMsgType (carma::canbus::msgType mid) |
| ...................................................................... More...
|
|
void | initRegs () |
| Init registers common to all CAN devices. More...
|
|
void | installHandler (carma::canbus::msgType mid, void(*handler)(void *arg1, unsigned arg2), void *arg1, unsigned arg2) |
|
bool | isBlankingFrameMonitor (carma::canbus::msgType mid) |
| Return true if this is a valid blanking frame monitor packet. More...
|
|
bool | isEngineeringMonitor (carma::canbus::msgType mid) |
| Return true if this is a valid Engineering packet. More...
|
|
bool | isSlowMonitor (carma::canbus::msgType mid) |
| Return true if this is a slow monitor packet. More...
|
|
bool | isStatusMessage (carma::canbus::msgType mid) |
| Return true if this is a valid status message for this device. More...
|
|
std::string | monthDayYearToString (unsigned int month, unsigned int day, unsigned year) |
|
carma::canbus::msgType | msgTypeOfBlankingFrameMonitorId (unsigned int id) |
| Return the message id corresponding to a standard enumerator. More...
|
|
carma::canbus::Message | nodeEngMessage (carma::canbus::msgType mid, std::vector< carma::canbus::byteType > &data) |
| Get an initialized engineering node message. More...
|
|
carma::canbus::Message | nodeMessage (carma::canbus::msgType mid, std::vector< carma::canbus::byteType > &data) |
| Get an initialized node message. More...
|
|
carma::canbus::Message | nodeMessage (carma::canbus::msgType mid) |
| Get an initialized node message with no intrinsic payload. More...
|
|
void | postDummyMessage () |
|
void | postEngMessage (carma::canbus::msgType mid, std::vector< carma::canbus::byteType > &data) |
| Post a message for this device. More...
|
|
void | postMessage (carma::canbus::msgType mid, std::vector< carma::canbus::byteType > &data) |
| Post a message for this device. More...
|
|
void | postMessage (carma::canbus::msgType mid) |
| Post a message with no intrinsic payload. More...
|
|
virtual void | processBlankingFrameMonitor (carma::canbus::msgType mid, std::vector< carma::canbus::byteType > &data, bool isSim) |
| Process a blanking frame monitor packet. More...
|
|
virtual void | processBlankingFrameMonitor1 (std::vector< carma::canbus::byteType > &data, bool isSim) |
| Stubs for processing up to 10 monitor packets. More...
|
|
virtual void | processBlankingFrameMonitor10 (std::vector< carma::canbus::byteType > &data, bool isSim) |
|
virtual void | processBlankingFrameMonitor11 (std::vector< carma::canbus::byteType > &data, bool isSim) |
|
virtual void | processBlankingFrameMonitor2 (std::vector< carma::canbus::byteType > &data, bool isSim) |
|
virtual void | processBlankingFrameMonitor3 (std::vector< carma::canbus::byteType > &data, bool isSim) |
|
virtual void | processBlankingFrameMonitor4 (std::vector< carma::canbus::byteType > &data, bool isSim) |
|
virtual void | processBlankingFrameMonitor5 (std::vector< carma::canbus::byteType > &data, bool isSim) |
|
virtual void | processBlankingFrameMonitor6 (std::vector< carma::canbus::byteType > &data, bool isSim) |
|
virtual void | processBlankingFrameMonitor7 (std::vector< carma::canbus::byteType > &data, bool isSim) |
|
virtual void | processBlankingFrameMonitor8 (std::vector< carma::canbus::byteType > &data, bool isSim) |
|
virtual void | processBlankingFrameMonitor9 (std::vector< carma::canbus::byteType > &data, bool isSim) |
|
virtual void | processEngineeringMonitor (carma::canbus::msgType mid, std::vector< carma::canbus::byteType > &data, bool isSim) |
| Process an engineering monitor packet. More...
|
|
virtual void | processEngineeringMonitor1 (std::vector< carma::canbus::byteType > &data, bool isSim) |
|
virtual void | processEngineeringMonitor2 (std::vector< carma::canbus::byteType > &data, bool isSim) |
|
virtual void | processEngineeringMonitor3 (std::vector< carma::canbus::byteType > &data, bool isSim) |
|
virtual void | processEngineeringMonitor4 (std::vector< carma::canbus::byteType > &data, bool isSim) |
|
virtual void | processGenericStatusMessage (bool isSim) |
|
virtual void | processMsg (carma::canbus::msgType messageId, std::vector< carma::canbus::byteType > &data, bool isSim) |
| Process a message for this device. More...
|
|
virtual void | processSlowMonitor (carma::canbus::msgType mid, std::vector< carma::canbus::byteType > &data, bool isSim) |
| Process a slow monitor packet. More...
|
|
virtual void | processSlowMonitor1 (std::vector< carma::canbus::byteType > &data, bool isSim) |
| Process the first slow monitor packet. More...
|
|
virtual void | processSlowMonitor2 (std::vector< carma::canbus::byteType > &data, bool isSim) |
| Process the second slow monitor packet. More...
|
|
virtual void | processSlowMonitor3 (std::vector< carma::canbus::byteType > &data, bool isSim) |
| Process the third slow monitor packet. More...
|
|
virtual void | processSlowMonitor4 (std::vector< carma::canbus::byteType > &data, bool isSim) |
| Process the fourth slow monitor packet. More...
|
|
virtual void | processSlowMonitor5 (std::vector< carma::canbus::byteType > &data, bool isSim) |
| Process the fifth slow monitor packet. More...
|
|
virtual void | processStatusMessage (carma::canbus::msgType mid, bool isSim) |
| Process an status message. More...
|
|
virtual void | processStatusMessage1 (bool isSim) |
|
virtual void | processStatusMessage2 (bool isSim) |
|
virtual void | processStatusMessage3 (bool isSim) |
|
void | registerReceived (unsigned id, bool isSim) |
| Register receipt of this monitor packet. More...
|
|
virtual void | requestId () |
| Request the module ID. More...
|
|
virtual void | retrieveErrorLogEntry (unsigned short recordNo) |
| Retrieve a numbered error log entry. More...
|
|
virtual void | sendAsciiString (std::string sendStr) |
| Send a std::string of up to 8 characters to the CAN node. More...
|
|
virtual carma::canbus::Message | simulateBlankingFrameMonitor (carma::canbus::msgType mid) |
| Simulate blanking frame monitor packets. More...
|
|
virtual carma::canbus::Message | simulateBlankingFrameMonitor1 () |
|
virtual carma::canbus::Message | simulateBlankingFrameMonitor10 () |
|
virtual carma::canbus::Message | simulateBlankingFrameMonitor11 () |
|
virtual carma::canbus::Message | simulateBlankingFrameMonitor2 () |
|
virtual carma::canbus::Message | simulateBlankingFrameMonitor3 () |
|
virtual carma::canbus::Message | simulateBlankingFrameMonitor4 () |
|
virtual carma::canbus::Message | simulateBlankingFrameMonitor5 () |
|
virtual carma::canbus::Message | simulateBlankingFrameMonitor6 () |
|
virtual carma::canbus::Message | simulateBlankingFrameMonitor7 () |
|
virtual carma::canbus::Message | simulateBlankingFrameMonitor8 () |
|
virtual carma::canbus::Message | simulateBlankingFrameMonitor9 () |
|
virtual carma::canbus::Message | simulateGenericBlankingFrameMonitor (carma::canbus::msgType mid) |
| Simulate a generic monitor packet. More...
|
|
virtual carma::canbus::Message | simulateMsg (carma::canbus::msgType mid) |
| Simulate messages to this device. More...
|
|
void | skipByte (std::vector< carma::canbus::byteType > &data, unsigned short nByte) |
| Skip a number of bytes in the data array. More...
|
|
virtual void | startDownLoad () |
| Start downloading a new program. More...
|
|
void | incrementLatePacketCount () |
| Increment the late packet count by 1. More...
|
|
bool | isPacketLate (double window=100.0) |
| Determine if the last packet sent from this device was late. More...
|
|
void | resetLatePacketCount () |
| Reset the late packet count to 0. More...
|
|
void | setApiVersion (char api) |
| Set API Version. More...
|
|
A class for encapsulating devices for the SZA which will be attached to a CAN bus.
CanDevice inherits the public interface of Device and the protected members of Board (SzaShare* share_ and RegMapBoard* board_)
Definition at line 56 of file CanDevice.h.