redux::sensors::canandgyro::details::setting Namespace Reference

Enumerations
enum	: uint8_t {   kStatusFramePeriod = 0x4 , kSerialNumber = 0x5 , kFirmwareVersion = 0x6 , kDeviceType = 0x8 ,   kYawFramePeriod = 0xff , kAngularPositionFramePeriod = 0xfe , kAngularVelocityFramePeriod = 0xfd , kAccelerationFramePeriod = 0xfc ,   kSetYaw = 0xfb , kSetPosePositiveW = 0xfa , kSetPoseNegativeW = 0xf9 }

Functions
uint64_t	constructStatusFramePeriod (uint16_t data)
uint16_t	extractStatusFramePeriod (uint64_t data)
uint64_t	constructSerialNumber (uint64_t data)
uint64_t	extractSerialNumber (uint64_t data)
uint64_t	constructFirmwareVersion (types::FirmwareVersion data)
types::FirmwareVersion	extractFirmwareVersion (uint64_t data)
uint64_t	constructDeviceType (uint16_t data)
uint16_t	extractDeviceType (uint64_t data)
uint64_t	constructYawFramePeriod (uint16_t data)
uint16_t	extractYawFramePeriod (uint64_t data)
uint64_t	constructAngularPositionFramePeriod (uint16_t data)
uint16_t	extractAngularPositionFramePeriod (uint64_t data)
uint64_t	constructAngularVelocityFramePeriod (uint16_t data)
uint16_t	extractAngularVelocityFramePeriod (uint64_t data)
uint64_t	constructAccelerationFramePeriod (uint16_t data)
uint16_t	extractAccelerationFramePeriod (uint64_t data)
uint64_t	constructSetYaw (types::Yaw data)
types::Yaw	extractSetYaw (uint64_t data)
uint64_t	constructSetPosePositiveW (types::QuatXyz data)
types::QuatXyz	extractSetPosePositiveW (uint64_t data)
uint64_t	constructSetPoseNegativeW (types::QuatXyz data)
types::QuatXyz	extractSetPoseNegativeW (uint64_t data)

Variables
const std::vector< uint8_t >	VDEP_SETTINGS

Detailed Description

Settings.

Enumeration Type Documentation

anonymous enum

anonymous enum : uint8_t

Enumerator
kStatusFramePeriod	Status frame period (ms)
kSerialNumber	Serial number
kFirmwareVersion	Firmware version
kDeviceType	Device-specific type identifier
kYawFramePeriod	Yaw angle frame period (ms)
kAngularPositionFramePeriod	Angular position frame period (ms)
kAngularVelocityFramePeriod	Angular velocity frame period (ms)
kAccelerationFramePeriod	Acceleration frame period (ms)
kSetYaw	Set yaw
kSetPosePositiveW	Set (normed) quaternion assuming positive W
kSetPoseNegativeW	Set (normed) quaternion assuming negative W

Function Documentation

constructAccelerationFramePeriod()

uint64_t redux::sensors::canandgyro::details::setting::constructAccelerationFramePeriod ( uint16_t  data )

inline

Construct setting ACCELERATION_FRAME_PERIOD

Parameters

data	the data to pack into a setting bitfield

Returns

48-bit data field of settings in the wire format

constructAngularPositionFramePeriod()

uint64_t redux::sensors::canandgyro::details::setting::constructAngularPositionFramePeriod ( uint16_t  data )

inline

Construct setting ANGULAR_POSITION_FRAME_PERIOD

Parameters

data	the data to pack into a setting bitfield

Returns

48-bit data field of settings in the wire format

constructAngularVelocityFramePeriod()

uint64_t redux::sensors::canandgyro::details::setting::constructAngularVelocityFramePeriod ( uint16_t  data )

inline

Construct setting ANGULAR_VELOCITY_FRAME_PERIOD

Parameters

data	the data to pack into a setting bitfield

Returns

48-bit data field of settings in the wire format

constructDeviceType()

uint64_t redux::sensors::canandgyro::details::setting::constructDeviceType ( uint16_t  data )

inline

Construct setting DEVICE_TYPE

Parameters

data	the data to pack into a setting bitfield

Returns

48-bit data field of settings in the wire format

constructFirmwareVersion()

uint64_t redux::sensors::canandgyro::details::setting::constructFirmwareVersion ( types::FirmwareVersion  data )

inline

Construct setting FIRMWARE_VERSION

Parameters

data	the data to pack into a setting bitfield

Returns

48-bit data field of settings in the wire format

constructSerialNumber()

uint64_t redux::sensors::canandgyro::details::setting::constructSerialNumber ( uint64_t  data )

inline

Construct setting SERIAL_NUMBER

Parameters

data	the data to pack into a setting bitfield

Returns

48-bit data field of settings in the wire format

constructSetPoseNegativeW()

uint64_t redux::sensors::canandgyro::details::setting::constructSetPoseNegativeW ( types::QuatXyz  data )

inline

Construct setting SET_POSE_NEGATIVE_W

Parameters

data	the data to pack into a setting bitfield

Returns

48-bit data field of settings in the wire format

constructSetPosePositiveW()

uint64_t redux::sensors::canandgyro::details::setting::constructSetPosePositiveW ( types::QuatXyz  data )

inline

Construct setting SET_POSE_POSITIVE_W

Parameters

data	the data to pack into a setting bitfield

Returns

48-bit data field of settings in the wire format

constructSetYaw()

uint64_t redux::sensors::canandgyro::details::setting::constructSetYaw ( types::Yaw  data )

inline

Construct setting SET_YAW

Parameters

data	the data to pack into a setting bitfield

Returns

48-bit data field of settings in the wire format

constructStatusFramePeriod()

uint64_t redux::sensors::canandgyro::details::setting::constructStatusFramePeriod ( uint16_t  data )

inline

Construct setting STATUS_FRAME_PERIOD

Parameters

data	the data to pack into a setting bitfield

Returns

48-bit data field of settings in the wire format

constructYawFramePeriod()

uint64_t redux::sensors::canandgyro::details::setting::constructYawFramePeriod ( uint16_t  data )

inline

Construct setting YAW_FRAME_PERIOD

Parameters

data	the data to pack into a setting bitfield

Returns

48-bit data field of settings in the wire format

extractAccelerationFramePeriod()

uint16_t redux::sensors::canandgyro::details::setting::extractAccelerationFramePeriod ( uint64_t  data )

inline

Unpack setting ACCELERATION_FRAME_PERIOD from the wire format.

Parameters

data	the 48-bit data field to extract a setting struct from.

Returns

a setting struct

extractAngularPositionFramePeriod()

uint16_t redux::sensors::canandgyro::details::setting::extractAngularPositionFramePeriod ( uint64_t  data )

inline

Unpack setting ANGULAR_POSITION_FRAME_PERIOD from the wire format.

Parameters

data	the 48-bit data field to extract a setting struct from.

Returns

a setting struct

extractAngularVelocityFramePeriod()

uint16_t redux::sensors::canandgyro::details::setting::extractAngularVelocityFramePeriod ( uint64_t  data )

inline

Unpack setting ANGULAR_VELOCITY_FRAME_PERIOD from the wire format.

Parameters

data	the 48-bit data field to extract a setting struct from.

Returns

a setting struct

extractDeviceType()

uint16_t redux::sensors::canandgyro::details::setting::extractDeviceType ( uint64_t  data )

inline

Unpack setting DEVICE_TYPE from the wire format.

Parameters

data	the 48-bit data field to extract a setting struct from.

Returns

a setting struct

extractFirmwareVersion()

types::FirmwareVersion redux::sensors::canandgyro::details::setting::extractFirmwareVersion ( uint64_t  data )

inline

Unpack setting FIRMWARE_VERSION from the wire format.

Parameters

data	the 48-bit data field to extract a setting struct from.

Returns

a setting struct

extractSerialNumber()

uint64_t redux::sensors::canandgyro::details::setting::extractSerialNumber ( uint64_t  data )

inline

Unpack setting SERIAL_NUMBER from the wire format.

Parameters

data	the 48-bit data field to extract a setting struct from.

Returns

a setting struct

extractSetPoseNegativeW()

types::QuatXyz redux::sensors::canandgyro::details::setting::extractSetPoseNegativeW ( uint64_t  data )

inline

Unpack setting SET_POSE_NEGATIVE_W from the wire format.

Parameters

data	the 48-bit data field to extract a setting struct from.

Returns

a setting struct

extractSetPosePositiveW()

types::QuatXyz redux::sensors::canandgyro::details::setting::extractSetPosePositiveW ( uint64_t  data )

inline

Unpack setting SET_POSE_POSITIVE_W from the wire format.

Parameters

data	the 48-bit data field to extract a setting struct from.

Returns

a setting struct

extractSetYaw()

types::Yaw redux::sensors::canandgyro::details::setting::extractSetYaw ( uint64_t  data )

inline

Unpack setting SET_YAW from the wire format.

Parameters

data	the 48-bit data field to extract a setting struct from.

Returns

a setting struct

extractStatusFramePeriod()

uint16_t redux::sensors::canandgyro::details::setting::extractStatusFramePeriod ( uint64_t  data )

inline

Unpack setting STATUS_FRAME_PERIOD from the wire format.

Parameters

data	the 48-bit data field to extract a setting struct from.

Returns

a setting struct

extractYawFramePeriod()

uint16_t redux::sensors::canandgyro::details::setting::extractYawFramePeriod ( uint64_t  data )

inline

Unpack setting YAW_FRAME_PERIOD from the wire format.

Parameters

data	the 48-bit data field to extract a setting struct from.

Returns

a setting struct

Variable Documentation

VDEP_SETTINGS

const std::vector<uint8_t> redux::sensors::canandgyro::details::setting::VDEP_SETTINGS

Initial value:

= {
            kStatusFramePeriod,
            kSerialNumber,
            kFirmwareVersion,
            kDeviceType,
            kYawFramePeriod,
            kAngularPositionFramePeriod,
            kAngularVelocityFramePeriod,
            kAccelerationFramePeriod,
        }

Settings that are required for the vdep to flag all values as received.