HiTechnicCompass Class Reference

#include <HiTechnicCompass.h>

Inheritance diagram for HiTechnicCompass:

Collaboration diagram for HiTechnicCompass:

Public Member Functions
	HiTechnicCompass (uint8_t moduleNumber)
virtual	~HiTechnicCompass ()
float	GetAngle ()
void	UpdateTable ()
void	StartLiveWindowMode ()
void	StopLiveWindowMode ()
std::string	GetSmartDashboardType ()
void	InitTable (ITable *subTable)
ITable *	GetTable ()
Public Member Functions inherited from SensorBase
	SensorBase ()
virtual	~SensorBase ()
Public Member Functions inherited from ErrorBase
virtual Error &	GetError ()
	Retrieve the current error. Get the current error information associated with this sensor.
virtual const Error &	GetError () const
virtual void	SetErrnoError (const char *contextMessage, const char *filename, const char *function, uint32_t lineNumber) const
	Set error information associated with a C library call that set an error to the "errno" global variable. More...
virtual void	SetImaqError (int success, const char *contextMessage, const char *filename, const char *function, uint32_t lineNumber) const
	Set the current error information associated from the nivision Imaq API. More...
virtual void	SetError (Error::Code code, const char *contextMessage, const char *filename, const char *function, uint32_t lineNumber) const
	Set the current error information associated with this sensor. More...
virtual void	SetWPIError (const char *errorMessage, const char *contextMessage, const char *filename, const char *function, uint32_t lineNumber) const
	Set the current error information associated with this sensor. More...
virtual void	CloneError (ErrorBase *rhs) const
virtual void	ClearError () const
	Clear the current error information associated with this sensor.
virtual bool	StatusIsFatal () const
	Check if the current error code represents a fatal error. More...

Additional Inherited Members
Static Public Member Functions inherited from SensorBase
static void	DeleteSingletons ()
static uint32_t	GetDefaultAnalogModule ()
static uint32_t	GetDefaultDigitalModule ()
static uint32_t	GetDefaultSolenoidModule ()
static bool	CheckAnalogModule (uint8_t moduleNumber)
static bool	CheckDigitalModule (uint8_t moduleNumber)
static bool	CheckPWMModule (uint8_t moduleNumber)
static bool	CheckRelayModule (uint8_t moduleNumber)
static bool	CheckSolenoidModule (uint8_t moduleNumber)
static bool	CheckDigitalChannel (uint32_t channel)
static bool	CheckRelayChannel (uint32_t channel)
static bool	CheckPWMChannel (uint32_t channel)
static bool	CheckAnalogChannel (uint32_t channel)
static bool	CheckSolenoidChannel (uint32_t channel)
Static Public Member Functions inherited from ErrorBase
static void	SetGlobalError (Error::Code code, const char *contextMessage, const char *filename, const char *function, uint32_t lineNumber)
static void	SetGlobalWPIError (const char *errorMessage, const char *contextMessage, const char *filename, const char *function, uint32_t lineNumber)
static Error &	GetGlobalError ()
Static Public Attributes inherited from SensorBase
static const uint32_t	kSystemClockTicksPerMicrosecond = 40
static const uint32_t	kDigitalChannels = 14
static const uint32_t	kAnalogChannels = 8
static const uint32_t	kAnalogModules = 2
static const uint32_t	kDigitalModules = 2
static const uint32_t	kSolenoidChannels = 8
static const uint32_t	kSolenoidModules = 2
static const uint32_t	kPwmChannels = 10
static const uint32_t	kRelayChannels = 8
static const uint32_t	kChassisSlots = 8
Protected Member Functions inherited from SensorBase
void	AddToSingletonList ()
Protected Member Functions inherited from ErrorBase
	ErrorBase ()
	Initialize the instance status to 0 for now.
Protected Attributes inherited from ErrorBase
Error	m_error
Static Protected Attributes inherited from ErrorBase
static SEM_ID	_globalErrorMutex = semMCreate(SEM_Q_PRIORITY | SEM_DELETE_SAFE | SEM_INVERSION_SAFE)
static Error	_globalError

Detailed Description

HiTechnic NXT Compass.

This class alows access to a HiTechnic NXT Compass on an I2C bus. These sensors to not allow changing addresses so you cannot have more than one on a single bus.

Details on the sensor can be found here: http://www.hitechnic.com/index.html?lang=en-us&target=d17.html

Todo:

Implement a calibration method for the sensor.

Definition at line 27 of file HiTechnicCompass.h.

Constructor & Destructor Documentation

HiTechnicCompass::HiTechnicCompass ( uint8_t  moduleNumber )

explicit

Constructor.

Parameters

moduleNumber

The digital module that the sensor is plugged into (1 or 2).

Definition at line 26 of file HiTechnicCompass.cpp.

HiTechnicCompass::~HiTechnicCompass ( )

virtual

Destructor.

Definition at line 56 of file HiTechnicCompass.cpp.

Member Function Documentation

float HiTechnicCompass::GetAngle

(

void

)

Get the compass angle in degrees.

The resolution of this reading is 1 degree.

Returns

Angle of the compass in degrees.

Definition at line 69 of file HiTechnicCompass.cpp.

std::string HiTechnicCompass::GetSmartDashboardType ( )

virtual

Returns

the string representation of the named data type that will be used by the smart dashboard for this sendable

Implements Sendable.

Definition at line 96 of file HiTechnicCompass.cpp.

ITable * HiTechnicCompass::GetTable ( )

virtual

Returns

the table that is currently associated with the sendable

Implements Sendable.

Definition at line 105 of file HiTechnicCompass.cpp.

void HiTechnicCompass::InitTable ( ITable *  subtable )

virtual

Initializes a table for this sendable object.

Parameters

subtable

The table to put the values in.

Implements Sendable.

Definition at line 100 of file HiTechnicCompass.cpp.

void HiTechnicCompass::StartLiveWindowMode ( )

virtual

Start having this sendable object automatically respond to value changes reflect the value on the table.

Implements LiveWindowSendable.

Definition at line 88 of file HiTechnicCompass.cpp.

void HiTechnicCompass::StopLiveWindowMode ( )

virtual

Stop having this sendable object automatically respond to value changes.

Implements LiveWindowSendable.

Definition at line 92 of file HiTechnicCompass.cpp.

void HiTechnicCompass::UpdateTable ( )

virtual

Update the table for this sendable object with the latest values.

Implements LiveWindowSendable.

Definition at line 82 of file HiTechnicCompass.cpp.

---

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

• HiTechnicCompass.h
• HiTechnicCompass.cpp