SharedObjectBase Class Reference
#include <SharedObject.h>
Inheritance diagram for SharedObjectBase:
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) | |
| SharedObjectBase & | operator= (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 | |
Constructor & Destructor Documentation
| virtual SharedObjectBase::~SharedObjectBase | ( | ) | [inline, virtual] |
| 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 24 of file SharedObject.h.
| SharedObjectBase::SharedObjectBase | ( | const SharedObjectBase & | sob | ) | [inline, protected] |
copy constructor, adds a reference to the existing region (shallow copy)
Definition at line 26 of file SharedObject.h.
Member Function Documentation
| void* SharedObjectBase::data | ( | ) | const [inline] |
returns a pointer to the data region
Definition at line 12 of file SharedObject.h.
Referenced by SharedObject< UPennWalkMC >::dataCasted(), and MotionManager::doAddMotion().
| RCRegion* SharedObjectBase::getRegion | ( | ) | const [inline] |
returns the OPEN-R memory region, should you need it
Definition at line 13 of file SharedObject.h.
Referenced by MotionManager::doAddMotion().
| SharedObjectBase& SharedObjectBase::operator= | ( | const SharedObjectBase & | sob | ) | [inline, protected] |
assignment, adds a reference to the existing region (shallow copy)
Definition at line 30 of file SharedObject.h.
| virtual void SharedObjectBase::removeRef | ( | ) | [protected, pure virtual] |
removes a reference from rcr, and if necessary, destructs its data
Implemented in SharedObject< MC >, SharedObject< WalkMC >, SharedObject< MotionSequenceMC< NumOutputs *26 > >, and SharedObject< UPennWalkMC >.
Referenced by operator=().
Member Data Documentation
RCRegion* SharedObjectBase::rcr [protected] |
the pointer to the shared memory region this is in charge of
Definition at line 41 of file SharedObject.h.
Referenced by data(), getRegion(), operator=(), SharedObject< UPennWalkMC >::removeRef(), SharedObject< UPennWalkMC >::SharedObject(), and SharedObjectBase().
The documentation for this class was generated from the following file:
