Homepage Demos Overview Downloads Tutorials Reference
Credits
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages | Search for 

SharedObjectBase Class Reference

#include <SharedObject.h>

Inheritance diagram for SharedObjectBase:

Inheritance graph
[legend]
List of all members.

Detailed Description

It's nice to have a parent class of SharedObject (which is what you probably want to be reading) so that you can pass around the data structure without worrying about what type is inside the shared memory region.

See MotionManager for an example on how to use this.

Definition at line 9 of file SharedObject.h.

Public Member Functions

void * data () const
 returns a pointer to the data region

RCRegion * getRegion () const
 returns the OPEN-R memory region, should you need it


Protected Member Functions

 SharedObjectBase ()
 constructor, protected because you shouldn't need to create this directly, just a common interface to all templates of SharedObject

virtual ~SharedObjectBase ()

Protected Attributes

RCRegion * rcr
 the pointer to the shared memory region this is in charge of


Private Member Functions

 SharedObjectBase (const SharedObjectBase &)
 this shouldn't be called...

SharedObjectBase & operator= (const SharedObjectBase &)
 this shouldn't be called...

Constructor & Destructor Documentation

SharedObjectBase::SharedObjectBase (   )  [inline, protected]
 

constructor, protected because you shouldn't need to create this directly, just a common interface to all templates of SharedObject

Definition at line 15 of file SharedObject.h.

virtual SharedObjectBase::~SharedObjectBase (   )  [inline, protected, virtual]
 

Definition at line 18 of file SharedObject.h.

SharedObjectBase::SharedObjectBase (  const SharedObjectBase &   )  [private]
 

this shouldn't be called...

Member Function Documentation

void* SharedObjectBase::data (   )  const [inline]
 

returns a pointer to the data region

Definition at line 11 of file SharedObject.h.

Referenced by MotionManager::addMotion(), and SharedObject< PostureMC >::dataCasted().

RCRegion* SharedObjectBase::getRegion (   )  const [inline]
 

returns the OPEN-R memory region, should you need it

Definition at line 12 of file SharedObject.h.

Referenced by MotionManager::addMotion(), HeadLevelBehavior::HeadLevelBehavior(), and HeadLevelBehavior::~HeadLevelBehavior().

SharedObjectBase& SharedObjectBase::operator= (  const SharedObjectBase &   )  [private]
 

this shouldn't be called...

Member Data Documentation

RCRegion* SharedObjectBase::rcr [protected]
 

the pointer to the shared memory region this is in charge of

Definition at line 26 of file SharedObject.h.

Referenced by data(), getRegion(), SharedObject< PostureMC >::SharedObject(), SharedObjectBase(), and ~SharedObjectBase().

The documentation for this class was generated from the following file:
Tekkotsu v2.0
 		Generated Wed Jan 21 03:23:26 2004 by Doxygen 1.3.4