Atlas-Cronos  7.3.0
Public Member Functions | Protected Member Functions | Protected Attributes | Properties | Events | List of all members
Flir.Atlas.Live.Device.CameraBase Class Reference

Base class for camera communication. More...

Inheritance diagram for Flir.Atlas.Live.Device.CameraBase:
Flir.Atlas.Live.Device.Camera Flir.Atlas.Live.Device.StreamingCamera Flir.Atlas.Live.Device.ThermalCamera Flir.Atlas.Live.Device.VideoOverlayCamera Flir.Atlas.Live.Device.DualStreamingThermalCamera Flir.Atlas.Live.Device.ThermalGigabitCamera Flir.Atlas.Live.Device.ThermalSpinnakerCamera

Public Member Functions

 CameraBase ()
 Initializes a new instance of the Camera More...
 
virtual void Connect (CameraDeviceInfo camera, SecurityParameters securityParameters=null)
 Asynchronous connects to a camera device. More...
 
virtual void Disconnect ()
 Disconnect the camera device. More...
 
virtual void Dispose ()
 Dispose the camera instance. More...
 

Protected Member Functions

virtual void DisposeCamera ()
 Get rid of the camera instance. More...
 
virtual void ProcessData ()
 Override if you need to process some custom data every cycle. More...
 
virtual bool CheckDevice ()
 Check if device is still alive. More...
 
virtual bool ConnectToCamera ()
 Connect camera More...
 
virtual void OnStatusChanged (ConnectionStatus status)
 Connection status More...
 
virtual void OnDeviceError (DeviceErrorEventArgs args)
 Fires DeviceError. More...
 

Protected Attributes

ICameraAdapter Device
 CLI Camera device. More...
 
Object LockDevice = new object()
 Sync. object for camera device. More...
 
Stopwatch CheckHeartbeat = new Stopwatch()
 Keep camera connection alive More...
 
const int TimeoutCheckForHeartbeat = 2000
 Interval when to check if camera is still present. More...
 

Properties

Diagnostics Diagnostics [get, protected set]
 Diagnostic information can be useful when debugging an application. More...
 
int TimelapseReconnect [get, set]
 Timelapse in milli seconds to wait before retrying to connect. More...
 
RemoteControl RemoteControl [get, protected set]
 Remotely control a camera device. More...
 
bool AutoReconnect [get, set]
 Automatically retries to connect to the camera if the connection is lost. More...
 
CameraDeviceInfo CameraDeviceInfo [get, set]
 Connected camera device information. More...
 
SecurityParameters SecurityParameters [get, set]
 Security parameters to use when connecting to the camera. More...
 
bool IsConnected [get]
 Check if the camera is connected. More...
 
ConnectionStatus ConnectionStatus [get, protected set]
 The camera connection status. More...
 
static string Version [get]
 Gets the used Atlas version. More...
 

Events

EventHandler< ConnectionStatusChangedEventArgsConnectionStatusChanged
 This event is fired when the connection status has changed. More...
 
EventHandler< DeviceErrorEventArgsDeviceError
 This event is fired when an error is detected. More...
 

Detailed Description

Base class for camera communication.

Constructor & Destructor Documentation

◆ CameraBase()

Flir.Atlas.Live.Device.CameraBase.CameraBase ( )
inline

Initializes a new instance of the Camera

Member Function Documentation

◆ CheckDevice()

virtual bool Flir.Atlas.Live.Device.CameraBase.CheckDevice ( )
inlineprotectedvirtual

Check if device is still alive.

Returns

◆ Connect()

virtual void Flir.Atlas.Live.Device.CameraBase.Connect ( CameraDeviceInfo  camera,
SecurityParameters  securityParameters = null 
)
inlinevirtual

Asynchronous connects to a camera device.

Parameters
cameraThe camera to connect.
securityParametersSecurity parameters to use when connecting
Examples
<![CDATA[
// Scan for an A310 camera with static ip address 192.168.1.10.
var device = CameraDeviceInfo.Create("192.168.1.10", Interface.Network);
if (device != null)
{
cam.Connect(device);
// wait until we are connected...
while (!cam.IsConnected)
{
Thread.Sleep(100);
}
// we are connected...
// Send a command to the camera.
if (cam.RemoteControl.Focus.IsSupported())
{
cam.RemoteControl.Focus.Mode(FocusMode.Auto);
}
// we are done, disconnect.
cam.Disconnect();
}
]]>

Reimplemented in Flir.Atlas.Live.Device.DualStreamingThermalCamera, Flir.Atlas.Live.Device.StreamingCamera, Flir.Atlas.Live.Device.ThermalCamera, and Flir.Atlas.Live.Device.VideoOverlayCamera.

◆ ConnectToCamera()

virtual bool Flir.Atlas.Live.Device.CameraBase.ConnectToCamera ( )
inlineprotectedvirtual

Connect camera

Returns

Reimplemented in Flir.Atlas.Live.Device.ThermalGigabitCamera.

◆ Disconnect()

virtual void Flir.Atlas.Live.Device.CameraBase.Disconnect ( )
inlinevirtual

Disconnect the camera device.

◆ Dispose()

virtual void Flir.Atlas.Live.Device.CameraBase.Dispose ( )
inlinevirtual

◆ DisposeCamera()

virtual void Flir.Atlas.Live.Device.CameraBase.DisposeCamera ( )
inlineprotectedvirtual

Get rid of the camera instance.

Reimplemented in Flir.Atlas.Live.Device.Camera.

◆ OnDeviceError()

virtual void Flir.Atlas.Live.Device.CameraBase.OnDeviceError ( DeviceErrorEventArgs  args)
inlineprotectedvirtual

Fires DeviceError.

Parameters
argsError message.

◆ OnStatusChanged()

virtual void Flir.Atlas.Live.Device.CameraBase.OnStatusChanged ( ConnectionStatus  status)
inlineprotectedvirtual

Connection status

Parameters
status

Reimplemented in Flir.Atlas.Live.Device.Camera.

◆ ProcessData()

virtual void Flir.Atlas.Live.Device.CameraBase.ProcessData ( )
inlineprotectedvirtual

Override if you need to process some custom data every cycle.

Member Data Documentation

◆ CheckHeartbeat

Stopwatch Flir.Atlas.Live.Device.CameraBase.CheckHeartbeat = new Stopwatch()
protected

Keep camera connection alive

◆ Device

ICameraAdapter Flir.Atlas.Live.Device.CameraBase.Device
protected

CLI Camera device.

◆ LockDevice

Object Flir.Atlas.Live.Device.CameraBase.LockDevice = new object()
protected

Sync. object for camera device.

◆ TimeoutCheckForHeartbeat

const int Flir.Atlas.Live.Device.CameraBase.TimeoutCheckForHeartbeat = 2000
protected

Interval when to check if camera is still present.

Property Documentation

◆ AutoReconnect

bool Flir.Atlas.Live.Device.CameraBase.AutoReconnect
getset

Automatically retries to connect to the camera if the connection is lost.

◆ CameraDeviceInfo

CameraDeviceInfo Flir.Atlas.Live.Device.CameraBase.CameraDeviceInfo
getset

Connected camera device information.

◆ ConnectionStatus

ConnectionStatus Flir.Atlas.Live.Device.CameraBase.ConnectionStatus
getprotected set

The camera connection status.

◆ Diagnostics

Diagnostics Flir.Atlas.Live.Device.CameraBase.Diagnostics
getprotected set

Diagnostic information can be useful when debugging an application.

◆ IsConnected

bool Flir.Atlas.Live.Device.CameraBase.IsConnected
get

Check if the camera is connected.

◆ RemoteControl

RemoteControl Flir.Atlas.Live.Device.CameraBase.RemoteControl
getprotected set

Remotely control a camera device.

◆ SecurityParameters

SecurityParameters Flir.Atlas.Live.Device.CameraBase.SecurityParameters
getset

Security parameters to use when connecting to the camera.

◆ TimelapseReconnect

int Flir.Atlas.Live.Device.CameraBase.TimelapseReconnect
getset

Timelapse in milli seconds to wait before retrying to connect.

◆ Version

string Flir.Atlas.Live.Device.CameraBase.Version
staticget

Gets the used Atlas version.

Event Documentation

◆ ConnectionStatusChanged

EventHandler<ConnectionStatusChangedEventArgs> Flir.Atlas.Live.Device.CameraBase.ConnectionStatusChanged

This event is fired when the connection status has changed.

◆ DeviceError

EventHandler<DeviceErrorEventArgs> Flir.Atlas.Live.Device.CameraBase.DeviceError

This event is fired when an error is detected.