Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
psen_scan_v2_standalone::ScanRangeTemplated< min_allowed_angle, max_allowed_angle > Class Template Reference

Higher level data type storing the range in which the scanner takes measurements. More...

#include <scan_range.h>

Public Member Functions

const util::TenthOfDegreeend () const
 
const util::TenthOfDegreegetEnd () const
 
const util::TenthOfDegreegetStart () const
 
constexpr ScanRangeTemplated (const util::TenthOfDegree &start_angle, const util::TenthOfDegree &end_angle)
 Constructor. More...
 
const util::TenthOfDegreestart () const
 

Static Public Member Functions

static constexpr ScanRangeTemplated< min_allowed_angle, max_allowed_angle > createInvalidScanRange ()
 

Private Member Functions

 ScanRangeTemplated ()=default
 

Private Attributes

util::TenthOfDegree end_angle_ { 0 }
 
util::TenthOfDegree start_angle_ { 0 }
 

Detailed Description

template<int16_t min_allowed_angle, int16_t max_allowed_angle>
class psen_scan_v2_standalone::ScanRangeTemplated< min_allowed_angle, max_allowed_angle >

Higher level data type storing the range in which the scanner takes measurements.

A ScanRange is given by a start- and an end-angle, which are represented in TenthOfDegree.

Definition at line 31 of file scan_range.h.

Constructor & Destructor Documentation

◆ ScanRangeTemplated() [1/2]

template<int16_t min_angle_raw, int16_t max_angle_raw>
constexpr psen_scan_v2_standalone::ScanRangeTemplated< min_angle_raw, max_angle_raw >::ScanRangeTemplated ( const util::TenthOfDegree start_angle,
const util::TenthOfDegree end_angle 
)
constexpr

Constructor.

Parameters
start_angleStart angle of measurement (scanner-zero = zero on the left).
end_angleEnd angle of measurement. Closed interval. (End angle included.)

Definition at line 64 of file scan_range.h.

◆ ScanRangeTemplated() [2/2]

template<int16_t min_allowed_angle, int16_t max_allowed_angle>
psen_scan_v2_standalone::ScanRangeTemplated< min_allowed_angle, max_allowed_angle >::ScanRangeTemplated ( )
privatedefault

Member Function Documentation

◆ createInvalidScanRange()

template<int16_t min_angle, int16_t max_angle>
constexpr ScanRangeTemplated< min_angle, max_angle > psen_scan_v2_standalone::ScanRangeTemplated< min_angle, max_angle >::createInvalidScanRange
staticconstexpr

Definition at line 88 of file scan_range.h.

◆ end()

template<int16_t min_angle, int16_t max_angle>
const util::TenthOfDegree & psen_scan_v2_standalone::ScanRangeTemplated< min_angle, max_angle >::end

Definition at line 100 of file scan_range.h.

◆ getEnd()

template<int16_t min_angle, int16_t max_angle>
const util::TenthOfDegree & psen_scan_v2_standalone::ScanRangeTemplated< min_angle, max_angle >::getEnd

deprecated: use const util::TenthOfDegree& end() const instead

Definition at line 112 of file scan_range.h.

◆ getStart()

template<int16_t min_angle, int16_t max_angle>
const util::TenthOfDegree & psen_scan_v2_standalone::ScanRangeTemplated< min_angle, max_angle >::getStart

deprecated: use const util::TenthOfDegree& start() const instead

Definition at line 106 of file scan_range.h.

◆ start()

template<int16_t min_angle, int16_t max_angle>
const util::TenthOfDegree & psen_scan_v2_standalone::ScanRangeTemplated< min_angle, max_angle >::start

Definition at line 94 of file scan_range.h.

Member Data Documentation

◆ end_angle_

template<int16_t min_allowed_angle, int16_t max_allowed_angle>
util::TenthOfDegree psen_scan_v2_standalone::ScanRangeTemplated< min_allowed_angle, max_allowed_angle >::end_angle_ { 0 }
private

Definition at line 60 of file scan_range.h.

◆ start_angle_

template<int16_t min_allowed_angle, int16_t max_allowed_angle>
util::TenthOfDegree psen_scan_v2_standalone::ScanRangeTemplated< min_allowed_angle, max_allowed_angle >::start_angle_ { 0 }
private

Definition at line 59 of file scan_range.h.


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


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