Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | Friends | List of all members
icl_hardware::can::HardwareCanSourceCanfile Class Reference

#include <HardwareCanSourceCanfile.h>

Inheritance diagram for icl_hardware::can::HardwareCanSourceCanfile:
Inheritance graph
[legend]

Public Types

typedef boost::shared_ptr< const HardwareCanSourceCanfileConstPtr
 Const shared pointer shorthand. More...
 
typedef boost::shared_ptr< HardwareCanSourceCanfilePtr
 Shared pointer shorthand. More...
 

Public Member Functions

virtual CanMessageStamped::Ptr get () const
 
virtual bool isSeekable () const
 This source works on CAN files and is therefore seekable. More...
 

Static Public Member Functions

static icl_sourcesink::URISchemeMap supportedURISchemes ()
 URI schemes supported by this source. More...
 

Protected Member Functions

virtual bool advance ()
 Implementation of DataSourceBase::advance(). More...
 
 HardwareCanSourceCanfile (const std::string &uri, const std::string &name="HardwareCanSourceCanfile")
 
void prepareFile ()
 
virtual bool seekImpl (const icl_sourcesink::InternalIndex internal_index)
 Implementation of DataSourceBase::seekImpl(). More...
 

Private Attributes

CanMessageStamped::Ptr m_buffer
 Buffers the current data element. More...
 
CanFileResolutionHelper::Ptr m_resolution_helper
 Our own resolution helper. More...
 
icl_sourcesink::KeyframePositionResolver::Ptr m_resolver_x
 
std::size_t m_sequence_number
 Ever-increasing sequence number. More...
 

Friends

class icl_sourcesink::DataSourceFactory< HardwareCanSourceCanfile >
 Provide access for the factory. More...
 
class icl_sourcesink::SourceSinkManager
 Provide access for the manager. More...
 

Detailed Description

This Source reads a given file and offers the possibility to return tCanMessage. Messages will be returned by calling GetNextMessage(). Call Seek() to jump to a specific part of the file.

The FZI CAN file format (version 1.0) is structured as follows: gmtime msg_id dlc data[0] data[1] data[2] data[3] data[4] data[5] data[6] data[7] An example line is given below: 1314957629.419675 55 8 0 0 0 0 1b f5 21 7a The message block time and position is stored in an additional XML file.

Definition at line 56 of file HardwareCanSourceCanfile.h.

Member Typedef Documentation

Const shared pointer shorthand.

Definition at line 62 of file HardwareCanSourceCanfile.h.

Shared pointer shorthand.

Definition at line 60 of file HardwareCanSourceCanfile.h.

Constructor & Destructor Documentation

icl_hardware::can::HardwareCanSourceCanfile::HardwareCanSourceCanfile ( const std::string &  uri,
const std::string &  name = "HardwareCanSourceCanfile" 
)
protected

Definition at line 36 of file HardwareCanSourceCanfile.cpp.

Member Function Documentation

bool icl_hardware::can::HardwareCanSourceCanfile::advance ( )
protectedvirtual

Implementation of DataSourceBase::advance().

Definition at line 149 of file HardwareCanSourceCanfile.cpp.

virtual CanMessageStamped::Ptr icl_hardware::can::HardwareCanSourceCanfile::get ( ) const
inlinevirtual

Definition at line 79 of file HardwareCanSourceCanfile.h.

virtual bool icl_hardware::can::HardwareCanSourceCanfile::isSeekable ( ) const
inlinevirtual

This source works on CAN files and is therefore seekable.

Definition at line 85 of file HardwareCanSourceCanfile.h.

void icl_hardware::can::HardwareCanSourceCanfile::prepareFile ( )
protected

Definition at line 56 of file HardwareCanSourceCanfile.cpp.

bool icl_hardware::can::HardwareCanSourceCanfile::seekImpl ( const icl_sourcesink::InternalIndex  internal_index)
protectedvirtual

Implementation of DataSourceBase::seekImpl().

Definition at line 119 of file HardwareCanSourceCanfile.cpp.

static icl_sourcesink::URISchemeMap icl_hardware::can::HardwareCanSourceCanfile::supportedURISchemes ( )
inlinestatic

URI schemes supported by this source.

Definition at line 65 of file HardwareCanSourceCanfile.h.

Friends And Related Function Documentation

friend class icl_sourcesink::DataSourceFactory< HardwareCanSourceCanfile >
friend

Provide access for the factory.

Definition at line 100 of file HardwareCanSourceCanfile.h.

friend class icl_sourcesink::SourceSinkManager
friend

Provide access for the manager.

Definition at line 97 of file HardwareCanSourceCanfile.h.

Member Data Documentation

CanMessageStamped::Ptr icl_hardware::can::HardwareCanSourceCanfile::m_buffer
private

Buffers the current data element.

Definition at line 110 of file HardwareCanSourceCanfile.h.

CanFileResolutionHelper::Ptr icl_hardware::can::HardwareCanSourceCanfile::m_resolution_helper
private

Our own resolution helper.

Definition at line 118 of file HardwareCanSourceCanfile.h.

icl_sourcesink::KeyframePositionResolver::Ptr icl_hardware::can::HardwareCanSourceCanfile::m_resolver_x
private

Shared pointer to the actual resolver type, to avoid repeated dynamic casting.

Definition at line 115 of file HardwareCanSourceCanfile.h.

std::size_t icl_hardware::can::HardwareCanSourceCanfile::m_sequence_number
private

Ever-increasing sequence number.

Definition at line 121 of file HardwareCanSourceCanfile.h.


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


fzi_icl_can
Author(s):
autogenerated on Mon Jun 10 2019 13:17:02