mars::Pressure Struct Reference

The Pressure struct describes the raw pressure measurement used for conversion later. More...

#include </home/runner/work/mars_lib/mars_lib/source/mars/include/mars/sensors/pressure/pressure_conversion.h>

Collaboration diagram for mars::Pressure:

Public Types
enum class	Type { LIQUID , GAS , HEIGHT }
	The Type enum determines the type of pressure measurement used for conversion. More...

Public Member Functions
	Pressure ()=default
	Default constructor initializing values to 0, and type to Type::GAS.
	Pressure (double pressure)
	Detailed constructor with pressure value.
	Pressure (double pressure, double temperature, Type type)
	Detailed constructor.
Pressure	operator+ (const Pressure &pressure)
void	operator+= (const Pressure &pressure)
void	operator/= (const double &n)

Public Attributes
double	data_ { 0 }
	measurement data
double	temperature_K_ { 0 }
	ambient temperature when measurement data was observed
Type	type_ { Type::GAS }
	type of the measurement

Friends
std::ostream &	operator<< (std::ostream &out, const Type &type)
std::ostream &	operator<< (std::ostream &out, const Pressure &pressure)

Detailed Description

The Pressure struct describes the raw pressure measurement used for conversion later.

Member Enumeration Documentation

Type

enum class mars::Pressure::Type

strong

The Type enum determines the type of pressure measurement used for conversion.

Enumerator
LIQUID	pressure measurement is in liquid medium, e.g., water
GAS	pressure measruement is in gas medium, e.g., air
HEIGHT	pressure measurement has already been converted to height by sensor

  {
    LIQUID,  
    GAS,     
    HEIGHT   
  };

Constructor & Destructor Documentation

Pressure() [1/3]

mars::Pressure::Pressure ( )

default

Default constructor initializing values to 0, and type to Type::GAS.

Pressure() [2/3]

mars::Pressure::Pressure ( double  pressure )

inline

Detailed constructor with pressure value.

Parameters

pressure	measured pressure value
temperature	temperature at time of measurement
type	Type of measurement

                            : data_(pressure)
  {
  }

Pressure() [3/3]

mars::Pressure::Pressure ( double  pressure, double  temperature, Type  type  )

inline

Detailed constructor.

Parameters

pressure	measured pressure value
temperature	temperature at time of measurement
type	Type of measurement

                                                           : data_(pressure), temperature_K_(temperature), type_(type)
  {
  }

Member Function Documentation

operator+()

Pressure mars::Pressure::operator+ ( const Pressure &  pressure )

inline

  {
    return { data_ + pressure.data_, temperature_K_ + pressure.temperature_K_, type_ };
  }

operator+=()

void mars::Pressure::operator+= ( const Pressure &  pressure )

inline

  {
    data_ += pressure.data_;
    temperature_K_ += pressure.temperature_K_;
  }

operator/=()

void mars::Pressure::operator/= ( const double &  n )

inline

  {
    if (n == 0)
    {
      throw std::overflow_error("Divide by zero exception");
    }
    data_ /= n;
    temperature_K_ /= n;
  }

Friends And Related Symbol Documentation

operator<< [1/2]

std::ostream & operator<< ( std::ostream &  out, const Type &  type  )

friend

operator<< [2/2]

std::ostream & operator<< ( std::ostream &  out, const Pressure &  pressure  )

friend

Member Data Documentation

data_

double mars::Pressure::data_ { 0 }

measurement data

{ 0 };           

temperature_K_

double mars::Pressure::temperature_K_ { 0 }

ambient temperature when measurement data was observed

{ 0 };  

type_

Type mars::Pressure::type_ { Type::GAS }

type of the measurement

{ Type::GAS };     

---

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

• pressure_conversion.h