OceanDirectLighthouseC++ 3.1.3
OceanDirect Lighthouse C++/C API
oceandirect::api::DeviceInformationAPI Class Reference

#include <DeviceInformationAPI.h>

Public Member Functions

 DeviceInformationAPI ()
 
virtual ~DeviceInformationAPI ()
 
virtual int getManufacturerString (long deviceID, int *errorCode, char *buffer, int bufferLength)
 
virtual int getModelString (long deviceID, int *errorCode, char *buffer, int bufferLength)
 
virtual int getOriginalManufacturerString (long deviceID, int *errorCode, char *buffer, int bufferLength)
 
virtual int getOriginalModelString (long deviceID, int *errorCode, char *buffer, int bufferLength)
 
virtual std::uint16_t getOriginalUsbPID (long deviceID, int *errorCode)
 
virtual std::uint16_t getOriginalUsbVID (long deviceID, int *errorCode)
 
virtual std::uint16_t getUsbPID (long deviceID, int *errorCode)
 
virtual std::uint16_t getUsbVID (long deviceID, int *errorCode)
 
virtual void resetDevice (long deviceID, int *errorCode)
 
virtual void setManufacturerString (long deviceID, int *errorCode, char *buffer, int bufferLength)
 
virtual void setModelString (long deviceID, int *errorCode, char *buffer, int bufferLength)
 
virtual void setUsbPID (long deviceID, int *errorCode, std::uint16_t pid)
 
virtual void setUsbVID (long deviceID, int *errorCode, std::uint16_t vid)
 

Static Public Member Functions

static DeviceInformationAPIgetInstance ()
 
static void shutdown ()
 

Static Protected Attributes

static DeviceInformationAPIinstance
 

Constructor & Destructor Documentation

◆ DeviceInformationAPI()

oceandirect::api::DeviceInformationAPI::DeviceInformationAPI ( )

◆ ~DeviceInformationAPI()

virtual oceandirect::api::DeviceInformationAPI::~DeviceInformationAPI ( )
virtual

Member Function Documentation

◆ getInstance()

static DeviceInformationAPI * oceandirect::api::DeviceInformationAPI::getInstance ( )
static

◆ getManufacturerString()

virtual int oceandirect::api::DeviceInformationAPI::getManufacturerString ( long deviceID,
int * errorCode,
char * buffer,
int bufferLength )
virtual

◆ getModelString()

virtual int oceandirect::api::DeviceInformationAPI::getModelString ( long deviceID,
int * errorCode,
char * buffer,
int bufferLength )
virtual

◆ getOriginalManufacturerString()

virtual int oceandirect::api::DeviceInformationAPI::getOriginalManufacturerString ( long deviceID,
int * errorCode,
char * buffer,
int bufferLength )
virtual

◆ getOriginalModelString()

virtual int oceandirect::api::DeviceInformationAPI::getOriginalModelString ( long deviceID,
int * errorCode,
char * buffer,
int bufferLength )
virtual

◆ getOriginalUsbPID()

virtual std::uint16_t oceandirect::api::DeviceInformationAPI::getOriginalUsbPID ( long deviceID,
int * errorCode )
virtual

◆ getOriginalUsbVID()

virtual std::uint16_t oceandirect::api::DeviceInformationAPI::getOriginalUsbVID ( long deviceID,
int * errorCode )
virtual

◆ getUsbPID()

virtual std::uint16_t oceandirect::api::DeviceInformationAPI::getUsbPID ( long deviceID,
int * errorCode )
virtual

◆ getUsbVID()

virtual std::uint16_t oceandirect::api::DeviceInformationAPI::getUsbVID ( long deviceID,
int * errorCode )
virtual

◆ resetDevice()

virtual void oceandirect::api::DeviceInformationAPI::resetDevice ( long deviceID,
int * errorCode )
virtual

◆ setManufacturerString()

virtual void oceandirect::api::DeviceInformationAPI::setManufacturerString ( long deviceID,
int * errorCode,
char * buffer,
int bufferLength )
virtual

◆ setModelString()

virtual void oceandirect::api::DeviceInformationAPI::setModelString ( long deviceID,
int * errorCode,
char * buffer,
int bufferLength )
virtual

◆ setUsbPID()

virtual void oceandirect::api::DeviceInformationAPI::setUsbPID ( long deviceID,
int * errorCode,
std::uint16_t pid )
virtual

◆ setUsbVID()

virtual void oceandirect::api::DeviceInformationAPI::setUsbVID ( long deviceID,
int * errorCode,
std::uint16_t vid )
virtual

◆ shutdown()

static void oceandirect::api::DeviceInformationAPI::shutdown ( )
static

Member Data Documentation

◆ instance

DeviceInformationAPI* oceandirect::api::DeviceInformationAPI::instance
staticprotected

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