All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
SurgSim::Device::LabJackScaffold::Handle Class Reference
Collaboration diagram for SurgSim::Device::LabJackScaffold::Handle:
Collaboration graph
[legend]

Public Member Functions

 Handle (SurgSim::Device::LabJack::Model model, SurgSim::Device::LabJack::Connection connection, const std::string &address)
 Constructor that attempts to open a device. More...
 
 ~Handle ()
 Destructor. More...
 
bool isValid () const
 
void create ()
 Helper function called by the constructor to open the LabJack device for communications. More...
 
bool destroy ()
 
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. More...
 
bool isValid () const
 
void create ()
 Helper function called by the constructor to open the LabJack device for communications. More...
 
bool destroy ()
 
LJ_HANDLE get () const
 

Private Member Functions

 Handle (const Handle &)
 
Handleoperator= (const Handle &)
 
 Handle (const Handle &)
 
Handleoperator= (const Handle &)
 

Private Attributes

LJ_HANDLE m_deviceHandle
 The exodriver device handle (or LABJACK_INVALID_HANDLE if not valid). More...
 
std::string m_address
 The address used to open the device. Can be the empty string if the first-found device was opened. More...
 
SurgSim::Device::LabJack::Model m_model
 The model of the device. More...
 
SurgSim::Device::LabJack::Connection m_connection
 The connection to the device. More...
 
std::shared_ptr< LabJackScaffoldm_scaffold
 The scaffold. More...
 
LabJack::Model m_model
 The device model. More...
 
LabJack::Connection m_connection
 The connection to the device. More...
 

Constructor & Destructor Documentation

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

Constructor that attempts to open a device.

Parameters
modelThe model of LabJack device to open (see strings in LabJackUD.h).
connectionHow to connect to the device (e.g., USB) (see strings in LabJackUD.h).
addressEither the ID or serial number (if USB), or the IP address.
SurgSim::Device::LabJackScaffold::Handle::~Handle ( )
inline

Destructor.

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

Constructor that attempts to open a device.

Parameters
modelThe model of LabJack device to open (see strings in LabJackUD.h).
connectionHow to connect to the device (e.g., USB) (see strings in LabJackUD.h).
addressEither the ID or serial number (if USB), or the IP address.
SurgSim::Device::LabJackScaffold::Handle::~Handle ( )
inline

Destructor.

SurgSim::Device::LabJackScaffold::Handle::Handle ( const Handle )
private

Member Function Documentation

void SurgSim::Device::LabJackScaffold::Handle::create ( )
inline

Helper function called by the constructor to open the LabJack device for communications.

void SurgSim::Device::LabJackScaffold::Handle::create ( )
inline

Helper function called by the constructor to open the LabJack device for communications.

bool SurgSim::Device::LabJackScaffold::Handle::destroy ( )
inline
bool SurgSim::Device::LabJackScaffold::Handle::destroy ( )
inline
LJ_HANDLE SurgSim::Device::LabJackScaffold::Handle::get ( ) const
inline
Returns
The LabJackUD's handle wrapped by this Handle.
LJ_HANDLE SurgSim::Device::LabJackScaffold::Handle::get ( ) const
inline
Returns
The LabJack SDK's handle wrapped by this Handle.
bool SurgSim::Device::LabJackScaffold::Handle::isValid ( ) const
inline
Returns
Whether or not the wrapped handle is valid.
bool SurgSim::Device::LabJackScaffold::Handle::isValid ( ) const
inline
Returns
Whether or not the wrapped handle is valid.
Handle& SurgSim::Device::LabJackScaffold::Handle::operator= ( const Handle )
private
Handle& SurgSim::Device::LabJackScaffold::Handle::operator= ( const Handle )
private

Member Data Documentation

std::string SurgSim::Device::LabJackScaffold::Handle::m_address
private

The address used to open the device. Can be the empty string if the first-found device was opened.

LabJack::Connection SurgSim::Device::LabJackScaffold::Handle::m_connection
private

The connection to the device.

SurgSim::Device::LabJack::Connection SurgSim::Device::LabJackScaffold::Handle::m_connection
private

The connection to the device.

LJ_HANDLE SurgSim::Device::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).

LabJack::Model SurgSim::Device::LabJackScaffold::Handle::m_model
private

The device model.

SurgSim::Device::LabJack::Model SurgSim::Device::LabJackScaffold::Handle::m_model
private

The model of the device.

std::shared_ptr< LabJackScaffold > SurgSim::Device::LabJackScaffold::Handle::m_scaffold
private

The scaffold.


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