velodyne::Input Class Reference

#include <input.h>

Inheritance diagram for velodyne::Input:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual int getPacket (velodyne_msgs::VelodynePacket *pkt)
 Read velodyne packet.
virtual int getPackets (uint8_t *buffer, int npacks, double *data_time)=0
 Read velodyne packets.
 Input ()
virtual int vclose (void)=0
 Close the data socket or file.
virtual int vopen (void)=0
 Open the data socket or file.

Detailed Description

Definition at line 49 of file input.h.


Constructor & Destructor Documentation

velodyne::Input::Input (  )  [inline]

Definition at line 52 of file input.h.


Member Function Documentation

int velodyne::Input::getPacket ( velodyne_msgs::VelodynePacket *  pkt  )  [virtual]

Read velodyne packet.

Parameters:
pkt[out] points to VelodynePacket message
Returns:
0 if successful, -1 if end of file > 0 if incomplete packet (is this possible?)

Definition at line 42 of file input.cc.

virtual int velodyne::Input::getPackets ( uint8_t *  buffer,
int  npacks,
double *  data_time 
) [pure virtual]

Read velodyne packets.

Parameters:
buffer array to receive raw data packets
npacks number of packets to read
data_time[out] average time when data received
Returns:
number of packets not read, if any 0 if successful, -1 if end of file
Deprecated:
Use getPacket() instead

Implemented in velodyne::InputSocket, and velodyne::InputPCAP.

virtual int velodyne::Input::vclose ( void   )  [pure virtual]

Close the data socket or file.

Returns:
0, if successful errno value, for failure

Implemented in velodyne::InputSocket, and velodyne::InputPCAP.

virtual int velodyne::Input::vopen ( void   )  [pure virtual]

Open the data socket or file.

Returns:
: 0, if successful; -1 for failure
Todo:
return errno value for failure

Implemented in velodyne::InputSocket, and velodyne::InputPCAP.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerator Defines


velodyne_common
Author(s): Jack O'Quin, Patrick Beeson, Michael Quinlan, Yaxin Liu
autogenerated on Fri Jan 11 10:05:58 2013