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

#include <DeviceRevision.h>

Inherits NetOceanDirect::ManagedObject< DeviceRevisionAPI >.

Public Member Functions

 DeviceRevision (DeviceRevisionAPI *instance)
 
virtual ~DeviceRevision ()
 
String getRevisionFirmware (long deviceID, int% errorCode)
 
String getRevisionFPGA (long deviceID, int% errorCode)
 
String getRevisionSystem (long deviceID, int% errorCode)
 
- Public Member Functions inherited from NetOceanDirect::ManagedObject< DeviceRevisionAPI >
 ManagedObject (DeviceRevisionAPI *instance)
 
 !ManagedObject ()
 
virtual ~ManagedObject ()
 
DeviceRevisionAPI * GetInstance ()
 

Static Public Member Functions

static DeviceRevision getInstance ()
 

Protected Member Functions

 DeviceRevision ()
 

Static Protected Attributes

static DeviceRevision revision
 

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ DeviceRevision() [1/2]

DeviceRevision::DeviceRevision ( )
protected

◆ DeviceRevision() [2/2]

DeviceRevision::DeviceRevision ( DeviceRevisionAPI * instance)

◆ ~DeviceRevision()

virtual NetOceanDirect::DeviceRevision::~DeviceRevision ( )
inlinevirtual

Member Function Documentation

◆ getInstance()

DeviceRevision DeviceRevision::getInstance ( )
static

◆ getRevisionFirmware()

String DeviceRevision::getRevisionFirmware ( long deviceID,
int% errorCode )

Retrieves the firmware revision of the the given device or sets an error code if this is not available.

Parameters
[in]deviceIDthe device ID for the device to be queried (from OceanDirect::findDevices())
[out]errorCodeset to 0 if successful, an OceanDirect error code (nonzero) otherwise
Returns
the firmware revision, or null if an error occurred

◆ getRevisionFPGA()

String DeviceRevision::getRevisionFPGA ( long deviceID,
int% errorCode )

Retrieves the fpga revision of the the given device or sets an error code if this is not available.

Parameters
[in]deviceIDthe device ID for the device to be queried (from OceanDirect::findDevices())
[out]errorCodeset to 0 if successful, an OceanDirect error code (nonzero) otherwise
Returns
the fpga revision, or null if an error occurred

◆ getRevisionSystem()

String DeviceRevision::getRevisionSystem ( long deviceID,
int% errorCode )

Retrieves the system revision of the the given device or sets an error code if this is not available.

Parameters
[in]deviceIDthe device ID for the device to be queried (from OceanDirect::findDevices())
[out]errorCodeset to 0 if successful, an OceanDirect error code (nonzero) otherwise
Returns
the system revision, or null if an error occurred

Member Data Documentation

◆ revision

DeviceRevision NetOceanDirect::DeviceRevision::revision
staticprotected

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