Atlas-Cronos  7.2.0
Public Member Functions | Properties | List of all members
Flir.Atlas.Live.Discovery.IpConfig Class Reference

Base class for IP configuration. More...

Public Member Functions

IpConfigError Connect ()
 Connect to the camera device. More...
 
void Disconnect ()
 Disconnect the camera device. More...
 
IpConfigError SetIp (string ip)
 Change the IP address. More...
 
IpConfigError SetIp (string ip, string subnetMask, string gateway)
 Change the IP settings. More...
 
IpConfigError EnableDhcp ()
 Enable DHCP. More...
 

Properties

IpConfigError Error [get]
 Gets the Error state More...
 
bool IsDhcpValid [get]
 Check if it is possible to change the DHCP setting. More...
 
bool IsDhcpEnabled [get]
 Check if DHCP is enabled. More...
 
string DefaultGateway [get]
 Device default gateway. More...
 
string SubnetMask [get]
 Device subnet mask. More...
 

Detailed Description

Base class for IP configuration.

See the "IP Config" sample for how to use this class.

Member Function Documentation

◆ Connect()

IpConfigError Flir.Atlas.Live.Discovery.IpConfig.Connect ( )
inline

Connect to the camera device.

Returns
Connection result.

◆ Disconnect()

void Flir.Atlas.Live.Discovery.IpConfig.Disconnect ( )
inline

Disconnect the camera device.

◆ EnableDhcp()

IpConfigError Flir.Atlas.Live.Discovery.IpConfig.EnableDhcp ( )
inline

Enable DHCP.

Gigabit cameras can only set DHCP if connected to a valid IP address. Check IsDhcpValid before using this property. If the gigabit camera is unreachable you first need to use a valid static IP address before it is possible to change the DHCP setting.

Returns
Exceptions
InvalidOperationException

◆ SetIp() [1/2]

IpConfigError Flir.Atlas.Live.Discovery.IpConfig.SetIp ( string  ip)
inline

Change the IP address.

Parameters
ipthe new IP address i.e. "192.168.0.1".
Returns
NoError if changing the IP address was successful.

The current subnet mask and gateway will be used.

◆ SetIp() [2/2]

IpConfigError Flir.Atlas.Live.Discovery.IpConfig.SetIp ( string  ip,
string  subnetMask,
string  gateway 
)
inline

Change the IP settings.

Parameters
ipThe new IP address i.e. "192.168.0.1"
subnetMaskThe new subnet mask i.e. "255.255.255.0"
gatewayThe new default gateway.
Exceptions
InvalidOperationExceptionCall connect before using SetIp.
Returns
NoError if changing the IP settings was successful.

Property Documentation

◆ DefaultGateway

string Flir.Atlas.Live.Discovery.IpConfig.DefaultGateway
get

Device default gateway.

Exceptions
InvalidOperationException

◆ Error

IpConfigError Flir.Atlas.Live.Discovery.IpConfig.Error
get

Gets the Error state

◆ IsDhcpEnabled

bool Flir.Atlas.Live.Discovery.IpConfig.IsDhcpEnabled
get

Check if DHCP is enabled.

Gigabit cameras can only set DHCP if connected to a valid IP address. Check IsDhcpValid before using this property. If the gigabit camera is unreachable you first need to use a valid static IP address before it is possible to change the DHCP setting.

◆ IsDhcpValid

bool Flir.Atlas.Live.Discovery.IpConfig.IsDhcpValid
get

Check if it is possible to change the DHCP setting.

Gigabit cameras can only change the DHCP setting if connected to a valid IP address.

◆ SubnetMask

string Flir.Atlas.Live.Discovery.IpConfig.SubnetMask
get

Device subnet mask.

Exceptions
InvalidOperationException