NetOceanDirectLighthouse  3.1.1
OceanDirect Lighthouse .NET API
Public Member Functions | Static Public Member Functions | Static Protected Attributes | List of all members
NetLighthouse::NetLighthouseNetworkConfiguration Class Reference

Inherits ManagedObject.

Public Member Functions

bool getEthernetAddOnAvailable (unsigned int deviceID, int %errorCode)
 
array< unsigned char > getEthernetMACAddress (unsigned int deviceID, int %errorCode)
 
net_lh_ip_assign_mode_t getIPAddressAssignedMode (unsigned int deviceID, int %errorCode)
 
void getManualNetworkConfiguration (unsigned int deviceID, int% errorCode, NetLHNetworkConfiguration^% configuration)
 
void getNetworkConfiguration (unsigned int deviceID, int %errorCode, bool %outManualAssignment, NetLHNetworkConfiguration^% configuration)
 
void setIPAddressAssignedMode (unsigned int deviceID, int% errorCode, net_lh_ip_assign_mode_t mode)
 
void setManualNetworkConfiguration (unsigned int deviceID, int% errorCode, NetLHNetworkConfiguration^ configuration)
 

Static Public Member Functions

static NetLighthouseNetworkConfiguration getInstance ()
 

Static Protected Attributes

static NetLighthouseNetworkConfiguration network
 

Member Function Documentation

◆ getEthernetAddOnAvailable()

bool NetLighthouseNetworkConfiguration::getEthernetAddOnAvailable ( unsigned int  deviceID,
int %  errorCode 
)

.getEthernetAddOnAvailable Determine if the device has an Ethernet add-on.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
true if the device has an Ethernet add-on, false otherwise.

◆ getEthernetMACAddress()

array< unsigned char > NetLighthouseNetworkConfiguration::getEthernetMACAddress ( unsigned int  deviceID,
int %  errorCode 
)

.getEthernetMACAddress Get the MAC address of the device.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the MAC address of the device.

◆ getIPAddressAssignedMode()

net_lh_ip_assign_mode_t NetLighthouseNetworkConfiguration::getIPAddressAssignedMode ( unsigned int  deviceID,
int %  errorCode 
)

.getIPAddressAssignedMode Read the IP address mode from the device.

See also
setIPAddressAssignedMode()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
"manual" if the ip address was statically assigned, "automatic" if the ip address was generated via DHCP, or "manual" on error.

◆ getManualNetworkConfiguration()

void NetLighthouseNetworkConfiguration::getManualNetworkConfiguration ( unsigned int  deviceID,
int%  errorCode,
NetLHNetworkConfiguration^%  configuration 
)

.getManualNetworkConfiguration Get the (manually set) network configuration parameters for the device.

See also
setManualNetworkConfiguration()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
configurationthe network configuration parameters: ipv4Address 4 bytes (array) specifying the IP address; ipv4AddressSize the size of the array ipv4Address (4); subnetMask 4 bytes (array) specifying the subnet mask; subnetMaskSize the size of the array subnetMask (4); defaultGateway 4 bytes (array) specifying the default network gateway; defaultGatewaySize the size of the array defaultGateway (4); dnsServer 4 bytes (array) specifying the DNS server; dnsServerSize the size of the array dnsServer(4).

◆ getNetworkConfiguration()

void NetLighthouseNetworkConfiguration::getNetworkConfiguration ( unsigned int  deviceID,
int %  errorCode,
bool %  outManualAssignment,
NetLHNetworkConfiguration^%  configuration 
)

.getNetworkConfiguration Get the network configuration parameters for the device.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
outManualAssignmenttrue if the configuration was set manually, false otherwise.
configurationthe network configuration parameters: ipv4Address 4 bytes (array) specifying the IP address; ipv4AddressSize the size of the array ipv4Address (4); subnetMask 4 bytes (array) specifying the subnet mask; subnetMaskSize the size of the array subnetMask (4); defaultGateway 4 bytes (array) specifying the default network gateway; defaultGatewaySize the size of the array defaultGateway (4); dnsServer 4 bytes (array) specifying the DNS server; dnsServerSize the size of the array dnsServer(4).

◆ setIPAddressAssignedMode()

void NetLighthouseNetworkConfiguration::setIPAddressAssignedMode ( unsigned int  deviceID,
int%  errorCode,
net_lh_ip_assign_mode_t  mode 
)

.setIPAddressAssignedMode Set the IP address mode for the device.

See also
getIPAddressAssignedMode()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
modeset to lh_ip_assign_mode_t::manual if the IP address is assigned manually or lh_ip_assign_mode_t::automatic if the address is assigned by DHCP.

◆ setManualNetworkConfiguration()

void NetLighthouseNetworkConfiguration::setManualNetworkConfiguration ( unsigned int  deviceID,
int%  errorCode,
NetLHNetworkConfiguration configuration 
)

.setManualNetworkConfiguration Set the (manually set) network configuration parameters for the device.

See also
getManualNetworkConfiguration()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
configurationthe network configuration parameters: ipv4Address 4 bytes (array) specifying the IP address; ipv4AddressSize the size of the array ipv4Address (4); subnetMask 4 bytes (array) specifying the subnet mask; subnetMaskSize the size of the array subnetMask (4); defaultGateway 4 bytes (array) specifying the default network gateway; defaultGatewaySize the size of the array defaultGateway (4); dnsServer 4 bytes (array) specifying the DNS server; dnsServerSize the size of the array dnsServer(4).

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