mars::PressureInit Class Reference

Pressure initalization object to calcualte mean initial pressure. More...

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

Collaboration diagram for mars::PressureInit:

Public Member Functions
	PressureInit ()=default
	PressureInit (const double &init_duration)
void	Reset ()
Pressure	get_press_mean (const std::shared_ptr< SensorAbsClass > &sensor_handle, const Buffer &buffer, const Pressure &cur_meas, const Time &cur_time)
	Calculates the mean pressure of the given sensor_handles's measurement.
bool	IsDone ()

Private Attributes
double	init_duration_ { 1.0 }
	Duration in sec used to average initialization.
bool	b_is_initialized_ { false }
	Flag to determine if initialization was performed successfully.
bool	b_verbose_ { false }
	Flag to enable verbos output.

Detailed Description

Pressure initalization object to calcualte mean initial pressure.

Constructor & Destructor Documentation

PressureInit() [1/2]

mars::PressureInit::PressureInit ( )

default

PressureInit() [2/2]

mars::PressureInit::PressureInit

(

const double &

init_duration

)

Parameters

init_duration

Duration in seconds used to calculate mean over. Use 0.0 if only the last measurement should be used.

Member Function Documentation

Reset()

void mars::PressureInit::Reset

(

)

get_press_mean()

Pressure mars::PressureInit::get_press_mean	(	const std::shared_ptr< SensorAbsClass > &	sensor_handle,
		const Buffer &	buffer,
		const Pressure &	cur_meas,
		const Time &	cur_time
	)

Calculates the mean pressure of the given sensor_handles's measurement.

Parameters

sensor_handle	mars::SensorAbsClass sensor handle describing which's sensor measurements to use
buffer	mars::Buffer with measurements stored
cur_meas	current measurement (latest)
cur_time	current time (to calcualte mean given the init_duration_)

Returns

Pressure mean pressure

IsDone()

bool mars::PressureInit::IsDone

(

)

Member Data Documentation

init_duration_

double mars::PressureInit::init_duration_ { 1.0 }

private

Duration in sec used to average initialization.

{ 1.0 };     

b_is_initialized_

bool mars::PressureInit::b_is_initialized_ { false }

private

Flag to determine if initialization was performed successfully.

{ false };  

b_verbose_

bool mars::PressureInit::b_verbose_ { false }

private

Flag to enable verbos output.

{ false };         

---

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

• pressure_utils.h