Class inertialsim::sensors::Parameter¶

template <typename ValueType>

ClassList > inertialsim > sensors > Parameter

Public Functions¶

Type	Name
Parameter	AsStandardUnits () const Return a new parameter in SI units.
	Parameter (const type_identity_t< ValueType > & value, const std::string & units="")
	Parameter (const Eigen::ArrayBase< Derived > & array, const std::string & units="")
	Parameter (const Eigen::MatrixBase< Derived > & matrix, const std::string & units="")
	Parameter (std::initializer_list< double > init_list, const std::string & units="")
	Parameter (std::initializer_list< std::initializer_list< double > > init_list, const std::string & units="")
auto	PerAxis (const int axes) const
std::string	units () const
ValueType	value () const

Public Functions Documentation¶

function AsStandardUnits¶

Return a new parameter in SI units.

Parameter inertialsim::sensors::Parameter::AsStandardUnits () const

Returns a new Parameter object with the value and units fields converted to SI units.

Warning:

This function only supports common inertial sensor units. It does not support conversion of arbitrary units. The numerator of the units string can include any of "deg" for degrees, "%", "ppm" for parts-per-million, "ft" for feet, "gauss" for magnetic field, or "g" for units of standard gravity. The denominator(s) can include any of "/h" for per hour, "/sqrt(h)" for per square-root hour, "/s/sqrt(Hz)" for per second per square root Hertz and "/F" for per degree Fahrenheit.

Returns:

New Parameter instance with promoted type (arithmetic types and Eigen types with non-double scalars become double). The original is unchanged.

function Parameter [⅕]¶

inline explicit inertialsim::sensors::Parameter::Parameter (
    const type_identity_t< ValueType > & value,
    const std::string & units=""
)

function Parameter [⅖]¶

template<typename Derived, typename>
inline explicit inertialsim::sensors::Parameter::Parameter (
    const Eigen::ArrayBase< Derived > & array,
    const std::string & units=""
)

function Parameter [⅗]¶

template<typename Derived, typename>
inline explicit inertialsim::sensors::Parameter::Parameter (
    const Eigen::MatrixBase< Derived > & matrix,
    const std::string & units=""
)

function Parameter [⅘]¶

template<typename T, typename>
inline inertialsim::sensors::Parameter::Parameter (
    std::initializer_list< double > init_list,
    const std::string & units=""
)

function Parameter [5/5]¶

template<typename T, typename>
inline inertialsim::sensors::Parameter::Parameter (
    std::initializer_list< std::initializer_list< double > > init_list,
    const std::string & units=""
)

function PerAxis¶

inline auto inertialsim::sensors::Parameter::PerAxis (
    const int axes
) const

function units¶

inline std::string inertialsim::sensors::Parameter::units () const

function value¶

inline ValueType inertialsim::sensors::Parameter::value () const

The documentation for this class was generated from the following file cpp/include/inertialsim/sensors/parameter.h