iRobot Namespace Reference

Main namespace. More...

Classes
class	Create
	Robot communication class, wraps Open Interface version 2. More...
Functions
	IROBOT_MAKE_EXCEPTION (CommandNotAvailable,"This command is not available in this mode.")
	Error thrown when the command is not valid in the current mode.
	IROBOT_MAKE_EXCEPTION (InvalidArgument,"This argument is invalid.")
	Exception thrown when an argument's value is invalid. Typically, it means that an argument is out of bound.
	IROBOT_MAKE_EXCEPTION (LibSerialNotAvailable,"Serial port support has not been compiled.")
	Exception thrown if no serial port support is available but one tries to use the feature anyway.

---

Detailed Description

Main namespace.

HAVE_LIBSERIAL.

The namespace gathers all the classes of this library.

---

Function Documentation

iRobot::IROBOT_MAKE_EXCEPTION	(	LibSerialNotAvailable	,
		"Serial port support has not been compiled."
	)

Exception thrown if no serial port support is available but one tries to use the feature anyway.

iRobot::IROBOT_MAKE_EXCEPTION	(	InvalidArgument	,
		"This argument is invalid."
	)

Exception thrown when an argument's value is invalid. Typically, it means that an argument is out of bound.

iRobot::IROBOT_MAKE_EXCEPTION	(	CommandNotAvailable	,
		"This command is not available in this mode."
	)

Error thrown when the command is not valid in the current mode.

The Create class never changes the mode behind your back, so you have to make sure that the command you want to send is supported by the current mode.

See also:

Create::sendStartCommand

Create::sendSafeCommand

Create::sendFullCommand

---