base::Universe Class Reference

Inheritance diagram for base::Universe:

[legend]Collaboration diagram for base::Universe:

[legend]List of all members.

Public Member Functions
	Universe (ref< VFileSystem > fs, const String &resourceDirectoryName, const String &cacheDirectoryName="cache")
virtual	~Universe ()
virtual String	className () const
virtual Object &	clone () const
virtual void	preSimulate ()
virtual void	simulateForSimTime (const Time &dt)
virtual void	simulateForRealTime (const Time &dt, Real simTimeStepSize=minSimStepSize)
void	setResourceDirectory (const PathName &resourceDirectory)
void	setCacheDirectory (const PathName &cacheDirectory)
ref< Cache >	cache ()
ref< VFileSystem >	filesystem ()
void	addWorld (ref< World > world)
ref< World >	removeWorld (ref< World > world)
void	renderWorlds ()
	render a single frame of all Worlds ( renderFrame() )
long	renderedFrameCount () const
void	enableSimulationRendering (bool renderWorlds)
void	addSimulatable (ref< Simulatable > simulatable)
ref< Simulatable >	removeSimulatable (ref< Simulatable > simulatable)
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
Public Attributes
Time	simTime
Static Public Attributes
const int	maxDisplayFrameRate = 30
const Real	minSimStepSize
Protected Attributes
int	_refCount
bool	onUnreferenceEnabled

---

Constructor & Destructor Documentation

base::Universe::Universe (  ref< VFileSystem >  fs, const String &  resourceDirectoryName, const String &  cacheDirectoryName = "cache" )

virtual base::Universe::~Universe (   )  [virtual]

---

Member Function Documentation

void base::Universe::addSimulatable (  ref< Simulatable >  simulatable  )

void base::Universe::addWorld (  ref< World >  world  )

ref<Cache> base::Universe::cache (   )  [inline]

Definition at line 60 of file Universe.

virtual String base::Universe::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 49 of file Universe. References base::String.

virtual Object& base::Universe::clone (   )  const [inline, virtual]

Definition at line 50 of file Universe.

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.

void base::Universe::enableSimulationRendering (  bool  renderWorlds  )  [inline]

Definition at line 71 of file Universe.

ref<VFileSystem> base::Universe::filesystem (   )  [inline]

Definition at line 61 of file Universe.

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().

virtual void base::Universe::preSimulate (   )  [virtual]

Implements base::Simulatable.

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().

ref<Simulatable> base::Universe::removeSimulatable (  ref< Simulatable >  simulatable  )

ref<World> base::Universe::removeWorld (  ref< World >  world  )

long base::Universe::renderedFrameCount (   )  const [inline]

Definition at line 68 of file Universe.

void base::Universe::renderWorlds (   )

render a single frame of all Worlds ( renderFrame() )

void base::Universe::setCacheDirectory (  const PathName &  cacheDirectory  )

void base::Universe::setResourceDirectory (  const PathName &  resourceDirectory  )

virtual void base::Universe::simulateForRealTime (  const Time &  dt, Real  simTimeStepSize = minSimStepSize )  [virtual]

Reimplemented from base::Simulatable.

virtual void base::Universe::simulateForSimTime (  const Time &  dt  )  [virtual]

Implements base::Simulatable.

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().

const int base::Universe::maxDisplayFrameRate = 30 [static]

Definition at line 69 of file Universe.

const Real base::Simulatable::minSimStepSize [static, inherited]

Definition at line 39 of file Simulatable.

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().

Time base::Universe::simTime

Definition at line 76 of file Universe.

---

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

• base/Universe

---