◆ Handle() [1/4]
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() [1/2]
SurgSim::Devices::LabJackScaffold::Handle::~Handle |
( |
| ) |
|
|
inline |
◆ Handle() [2/4]
SurgSim::Devices::LabJackScaffold::Handle::Handle |
( |
const Handle & |
| ) |
|
|
private |
◆ Handle() [3/4]
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 |
( |
| ) |
|
|
inline |
◆ Handle() [4/4]
SurgSim::Devices::LabJackScaffold::Handle::Handle |
( |
const Handle & |
| ) |
|
|
private |
◆ 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 |
◆ 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.
◆ operator=() [1/2]
Handle& SurgSim::Devices::LabJackScaffold::Handle::operator= |
( |
const Handle & |
| ) |
|
|
private |
◆ operator=() [2/2]
Handle& SurgSim::Devices::LabJackScaffold::Handle::operator= |
( |
const Handle & |
| ) |
|
|
private |
◆ m_address
std::string SurgSim::Devices::LabJackScaffold::Handle::m_address |
|
private |
The address used to open the device. Can be the empty string if the first-found device was opened.
◆ m_connection [1/2]
The connection to the device.
◆ m_connection [2/2]
The connection to the device.
◆ m_deviceHandle
LJ_HANDLE SurgSim::Devices::LabJackScaffold::Handle::m_deviceHandle |
|
private |
The exodriver device handle (or LABJACK_INVALID_HANDLE if not valid).
The HDAL device handle (or LABJACK_INVALID_HANDLE if not valid).
◆ m_logger
std::shared_ptr< Framework::Logger > SurgSim::Devices::LabJackScaffold::Handle::m_logger |
|
private |
◆ m_model [1/2]
◆ m_model [2/2]
The documentation for this class was generated from the following file: