segway::FaultPacking Class Reference

#include <RmpFault.h>

List of all members.

Public Member Functions
	FaultPacking (const FaultPacking &rOther)
const FaultGroup &	GetGroup () const
const uint32_t &	GetMask () const
const uint32_t &	GetShift () const
FaultPacking &	operator= (const FaultPacking &rOther)
Private Member Functions
	FaultPacking (uint32_t shift, uint32_t mask, FaultGroup group)
	FaultPacking ()
Private Attributes
FaultGroup	m_Group
uint32_t	m_Mask
uint32_t	m_Shift
Friends
class	RmpFault

---

Detailed Description

This class describes how the status bits are packed in the feedback words Please read the rmp user manual (for instance, page 77 of the RMP 440LE manual)

Definition at line 77 of file RmpFault.h.

---

Constructor & Destructor Documentation

segway::FaultPacking::FaultPacking

(

const FaultPacking &

rOther

)

[inline]

Copy constructor

Parameters:

rOther

other instance of FaultPacking

Definition at line 86 of file RmpFault.h.

segway::FaultPacking::FaultPacking	(	uint32_t	shift,
		uint32_t	mask,
		FaultGroup	group
	)		[inline, private]

Constructor

Parameters:

shift	number of bits to shift
mask	bit mask
group	fault group

Definition at line 128 of file RmpFault.h.

segway::FaultPacking::FaultPacking

(

)

[inline, private]

Default constructor

Definition at line 137 of file RmpFault.h.

---

Member Function Documentation

const FaultGroup & segway::FaultPacking::GetGroup

(

)

const

Return fault group

Returns:

fault group

Definition at line 73 of file RmpFault.cpp.

const uint32_t & segway::FaultPacking::GetMask

(

)

const

Return mask member

Returns:

bit mask

Definition at line 68 of file RmpFault.cpp.

const uint32_t & segway::FaultPacking::GetShift

(

)

const

Return shift member

Returns:

bit shift

Definition at line 63 of file RmpFault.cpp.

FaultPacking& segway::FaultPacking::operator=

(

const FaultPacking &

rOther

)

[inline]

Assignment operator

Parameters:

rOther

other instance of FaultPacking

Definition at line 96 of file RmpFault.h.

---

Friends And Related Function Documentation

friend class RmpFault [friend]

Definition at line 79 of file RmpFault.h.

---

Member Data Documentation

FaultGroup segway::FaultPacking::m_Group [private]

Fault group

Definition at line 153 of file RmpFault.h.

uint32_t segway::FaultPacking::m_Mask [private]

Mask for the fault group

Definition at line 148 of file RmpFault.h.

uint32_t segway::FaultPacking::m_Shift [private]

Number of bits to shift in order to read the fault group

Definition at line 143 of file RmpFault.h.

---

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

• RmpFault.h
• RmpFault.cpp