Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
psen_scan_v2_standalone::ScannerConfiguration Class Reference

Higher level data type storing the configuration details of the scanner like scanner IP, port, scan range, etc. More...

#include <scanner_configuration.h>

Public Member Functions

uint32_t clientIp () const
 
bool diagnosticsEnabled () const
 
bool fragmentedScansEnabled () const
 
boost::optional< uint32_t > hostIp () const
 
void hostIp (const uint32_t &host_ip)
 
uint16_t hostUDPPortControl () const
 
uint16_t hostUDPPortData () const
 
bool intensitiesEnabled () const
 
uint16_t scannerControlPort () const
 
uint16_t scannerDataPort () const
 
const ScanRange & scanRange () const
 
const util::TenthOfDegree & scanResolution () const
 
void setHostIp (const uint32_t &host_ip)
 

Private Member Functions

bool isComplete () const
 
bool isValid () const
 
 ScannerConfiguration ()=default
 

Private Attributes

bool diagnostics_enabled_ { configuration::DIAGNOSTICS }
 
bool fragmented_scans_ { configuration::FRAGMENTED_SCANS }
 
uint16_t host_control_port_ { configuration::CONTROL_PORT_OF_HOST_DEVICE }
 
uint16_t host_data_port_ { configuration::DATA_PORT_OF_HOST_DEVICE }
 
boost::optional< uint32_t > host_ip_
 
bool intensities_enabled_ { configuration::INTENSITIES }
 
boost::optional< ScanRange > scan_range_ {}
 
util::TenthOfDegree scan_resolution_
 
uint16_t scanner_control_port_ { configuration::CONTROL_PORT_OF_SCANNER_DEVICE }
 
uint16_t scanner_data_port_ { configuration::DATA_PORT_OF_SCANNER_DEVICE }
 
boost::optional< uint32_t > scanner_ip_
 

Friends

class ScannerConfigurationBuilder
 

Detailed Description

Higher level data type storing the configuration details of the scanner like scanner IP, port, scan range, etc.

If no host IP is set the driver will use the IP of the local machine.

See also
ScanRange

Definition at line 34 of file scanner_configuration.h.

Constructor & Destructor Documentation

◆ ScannerConfiguration()

psen_scan_v2_standalone::ScannerConfiguration::ScannerConfiguration ( )
privatedefault

Member Function Documentation

◆ clientIp()

uint32_t psen_scan_v2_standalone::ScannerConfiguration::clientIp ( ) const
inline

Definition at line 114 of file scanner_configuration.h.

◆ diagnosticsEnabled()

bool psen_scan_v2_standalone::ScannerConfiguration::diagnosticsEnabled ( ) const
inline

Definition at line 139 of file scanner_configuration.h.

◆ fragmentedScansEnabled()

bool psen_scan_v2_standalone::ScannerConfiguration::fragmentedScansEnabled ( ) const
inline

Definition at line 149 of file scanner_configuration.h.

◆ hostIp() [1/2]

boost::optional< uint32_t > psen_scan_v2_standalone::ScannerConfiguration::hostIp ( ) const
inline

Definition at line 99 of file scanner_configuration.h.

◆ hostIp() [2/2]

void psen_scan_v2_standalone::ScannerConfiguration::hostIp ( const uint32_t &  host_ip)
inline

Definition at line 154 of file scanner_configuration.h.

◆ hostUDPPortControl()

uint16_t psen_scan_v2_standalone::ScannerConfiguration::hostUDPPortControl ( ) const
inline

Definition at line 109 of file scanner_configuration.h.

◆ hostUDPPortData()

uint16_t psen_scan_v2_standalone::ScannerConfiguration::hostUDPPortData ( ) const
inline

Definition at line 104 of file scanner_configuration.h.

◆ intensitiesEnabled()

bool psen_scan_v2_standalone::ScannerConfiguration::intensitiesEnabled ( ) const
inline

Definition at line 144 of file scanner_configuration.h.

◆ isComplete()

bool psen_scan_v2_standalone::ScannerConfiguration::isComplete ( ) const
inlineprivate

Definition at line 84 of file scanner_configuration.h.

◆ isValid()

bool psen_scan_v2_standalone::ScannerConfiguration::isValid ( ) const
inlineprivate

Definition at line 89 of file scanner_configuration.h.

◆ scannerControlPort()

uint16_t psen_scan_v2_standalone::ScannerConfiguration::scannerControlPort ( ) const
inline

Definition at line 124 of file scanner_configuration.h.

◆ scannerDataPort()

uint16_t psen_scan_v2_standalone::ScannerConfiguration::scannerDataPort ( ) const
inline

Definition at line 119 of file scanner_configuration.h.

◆ scanRange()

const ScanRange & psen_scan_v2_standalone::ScannerConfiguration::scanRange ( ) const
inline

Definition at line 129 of file scanner_configuration.h.

◆ scanResolution()

const util::TenthOfDegree & psen_scan_v2_standalone::ScannerConfiguration::scanResolution ( ) const
inline

Definition at line 134 of file scanner_configuration.h.

◆ setHostIp()

void psen_scan_v2_standalone::ScannerConfiguration::setHostIp ( const uint32_t &  host_ip)
inline

deprecated: use void hostIp(const uint32_t& host_ip) instead

Definition at line 159 of file scanner_configuration.h.

Friends And Related Function Documentation

◆ ScannerConfigurationBuilder

friend class ScannerConfigurationBuilder
friend

Definition at line 61 of file scanner_configuration.h.

Member Data Documentation

◆ diagnostics_enabled_

bool psen_scan_v2_standalone::ScannerConfiguration::diagnostics_enabled_ { configuration::DIAGNOSTICS }
private

Definition at line 79 of file scanner_configuration.h.

◆ fragmented_scans_

bool psen_scan_v2_standalone::ScannerConfiguration::fragmented_scans_ { configuration::FRAGMENTED_SCANS }
private

Definition at line 81 of file scanner_configuration.h.

◆ host_control_port_

uint16_t psen_scan_v2_standalone::ScannerConfiguration::host_control_port_ { configuration::CONTROL_PORT_OF_HOST_DEVICE }
private

Definition at line 70 of file scanner_configuration.h.

◆ host_data_port_

uint16_t psen_scan_v2_standalone::ScannerConfiguration::host_data_port_ { configuration::DATA_PORT_OF_HOST_DEVICE }
private

Definition at line 69 of file scanner_configuration.h.

◆ host_ip_

boost::optional<uint32_t> psen_scan_v2_standalone::ScannerConfiguration::host_ip_
private

Definition at line 68 of file scanner_configuration.h.

◆ intensities_enabled_

bool psen_scan_v2_standalone::ScannerConfiguration::intensities_enabled_ { configuration::INTENSITIES }
private

Definition at line 80 of file scanner_configuration.h.

◆ scan_range_

boost::optional<ScanRange> psen_scan_v2_standalone::ScannerConfiguration::scan_range_ {}
private

Definition at line 76 of file scanner_configuration.h.

◆ scan_resolution_

util::TenthOfDegree psen_scan_v2_standalone::ScannerConfiguration::scan_resolution_
private
Initial value:
{ data_conversion_layer::radToTenthDegree(
configuration::DEFAULT_SCAN_ANGLE_RESOLUTION) }

Definition at line 77 of file scanner_configuration.h.

◆ scanner_control_port_

uint16_t psen_scan_v2_standalone::ScannerConfiguration::scanner_control_port_ { configuration::CONTROL_PORT_OF_SCANNER_DEVICE }
private

Definition at line 74 of file scanner_configuration.h.

◆ scanner_data_port_

uint16_t psen_scan_v2_standalone::ScannerConfiguration::scanner_data_port_ { configuration::DATA_PORT_OF_SCANNER_DEVICE }
private

Definition at line 73 of file scanner_configuration.h.

◆ scanner_ip_

boost::optional<uint32_t> psen_scan_v2_standalone::ScannerConfiguration::scanner_ip_
private

Definition at line 72 of file scanner_configuration.h.

The documentation for this class was generated from the following file:
psen_scan_v2_standalone::data_conversion_layer::radToTenthDegree
static int16_t radToTenthDegree(const double &angle_in_rad)
Definition: angle_conversions.h:51
psen_scan_v2_standalone::configuration::DEFAULT_SCAN_ANGLE_RESOLUTION
static constexpr double DEFAULT_SCAN_ANGLE_RESOLUTION(data_conversion_layer::degreeToRadian(0.1))

psen_scan_v2
Author(s): Pilz GmbH + Co. KG
autogenerated on Sat Nov 25 2023 03:46:26