opensurgsim
Classes | Public Member Functions | Static Public Member Functions | Friends | List of all members
SurgSim::Devices::LabJackScaffold Class Reference

A class that implements the behavior of LabJackDevice objects. More...

#include <LabJackScaffold.h>

Classes

struct  DeviceData
 The per-device data. More...
 
class  Handle
 
struct  StateData
 The per-scaffold data (in comparison to DeviceData the per-device data). More...
 

Public Member Functions

 LabJackScaffold ()
 Constructor.
 
 ~LabJackScaffold ()
 Destructor.
 
void configureDevice (DeviceData *device)
 Does one-time configuration of the LabJack for timers, counters, and analog inputs. More...
 

Static Public Member Functions

static std::shared_ptr< LabJackScaffoldgetOrCreateSharedInstance ()
 Gets or creates the scaffold shared by all LabJackDevice instances. More...
 

Friends

class LabJackDevice
 
class LabJackThread
 
struct StateData
 

Detailed Description

A class that implements the behavior of LabJackDevice objects.

See also
SurgSim::Devices::LabJackDevice

Member Function Documentation

§ configureDevice()

void SurgSim::Devices::LabJackScaffold::configureDevice ( DeviceData device)

Does one-time configuration of the LabJack for timers, counters, and analog inputs.

Must be called by the LabJackThread because the LabJack separates all commands by the calling thread.

Parameters
deviceThe internal device data.

§ getOrCreateSharedInstance()

std::shared_ptr< LabJackScaffold > SurgSim::Devices::LabJackScaffold::getOrCreateSharedInstance ( )
static

Gets or creates the scaffold shared by all LabJackDevice 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: