NetOceanDirectLighthouse 3.1.3
OceanDirect Lighthouse .NET API
NetLighthouse::NetLighthouseDeviceInformation Class Reference

#include <NetLighthouseDeviceInformation.h>

Inherits ManagedObject.

Public Member Functions

 ~NetLighthouseDeviceInformation ()
 
virtual String getDeviceAlias (unsigned int deviceID, int %errorCode)
 
virtual String getManufacturer (unsigned int deviceID, int %errorCode)
 
virtual String getModel (unsigned int deviceID, int %errorCode)
 
virtual String getOriginalManufacturer (unsigned int deviceID, int %errorCode)
 
virtual String getOriginalModel (unsigned int deviceID, int %errorCode)
 
virtual unsigned short getOriginalUsbPID (unsigned int deviceID, int %errorCode)
 
virtual unsigned short getOriginalUsbVID (unsigned int deviceID, int %errorCode)
 
virtual array< unsigned char > getRevisionFirmware (unsigned int deviceID, int %errorCode)
 
virtual array< unsigned char > getRevisionFPGA (unsigned int deviceID, int %errorCode)
 
virtual array< unsigned char > getRevisionSystem (unsigned int deviceID, int% errorCode)
 
virtual String getSerialNumber (unsigned int deviceID, int %errorCode)
 
virtual unsigned short getUsbPID (unsigned int deviceID, int %errorCode)
 
virtual unsigned short getUsbVID (unsigned int deviceID, int %errorCode)
 
virtual void resetDevice (unsigned int deviceID, int %errorCode)
 

Static Public Member Functions

static NetLighthouseDeviceInformation getInstance ()
 

Protected Member Functions

 NetLighthouseDeviceInformation ()
 

Static Protected Attributes

static NetLighthouseDeviceInformation devInfo
 

Constructor & Destructor Documentation

◆ NetLighthouseDeviceInformation()

NetLighthouseDeviceInformation::NetLighthouseDeviceInformation ( )
protected

◆ ~NetLighthouseDeviceInformation()

NetLighthouse::NetLighthouseDeviceInformation::~NetLighthouseDeviceInformation ( )
inline

Member Function Documentation

◆ getDeviceAlias()

String NetLighthouseDeviceInformation::getDeviceAlias ( unsigned int deviceID,
int % errorCode )
virtual

.getDeviceAlias Determine the device alias of the device.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
a string containing the device alias.

◆ getInstance()

NetLighthouseDeviceInformation NetLighthouseDeviceInformation::getInstance ( )
static

◆ getManufacturer()

String NetLighthouseDeviceInformation::getManufacturer ( unsigned int deviceID,
int % errorCode )
virtual

.getManufacturer Determine the current manufacturer stored string.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
a string containing the current manufacturer.

◆ getModel()

String NetLighthouseDeviceInformation::getModel ( unsigned int deviceID,
int % errorCode )
virtual

.getModel Determine the current model stored string.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
a string containing the current model.

◆ getOriginalManufacturer()

String NetLighthouseDeviceInformation::getOriginalManufacturer ( unsigned int deviceID,
int % errorCode )
virtual

.getOriginalManufacturer Determine the original manufacturer stored string.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
a string containing the original manufacturer

◆ getOriginalModel()

String NetLighthouseDeviceInformation::getOriginalModel ( unsigned int deviceID,
int % errorCode )
virtual

.getOriginalModel Determine the original model stored string.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
a string containing the original model.

◆ getOriginalUsbPID()

unsigned short NetLighthouseDeviceInformation::getOriginalUsbPID ( unsigned int deviceID,
int % errorCode )
virtual

.getOriginalUsbPID Determine the original device USB Product ID.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the original USB Product ID or 0 on error.

◆ getOriginalUsbVID()

unsigned short NetLighthouseDeviceInformation::getOriginalUsbVID ( unsigned int deviceID,
int % errorCode )
virtual

.getOriginalUsbVID Determine the original device USB Vendor ID.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the original USB Vendor ID or 0 on error.

◆ getRevisionFirmware()

array< unsigned char > NetLighthouseDeviceInformation::getRevisionFirmware ( unsigned int deviceID,
int % errorCode )
virtual

.getRevisionFirmware Determine the firmware version of the device.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
an array containing the firmware version numbers (major, minor, point).

◆ getRevisionFPGA()

array< unsigned char > NetLighthouseDeviceInformation::getRevisionFPGA ( unsigned int deviceID,
int % errorCode )
virtual

.getRevisionFPGA Determine the FPGA version of the device.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
an array containing the FPGA version numbers (major, minor, point).

◆ getRevisionSystem()

array< unsigned char > NetLighthouseDeviceInformation::getRevisionSystem ( unsigned int deviceID,
int% errorCode )
virtual

.getRevisionSystem Determine the System version of the device.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
an array containing the System version numbers (major, minor, point).

◆ getSerialNumber()

String NetLighthouseDeviceInformation::getSerialNumber ( unsigned int deviceID,
int % errorCode )
virtual

.getSerialNumber Determine the serial number of the device.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
a string containing the serial number

◆ getUsbPID()

unsigned short NetLighthouseDeviceInformation::getUsbPID ( unsigned int deviceID,
int % errorCode )
virtual

.getUsbPID Determine the current device USB Product ID.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the current USB Product ID or 0 on error.

◆ getUsbVID()

unsigned short NetLighthouseDeviceInformation::getUsbVID ( unsigned int deviceID,
int % errorCode )
virtual

.getUsbVID Determine the current device USB Vendor ID.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the current USB Vendor ID or 0 on error.

◆ resetDevice()

void NetLighthouseDeviceInformation::resetDevice ( unsigned int deviceID,
int % errorCode )
virtual

.resetDevice Trigger a software reset of the device.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.

Member Data Documentation

◆ devInfo

NetLighthouseDeviceInformation NetLighthouse::NetLighthouseDeviceInformation::devInfo
staticprotected

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