duds::data::QuantityXyz Struct Reference

A QuantityArray for the common usage of a three dimentional coordinate or a triple axis sample. More...

#include <QuantityArray.hpp>

Inheritance diagram for duds::data::QuantityXyz:

Collaboration diagram for duds::data::QuantityXyz:

Public Member Functions
double &	x ()
	Returns the scalar value for the X-axis. More...
const double &	x () const
	Returns the scalar value for the X-axis. More...
Quantity	xQ () const
	Returns the Quantity for the X-axis. More...
double &	y ()
	Returns the scalar value for the Y-axis. More...
const double &	y () const
	Returns the scalar value for the Y-axis. More...
Quantity	yQ () const
	Returns the Quantity for the Y-axis. More...
double &	z ()
	Returns the scalar value for the Z-axis. More...
const double &	z () const
	Returns the scalar value for the Z-axis. More...
Quantity	zQ () const
	Returns the Quantity for the Z-axis. More...
Public Member Functions inherited from duds::data::QuantityArray< 3 >
iterator	begin ()
const_iterator	begin () const
const_iterator	cbegin () const
const_iterator	cend () const
QuantityArray &	copy (const QuantityArray< N > &a)
	Copies one QuantityArray into another; sizes do not need to match. More...
iterator	end ()
const_iterator	end () const
Quantity	get (std::size_t pos) const
	Returns a new Quantity object for the requested position. More...
QuantityArray &	operator= (const QuantityArray &a)=default
	Copies one QuantityArray into another for an exact match. More...
QuantityArray &	operator= (const QuantityNddArray &a)
	Copies the contents of a QuantityNddArray into this object. More...
void	set (std::size_t pos, const Quantity &q)
	Sets a stored quantity to be the same as given Quantity object. More...

Additional Inherited Members
Public Types inherited from duds::data::QuantityArray< 3 >
typedef std::array< double, L >	Array
	The type of the array holding quantity values. More...
typedef QuantityIterator< typename Array::const_iterator >	const_iterator
	A const iterator type that will yield Quantity objects when dereferenced. More...
typedef QuantityIterator< typename Array::iterator >	iterator
	An iterator type that will yield Quantity objects when dereferenced. More...
Public Attributes inherited from duds::data::QuantityArray< 3 >
Array	array
	The array of quantity values. More...
Unit	unit
	The units of all values in the array. More...

Detailed Description

A QuantityArray for the common usage of a three dimentional coordinate or a triple axis sample.

Author

Jeff Jackowski

Definition at line 218 of file QuantityArray.hpp.

Member Function Documentation

x() [1/2]

double& duds::data::QuantityXyz::x ( )

inline

Returns the scalar value for the X-axis.

Definition at line 222 of file QuantityArray.hpp.

Referenced by duds::hardware::devices::instruments::LSM9DS1AccelGyro::accelerometerQuantity(), duds::hardware::devices::instruments::LSM9DS1AccelGyro::gyroscopeQuantity(), and duds::hardware::devices::instruments::LSM9DS1Mag::quantity().

x() [2/2]

const double& duds::data::QuantityXyz::x ( ) const

inline

Returns the scalar value for the X-axis.

Definition at line 228 of file QuantityArray.hpp.

xQ()

Quantity duds::data::QuantityXyz::xQ ( ) const

inline

Returns the Quantity for the X-axis.

Definition at line 258 of file QuantityArray.hpp.

y() [1/2]

double& duds::data::QuantityXyz::y ( )

inline

Returns the scalar value for the Y-axis.

Definition at line 234 of file QuantityArray.hpp.

Referenced by duds::hardware::devices::instruments::LSM9DS1AccelGyro::accelerometerQuantity(), duds::hardware::devices::instruments::LSM9DS1AccelGyro::gyroscopeQuantity(), and duds::hardware::devices::instruments::LSM9DS1Mag::quantity().

y() [2/2]

const double& duds::data::QuantityXyz::y ( ) const

inline

Returns the scalar value for the Y-axis.

Definition at line 240 of file QuantityArray.hpp.

yQ()

Quantity duds::data::QuantityXyz::yQ ( ) const

inline

Returns the Quantity for the Y-axis.

Definition at line 264 of file QuantityArray.hpp.

z() [1/2]

double& duds::data::QuantityXyz::z ( )

inline

Returns the scalar value for the Z-axis.

Definition at line 246 of file QuantityArray.hpp.

Referenced by duds::hardware::devices::instruments::LSM9DS1AccelGyro::accelerometerQuantity(), duds::hardware::devices::instruments::LSM9DS1AccelGyro::gyroscopeQuantity(), and duds::hardware::devices::instruments::LSM9DS1Mag::quantity().

z() [2/2]

const double& duds::data::QuantityXyz::z ( ) const

inline

Returns the scalar value for the Z-axis.

Definition at line 252 of file QuantityArray.hpp.

zQ()

Quantity duds::data::QuantityXyz::zQ ( ) const

inline

Returns the Quantity for the Z-axis.

Definition at line 270 of file QuantityArray.hpp.

---

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

• QuantityArray.hpp