NetOceanDirect  2.4.0
OceanDirect .NET API
Public Member Functions | Static Public Member Functions | List of all members
NetOceanDirect::SerialPort Class Reference

Inherits NetOceanDirect::ManagedObject< SerialPortAPI >.

Public Member Functions

int getBaudRate (long deviceID, int %errorCode)
 
void saveBaudRateSettings (long deviceID, int %errorCode)
 
void setBaudRate (long deviceID, int %errorCode, int baudRate)
 
- Public Member Functions inherited from NetOceanDirect::ManagedObject< SerialPortAPI >
 ManagedObject (SerialPortAPI *instance)
 
SerialPortAPI * GetInstance ()
 

Static Public Member Functions

static SerialPort getInstance ()
 

Additional Inherited Members

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

Member Function Documentation

◆ getBaudRate()

int SerialPort::getBaudRate ( long  deviceID,
int %  errorCode 
)

Read the serial port baud rate..

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
Returns
the baud rate.

◆ saveBaudRateSettings()

void SerialPort::saveBaudRateSettings ( long  deviceID,
int %  errorCode 
)

Save baud settings on flash.

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

◆ setBaudRate()

void SerialPort::setBaudRate ( long  deviceID,
int %  errorCode,
int  baudRate 
)

Set the serial port baud rate.

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
[in]baudRatethe serial port baud rate

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