LABUST::MICROSTRAIN::GX3 Class Reference

#include <GX3.hpp>

List of all members.

Public Types
enum	Mode { Continuous, Active, Idle }
Public Member Functions
	GX3 (const std::string &portName, int baud=115200)
double	heading ()
Mode	mode ()
void	mode (Mode mode)
Private Member Functions
void	checkFirmware ()
void	connect (const std::string &portName, int baud)
void	readConfiguration ()
Private Attributes
boost::asio::io_service	io
Mode	mode_
boost::asio::serial_port	port
Static Private Attributes
static const size_t	supportedFirmware

---

Detailed Description

This class implements the class abstraction for the 3DM-GX3-25 AHRS sensor.

Definition at line 21 of file GX3.hpp.

---

Member Enumeration Documentation

enum LABUST::MICROSTRAIN::GX3::Mode

The GX3 operation modes.

Enumerator:

Continuous
Active
Idle

Definition at line 31 of file GX3.hpp.

---

Constructor & Destructor Documentation

GX3::GX3	(	const std::string &	portName,
		int	baud = 115200
	)

Main constructor. Opens the sensor at the desired port.

Parameters:

portName	Name of the serial port for the GX3 device.
baud	Baudrate to use for the communication. Defaults to 115200.

Definition at line 17 of file GX3.cpp.

---

Member Function Documentation

void GX3::checkFirmware

(

)

[private]

Read and check the device firmware.

Definition at line 53 of file GX3.cpp.

void GX3::connect	(	const std::string &	portName,
		int	baud
	)		[private]

This performs connection to the device.

Parameters:

portName	Name of the serial port for the GX3 device.
baud	Baudrate to use for the communication. Defaults to 115200.

Definition at line 26 of file GX3.cpp.

double GX3::heading

(

)

Added preliminary for testing

Definition at line 64 of file GX3.cpp.

Mode LABUST::MICROSTRAIN::GX3::mode

(

)

[inline]

Returns a the mode of operation.

Definition at line 43 of file GX3.hpp.

void LABUST::MICROSTRAIN::GX3::mode

(

Mode

mode

)

[inline]

Sets the desired mode of operation.

Definition at line 47 of file GX3.hpp.

void LABUST::MICROSTRAIN::GX3::readConfiguration

(

)

[private]

Read the configuration of the device.

---

Member Data Documentation

boost::asio::io_service LABUST::MICROSTRAIN::GX3::io [private]

Input/output service for the serial port.

Definition at line 74 of file GX3.hpp.

Mode LABUST::MICROSTRAIN::GX3::mode_ [private]

Mode of operation

Definition at line 83 of file GX3.hpp.

boost::asio::serial_port LABUST::MICROSTRAIN::GX3::port [private]

Serial port for the device.

Definition at line 78 of file GX3.hpp.

const size_t GX3::supportedFirmware [static, private]

Supported firmware version.

Definition at line 26 of file GX3.hpp.

---

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

• GX3.hpp
• GX3.cpp