SurgSim::Devices::LabJackScaffold::Handle Class Reference

Public Member Functions
	Handle (SurgSim::Devices::LabJack::Model model, SurgSim::Devices::LabJack::Connection connection, const std::string &address)
	Constructor that attempts to open a device. More...
	~Handle ()
	Destructor.
bool	isValid () const
void	destroy (bool reset=false)
	Close communication with the hardware. More...
LJ_HANDLE	get () const
	Handle (LabJack::Model model, LabJack::Connection connection, const std::string &address)
	Constructor that attempts to open a device. More...
	~Handle ()
	Destructor.
bool	isValid () const
void	destroy (bool reset=false)
	Close communication with the hardware. More...
LJ_HANDLE	get () const

Constructor & Destructor Documentation

Handle() [1/2]

SurgSim::Devices::LabJackScaffold::Handle::Handle ( SurgSim::Devices::LabJack::Model  model, SurgSim::Devices::LabJack::Connection  connection, const std::string &  address  )

inline

Constructor that attempts to open a device.

Parameters

model	The model of LabJack device to open (see strings in LabJackUD.h).
connection	How to connect to the device (e.g., USB) (see strings in LabJackUD.h).
address	Either the ID or serial number (if USB), or the IP address.

Handle() [2/2]

SurgSim::Devices::LabJackScaffold::Handle::Handle ( LabJack::Model  model, LabJack::Connection  connection, const std::string &  address  )

inline

Constructor that attempts to open a device.

Parameters

model	The model of LabJack device to open (see strings in LabJackUD.h).
connection	How to connect to the device (e.g., USB) (see strings in LabJackUD.h).
address	Either the ID or serial number (if USB), or the IP address.

Member Function Documentation

destroy() [1/2]

void SurgSim::Devices::LabJackScaffold::Handle::destroy ( bool  reset = false )

inline

Close communication with the hardware.

Parameters

reset

true to cause a hardware reset & USB re-enumeration. Otherwise the hardware's settings will be unchanged (i.e., it will continue timing, counting, and outputting).

destroy() [2/2]

void SurgSim::Devices::LabJackScaffold::Handle::destroy ( bool  reset = false )

inline

Close communication with the hardware.

Parameters

reset

true to cause a hardware reset & USB re-enumeration. Otherwise the hardware's settings will be unchanged (i.e., it will continue timing, counting, and outputting).

get() [1/2]

LJ_HANDLE SurgSim::Devices::LabJackScaffold::Handle::get ( ) const

inline

Returns

The LabJackUD's handle wrapped by this Handle.

get() [2/2]

LJ_HANDLE SurgSim::Devices::LabJackScaffold::Handle::get ( ) const

inline

Returns

The LabJack SDK's handle wrapped by this Handle.

isValid() [1/2]

bool SurgSim::Devices::LabJackScaffold::Handle::isValid ( ) const

inline

Returns

Whether or not the wrapped handle is valid.

isValid() [2/2]

bool SurgSim::Devices::LabJackScaffold::Handle::isValid ( ) const

inline

Returns

Whether or not the wrapped handle is valid.

---

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

• SurgSim/Devices/LabJack/linux/LabJackScaffold.cpp