cisst-saw
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
mtsCANBusFrame Class Reference

#include <mtsCANBusFrame.h>

Inheritance diagram for mtsCANBusFrame:
mtsGenericObject osaCANBusFrame cmnGenericObject

Public Member Functions

 mtsCANBusFrame ()
 Create an empty CAN frame. More...
 
 mtsCANBusFrame (const osaCANBusFrame &frame)
 Create a mtsCANBusFrame from a osaCANBusFrame. More...
 
 mtsCANBusFrame (ID canid, DataField data, DataLength nbytes)
 Create a mtsCANBusFrame from a CAN id and data field. More...
 
 mtsCANBusFrame (ID canid, const vctDynamicVector< osaCANBusFrame::Data > &data)
 Create a mtsCANBusFrame from a vctVector. More...
 
- Public Member Functions inherited from mtsGenericObject
 mtsGenericObject (void)
 
 mtsGenericObject (double timestamp, bool automaticTimestamp, bool valid)
 
 mtsGenericObject (const mtsGenericObject &other)
 
virtual ~mtsGenericObject (void)
 
bool SetTimestampIfAutomatic (double timestamp)
 
virtual void ToStream (std::ostream &outputStream) const
 
virtual void ToStreamRaw (std::ostream &outputStream, const char delimiter= ' ', bool headerOnly=false, const std::string &headerPrefix="") const
 
virtual bool FromStreamRaw (std::istream &inputStream, const char delimiter= ' ')
 
virtual void SerializeRaw (std::ostream &outputStream) const
 
virtual void DeSerializeRaw (std::istream &inputStream)
 
size_t ScalarNumber (void) const
 
bool ScalarNumberIsFixed (void) const
 
double Scalar (const size_t index) const throw (std::out_of_range)
 
std::string ScalarDescription (const size_t index, const std::string &userDescription="") const throw (std::out_of_range)
 
- Public Member Functions inherited from cmnGenericObject
virtual ~cmnGenericObject (void)
 
virtual const
cmnClassServicesBase
Services (void) const =0
 
bool ReconstructFrom (const cmnGenericObject &other)
 
std::string ToString (void) const
 
virtual cmnLogger::StreamBufTypeGetLogMultiplexer (void) const
 
virtual double Scalar (const size_t CMN_UNUSED(index)) const throw (std::out_of_range)
 
virtual std::string ScalarDescription (const size_t CMN_UNUSED(index), const std::string &CMN_UNUSED(userDescription)) const
 
- Public Member Functions inherited from osaCANBusFrame
 osaCANBusFrame ()
 Default constructor. More...
 
 osaCANBusFrame (ID canid, DataField data, DataLength nbytes)
 Overloaded constructor. More...
 
 osaCANBusFrame (ID canid, const vctDynamicVector< Data > &data)
 
ID GetID () const
 Return the identifier of the frame. More...
 
DataLength GetLength () const
 Return the length in bytes of the data. More...
 
DataGetData ()
 Return a pointer to the data. More...
 
const DataGetData () const
 Return a const pointer to the data. More...
 

Additional Inherited Members

- Public Types inherited from osaCANBusFrame
typedef unsigned short ID
 The id of a CAN frame. More...
 
typedef unsigned short Mask
 
typedef unsigned char Data
 The data type. More...
 
typedef Data DataField [8]
 The field of data. More...
 
typedef unsigned char DataLength
 The data length type. More...
 
- Protected Attributes inherited from osaCANBusFrame
ID id
 The ID of the node origin. More...
 
DataField data
 The message (8 bytes) More...
 
DataLength nbytes
 The lenght of the message in bytes. More...
 

Constructor & Destructor Documentation

mtsCANBusFrame::mtsCANBusFrame ( )

Create an empty CAN frame.

mtsCANBusFrame::mtsCANBusFrame ( const osaCANBusFrame frame)

Create a mtsCANBusFrame from a osaCANBusFrame.

mtsCANBusFrame::mtsCANBusFrame ( ID  canid,
DataField  data,
DataLength  nbytes 
)

Create a mtsCANBusFrame from a CAN id and data field.

mtsCANBusFrame::mtsCANBusFrame ( ID  canid,
const vctDynamicVector< osaCANBusFrame::Data > &  data 
)

Create a mtsCANBusFrame from a vctVector.


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