icarus::QuatHandle< Scalar > Struct Template Reference

Handle for accessing a quaternion signal as four scalar components. More...

#include <VecHandle.hpp>

Collaboration diagram for icarus::QuatHandle< Scalar >:

Public Member Functions
Vec4< Scalar >	get () const
	Read all components as a Vec4 (w, x, y, z order).
void	set (const Vec4< Scalar > &q)
	Write all components from a Vec4 (w, x, y, z order).
bool	valid () const
	Check if all handles are valid.
	operator bool () const
	Check if handle is valid.

Public Attributes
SignalHandle< Scalar >	w
	W (scalar) component handle.
SignalHandle< Scalar >	x
	X component handle.
SignalHandle< Scalar >	y
	Y component handle.
SignalHandle< Scalar >	z
	Z component handle.

Detailed Description

template<typename Scalar>
struct icarus::QuatHandle< Scalar >

Handle for accessing a quaternion signal as four scalar components.

Template Parameters

Scalar

The scalar type (double or casadi::MX)

Member Function Documentation

get()

template<typename Scalar>

Vec4< Scalar > icarus::QuatHandle< Scalar >::get ( ) const

inlinenodiscard

Read all components as a Vec4 (w, x, y, z order).

operator bool()

template<typename Scalar>

icarus::QuatHandle< Scalar >::operator bool ( ) const

inlineexplicit

Check if handle is valid.

set()

template<typename Scalar>

void icarus::QuatHandle< Scalar >::set ( const Vec4< Scalar > & q )

inline

Write all components from a Vec4 (w, x, y, z order).

valid()

template<typename Scalar>

bool icarus::QuatHandle< Scalar >::valid ( ) const

inlinenodiscard

Check if all handles are valid.

Member Data Documentation

w

template<typename Scalar>

SignalHandle<Scalar> icarus::QuatHandle< Scalar >::w

W (scalar) component handle.

x

template<typename Scalar>

SignalHandle<Scalar> icarus::QuatHandle< Scalar >::x

X component handle.

y

template<typename Scalar>

SignalHandle<Scalar> icarus::QuatHandle< Scalar >::y

Y component handle.

z

template<typename Scalar>

SignalHandle<Scalar> icarus::QuatHandle< Scalar >::z

Z component handle.

---

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

• include/icarus/signal/VecHandle.hpp