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

#include <Ethernet.h>

Inherits NetOceanDirect::ManagedObject< EthernetAPI >.

Public Member Functions

 Ethernet (EthernetAPI *instance)
 
virtual ~Ethernet ()
 
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)
 
 !ManagedObject ()
 
virtual ~ManagedObject ()
 
EthernetAPI * GetInstance ()
 

Static Public Member Functions

static Ethernet getInstance ()
 

Protected Member Functions

 Ethernet ()
 

Static Protected Attributes

static Ethernet ethernet
 

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ Ethernet() [1/2]

Ethernet::Ethernet ( )
protected

◆ Ethernet() [2/2]

Ethernet::Ethernet ( EthernetAPI * instance)

◆ ~Ethernet()

virtual NetOceanDirect::Ethernet::~Ethernet ( )
inlinevirtual

Member Function Documentation

◆ getGigabitEthernetEnableStatus() [1/2]

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

◆ getGigabitEthernetEnableStatus() [2/2]

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

Return the status on whether the gigabit ethernet is enabled or not. This function only applies to HDX/FX devices.

See also
setGigabitEthernetEnableStatus()
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.

◆ getInstance()

Ethernet Ethernet::getInstance ( )
static

◆ getMACAddress() [1/2]

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

◆ getMACAddress() [2/2]

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

Read the ethernet 6-byte mac address from the spectrometer. This function only applies to HDX/FX devices.

See also
setMACAddress()
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() [1/2]

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

◆ setGigabitEthernetEnableStatus() [2/2]

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

Enable or disable the gigabit ethernet status. This function only applies to HDX/FX devices.

See also
getGigabitEthernetEnableStatus()
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() [1/2]

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

◆ setMACAddress() [2/2]

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. This function only applies to HDX/FX devices.

See also
getMACAddress()
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.

Member Data Documentation

◆ ethernet

Ethernet NetOceanDirect::Ethernet::ethernet
staticprotected

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