---

robot::Platform Class Reference

Inherits robot::RobotPart.

Inherited by robot::sim::SimulatedPlatform, and TestRobot::TestRobotPlatform.

Inheritance diagram for robot::Platform:

[legend]Collaboration diagram for robot::Platform:

[legend]List of all members.

Public Methods
virtual bool	isMobile () const
	< is the robot mobile, or fixed (e.g. to the floor)? More...
virtual bool	isHolonomic () const
	< if mobile, is the platform capable of holonomic movement. More...
virtual base::Dimension3	getDimensions () const
	< physical platform bounding dimensions (Length, Width, Thickness). More...
virtual String	getName () const
virtual bool	isSameKindAs (const ReferencedObject &) const
virtual bool	isSameKindAs (const Object &) const
virtual String	className () const=0
void	reference () const
bool	unreference () const
const int	referenceCount () const
void	enableOnUnreferenceCall (bool enabled)
virtual void	onUnreference () const
Protected Methods
	Platform ()
	Platform (String name)
	Platform (const Platform &p)
Protected Attributes
bool	mobile
bool	holonomic
base::Dimension3	dimensions
String	name
int	_refCount
bool	onUnreferenceEnabled

---

Detailed Description

An abstract description of a Robot's platform (typically the mobile base, if any)

Definition at line 40 of file Platform.

---

Constructor & Destructor Documentation

robot::Platform::Platform (    )  [inline, protected]

Definition at line 52 of file Platform. References mobile.

robot::Platform::Platform (  String    name )  [inline, protected]

Definition at line 54 of file Platform. References mobile, robot::RobotPart::name, robot::RobotPart::RobotPart, and base::String.

robot::Platform::Platform (  const Platform &    p )  [inline, protected]

Definition at line 55 of file Platform. References dimensions, holonomic, mobile, and robot::RobotPart::RobotPart.

---

Member Function Documentation

virtual String base::Object::className (    )  const [pure virtual, inherited]

return the name of the object's class type. Must be defined by derived classes. Implemented in base::Application.

void base::Referenced::enableOnUnreferenceCall (  bool    enabled )  [inline, inherited]

If enabled, each call to unreference() will also call virtual method onUnreference() Definition at line 108 of file Referenced. References base::Referenced::onUnreferenceEnabled. Referenced by robot::control::ControllableAdaptor::ControllableAdaptor.

virtual base::Dimension3 robot::Platform::getDimensions (    )  const [inline, virtual]

< physical platform bounding dimensions (Length, Width, Thickness). Definition at line 48 of file Platform. References dimensions.

virtual String robot::RobotPart::getName (    )  const [inline, virtual, inherited]

Definition at line 41 of file RobotPart. References robot::RobotPart::name, and base::String. Referenced by robot::SerialManipulator::serialize.

virtual bool robot::Platform::isHolonomic (    )  const [inline, virtual]

< if mobile, is the platform capable of holonomic movement. Definition at line 45 of file Platform. References holonomic.

virtual bool robot::Platform::isMobile (    )  const [inline, virtual]

< is the robot mobile, or fixed (e.g. to the floor)? Definition at line 43 of file Platform. References mobile.

virtual bool base::Object::isSameKindAs (  const Object &    )  const [inline, virtual, inherited]

Definition at line 47 of file Object.

virtual bool base::ReferencedObject::isSameKindAs (  const ReferencedObject &    )  const [inline, virtual, inherited]

Definition at line 58 of file ReferencedObject.

virtual void base::Referenced::onUnreference (    )  const [inline, virtual, inherited]

Called by unreference() if enabled via enableOnUnreferenceCall(true). Typically overridden in subclasses that wish to know about unreference() calls - for example to handle manually breaking cyclic references Reimplemented in robot::control::ControllableAdaptor::AdaptorControlInterface. Definition at line 114 of file Referenced. Referenced by base::Referenced::unreference.

void base::Referenced::reference (    )  const [inline, inherited]

Increment the reference count by one, indicating that this object has another pointer which is referencing it. Definition at line 58 of file Referenced. References base::Referenced::_refCount. Referenced by robot::control::kinematics::FullSpaceSolver::reduceA.

const int base::Referenced::referenceCount (    )  const [inline, inherited]

Return the number pointers currently referencing this object. Definition at line 105 of file Referenced. References base::Referenced::_refCount. Referenced by robot::control::ControllableAdaptor::onUnreference, and robot::control::ControllableAdaptor::AdaptorControlInterface::onUnreference.

bool base::Referenced::unreference (    )  const [inline, inherited]

Decrement the reference count by one, indicating that a pointer to this object is referencing it. If the refence count goes to zero, it is assumed that this object is nolonger referenced and is automatically deleted. Definition at line 74 of file Referenced. References base::Referenced::_refCount, Exception, and base::Referenced::onUnreference.

---

Member Data Documentation

int base::Referenced::_refCount [protected, inherited]

Definition at line 129 of file Referenced. Referenced by base::Referenced::reference, base::Referenced::referenceCount, base::Referenced::Referenced, base::Referenced::unreference, and base::Referenced::~Referenced.

base::Dimension3 robot::Platform::dimensions [protected]

Definition at line 62 of file Platform. Referenced by getDimensions, Platform, and TestRobot::TestRobotPlatform::TestRobotPlatform.

bool robot::Platform::holonomic [protected]

Definition at line 60 of file Platform. Referenced by isHolonomic, Platform, and TestRobot::TestRobotPlatform::TestRobotPlatform.

bool robot::Platform::mobile [protected]

Definition at line 59 of file Platform. Referenced by isMobile, Platform, and TestRobot::TestRobotPlatform::TestRobotPlatform.

String robot::RobotPart::name [protected, inherited]

Definition at line 48 of file RobotPart. Referenced by robot::sim::SimulatedSerialManipulator::externalize, robot::RobotPart::getName, robot::Manipulator::Manipulator, Platform, robot::RobotPart::RobotPart, robot::SerialManipulator::SerialManipulator, and robot::sim::SimulatedPlatform::SimulatedPlatform.

bool base::Referenced::onUnreferenceEnabled [protected, inherited]

Definition at line 130 of file Referenced. Referenced by base::Referenced::enableOnUnreferenceCall, and base::Referenced::Referenced.

---

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

• robot/Platform

---