robot::sim::BasicEnvironment::Obstacle Class Reference

Inheritance diagram for robot::sim::BasicEnvironment::Obstacle:

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

[legend]List of all members.


Public Types
enum	ObstacleType { BoxObstacle, SphereObstacle }
Public Member Functions
	Obstacle (base::Dimension3 dims, const base::Point3 &position, const base::Orient &orientation)
	Obstacle (Real radius, const base::Point3 &position, const base::Orient &orientation)
virtual String	className () const
void	setName (const String &name)
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
virtual const String &	getName () const
Public Attributes
ObstacleType	type
base::Dimension3	dims
Real	radius
base::Point3	position
base::Orient	orientation
Protected Attributes
int	_refCount
bool	onUnreferenceEnabled

Member Enumeration Documentation

enum robot::sim::BasicEnvironment::Obstacle::ObstacleType

Enumeration values:

BoxObstacle

SphereObstacle

Definition at line 99 of file BasicEnvironment.

Constructor & Destructor Documentation

robot::sim::BasicEnvironment::Obstacle::Obstacle ( base::Dimension3 dims,

const base::Point3 & position,

const base::Orient & orientation

) [inline]

Definition at line 101 of file BasicEnvironment.
References BoxObstacle, base::Dimension3, and base::Point3.

robot::sim::BasicEnvironment::Obstacle::Obstacle ( Real radius,

const base::Point3 & position,

const base::Orient & orientation

) [inline]

Definition at line 107 of file BasicEnvironment.
References base::Point3, and SphereObstacle.

Member Function Documentation

virtual String robot::sim::BasicEnvironment::Obstacle::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 113 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 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().

void robot::sim::BasicEnvironment::Obstacle::setName ( const String & name ) [inline, virtual]

Reimplemented from base::Named.
Definition at line 115 of file BasicEnvironment.

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.