iCub-main
Loading...
Searching...
No Matches
Classes | Public Member Functions | List of all members
can_string_eth Class Reference

#include <can_string_eth.h>

Public Member Functions

 can_string_eth ()
 Default constructor.
 
 ~can_string_eth ()
 Destructor.
 
int add_string (CanFrame *can_packet)
 Process a string can packet.
 
void clear_string (int buffer_num)
 Resets the string buffer.
 
char * get_string (int buffer_num)
 

Detailed Description

Definition at line 88 of file can_string_eth.h.

Constructor & Destructor Documentation

◆ can_string_eth()

can_string_eth::can_string_eth ( )
inline

Default constructor.

Definition at line 128 of file can_string_eth.h.

◆ ~can_string_eth()

can_string_eth::~can_string_eth ( )
inline

Destructor.

Definition at line 134 of file can_string_eth.h.

Member Function Documentation

◆ add_string()

int can_string_eth::add_string ( CanFrame can_packet)
inline

Process a string can packet.

All can packets belonging to the same string are joined in the same string buffer untill the string is complete.

Parameters
can_packetis the can message (CMSG* type). It must belong to the CAN_BCAST_PRINT class.
Returns
the number of the buffer where the string part has been inserted. 0 <= buffer_num <= MAX_STRINGS

Definition at line 138 of file can_string_eth.h.

◆ clear_string()

void can_string_eth::clear_string ( int  buffer_num)
inline

Resets the string buffer.

Parameters
cbuffer_numis the number of the buffer. 0 <= buffer_num <= MAX_STRINGS

Definition at line 190 of file can_string_eth.h.

◆ get_string()

char * can_string_eth::get_string ( int  buffer_num)
inline

Definition at line 203 of file can_string_eth.h.


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