ItalaApi  1.3.3
Public Member Functions | List of all members
Itala::ISystem Struct Referenceabstract
Inheritance diagram for Itala::ISystem:
Itala::IDisposable

Public Member Functions

virtual DeviceInfoList EnumerateDevices (uint64_t timeout)=0
 
virtual DeviceInfoList EnumerateDevices (InterfaceInfo itfInfo, uint64_t timeout)=0
 
virtual DeviceInfoList EnumerateDevices (InterfaceInfoList itfInfos, uint64_t timeout)=0
 
virtual IDeviceCreateDevice (DeviceInfo devInfo)=0
 
virtual GenApi::INodeMap & GetNodeMap () const =0
 
virtual InterfaceInfoList EnumerateInterfaces ()=0
 
virtual GenApi::INodeMap & GetInterfaceNodeMap (InterfaceInfo itfInfo)=0
 
- Public Member Functions inherited from Itala::IDisposable
virtual void Dispose ()=0
 

Detailed Description

Root of the API. This interface represents the whole runtime and its main task is to provide functions for device enumeration and configuration. Only one system can be created at a time. It encloses the functionalities defined by the GenTL standard. The ownership of the system instance belongs to the client code: it needs to be disposed when it's no longer required via ISystem::Dispose.

Member Function Documentation

◆ EnumerateDevices() [1/3]

virtual DeviceInfoList Itala::ISystem::EnumerateDevices ( uint64_t  timeout)
pure virtual

Enumerates devices across all interfaces. The maximum number of enumerated devices is 255.

Parameters
timeoutmaximum amount of time in ms for the enumeration to terminate.
Returns
A list of information objects identifying each enumerated device.

◆ EnumerateDevices() [2/3]

virtual DeviceInfoList Itala::ISystem::EnumerateDevices ( InterfaceInfo  itfInfo,
uint64_t  timeout 
)
pure virtual

Enumerates all devices under a specific network interface. The maximum number of enumerated devices is 255.

Parameters
itfInfoinfo object identyfing the interface to be used for enumeration.
timeoutmaximum amount of time in ms for the enumeration to terminate.
See also
EnumerateDevices()

◆ EnumerateDevices() [3/3]

virtual DeviceInfoList Itala::ISystem::EnumerateDevices ( InterfaceInfoList  itfInfos,
uint64_t  timeout 
)
pure virtual

Enumerates all devices under a list of specific interfaces. The maximum number of enumerated devices is 255.

Parameters
itfInfoslist of info objects identyfing the interfaces to be used for enumeration.
timeoutmaximum amount of time in ms for the enumeration to terminate.
See also
EnumerateDevices()

◆ CreateDevice()

virtual IDevice* Itala::ISystem::CreateDevice ( DeviceInfo  devInfo)
pure virtual

Creates a device instance which represents a physical device, given its identyfing info. The maximum number of simultaneously created devices is 50. When no longer needed, device instances must be disposed via IDevice::Dispose. The filter driver and packet resend functionalities are automatically enabled for the created device instance. Make sure the filter driver component is enabled on the NIC the device is connected to. If the instance is owned by a smart pointer, the IDevice::Dispose function must be used as deleter.

Parameters
devInfoinfo object identyfing the device to be created.
Returns
Pointer to the created device instance.

◆ GetNodeMap()

virtual GenApi::INodeMap& Itala::ISystem::GetNodeMap ( ) const
pure virtual

Get the GenICam nodemap of the GenTL System module. The nodemap instance is accessible via GenApi library and allows the user to configure the behaviour of the system. The nodemap is owned by ItalaApi thus it's returned by reference.

Returns
Reference to the system nodemap.

◆ EnumerateInterfaces()

virtual InterfaceInfoList Itala::ISystem::EnumerateInterfaces ( )
pure virtual

Enumerates the available network interfaces.

Returns
List of information objects identifying each interface found.

◆ GetInterfaceNodeMap()

virtual GenApi::INodeMap& Itala::ISystem::GetInterfaceNodeMap ( InterfaceInfo  itfInfo)
pure virtual

Get the GenICam nodemap of a network interface. The nodemap instance is accessible via GenApi library and allows the user to configure the behaviour of the interface. The nodemap is owned by ItalaApi thus it's returned by reference.

Returns
Reference to the nodemap of the requested interface.

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