Public Member Functions | Static Public Attributes | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
create::RobotModel Class Reference

#include <types.h>

Public Member Functions

float getAxleLength () const
 
unsigned int getBaud () const
 
uint32_t getId () const
 
float getMaxVelocity () const
 
ProtocolVersion getVersion () const
 
float getWheelDiameter () const
 
 operator uint32_t () const
 
bool operator== (RobotModel &other) const
 

Static Public Attributes

static RobotModel CREATE_1
 Compatible with Create 1 or Roomba 500 series. More...
 
static RobotModel CREATE_2
 Compatible with Create 2 or Roomba 600 series and greater. More...
 
static RobotModel ROOMBA_400
 Compatible with Roomba 400 series and earlier. More...
 

Private Member Functions

 RobotModel (const ProtocolVersion version, const float axleLength, const unsigned int baud, const float maxVelocity=0.5, const float wheelDiameter=0.078)
 

Private Attributes

float axleLength
 
unsigned int baud
 
uint32_t id
 
float maxVelocity
 
ProtocolVersion version
 
float wheelDiameter
 

Static Private Attributes

static uint32_t nextId = 1
 

Detailed Description

Definition at line 48 of file types.h.

Constructor & Destructor Documentation

create::RobotModel::RobotModel ( const ProtocolVersion  version,
const float  axleLength,
const unsigned int  baud,
const float  maxVelocity = 0.5,
const float  wheelDiameter = 0.078 
)
private

Definition at line 5 of file types.cpp.

Member Function Documentation

float create::RobotModel::getAxleLength ( ) const

Definition at line 31 of file types.cpp.

unsigned int create::RobotModel::getBaud ( ) const

Definition at line 35 of file types.cpp.

uint32_t create::RobotModel::getId ( ) const

Definition at line 23 of file types.cpp.

float create::RobotModel::getMaxVelocity ( ) const

Definition at line 39 of file types.cpp.

ProtocolVersion create::RobotModel::getVersion ( ) const

Definition at line 27 of file types.cpp.

float create::RobotModel::getWheelDiameter ( ) const

Definition at line 43 of file types.cpp.

create::RobotModel::operator uint32_t ( ) const

Definition at line 19 of file types.cpp.

bool create::RobotModel::operator== ( RobotModel other) const

Definition at line 15 of file types.cpp.

Member Data Documentation

float create::RobotModel::axleLength
private

Definition at line 78 of file types.h.

unsigned int create::RobotModel::baud
private

Definition at line 79 of file types.h.

RobotModel create::RobotModel::CREATE_1
static

Compatible with Create 1 or Roomba 500 series.

Definition at line 68 of file types.h.

RobotModel create::RobotModel::CREATE_2
static

Compatible with Create 2 or Roomba 600 series and greater.

Definition at line 73 of file types.h.

uint32_t create::RobotModel::id
private

Definition at line 76 of file types.h.

float create::RobotModel::maxVelocity
private

Definition at line 80 of file types.h.

uint32_t create::RobotModel::nextId = 1
staticprivate

Definition at line 84 of file types.h.

RobotModel create::RobotModel::ROOMBA_400
static

Compatible with Roomba 400 series and earlier.

Definition at line 63 of file types.h.

ProtocolVersion create::RobotModel::version
private

Definition at line 77 of file types.h.

float create::RobotModel::wheelDiameter
private

Definition at line 81 of file types.h.


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


libcreate
Author(s): Jacob Perron
autogenerated on Thu Dec 5 2019 04:03:13