NetOceanDirect 3.1.3
OceanDirect .NET API
NetOceanDirect::DeviceInformation Class Reference

#include <DeviceInformation.h>

Inherits NetOceanDirect::ManagedObject< DeviceInformationAPI >.

Public Member Functions

 DeviceInformation (DeviceInformationAPI *instance)
 
virtual ~DeviceInformation ()
 
String getManufacturerString (long deviceID, int% errorCode)
 
String getModelString (long deviceID, int% errorCode)
 
String getOriginalManufacturerString (long deviceID, int% errorCode)
 
String getOriginalModelString (long deviceID, int% errorCode)
 
std::uint16_t getOriginalUsbPID (long deviceID, int% errorCode)
 
std::uint16_t getOriginalUsbVID (long deviceID, int% errorCode)
 
std::uint16_t getUsbPID (long deviceID, int% errorCode)
 
std::uint16_t getUsbVID (long deviceID, int% errorCode)
 
void resetDevice (long deviceID, int% errorCode)
 
void setManufacturerString (long deviceID, int% errorCode, String^ buffer)
 
void setModelString (long deviceID, int% errorCode, String^ buffer)
 
- Public Member Functions inherited from NetOceanDirect::ManagedObject< DeviceInformationAPI >
 ManagedObject (DeviceInformationAPI *instance)
 
 !ManagedObject ()
 
virtual ~ManagedObject ()
 
DeviceInformationAPI * GetInstance ()
 

Static Public Member Functions

static DeviceInformation getInstance ()
 

Protected Member Functions

 DeviceInformation ()
 

Static Protected Attributes

static DeviceInformation deviceInfo
 

Additional Inherited Members

- Protected Attributes inherited from NetOceanDirect::ManagedObject< DeviceInformationAPI >
DeviceInformationAPI * m_Instance
 

Constructor & Destructor Documentation

◆ DeviceInformation() [1/2]

DeviceInformation::DeviceInformation ( )
protected

◆ DeviceInformation() [2/2]

DeviceInformation::DeviceInformation ( DeviceInformationAPI * instance)

◆ ~DeviceInformation()

virtual NetOceanDirect::DeviceInformation::~DeviceInformation ( )
inlinevirtual

Member Function Documentation

◆ getInstance()

DeviceInformation DeviceInformation::getInstance ( )
static

◆ getManufacturerString()

String DeviceInformation::getManufacturerString ( long deviceID,
int% errorCode )

◆ getModelString()

String DeviceInformation::getModelString ( long deviceID,
int% errorCode )

◆ getOriginalManufacturerString()

String DeviceInformation::getOriginalManufacturerString ( long deviceID,
int% errorCode )

◆ getOriginalModelString()

String DeviceInformation::getOriginalModelString ( long deviceID,
int% errorCode )

◆ getOriginalUsbPID()

std::uint16_t DeviceInformation::getOriginalUsbPID ( long deviceID,
int% errorCode )

◆ getOriginalUsbVID()

std::uint16_t DeviceInformation::getOriginalUsbVID ( long deviceID,
int% errorCode )

◆ getUsbPID()

std::uint16_t DeviceInformation::getUsbPID ( long deviceID,
int% errorCode )

◆ getUsbVID()

std::uint16_t DeviceInformation::getUsbVID ( long deviceID,
int% errorCode )

◆ resetDevice()

void DeviceInformation::resetDevice ( long deviceID,
int% errorCode )

Enables/disables the specified strobe lamp connected to the given device.

Parameters
[in]deviceIDthe device ID for the device to be configured (from OceanDirect::findDevices())
[out]errorCodeset to 0 if successful, an OceanDirect error code (nonzero) otherwise ERROR_NO_DEVICE if deviceID is not a valid and open deviceID ERROR_FEATURE_NOT_FOUND if device does not support this feature ERROR_TRANSFER_ERROR if data transfer to/from device fails
[in]enableif true, lamp is to be enabled - will be disabled otherwise
See also
isEnabled()

◆ setManufacturerString()

void DeviceInformation::setManufacturerString ( long deviceID,
int% errorCode,
String^ buffer )

◆ setModelString()

void DeviceInformation::setModelString ( long deviceID,
int% errorCode,
String^ buffer )

Member Data Documentation

◆ deviceInfo

DeviceInformation NetOceanDirect::DeviceInformation::deviceInfo
staticprotected

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