goby::acomms::MMDriver Class Reference

provides an API to the WHOI Micro-Modem driver More...

#include <goby/acomms/modem_driver.h>

Inherits goby::acomms::ModemDriverBase.

List of all members.

Public Member Functions
	MMDriver (std::ostream *log=0)
	Default constructor.
	~MMDriver ()
	Destructor.
void	startup (const protobuf::DriverConfig &cfg)
	Starts the driver.
void	shutdown ()
	Shuts down the modem driver.
void	do_work ()
	Must be called regularly for the driver to perform its work. 10 Hz is good, but less frequently is fine too. Signals will be emitted only during calls to this method.
void	handle_initiate_transmission (protobuf::ModemMsgBase *m)
	Initiate a transmission to the modem.
void	handle_initiate_ranging (protobuf::ModemRangingRequest *m)
	Initiate ranging ("ping") to the modem.

---

Detailed Description

provides an API to the WHOI Micro-Modem driver

Examples:

acomms/chat/chat.cpp, and libmodemdriver/driver_simple/driver_simple.cpp.

Definition at line 37 of file mm_driver.h.

---

Constructor & Destructor Documentation

goby::acomms::MMDriver::MMDriver

(

std::ostream *

log = 0

)

Default constructor.

Parameters:

log	std::ostream object or FlexOstream to capture all humanly readable runtime and debug information (optional).

Definition at line 52 of file mm_driver.cpp.

---

Member Function Documentation

void goby::acomms::MMDriver::startup

(

const protobuf::DriverConfig &

cfg

)

[virtual]

Starts the driver.

Parameters:

cfg	Configuration for the Micro-Modem driver. DriverConfig is defined in driver_base.proto, and various extensions specific to the WHOI Micro-Modem are defined in mm_driver.proto.

Implements goby::acomms::ModemDriverBase.

Definition at line 68 of file mm_driver.cpp.

---

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

• acomms/libmodemdriver/mm_driver.h
• acomms/libmodemdriver/mm_driver.cpp