robot::sim::BasicEnvironment::Tool Class Reference

Inheritance diagram for robot::sim::BasicEnvironment::Tool:

[legend]Collaboration diagram for robot::sim::BasicEnvironment::Tool:

[legend]List of all members.

Public Member Functions
	Tool (String name, ref< const robot::ToolDescription > toolDescription, const base::Point3 &position, const base::Orient &orientation)
virtual String	className () const
virtual ref< const robot::ToolDescription >	getToolDescription () const
virtual const base::Point3 &	getPosition () const
virtual base::Point3 &	getPosition ()
virtual const base::Orient &	getOrientation () const
virtual base::Orient &	getOrientation ()
virtual const String &	getName () const
virtual bool	isSameKindAs (const ReferencedObject &) const
virtual bool	isSameKindAs (const Object &) const
void	reference () const
bool	unreference () const
const int	referenceCount () const
void	enableOnUnreferenceCall (bool enabled)
virtual void	onUnreference () const
Protected Member Functions
virtual void	setName (const String &name)
Protected Attributes
ref< const robot::ToolDescription >	toolDescription
base::Point3	position
base::Orient	orientation
int	_refCount
bool	onUnreferenceEnabled

---

Constructor & Destructor Documentation

robot::sim::BasicEnvironment::Tool::Tool (  String  name, ref< const robot::ToolDescription >  toolDescription, const base::Point3 &  position, const base::Orient &  orientation )  [inline]

Definition at line 59 of file BasicEnvironment. References base::Point3.

---

Member Function Documentation

virtual String robot::sim::BasicEnvironment::Tool::className (   )  const [inline, virtual]

return the name of the object's class type. Must be defined by derived classes. Implements base::Object. Definition at line 65 of file BasicEnvironment.

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

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

virtual const String& base::Named::getName (   )  const [inline, virtual, inherited]

Definition at line 44 of file Named. References base::String. Referenced by physics::Collidable::findNamed(), physics::operator<<(), robot::ToolDescription::operator=(), robot::RobotDescription::operator=(), robot::PlatformDescription::operator=(), robot::ManipulatorDescription::operator=(), base::Named::operator=(), and robot::ManipulatorDescription::operator==().

virtual base::Orient& robot::sim::BasicEnvironment::Tool::getOrientation (   )  [inline, virtual]

Definition at line 71 of file BasicEnvironment. References orientation.

virtual const base::Orient& robot::sim::BasicEnvironment::Tool::getOrientation (   )  const [inline, virtual]

Definition at line 70 of file BasicEnvironment. References orientation.

virtual base::Point3& robot::sim::BasicEnvironment::Tool::getPosition (   )  [inline, virtual]

Definition at line 69 of file BasicEnvironment. References base::Point3.

virtual const base::Point3& robot::sim::BasicEnvironment::Tool::getPosition (   )  const [inline, virtual]

Definition at line 68 of file BasicEnvironment. References base::Point3.

virtual ref<const robot::ToolDescription> robot::sim::BasicEnvironment::Tool::getToolDescription (   )  const [inline, virtual]

Definition at line 67 of file BasicEnvironment. References toolDescription.

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 52 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, and robot::control::ControllableAdaptor. Definition at line 121 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 65 of file Referenced. References base::Referenced::_refCount.

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

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

virtual void base::Named::setName (  const String &  name  )  [inline, protected, virtual, inherited]

Reimplemented in physics::Collidable, physics::Solid, and robot::sim::BasicEnvironment::Obstacle. Definition at line 47 of file Named. References base::String. Referenced by robot::control::ControllableAdaptor::AdaptorControlInterface::AdaptorControlInterface(), robot::control::kinematics::BetaFormConstraints::BetaFormConstraint::BetaFormConstraint(), robot::control::kinematics::IKORController::EEPositionControlInterface::EEPositionControlInterface(), robot::control::kinematics::IKOR::JointLimitBetaConstraint::JointLimitBetaConstraint(), robot::control::kinematics::IKORController::LinkPositionsControlInterface::LinkPositionsControlInterface(), robot::ToolDescription::operator=(), robot::RobotDescription::operator=(), robot::PlatformDescription::operator=(), robot::ManipulatorDescription::operator=(), base::Named::operator=(), robot::control::ManipulatorPIDPositionController::PositionInterface::PositionInterface(), robot::RobotDescription::set(), robot::PlatformDescription::set(), robot::ManipulatorDescription::set(), and physics::Solid::setName().

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 81 of file Referenced. References base::Referenced::_refCount, Exception, base::Referenced::onUnreference(), and base::Referenced::onUnreferenceEnabled.

---

Member Data Documentation

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

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

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

Definition at line 137 of file Referenced. Referenced by base::Referenced::enableOnUnreferenceCall(), base::Referenced::Referenced(), and base::Referenced::unreference().

base::Orient robot::sim::BasicEnvironment::Tool::orientation [protected]

Definition at line 76 of file BasicEnvironment. Referenced by getOrientation().

base::Point3 robot::sim::BasicEnvironment::Tool::position [protected]

Definition at line 75 of file BasicEnvironment.

ref<const robot::ToolDescription> robot::sim::BasicEnvironment::Tool::toolDescription [protected]

Definition at line 74 of file BasicEnvironment. Referenced by getToolDescription().

---

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

• robot/sim/BasicEnvironment

---