Tekkotsu Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

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 10 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
virtual ~SharedObjectBase ()
 destructor

Protected Member Functions

 SharedObjectBase ()
 constructor, protected because you shouldn't need to create this directly, just a common interface to all templates of SharedObject
 SharedObjectBase (const SharedObjectBase &sob)
 copy constructor, adds a reference to the existing region (shallow copy)
SharedObjectBaseoperator= (const SharedObjectBase &sob)
 assignment, adds a reference to the existing region (shallow copy)
virtual void removeRef ()=0
 removes a reference from rcr, and if necessary, destructs its data

Protected Attributes

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


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

Tekkotsu v3.0
Generated Fri May 11 20:08:46 2007 by Doxygen 1.4.7