optris::DeviceNetworkConfig Class Reference

Encapsulates the on device network configuration. More...

#include <DeviceNetworkConfig.h>

Collaboration diagram for optris::DeviceNetworkConfig:

Public Member Functions
	DeviceNetworkConfig ()=default
	Constructor.
	DeviceNetworkConfig (const IpAddress &deviceIp, const IpAddress &destinationIp, const Port &destinationPort, const IpAddress &subnetMask) noexcept
	Constructor.
const IpAddress &	getDeviceIp () const noexcept
	Returns the IP address of the device.
const IpAddress &	getDestinationIp () const noexcept
	Returns the IP address to which the device sends its data to.
const Port &	getDestinationPort () const noexcept
	Returns the port to which the device sends its data to.
const IpAddress &	getSubnetMask () const noexcept
	Returns the subnet mask.
void	setDeviceIp (const IpAddress &address) noexcept
	Sets the device IP address.
void	setDestinationIp (const IpAddress &address) noexcept
	Sets the destination IP address to which the device sends its data to.
void	setDestinationPort (const Port &port) noexcept
	Sets the port to which the device sends its data to.
void	setSubnetMask (const IpAddress &subnetMask) noexcept
	Sets the subnet mask.
bool	operator== (const DeviceNetworkConfig &rhs) const noexcept
	Returns whether this configuration equals the provided one.
bool	operator!= (const DeviceNetworkConfig &rhs) const noexcept
	Returns whether this configuration is different from the provided one.

Detailed Description

Encapsulates the on device network configuration.

Constructor & Destructor Documentation

DeviceNetworkConfig()

optris::DeviceNetworkConfig::DeviceNetworkConfig ( const IpAddress &  deviceIp, const IpAddress &  destinationIp, const Port &  destinationPort, const IpAddress &  subnetMask  )

inlinenoexcept

Constructor.

Parameters

[in]	deviceIp	address.
[in]	destinationIp	address for the device to send data to.
[in]	destinationPort	for the device to send data to.
[in]	subnetMask	of the network.

Member Function Documentation

getDestinationIp()

const IpAddress & optris::DeviceNetworkConfig::getDestinationIp ( ) const

inlinenoexcept

Returns the IP address to which the device sends its data to.

Returns

IP address to which the device sends its data to.

getDestinationPort()

const Port & optris::DeviceNetworkConfig::getDestinationPort ( ) const

inlinenoexcept

Returns the port to which the device sends its data to.

Returns

port to which the device sends its data to.

getDeviceIp()

const IpAddress & optris::DeviceNetworkConfig::getDeviceIp ( ) const

inlinenoexcept

Returns the IP address of the device.

Returns

IP address of the device.

getSubnetMask()

const IpAddress & optris::DeviceNetworkConfig::getSubnetMask ( ) const

inlinenoexcept

Returns the subnet mask.

Returns

subnet mask.

operator!=()

bool optris::DeviceNetworkConfig::operator!= ( const DeviceNetworkConfig &  rhs ) const

inlinenoexcept

Returns whether this configuration is different from the provided one.

Parameters

[in]

rhs

device network configuration to compare this one to.

Returns

true, if this configuration is different from the provided one.

operator==()

bool optris::DeviceNetworkConfig::operator== ( const DeviceNetworkConfig &  rhs ) const

inlinenoexcept

Returns whether this configuration equals the provided one.

Parameters

[in]

rhs

device network configuration to compare this one to.

Returns

true, if this configuration equals the provided one.

setDestinationIp()

void optris::DeviceNetworkConfig::setDestinationIp ( const IpAddress &  address )

inlinenoexcept

Sets the destination IP address to which the device sends its data to.

Parameters

[in]

address

to set.

setDestinationPort()

void optris::DeviceNetworkConfig::setDestinationPort ( const Port &  port )

inlinenoexcept

Sets the port to which the device sends its data to.

Parameters

[in]

port

to set.

setDeviceIp()

void optris::DeviceNetworkConfig::setDeviceIp ( const IpAddress &  address )

inlinenoexcept

Sets the device IP address.

Parameters

[in]

address

to set.

setSubnetMask()

void optris::DeviceNetworkConfig::setSubnetMask ( const IpAddress &  subnetMask )

inlinenoexcept

Sets the subnet mask.

Parameters

[in]

subnetMask

to set.

---

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

• DeviceNetworkConfig.h