NetOceanDirect  1.31.0
OceanDirect .NET API
Public Member Functions | Static Public Member Functions
NetOceanDirect::OpticalBench Class Reference

Inherits NetOceanDirect::ManagedObject< OpticalBenchAPI >.

Public Member Functions

String getArrayWavelength (long deviceID, int% errorCode)
 
String getCoating (long deviceID, int% errorCode)
 
unsigned short int getFiberDiameter (long deviceID, int% errorCode)
 
String getFilter (long deviceID, int% errorCode)
 
String getGrating (long deviceID, int% errorCode)
 
String getId (long deviceID, int% errorCode)
 
String getLensInstalled (long deviceID, int% errorCode)
 
String getSerialNumber (long deviceID, int% errorCode)
 
unsigned short int getSlitWidthMicrons (long deviceID, int% errorCode)
 
void setCoating (long deviceID, int% errorCode, String^ coating)
 
void setFiberDiameter (long deviceID, int% errorCode, unsigned short int diameterMicrons)
 
void setFilter (long deviceID, int% errorCode, String^ filter)
 
void setGrating (long deviceID, int% errorCode, String^ grating)
 
void setId (long deviceID, int% errorCode, String^ id)
 
void setSerialNumber (long deviceID, int% errorCode, String^ serialNumber)
 
void setSlitWidthMicrons (long deviceID, int% errorCode, unsigned short int widthMicrons)
 
- Public Member Functions inherited from NetOceanDirect::ManagedObject< OpticalBenchAPI >
 ManagedObject (OpticalBenchAPI *instance)
 
OpticalBenchAPI * GetInstance ()
 

Static Public Member Functions

static OpticalBench getInstance ()
 

Additional Inherited Members

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

Member Function Documentation

◆ getArrayWavelength()

String OpticalBench::getArrayWavelength ( long  deviceID,
int%  errorCode 
)

Retrieves the optical array wavelength from a given device.

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 array wavelength, or null if an error occurred

◆ getCoating()

String OpticalBench::getCoating ( long  deviceID,
int%  errorCode 
)

Retrieves the name of the optical bench coating from a given device.

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
a tracked handle to a new array containing the optical bench coating.

◆ getFiberDiameter()

unsigned short int OpticalBench::getFiberDiameter ( long  deviceID,
int%  errorCode 
)

Retrieves the optical bench fiber diameter from a given device.

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 optical bench fiber diameter.

◆ getFilter()

String OpticalBench::getFilter ( long  deviceID,
int%  errorCode 
)

Retrieves the name of the optical bench filter from a given device.

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
a tracked handle to a new array containing the filter name.

◆ getGrating()

String OpticalBench::getGrating ( long  deviceID,
int%  errorCode 
)

Retrieves the name of the optical bench diffraction grating from a given device.

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
a tracked handle to a new array containing the grating name.

◆ getId()

String OpticalBench::getId ( long  deviceID,
int%  errorCode 
)

Retrieves the optical bench ID from a given device.

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 optical bench id.

◆ getLensInstalled()

String OpticalBench::getLensInstalled ( long  deviceID,
int%  errorCode 
)

Retrieves whether a lens is installed for a given device.

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 string truw or false whether a lens is installed.

◆ getSerialNumber()

String OpticalBench::getSerialNumber ( long  deviceID,
int%  errorCode 
)

Retrieves the optical bench serial number from a given device.

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
a tracked handle to a new array containing the optical bench serial number.

◆ getSlitWidthMicrons()

unsigned short int OpticalBench::getSlitWidthMicrons ( long  deviceID,
int%  errorCode 
)

Retrieves the slit width from a given device. If this field in the device is not yet populated then a non-zero(6) code will be returned.

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 slit width, in microns, or null if an error occurred

◆ setCoating()

void OpticalBench::setCoating ( long  deviceID,
int%  errorCode,
String^  coating 
)

Set the optical bench coating of a given device.

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
[in]coatingthe optical bench coating.

◆ setFiberDiameter()

void OpticalBench::setFiberDiameter ( long  deviceID,
int%  errorCode,
unsigned short int  diameterMicrons 
)

Set the optical bench fiber diameter of a given device.

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
[in]diameterMicronsthe optical bench fiber diameter in microns.

◆ setFilter()

void OpticalBench::setFilter ( long  deviceID,
int%  errorCode,
String^  filter 
)

Set the optical bench filter of a given device.

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
[in]filterthe optical bench filter.

◆ setGrating()

void OpticalBench::setGrating ( long  deviceID,
int%  errorCode,
String^  grating 
)

Set the optical bench grating of a given device.

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
[in]gratingthe optical bench grating.

◆ setId()

void OpticalBench::setId ( long  deviceID,
int%  errorCode,
String^  id 
)

Set the optical bench fiber diameter of a given device.

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
[in]idthe optical bench ID.

◆ setSerialNumber()

void OpticalBench::setSerialNumber ( long  deviceID,
int%  errorCode,
String^  serialNumber 
)

Set the optical bench serial number of a given device.

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
[in]serialNumberthe optical bench serial number.

◆ setSlitWidthMicrons()

void OpticalBench::setSlitWidthMicrons ( long  deviceID,
int%  errorCode,
unsigned short int  widthMicrons 
)

Set the optical bench slit width of a given device.

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
[in]widthMicronsthe optical bench slit width in microns.

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