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

#include <DeviceAliasAPI.h>

Public Member Functions

 DeviceAliasAPI ()
 
virtual ~DeviceAliasAPI ()
 
virtual int getDeviceAlias (long deviceID, int *errorCode, char *buffer, int bufferLength)
 
virtual void setDeviceAlias (long deviceID, int *errorCode, char *buffer, int bufferLength)
 

Static Public Member Functions

static DeviceAliasAPIgetInstance ()
 
static void shutdown ()
 

Static Protected Attributes

static DeviceAliasAPIinstance
 

Constructor & Destructor Documentation

◆ DeviceAliasAPI()

oceandirect::api::DeviceAliasAPI::DeviceAliasAPI ( )

◆ ~DeviceAliasAPI()

virtual oceandirect::api::DeviceAliasAPI::~DeviceAliasAPI ( )
virtual

Member Function Documentation

◆ getDeviceAlias()

virtual int oceandirect::api::DeviceAliasAPI::getDeviceAlias ( long deviceID,
int * errorCode,
char * buffer,
int bufferLength )
virtual

Get the device alias of the device.

See also
setDeviceAlias()
Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found.
bufferthe buffer to receive the device alias.
bufferLengththe length of the buffer.
Returns
the number of bytes read.

◆ getInstance()

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

◆ setDeviceAlias()

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

Set the device alias of the device.

See also
getDeviceAlias()
Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found.
bufferthe buffer containing the desired device alias.
bufferLengththe length of the buffer.

◆ shutdown()

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

Member Data Documentation

◆ instance

DeviceAliasAPI* oceandirect::api::DeviceAliasAPI::instance
staticprotected

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