#include <HardwareCanSourcePeak.h>

Classes
class	WorkerThread
Public Types
typedef boost::shared_ptr < const HardwareCanSourcePeak >	ConstPtr
	Const shared pointer shorthand.
typedef boost::shared_ptr < HardwareCanSourcePeak >	Ptr
	Shared pointer shorthand.
Public Member Functions
virtual CanMessageStamped::Ptr	get () const
virtual bool	isSeekable () const
	~HardwareCanSourcePeak ()
Static Public Member Functions
static icl_sourcesink::URISchemeMap	supportedURISchemes ()
	URI schemes supported by this source.
Protected Member Functions
bool	advance ()
	Advance to the next data element.
	HardwareCanSourcePeak (const std::string &uri="", const std::string &name="HardwareCanSourcePeak")
	Constructor.
Private Attributes
CanMessageStamped::Ptr	m_buffer
	Buffers the latest data element.
uint32_t	m_sleep_time
boost::scoped_ptr< WorkerThread >	m_worker_thread
Friends
class	icl_sourcesink::DataSourceFactory< HardwareCanSourcePeak >
	Provide access for the factory.
class	icl_sourcesink::SourceSinkManager
	Provide access for the manager.

Detailed Description

This Source reads from a given CAN bus and returns its messages as time-stamped tCanMessage objects.

Definition at line 40 of file HardwareCanSourcePeak.h.

Member Typedef Documentation

typedef boost::shared_ptr<const HardwareCanSourcePeak> icl_hardware::can::HardwareCanSourcePeak::ConstPtr

Const shared pointer shorthand.

Definition at line 52 of file HardwareCanSourcePeak.h.

typedef boost::shared_ptr<HardwareCanSourcePeak> icl_hardware::can::HardwareCanSourcePeak::Ptr

Shared pointer shorthand.

Definition at line 46 of file HardwareCanSourcePeak.h.

Constructor & Destructor Documentation

icl_hardware::can::HardwareCanSourcePeak::~HardwareCanSourcePeak ( )

Definition at line 299 of file HardwareCanSourcePeak.cpp.

icl_hardware::can::HardwareCanSourcePeak::HardwareCanSourcePeak	(	const std::string &	uri = `""`,
		const std::string &	name = `"HardwareCanSourcePeak"`
	)		`[protected]`

Constructor.

Definition at line 197 of file HardwareCanSourcePeak.cpp.

Member Function Documentation

bool icl_hardware::can::HardwareCanSourcePeak::advance ( ) [protected]

Advance to the next data element.

Definition at line 308 of file HardwareCanSourcePeak.cpp.

virtual CanMessageStamped::Ptr icl_hardware::can::HardwareCanSourcePeak::get ( ) const [inline, virtual]

Definition at line 74 of file HardwareCanSourcePeak.h.

virtual bool icl_hardware::can::HardwareCanSourcePeak::isSeekable ( ) const [inline, virtual]

Definition at line 79 of file HardwareCanSourcePeak.h.

static icl_sourcesink::URISchemeMap icl_hardware::can::HardwareCanSourcePeak::supportedURISchemes ( ) [inline, static]

URI schemes supported by this source.

Definition at line 55 of file HardwareCanSourcePeak.h.

Friends And Related Function Documentation

friend class icl_sourcesink::DataSourceFactory< HardwareCanSourcePeak > [friend]

Provide access for the factory.

Definition at line 92 of file HardwareCanSourcePeak.h.

friend class icl_sourcesink::SourceSinkManager [friend]

Provide access for the manager.

Definition at line 89 of file HardwareCanSourcePeak.h.

Member Data Documentation

CanMessageStamped::Ptr icl_hardware::can::HardwareCanSourcePeak::m_buffer [private]

Buffers the latest data element.

Definition at line 99 of file HardwareCanSourcePeak.h.

uint32_t icl_hardware::can::HardwareCanSourcePeak::m_sleep_time [private]

Time (in microseconds) we sleep before checking for the next CAN message. Always set to half the CAN symbol time. I.e., at 1 Kbps this is set to 500 microseconds. At 1 Mbps this is zero.

Definition at line 105 of file HardwareCanSourcePeak.h.

boost::scoped_ptr<WorkerThread> icl_hardware::can::HardwareCanSourcePeak::m_worker_thread [private]

The worker thread that monitors the CAN device and buffers newly received data.

Definition at line 110 of file HardwareCanSourcePeak.h.

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions