ItalaApiNET  1.3.3
Public Member Functions | Properties | List of all members
Itala.IDevice Interface Reference

Interface representing a device. Provides functions for image acquisition, camera configuration and event handling. It encloses the functionalities of GenTL's Datastream and Local Device modules. The instance must be disposed via IDevice.Dispose when it's no longer required. More...

Inherits IDisposable.

Inherited by Itala.ItalaDevice.

Public Member Functions

GenApi.INodeMap GetNodeMap ()
 Get the GenICam nodemap of the physical device. The nodemap instance is accessible via GenApi library and allows the user to configure the behaviour of the camera. More...
 
GenApi.INodeMap GetTLDeviceNodeMap ()
 Get the GenICam nodemap of GenTL's Local Device module. The nodemap instance is accessible via GenApi library and allows the user to configure the behaviour of the module. More...
 
GenApi.INodeMap GetDatastreamNodeMap ()
 Get the GenICam nodemap of GenTL's Datastream module. The nodemap instance is accessible via GenApi library and allows the user to configure the behaviour of the module. More...
 
void StartAcquisition (UInt64 bufferCount=16, UInt64 numFrames=0)
 Starts the image acquisition on the device. A number of buffers equal to bufferCount is allocated and kept in the acquisition engine input pool. Internally, the acquisition engine picks buffers from the input pool and fills them with new data, before pushing them to the output queue, in accordance with the policy defined by the GenTL SFNC standard feature "StreamBufferHandlingMode" (configurable through the Datastream nodemap). The acquisition engine keeps running until numFrames frames are pushed to the output queue(i.e.until the specified amount of frames is available to the user). The AcquisitionStart GenICam command is automatically executed and all the acquisition critical features are automatically locked by ItalaApiNET. The client code must not perform these two operations. More...
 
void StopAcquisition ()
 The image acquisition is stopped and all the resources deallocated. The AcquisitionStop GenICam command is automatically executed and all the acquisition critical features are automatically unlocked by ItalaApiNET. The client code must not perform these last two operations since they're automatically managed internally. More...
 
IImage GetNextImage (Int64 timeout)
 rabs the first available image buffer in the output queue of the acquisition engine.If the specified timeout expires, a TimeoutException occurs. When an image buffer is grabbed, it's removed from the acquisition engine and delivered to the client code so that its data can be used. When the image buffer is no longer required by the client code, it must be disposed with IImage.Dispose. More...
 
void EnableEvents ()
 Starts the event functionality. The event listening thread is started and ItalaApiNET waits for incoming events from the device. More...
 
void DisableEvents ()
 Stops the event functionality. The event listening thread is stopped. More...
 

Properties

DeviceEventHandler DeviceEvent
 Subscribes and Unsubscribe a DeviceEventHandler instance to the current device. The implementation must be provided by the client code. More...
 
UInt64 TimestampFrequency [get]
 Get the tick frequency of the device timestamp counter in ticks per second.The counter is used, for instance, to assign timestamps to the individual acquired images; More...
 
DeviceInfo DeviceInfo [get]
 Get the informatin object of the device. More...
 

Detailed Description

Interface representing a device. Provides functions for image acquisition, camera configuration and event handling. It encloses the functionalities of GenTL's Datastream and Local Device modules. The instance must be disposed via IDevice.Dispose when it's no longer required.

Member Function Documentation

◆ GetNodeMap()

GenApi.INodeMap Itala.IDevice.GetNodeMap ( )

Get the GenICam nodemap of the physical device. The nodemap instance is accessible via GenApi library and allows the user to configure the behaviour of the camera.

Returns
Reference to the device nodemap.

◆ GetTLDeviceNodeMap()

GenApi.INodeMap Itala.IDevice.GetTLDeviceNodeMap ( )

Get the GenICam nodemap of GenTL's Local Device module. The nodemap instance is accessible via GenApi library and allows the user to configure the behaviour of the module.

Returns
Reference to GenTL Local Device module's nodemap.

◆ GetDatastreamNodeMap()

GenApi.INodeMap Itala.IDevice.GetDatastreamNodeMap ( )

Get the GenICam nodemap of GenTL's Datastream module. The nodemap instance is accessible via GenApi library and allows the user to configure the behaviour of the module.

Returns
Reference to GenTL Datastream module's nodemap.

◆ StartAcquisition()

void Itala.IDevice.StartAcquisition ( UInt64  bufferCount = 16,
UInt64  numFrames = 0 
)

Starts the image acquisition on the device. A number of buffers equal to bufferCount is allocated and kept in the acquisition engine input pool. Internally, the acquisition engine picks buffers from the input pool and fills them with new data, before pushing them to the output queue, in accordance with the policy defined by the GenTL SFNC standard feature "StreamBufferHandlingMode" (configurable through the Datastream nodemap). The acquisition engine keeps running until numFrames frames are pushed to the output queue(i.e.until the specified amount of frames is available to the user). The AcquisitionStart GenICam command is automatically executed and all the acquisition critical features are automatically locked by ItalaApiNET. The client code must not perform these two operations.

Parameters
bufferCountNumber of buffers to be used for acquisition
numFramesNumber of frames to be acquired. If 0, the acquisition runs continuously until IDevice.StopAcquisition is called.

◆ StopAcquisition()

void Itala.IDevice.StopAcquisition ( )

The image acquisition is stopped and all the resources deallocated. The AcquisitionStop GenICam command is automatically executed and all the acquisition critical features are automatically unlocked by ItalaApiNET. The client code must not perform these last two operations since they're automatically managed internally.

◆ GetNextImage()

IImage Itala.IDevice.GetNextImage ( Int64  timeout)

rabs the first available image buffer in the output queue of the acquisition engine.If the specified timeout expires, a TimeoutException occurs. When an image buffer is grabbed, it's removed from the acquisition engine and delivered to the client code so that its data can be used. When the image buffer is no longer required by the client code, it must be disposed with IImage.Dispose.

Parameters
timeoutThe amount of time in millisecond to wait for a new image
Returns
Reference to the grabbed image buffer

◆ EnableEvents()

void Itala.IDevice.EnableEvents ( )

Starts the event functionality. The event listening thread is started and ItalaApiNET waits for incoming events from the device.

◆ DisableEvents()

void Itala.IDevice.DisableEvents ( )

Stops the event functionality. The event listening thread is stopped.

Property Documentation

◆ DeviceEvent

DeviceEventHandler Itala.IDevice.DeviceEvent
addremove

Subscribes and Unsubscribe a DeviceEventHandler instance to the current device. The implementation must be provided by the client code.

◆ TimestampFrequency

UInt64 Itala.IDevice.TimestampFrequency
get

Get the tick frequency of the device timestamp counter in ticks per second.The counter is used, for instance, to assign timestamps to the individual acquired images;

◆ DeviceInfo

DeviceInfo Itala.IDevice.DeviceInfo
get

Get the informatin object of the device.


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