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

#include <VisionaryDataStream.h>

Public Member Functions

void close ()
 
bool getNextFrame ()
 
bool open (const std::string &hostname, std::uint16_t port)
 
bool syncCoLa () const
 
 VisionaryDataStream (std::shared_ptr< VisionaryData > dataHandler)
 
 ~VisionaryDataStream ()
 

Private Member Functions

bool parseSegmentBinaryData (const std::vector< uint8_t >::iterator itBuf)
 

Private Attributes

std::shared_ptr< VisionaryDatam_dataHandler
 
std::unique_ptr< TcpSocketm_pTransport
 

Detailed Description

Definition at line 30 of file VisionaryDataStream.h.

Constructor & Destructor Documentation

◆ VisionaryDataStream()

visionary::VisionaryDataStream::VisionaryDataStream ( std::shared_ptr< VisionaryData dataHandler)

Definition at line 30 of file VisionaryDataStream.cpp.

◆ ~VisionaryDataStream()

visionary::VisionaryDataStream::~VisionaryDataStream ( )

Definition at line 35 of file VisionaryDataStream.cpp.

Member Function Documentation

◆ close()

void visionary::VisionaryDataStream::close ( )

Close a connection

Closes the connection. It is allowed to call close of a connection that is not open. In this case this call is a no-op.

Definition at line 53 of file VisionaryDataStream.cpp.

◆ getNextFrame()

bool visionary::VisionaryDataStream::getNextFrame ( )

Definition at line 86 of file VisionaryDataStream.cpp.

◆ open()

bool visionary::VisionaryDataStream::open ( const std::string &  hostname,
std::uint16_t  port 
)

Opens a connection to a Visionary sensor

Parameters
[in]hostnamename or IP address of the Visionary sensor.
[in]portcontrol command port of the sensor, usually 2112 for CoLa-B or 2122 for CoLa-2.
Return values
trueThe connection to the sensor successfully was established.
falseThe connection attempt failed; the sensor is either
  • switched off or has a different IP address or name
  • not available using for PCs network settings (different subnet)
  • the protocol type or the port did not match. Please check your sensor documentation.

Definition at line 37 of file VisionaryDataStream.cpp.

◆ parseSegmentBinaryData()

bool visionary::VisionaryDataStream::parseSegmentBinaryData ( const std::vector< uint8_t >::iterator  itBuf)
private

Definition at line 125 of file VisionaryDataStream.cpp.

◆ syncCoLa()

bool visionary::VisionaryDataStream::syncCoLa ( ) const

Definition at line 62 of file VisionaryDataStream.cpp.

Member Data Documentation

◆ m_dataHandler

std::shared_ptr<VisionaryData> visionary::VisionaryDataStream::m_dataHandler
private

Definition at line 64 of file VisionaryDataStream.h.

◆ m_pTransport

std::unique_ptr<TcpSocket> visionary::VisionaryDataStream::m_pTransport
private

Definition at line 65 of file VisionaryDataStream.h.


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


sick_safevisionary_base
Author(s):
autogenerated on Sat Oct 21 2023 02:24:26