hebi::Info::HighResAngleField Class Reference

A message field for an angle measurement which does not lose precision at very high angles. More...

#include <info.hpp>

Public Member Functions
double	get () const
	If the field has a value, returns that value as a double; otherwise, returns a default. More...
void	get (int64_t *revolutions, float *radian_offset) const
	If the field has a value, returns that value in the int64 and float parameters passed in; otherwise, returns a default. More...
bool	has () const
	True if (and only if) the field has a value. More...
	HighResAngleField (HebiInfoPtr internal, HebiInfoHighResAngleField field)
	operator bool () const
	Allows casting to a bool to check if the field has a value without directly calling has(). More...

Private Attributes
HebiInfoHighResAngleField const	field_
HebiInfoPtr const	internal_

Detailed Description

A message field for an angle measurement which does not lose precision at very high angles.

This field is represented as an int64_t for the number of revolutions and a float for the radian offset from that number of revolutions.

Definition at line 96 of file info.hpp.

Constructor & Destructor Documentation

hebi::Info::HighResAngleField::HighResAngleField	(	HebiInfoPtr	internal,
		HebiInfoHighResAngleField	field
	)

Definition at line 31 of file info.cpp.

Member Function Documentation

double hebi::Info::HighResAngleField::get

(

)

const

If the field has a value, returns that value as a double; otherwise, returns a default.

Note that some precision might be lost converting to a double at very high number of revolutions.

Definition at line 44 of file info.cpp.

void hebi::Info::HighResAngleField::get	(	int64_t *	revolutions,
		float *	radian_offset
	)		const

If the field has a value, returns that value in the int64 and float parameters passed in; otherwise, returns a default.

Note that this maintains the full precision of the underlying angle measurement, even for very large numbers of revolutions.

Parameters

revolutions	The number of full revolutions
radian_offset	The offset from the given number of full revolutions. Note that this is usually between 0 and 2*M_PI, but callers should not assume this.

Definition at line 58 of file info.cpp.

bool hebi::Info::HighResAngleField::has

(

)

const

True if (and only if) the field has a value.

Definition at line 39 of file info.cpp.

hebi::Info::HighResAngleField::operator bool ( ) const

explicit

Allows casting to a bool to check if the field has a value without directly calling has().

This can be used as in the following (assuming 'parent' is a parent message, and this field is called 'myField')

Info::HighResAngleField& f = parent.myField();
if (f)
  std::cout << "Field has value: " << f.get() << std::endl;
else
  std::cout << "Field has no value!" << std::endl;

Definition at line 34 of file info.cpp.

Member Data Documentation

HebiInfoHighResAngleField const hebi::Info::HighResAngleField::field_

private

Definition at line 138 of file info.hpp.

HebiInfoPtr const hebi::Info::HighResAngleField::internal_

private

Definition at line 137 of file info.hpp.

---

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

• info.hpp
• info.cpp