Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
visionary::CoLa2ProtocolHandler Class Reference

#include <CoLa2ProtocolHandler.h>

Inheritance diagram for visionary::CoLa2ProtocolHandler:
Inheritance graph
[legend]

Public Member Functions

void closeSession () override
 
 CoLa2ProtocolHandler (ITransport &rTransport)
 
std::uint16_t getReqId () const
 
std::uint32_t getSessionId () const
 
bool openSession (std::uint8_t sessionTimeout) override
 
CoLaCommand send (CoLaCommand cmd) override
 
 ~CoLa2ProtocolHandler () override
 
- Public Member Functions inherited from visionary::IProtocolHandler
virtual bool openSession (uint8_t sessionTimeout)=0
 
virtual ~IProtocolHandler ()=default
 

Private Types

using ByteBuffer = std::vector< std::uint8_t >
 

Private Member Functions

ByteBuffer createCommandHeader (std::size_t payloadSize, std::size_t extraReserve=0u)
 
ByteBuffer createProtocolHeader (std::size_t payloadSize, std::size_t extraReserve=0u)
 
std::uint16_t createReqId ()
 
ByteBuffer readProtocol ()
 parse a response on protocol level More...
 
ByteBuffer readResponse (std::uint32_t &rSessionId, uint16_t &rReqId)
 read a command response packet More...
 

Private Attributes

std::uint16_t m_reqID
 
ITransportm_rtransport
 
std::uint32_t m_sessionID
 

Detailed Description

Definition at line 17 of file CoLa2ProtocolHandler.h.

Member Typedef Documentation

◆ ByteBuffer

using visionary::CoLa2ProtocolHandler::ByteBuffer = std::vector<std::uint8_t>
private

Definition at line 39 of file CoLa2ProtocolHandler.h.

Constructor & Destructor Documentation

◆ CoLa2ProtocolHandler()

visionary::CoLa2ProtocolHandler::CoLa2ProtocolHandler ( ITransport rTransport)

Definition at line 19 of file CoLa2ProtocolHandler.cpp.

◆ ~CoLa2ProtocolHandler()

visionary::CoLa2ProtocolHandler::~CoLa2ProtocolHandler ( )
overridedefault

Member Function Documentation

◆ closeSession()

void visionary::CoLa2ProtocolHandler::closeSession ( )
overridevirtual

Implements visionary::IProtocolHandler.

Definition at line 274 of file CoLa2ProtocolHandler.cpp.

◆ createCommandHeader()

CoLa2ProtocolHandler::ByteBuffer visionary::CoLa2ProtocolHandler::createCommandHeader ( std::size_t  payloadSize,
std::size_t  extraReserve = 0u 
)
private

Definition at line 155 of file CoLa2ProtocolHandler.cpp.

◆ createProtocolHeader()

CoLa2ProtocolHandler::ByteBuffer visionary::CoLa2ProtocolHandler::createProtocolHeader ( std::size_t  payloadSize,
std::size_t  extraReserve = 0u 
)
private

Definition at line 128 of file CoLa2ProtocolHandler.cpp.

◆ createReqId()

std::uint16_t visionary::CoLa2ProtocolHandler::createReqId ( )
private

Definition at line 26 of file CoLa2ProtocolHandler.cpp.

◆ getReqId()

std::uint16_t visionary::CoLa2ProtocolHandler::getReqId ( ) const
inline

Definition at line 29 of file CoLa2ProtocolHandler.h.

◆ getSessionId()

std::uint32_t visionary::CoLa2ProtocolHandler::getSessionId ( ) const
inline

Definition at line 33 of file CoLa2ProtocolHandler.h.

◆ openSession()

bool visionary::CoLa2ProtocolHandler::openSession ( std::uint8_t  sessionTimeout)
override

Definition at line 223 of file CoLa2ProtocolHandler.cpp.

◆ readProtocol()

CoLa2ProtocolHandler::ByteBuffer visionary::CoLa2ProtocolHandler::readProtocol ( )
private

parse a response on protocol level

Definition at line 32 of file CoLa2ProtocolHandler.cpp.

◆ readResponse()

CoLa2ProtocolHandler::ByteBuffer visionary::CoLa2ProtocolHandler::readResponse ( std::uint32_t &  rSessionId,
uint16_t &  rReqId 
)
private

read a command response packet

Definition at line 107 of file CoLa2ProtocolHandler.cpp.

◆ send()

CoLaCommand visionary::CoLa2ProtocolHandler::send ( CoLaCommand  cmd)
overridevirtual

Implements visionary::IProtocolHandler.

Definition at line 182 of file CoLa2ProtocolHandler.cpp.

Member Data Documentation

◆ m_reqID

std::uint16_t visionary::CoLa2ProtocolHandler::m_reqID
private

Definition at line 52 of file CoLa2ProtocolHandler.h.

◆ m_rtransport

ITransport& visionary::CoLa2ProtocolHandler::m_rtransport
private

Definition at line 51 of file CoLa2ProtocolHandler.h.

◆ m_sessionID

std::uint32_t visionary::CoLa2ProtocolHandler::m_sessionID
private

Definition at line 53 of file CoLa2ProtocolHandler.h.


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


sick_visionary_ros
Author(s): SICK AG TechSupport 3D Snapshot
autogenerated on Thu Feb 8 2024 04:38:18