mars::BufferDataType Class Reference

The BufferDataType binds the core and sensor state in form of a shared void pointer. More...

#include </home/runner/work/mars_lib/mars_lib/source/mars/include/mars/type_definitions/buffer_data_type.h>

Collaboration diagram for mars::BufferDataType:

Public Member Functions
	BufferDataType ()=default
	BufferDataType (std::shared_ptr< void > meas)
	BufferDataType. More...
	BufferDataType (std::shared_ptr< void > core, std::shared_ptr< void > sensor)
void	set_core_state (std::shared_ptr< void > core)
void	set_sensor_state (std::shared_ptr< void > sensor)
void	set_states (std::shared_ptr< void > core, std::shared_ptr< void > sensor)
void	set_measurement (std::shared_ptr< void > meas)
void	ClearStates (void)
bool	HasCoreStates (void) const
bool	HasSensorStates (void) const
bool	HasStates (void) const

Public Attributes
std::shared_ptr< void >	core_state_ { nullptr }
	Core state data. More...
std::shared_ptr< void >	sensor_state_ { nullptr }
	Sensor state data. More...
std::shared_ptr< void >	measurement_ { nullptr }
	Sensor measurement. More...

Private Attributes
bool	has_core_state_ = { false }
bool	has_sensor_state_ = { false }

Detailed Description

The BufferDataType binds the core and sensor state in form of a shared void pointer.

This shared pointer is of type void to allow generalized storage of different sensor and core data types. The need for the versatility of data types is caused by the fact that sensor measurements can not be stored with a common base class since the input and output parameter differ for each class. A high-level class such as the PoseSensorClass needs to keep track of the type such that it can cast the data before it is used.

An entry always contains a measurement, if has_state is true, then the entry also has a core state. Not all entrys have sensor states.

Attention

Shared pointer should be passed by value to ensure the correct reference count. Further, using the move operator saves two internal atomic copys of the shared pointer and is more efficient.

Remarks

Implementation: Done, Testing: Open

Constructor & Destructor Documentation

BufferDataType() [1/3]

mars::BufferDataType::BufferDataType ( )

default

BufferDataType() [2/3]

mars::BufferDataType::BufferDataType ( std::shared_ptr< void >  meas )

inline

BufferDataType.

Parameters

core	this data field holds the core state data
sensor	this data field holds the sensor state or measurement data

Note

Return/pass smart pointers by value

  {
    set_measurement(meas);
  }

Here is the call graph for this function:

BufferDataType() [3/3]

mars::BufferDataType::BufferDataType ( std::shared_ptr< void >  core, std::shared_ptr< void >  sensor  )

inline

  {
    set_states(core, sensor);
  }

Here is the call graph for this function:

Member Function Documentation

set_core_state()

void mars::BufferDataType::set_core_state ( std::shared_ptr< void >  core )

inline

  {
    core_state_ = core;
    has_core_state_ = true;
  }

Here is the caller graph for this function:

set_sensor_state()

void mars::BufferDataType::set_sensor_state ( std::shared_ptr< void >  sensor )

inline

  {
    sensor_state_ = sensor;
    has_sensor_state_ = true;
  }

Here is the caller graph for this function:

set_states()

void mars::BufferDataType::set_states ( std::shared_ptr< void >  core, std::shared_ptr< void >  sensor  )

inline

  {
    set_core_state(core);
    set_sensor_state(sensor);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

set_measurement()

void mars::BufferDataType::set_measurement ( std::shared_ptr< void >  meas )

inline

  {
    measurement_ = meas;
  }

Here is the caller graph for this function:

ClearStates()

void mars::BufferDataType::ClearStates ( void  )

inline

  {
    core_state_ = nullptr;
    sensor_state_ = nullptr;
    has_core_state_ = false;
    has_sensor_state_ = false;
  }

HasCoreStates()

bool mars::BufferDataType::HasCoreStates ( void  ) const

inline

  {
    return has_core_state_;
  }

Here is the caller graph for this function:

HasSensorStates()

bool mars::BufferDataType::HasSensorStates ( void  ) const

inline

  {
    return has_sensor_state_;
  }

Here is the caller graph for this function:

HasStates()

bool mars::BufferDataType::HasStates ( void  ) const

inline

  {
    return HasCoreStates() || HasSensorStates();
  }

Here is the call graph for this function:

Member Data Documentation

core_state_

std::shared_ptr<void> mars::BufferDataType::core_state_ { nullptr }

Core state data.

sensor_state_

std::shared_ptr<void> mars::BufferDataType::sensor_state_ { nullptr }

Sensor state data.

measurement_

std::shared_ptr<void> mars::BufferDataType::measurement_ { nullptr }

Sensor measurement.

has_core_state_

bool mars::BufferDataType::has_core_state_ = { false }

private

has_sensor_state_

bool mars::BufferDataType::has_sensor_state_ = { false }

private

---

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

• buffer_data_type.h