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

Inherits NetOceanDirect::ManagedObject< EthernetAPI >.

Public Member Functions

bool getGigabitEthernetEnableStatus (long deviceID, int% errorCode)
 
bool getGigabitEthernetEnableStatus (long deviceID, int% errorCode, unsigned int interfaceIndex)
 
array< unsigned char > getMACAddress (long deviceID, int% errorCode)
 
array< unsigned char > getMACAddress (long deviceID, int% errorCode, unsigned int interfaceIndex)
 
void setGigabitEthernetEnableStatus (long deviceID, int% errorCode, bool enable)
 
void setGigabitEthernetEnableStatus (long deviceID, int% errorCode, unsigned int interfaceIndex, bool enable)
 
void setMACAddress (long deviceID, int% errorCode, array< unsigned char >^% macAddress)
 
void setMACAddress (long deviceID, int% errorCode, unsigned int interfaceIndex, array< unsigned char >^% macAddress)
 
- Public Member Functions inherited from NetOceanDirect::ManagedObject< EthernetAPI >
 ManagedObject (EthernetAPI *instance)
 
EthernetAPI * GetInstance ()
 

Static Public Member Functions

static Ethernet getInstance ()
 

Additional Inherited Members

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

Member Function Documentation

◆ getGigabitEthernetEnableStatus()

bool Ethernet::getGigabitEthernetEnableStatus ( long  deviceID,
int%  errorCode,
unsigned int  interfaceIndex 
)

Return the status on whether the gigabit ethernet is enabled or not.

Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodeon exit this contains zero on success, nonzero otherwise.
interfaceIndex[in]The ethernet interface to look at.
Returns
The interface status.

◆ getMACAddress()

array< unsigned char > Ethernet::getMACAddress ( long  deviceID,
int%  errorCode,
unsigned int  interfaceIndex 
)

Read the ethernet 6-byte mac address from the spectrometer.

Attention
For devices with a single interface, the interfaceIndex parameter is ignored.
Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodeon exit this contains zero on success, nonzero otherwise.
interfaceIndex[in]The ethernet interface to look at.
Returns
The ethernet mac address.

◆ setGigabitEthernetEnableStatus()

void Ethernet::setGigabitEthernetEnableStatus ( long  deviceID,
int%  errorCode,
unsigned int  interfaceIndex,
bool  enable 
)

Enable or disable the gigabit ethernet status.

Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodeon exit this contains zero on success, nonzero otherwise.
interfaceIndex[in]The ethernet interface to look at.
enable[in]True will enable gigabit ethernet. False disable the ethernet.

◆ setMACAddress()

void Ethernet::setMACAddress ( long  deviceID,
int%  errorCode,
unsigned int  interfaceIndex,
array< unsigned char >^%  macAddress 
)

Writes a new ethernet 6-byte mac address into the spectrometer.

Attention
For devices with a single interface, the interfaceIndex parameter is ignored.
Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodeon exit this contains zero on success, nonzero otherwise.
interfaceIndex[in]The ethernet interface to look at.
macAddress[in]The new mac address.

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