Classes | Public Member Functions | Protected Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | Friends | List of all members
SurgSim::Devices::OpenNIScaffold Class Reference

A class that manages OpenNI devices. More...

#include <SurgSim/Devices/OpenNI/OpenNIScaffold.h>

Inheritance diagram for SurgSim::Devices::OpenNIScaffold:
SurgSim::Framework::BasicThread

Classes

struct  DeviceData
 
struct  StateData
 

Public Member Functions

virtual ~OpenNIScaffold ()
 Destructor. More...
 
- Public Member Functions inherited from SurgSim::Framework::BasicThread
 BasicThread (const std::string &name="Unknown Thread")
 
virtual ~BasicThread () noexcept(false)
 C++11 introduced noexcept. More...
 
void start (std::shared_ptr< Barrier > startupBarrier=nullptr, bool isSynchronous=false)
 C++11 introduced noexcept. 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. More...
 
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. 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 ()
 

Private Member Functions

 OpenNIScaffold ()
 Constructor. More...
 
bool registerDevice (OpenNIDevice *device)
 Registers the specified device object. More...
 
bool unregisterDevice (const OpenNIDevice *device)
 Unregisters the specified device object. More...
 
bool doRegisterDevice (DeviceData *info)
 Do the OpenNI specific registration. More...
 
bool doUnregisterDevice (DeviceData *info)
 Do the OpenNI specific unregistration. More...
 

Static Private Member Functions

static std::shared_ptr< OpenNIScaffoldgetOrCreateSharedInstance ()
 Gets or creates the scaffold shared by all OpenNIDevice instances. More...
 
static SurgSim::DataStructures::DataGroup buildDeviceInputData ()
 Builds the data layout for the application input (i.e. device output). More...
 

Private Attributes

std::unique_ptr< StateDatam_state
 Internal scaffold state. More...
 
std::shared_ptr< SurgSim::Framework::Loggerm_logger
 Logger used by the scaffold. More...
 

Friends

class OpenNIDevice
 

Additional Inherited Members

- Protected Attributes inherited from SurgSim::Framework::BasicThread
Timer m_timer
 Timer to measure the actual time taken to doUpdate. More...
 
std::shared_ptr< SurgSim::Framework::Loggerm_logger
 Logger for this thread. More...
 

Detailed Description

A class that manages OpenNI devices.

See also
SurgSim::Devices::OpenNIDevice

Constructor & Destructor Documentation

§ ~OpenNIScaffold()

SurgSim::Devices::OpenNIScaffold::~OpenNIScaffold ( )
virtual

Destructor.

§ OpenNIScaffold()

SurgSim::Devices::OpenNIScaffold::OpenNIScaffold ( )
private

Constructor.

Member Function Documentation

§ buildDeviceInputData()

SurgSim::DataStructures::DataGroup SurgSim::Devices::OpenNIScaffold::buildDeviceInputData ( )
staticprivate

Builds the data layout for the application input (i.e. device output).

§ doInitialize()

bool SurgSim::Devices::OpenNIScaffold::doInitialize ( )
overrideprotectedvirtual

§ doRegisterDevice()

bool SurgSim::Devices::OpenNIScaffold::doRegisterDevice ( DeviceData info)
private

Do the OpenNI specific registration.

Parameters
infoThe device data
Returns
true on success, false on failure.

§ doStartUp()

bool SurgSim::Devices::OpenNIScaffold::doStartUp ( )
overrideprotectedvirtual

§ doUnregisterDevice()

bool SurgSim::Devices::OpenNIScaffold::doUnregisterDevice ( DeviceData info)
private

Do the OpenNI specific unregistration.

Parameters
infoThe device data
Returns
true on success, false on failure.

§ doUpdate()

bool SurgSim::Devices::OpenNIScaffold::doUpdate ( double  dt)
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()

std::shared_ptr< OpenNIScaffold > SurgSim::Devices::OpenNIScaffold::getOrCreateSharedInstance ( )
staticprivate

Gets or creates the scaffold shared by all OpenNIDevice instances.

The scaffold is managed using a SharedInstance object, so it will be destroyed when all devices are released.

Returns
the scaffold object.

§ registerDevice()

bool SurgSim::Devices::OpenNIScaffold::registerDevice ( OpenNIDevice device)
private

Registers the specified device object.

Parameters
deviceThe device object to be used
Returns
True if the initialization succeeds, false if it fails.

§ unregisterDevice()

bool SurgSim::Devices::OpenNIScaffold::unregisterDevice ( const OpenNIDevice device)
private

Unregisters the specified device object.

Parameters
deviceThe device object.
Returns
true on success, false on failure.

Friends And Related Function Documentation

§ OpenNIDevice

friend class OpenNIDevice
friend

Member Data Documentation

§ m_logger

std::shared_ptr<SurgSim::Framework::Logger> SurgSim::Devices::OpenNIScaffold::m_logger
private

Logger used by the scaffold.

§ m_state

std::unique_ptr<StateData> SurgSim::Devices::OpenNIScaffold::m_state
private

Internal scaffold state.


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