OceanDirectLighthouse 3.1.3
OceanDirect Lighthouse C++/C API
oceandirect::api::LHNetworkConfigurationAPI Class Reference

#include <LHNetworkConfigurationAPI.h>

Public Member Functions

virtual ~LHNetworkConfigurationAPI ()=default
 
virtual bool getEthernetAddOnAvailable (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual void getEthernetMACAddress (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_mac_address_array_t outMACAddress, size_t outMACAddressSize)
 
virtual lh_ip_assign_mode_t getIPAddressAssignedMode (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual void getManualNetworkConfiguration (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_network_configuration_t &configuration)
 
virtual void getNetworkConfiguration (lh_device_id_t deviceID, lh_error_code_t *errorCode, bool &outManualAssignment, lh_network_configuration_t &configuration)
 
virtual void setIPAddressAssignedMode (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_ip_assign_mode_t mode)
 
virtual void setManualNetworkConfiguration (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_network_configuration_t &configuration)
 

Constructor & Destructor Documentation

◆ ~LHNetworkConfigurationAPI()

virtual oceandirect::api::LHNetworkConfigurationAPI::~LHNetworkConfigurationAPI ( )
virtualdefault

Member Function Documentation

◆ getEthernetAddOnAvailable()

virtual bool oceandirect::api::LHNetworkConfigurationAPI::getEthernetAddOnAvailable ( lh_device_id_t deviceID,
lh_error_code_t * errorCode )
virtual

.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()

virtual void oceandirect::api::LHNetworkConfigurationAPI::getEthernetMACAddress ( lh_device_id_t deviceID,
lh_error_code_t * errorCode,
lh_mac_address_array_t outMACAddress,
size_t outMACAddressSize )
virtual

.getEthernetMACAddress Get the MAC address of the device.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
outMACAddressthe array where the retrieved MAC address will be stored.
outMACAddressSizethe size of the array outMACAddress (6).

◆ getIPAddressAssignedMode()

virtual lh_ip_assign_mode_t oceandirect::api::LHNetworkConfigurationAPI::getIPAddressAssignedMode ( lh_device_id_t deviceID,
lh_error_code_t * errorCode )
virtual

.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()

virtual void oceandirect::api::LHNetworkConfigurationAPI::getManualNetworkConfiguration ( lh_device_id_t deviceID,
lh_error_code_t * errorCode,
lh_network_configuration_t & configuration )
virtual

.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()

virtual void oceandirect::api::LHNetworkConfigurationAPI::getNetworkConfiguration ( lh_device_id_t deviceID,
lh_error_code_t * errorCode,
bool & outManualAssignment,
lh_network_configuration_t & configuration )
virtual

.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()

virtual void oceandirect::api::LHNetworkConfigurationAPI::setIPAddressAssignedMode ( lh_device_id_t deviceID,
lh_error_code_t * errorCode,
lh_ip_assign_mode_t mode )
virtual

.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()

virtual void oceandirect::api::LHNetworkConfigurationAPI::setManualNetworkConfiguration ( lh_device_id_t deviceID,
lh_error_code_t * errorCode,
lh_network_configuration_t & configuration )
virtual

.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 file: