Simple_HCSR04
A simple wrapper for the HC-SR04 Module to be used for e.g. an Arduino.
Public Member Functions | List of all members
Simple_HCSR04::Measurement Class Reference

A simple wrapper for holding the measured distance. More...

#include <Simple_HCSR04.h>

Public Member Functions

 Measurement (unsigned long measurement)
 The measured distance. More...
 
unsigned long mm () const
 Measurement/ Distance in millimeters. More...
 
unsigned long cm () const
 Measurement/ Distance in centimeters. More...
 
float dm () const
 Measurement/ Distance in decimeters. More...
 
float m () const
 Measurement/ Distance in meters. More...
 

Detailed Description

A simple wrapper for holding the measured distance.

Constructor & Destructor Documentation

◆ Measurement()

Simple_HCSR04::Measurement::Measurement ( unsigned long  measurement)

The measured distance.

Construct a new Simple_HCSR04::Measurement::Measurement object from a given number. The given number should be provided in centimeters to provide a reasonable conversion.

Parameters
measurementdistance

Member Function Documentation

◆ cm()

unsigned long Simple_HCSR04::Measurement::cm ( ) const

Measurement/ Distance in centimeters.

Returns
unsigned long

◆ dm()

float Simple_HCSR04::Measurement::dm ( ) const

Measurement/ Distance in decimeters.

Returns
float

◆ m()

float Simple_HCSR04::Measurement::m ( ) const

Measurement/ Distance in meters.

Returns
float

◆ mm()

unsigned long Simple_HCSR04::Measurement::mm ( ) const

Measurement/ Distance in millimeters.

Returns
unsigned long

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