SPARK MAX - C++ Documentation
rev::CANStreamable< T_ID, T_Message > Class Template Referenceabstract

Public Member Functions

 CANStreamable ()
 
virtual void StartStream ()=0
 
virtual void ReadStream (std::vector< T_ID > &streams, std::vector< T_Message > *messages)=0
 
virtual void CloseStream ()=0
 
virtual void ListStreamable (std::vector< T_Message > &streams)=0
 

Constructor & Destructor Documentation

◆ CANStreamable()

template<typename T_ID, typename T_Message>
rev::CANStreamable< T_ID, T_Message >::CANStreamable ( )
inline

CAN Stream manager that handles all the streams CAN Streamables passed to the manager that then you read from as well The Streamables are add with an AddStream method and read from with a ReadStream method Takes in a stream ID or a custom parameter ID to pass through to open the stream

The streamables are stored by the stream manager who handles the internals of what streams are read from Allows the customability of adding new streams when needed

Member Function Documentation

◆ CloseStream()

template<typename T_ID, typename T_Message>
virtual void rev::CANStreamable< T_ID, T_Message >::CloseStream ( )
pure virtual

Using predefined Stream IDs. Closes multiple streams at once.

Implemented in rev::CANSparkMax.

◆ ReadStream()

template<typename T_ID, typename T_Message>
virtual void rev::CANStreamable< T_ID, T_Message >::ReadStream ( std::vector< T_ID > &  streams,
std::vector< T_Message > *  messages 
)
pure virtual

Using predefined Stream IDs. Reads back data from the given streams in the form of StreamMessages

Implemented in rev::CANSparkMax.

◆ StartStream()

template<typename T_ID, typename T_Message>
virtual void rev::CANStreamable< T_ID, T_Message >::StartStream ( )
pure virtual

Using predefined Stream IDs. Starts multiple streams at once.

Implemented in rev::CANSparkMax.


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