/usr/src/rpm/BUILD/libirobot-create-0.1/src/irobot-create.hh File Reference

Declaration of the Create class. More...

#include <iostream>
#include <queue>
#include <stdexcept>
#include <utility>
#include <vector>
#include <irobot-create-fwd.hh>

Include dependency graph for irobot-create.hh:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	iRobot
Classes
class	iRobot::Create
	Robot communication class, wraps Open Interface version 2. More...
Defines
#define	IROBOT_MAKE_EXCEPTION(NAME, DESCRIPTION)
	Create an exception class which inherits from std::runtime_error.
Functions
	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.
	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 (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

Declaration of the Create class.

---

Define Documentation

#define IROBOT_MAKE_EXCEPTION	(	NAME,
		DESCRIPTION		)

Value:

struct NAME : public std::runtime_error                               \
  {                                                                     \
    explicit NAME ()                                                    \
      : std::runtime_error (DESCRIPTION)                                \
    {}                                                                  \
    explicit NAME (const std::string& what)                             \
      : std::runtime_error (what)                                       \
    {}                                                                  \
  }

Create an exception class which inherits from std::runtime_error.

The class inherits from std::runtime_error and is default constructible. The default error message is set by the DESCRIPTION parameter, a specific error message can also be set by passing a string to the constructor.

Parameters:

	NAME	Name of the generated exception class.
	DESCRIPTION	Default error message.

---