Inheritance diagram for SurgSim::Devices::ReplayPoseScaffold:
Classes | |
| struct | DeviceData |
Public Member Functions | |
| ReplayPoseScaffold () | |
| Constructor. | |
| ~ReplayPoseScaffold () | |
| Destructor. | |
 Public Member Functions inherited from SurgSim::Framework::BasicThread | |
| BasicThread (const std::string &name="Unknown Thread") | |
| virtual | ~BasicThread () noexcept(false) |
| C++11 introduced noexcept. | |
| void | start (std::shared_ptr< Barrier > startupBarrier=nullptr, bool isSynchronous=false) |
| Live cycle functions, public implementation. More... | |
| void | stop () |
| Stopping the execution, blocks until the running thread has actually stopped,. More... | |
| void | setIdle (bool isIdle) |
| Set/Unset the thread in an idle state (doUpdate() called or not in the update() method) More... | |
| bool | isIdle () |
| Query if this thread is in idle state or not. More... | |
| bool | isInitialized () |
| Query if this object is initialized. More... | |
| bool | isRunning () const |
| Query if this object is running. More... | |
| void | operator() () |
| This is what boost::thread executes on thread creation. | |
| boost::thread & | getThread () |
| std::string | getName () const |
| void | setRate (double val) |
| Set the update rate of the thread. More... | |
| bool | setSynchronous (bool val) |
| Sets the thread to synchronized execution in concert with the startup barrier, the startup barrier has to exist for this call to succeed. More... | |
| bool | isSynchronous () |
| Query if this object is synchronized. More... | |
| double | getCpuTime () const |
| size_t | getUpdateCount () const |
| void | resetCpuTimeAndUpdateCount () |
| Reset the cpu time and the update count to 0. | |
| bool | ignoresExceptions () const |
| void | setIgnoreExceptions (bool val) |
Static Public Member Functions | |
| static std::shared_ptr< ReplayPoseScaffold > | getOrCreateSharedInstance () |
| Gets or creates the scaffold shared by all ReplayPoseDevice instances. More... | |
Protected Member Functions | |
| bool | doInitialize () override |
| bool | doStartUp () override |
| bool | doUpdate (double dt) override |
| Implementation of actual work function for this thread, this has a default implementation to handle destruction better, as it could be called while the thread is under destruction, if left unimplemented this would trigger a call to a pure virtual function. More... | |
| Protected Member Functions inherited from SurgSim::Framework::BasicThread | |
| bool | initialize () |
| Trigger the initialization of this object, this will be called before all other threads doStartup() are called. More... | |
| bool | startUp () |
| Trigger the startup of this object, this will be called after all other threads doInit() was called the thread will only enter the run loop triggering upated() if all threads doInit() and doStartup() returned true. More... | |
| bool | waitForBarrier (bool success) |
| virtual bool | executeInitialization () |
Friends | |
| class | ReplayPoseDevice |
Additional Inherited Members | |
| Protected Attributes inherited from SurgSim::Framework::BasicThread | |
| Timer | m_timer |
| Timer to measure the actual time taken to doUpdate. | |
| std::shared_ptr< SurgSim::Framework::Logger > | m_logger |
| Logger for this thread. | |
Member Function Documentation
§ doUpdate()
|
overrideprotectedvirtual |
Implementation of actual work function for this thread, this has a default implementation to handle destruction better, as it could be called while the thread is under destruction, if left unimplemented this would trigger a call to a pure virtual function.
- Returns
- false when the thread is done, this will stop execution
Reimplemented from SurgSim::Framework::BasicThread.
§ getOrCreateSharedInstance()
|
static |
Gets or creates the scaffold shared by all ReplayPoseDevice instances.
The scaffold is managed using a SharedInstance object, so it will be destroyed when all devices are released.
- Returns
- the scaffold object.
The documentation for this class was generated from the following files:
- SurgSim/Devices/ReplayPoseDevice/ReplayPoseScaffold.h
- SurgSim/Devices/ReplayPoseDevice/ReplayPoseScaffold.cpp
