Public Member Functions | List of all members
kobuki::PacketFinder Class Reference

#include <kobuki.hpp>

Inheritance diagram for kobuki::PacketFinder:
Inheritance graph
[legend]

Public Member Functions

bool checkSum ()
 
virtual ~PacketFinder ()
 
- Public Member Functions inherited from kobuki::PacketFinderBase
void clear ()
 
void configure (const std::string &sigslots_namespace, const BufferType &putStx, const BufferType &putEtx, unsigned int sizeLengthField, unsigned int sizeMaxPayload, unsigned int sizeChecksumField, bool variableSizePayload)
 
void enableVerbose ()
 
void getBuffer (BufferType &bufferRef)
 
void getPayload (BufferType &bufferRef)
 
unsigned int numberOfDataToRead ()
 
 PacketFinderBase ()
 
virtual bool update (const unsigned char *incoming, unsigned int numberOfIncoming)
 
virtual ~PacketFinderBase ()
 

Additional Inherited Members

- Public Types inherited from kobuki::PacketFinderBase
typedef ecl::PushAndPop< unsigned char > BufferType
 
enum  packetFinderState {
  clearBuffer = 0, waitingForStx, waitingForPayloadSize, waitingForPayloadToEtx,
  waitingForEtx
}
 
- Public Attributes inherited from kobuki::PacketFinderBase
enum packetFinderState state
 
- Protected Member Functions inherited from kobuki::PacketFinderBase
bool waitForEtx (const unsigned char incoming, bool &foundPacket)
 
bool waitForPayloadAndEtx (const unsigned char *incoming, unsigned int numberOfIncoming, bool &foundPacket)
 
bool waitForPayloadSize (const unsigned char *incoming, unsigned int numberOfIncoming)
 
bool WaitForStx (const unsigned char datum)
 
- Protected Attributes inherited from kobuki::PacketFinderBase
BufferType buffer
 
BufferType ETX
 
ecl::Signal< const std::string & > sig_error
 
ecl::Signal< const std::string & > sig_warn
 
unsigned int size_checksum_field
 
unsigned int size_etx
 
unsigned int size_length_field
 
unsigned int size_max_payload
 
unsigned int size_payload
 
unsigned int size_stx
 
BufferType STX
 
bool variable_size_payload
 
bool verbose
 

Detailed Description

Definition at line 80 of file kobuki.hpp.

Constructor & Destructor Documentation

◆ ~PacketFinder()

virtual kobuki::PacketFinder::~PacketFinder ( )
inlinevirtual

Definition at line 85 of file kobuki.hpp.

Member Function Documentation

◆ checkSum()

bool kobuki::PacketFinder::checkSum ( )
virtual

Reimplemented from kobuki::PacketFinderBase.

Definition at line 40 of file kobuki.cpp.


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


kobuki_driver
Author(s): Daniel Stonier , Younghun Ju , Jorge Santos Simon
autogenerated on Wed Mar 2 2022 00:26:14