Namespaces | Classes | Typedefs | Functions | Variables
psen_scan_v2_standalone Namespace Reference

Root namespace in which the software components to communicate with the scanner (firmware-version: 2) are realised/implemented. More...

Namespaces

 communication_layer
 Namespace for the primitive communication layer implementation.
 
 configuration
 Namespace for configuration defaults and definitions.
 
 data_conversion_layer
 Contains the data serialization and deserialization layer.
 
 protocol_layer
 Namespace for the implementation of the scanner protocol state machine.
 
 util
 Namespace containing utilities like the watchdog and barrier.
 

Classes

class  IOState
 Represents the set of all I/Os of the scanner and their states. More...
 
class  IScanner
 This is the API definition for external interaction with the scanner driver. More...
 
class  LaserScan
 This class represents a single laser scan in the <tf_prefix> target frame. More...
 
class  PinState
 Represents a single I/O pin. More...
 
class  ScannerConfiguration
 Higher level data type storing the configuration details of the scanner like scanner IP, port, scan range, etc. More...
 
class  ScannerConfigurationBuilder
 Helper class to simplify/improve the construction of the psen_scan_v2_standalone::ScannerConfiguration. More...
 
class  ScannerV2
 This is the implementation of the Scanner API defined by IScanner. More...
 
class  ScanRangeTemplated
 Higher level data type storing the range in which the scanner takes measurements. More...
 

Typedefs

using ScanRange = ScanRangeTemplated< 1, 2749 >
 

Functions

std::string formatPinState (const PinState &pin)
 Formats a PinState just using its name and state. (e.g. Safety 1 intrusion = true) More...
 
std::string formatPinStates (const std::vector< PinState > &pins)
 Formats a vector of PinStates. More...
 
std::ostream & operator<< (std::ostream &os, const IOState &io_state)
 
std::ostream & operator<< (std::ostream &os, const LaserScan &scan)
 
std::ostream & operator<< (std::ostream &os, const PinState &pin_state)
 

Variables

static const util::TenthOfDegree MAX_X_AXIS_ROTATION { 275 }
 

Detailed Description

Root namespace in which the software components to communicate with the scanner (firmware-version: 2) are realised/implemented.

Typedef Documentation

◆ ScanRange

Definition at line 117 of file scan_range.h.

Function Documentation

◆ formatPinState()

std::string psen_scan_v2_standalone::formatPinState ( const PinState pin)
inline

Formats a PinState just using its name and state. (e.g. Safety 1 intrusion = true)

Definition at line 53 of file io_state.h.

◆ formatPinStates()

std::string psen_scan_v2_standalone::formatPinStates ( const std::vector< PinState > &  pins)
inline

Formats a vector of PinStates.

Definition at line 59 of file io_state.h.

◆ operator<<() [1/3]

std::ostream & psen_scan_v2_standalone::operator<< ( std::ostream &  os,
const IOState io_state 
)

Definition at line 105 of file io_state.cpp.

◆ operator<<() [2/3]

std::ostream & psen_scan_v2_standalone::operator<< ( std::ostream &  os,
const LaserScan scan 
)

Definition at line 203 of file laserscan.cpp.

◆ operator<<() [3/3]

std::ostream & psen_scan_v2_standalone::operator<< ( std::ostream &  os,
const PinState pin_state 
)

Definition at line 59 of file io_state.cpp.

Variable Documentation

◆ MAX_X_AXIS_ROTATION

const util::TenthOfDegree psen_scan_v2_standalone::MAX_X_AXIS_ROTATION { 275 }
static

Definition at line 31 of file laserscan.cpp.



psen_scan_v2
Author(s): Pilz GmbH + Co. KG
autogenerated on Sat Jun 22 2024 02:46:12