iCub-main
Public Member Functions | List of all members
yarp::dev::FakeCan Class Reference

fakecan : implements yarp::dev::ICanBus for a software (fake) can bus board. More...

#include <fakeCan.h>

+ Inheritance diagram for yarp::dev::FakeCan:

Public Member Functions

 FakeCan ()
 
 ~FakeCan ()
 
virtual bool canSetBaudRate (unsigned int rate)
 
virtual bool canGetBaudRate (unsigned int *rate)
 
virtual bool canIdAdd (unsigned int id)
 
virtual bool canIdDelete (unsigned int id)
 
virtual bool canRead (CanBuffer &msgs, unsigned int size, unsigned int *read, bool wait=false)
 
virtual bool canWrite (const CanBuffer &msgs, unsigned int size, unsigned int *sent, bool wait=false)
 
virtual bool open (yarp::os::Searchable &par)
 
virtual bool close ()
 

Detailed Description

fakecan : implements yarp::dev::ICanBus for a software (fake) can bus board.

It accepts the same parameter file that can be passed to the real hw (you just need to replace ecan or pcan with fakecan). Useful for debugging robot code in absence of real hw.

The behavior of the fake boards is very simplified, this module is not simulating a real robot.

YARP device name
fakecan

Definition at line 105 of file fakeCan.h.

Constructor & Destructor Documentation

◆ FakeCan()

FakeCan::FakeCan ( )

Definition at line 18 of file fakeCan.cpp.

◆ ~FakeCan()

FakeCan::~FakeCan ( )

Definition at line 21 of file fakeCan.cpp.

Member Function Documentation

◆ canGetBaudRate()

bool FakeCan::canGetBaudRate ( unsigned int *  rate)
virtual

Definition at line 30 of file fakeCan.cpp.

◆ canIdAdd()

bool FakeCan::canIdAdd ( unsigned int  id)
virtual

Definition at line 35 of file fakeCan.cpp.

◆ canIdDelete()

bool FakeCan::canIdDelete ( unsigned int  id)
virtual

Definition at line 40 of file fakeCan.cpp.

◆ canRead()

bool FakeCan::canRead ( CanBuffer &  msgs,
unsigned int  size,
unsigned int *  read,
bool  wait = false 
)
virtual

Definition at line 45 of file fakeCan.cpp.

◆ canSetBaudRate()

bool FakeCan::canSetBaudRate ( unsigned int  rate)
virtual

Definition at line 25 of file fakeCan.cpp.

◆ canWrite()

bool FakeCan::canWrite ( const CanBuffer &  msgs,
unsigned int  size,
unsigned int *  sent,
bool  wait = false 
)
virtual

Definition at line 73 of file fakeCan.cpp.

◆ close()

bool FakeCan::close ( void  )
virtual

Definition at line 127 of file fakeCan.cpp.

◆ open()

bool FakeCan::open ( yarp::os::Searchable &  par)
virtual

Definition at line 98 of file fakeCan.cpp.


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