All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | List of all members
Pylon::CTlFactory Class Reference

the Transport Layer Factory More...

#include <pylon/TlFactory.h>

Inheritance diagram for Pylon::CTlFactory:
Inheritance graph
[legend]

Public Member Functions

int EnumerateTls (TlInfoList_t &)
 Retrieve a list of available transport layers.
 
ITransportLayerCreateTl (const CTlInfo &)
 Create a transport layer object from a TlInfo object.
 
ITransportLayerCreateTl (const String_t &DeviceClass)
 Create a transport layer object specified by the transport layer's device class identifier.
 
void ReleaseTl (const ITransportLayer *)
 Destroys a transport layer object.
 
virtual int EnumerateDevices (DeviceInfoList_t &, bool addToList=false)
 returns a list of available devices, see IDeviceFactory for more information
 
virtual int EnumerateDevices (DeviceInfoList_t &list, const DeviceInfoList_t &filter, bool addToList=false)
 returns a list of available devices that match the filter, see IDeviceFactory for more information
 
virtual IPylonDeviceCreateDevice (const CDeviceInfo &di)
 creates a device from a device info object, see IDeviceFactory for more information
 
virtual IPylonDeviceCreateFirstDevice (const CDeviceInfo &di=CDeviceInfo())
 creates first found device from a device info object, see IDeviceFactory for more information
 
virtual IPylonDeviceCreateDevice (const CDeviceInfo &di, const StringList_t &InjectedXmlStrings)
 creates a device from a device info object, injecting additional GenICam XML definition strings
 
virtual IPylonDeviceCreateFirstDevice (const CDeviceInfo &di, const StringList_t &InjectedXmlStrings)
 creates first found device from a device info object, injecting additional GenICam XML definition strings
 
virtual IPylonDeviceCreateDevice (const String_t &)
 
virtual void DestroyDevice (IPylonDevice *)
 destroys a device
 
virtual bool IsDeviceAccessible (const CDeviceInfo &deviceInfo, AccessModeSet mode=Control, EDeviceAccessiblityInfo *pAccessibilityInfo=NULL)
 This method can be used to check if a camera device can be created and opened. More...
 

Static Public Member Functions

static CTlFactoryGetInstance ()
 

Detailed Description

the Transport Layer Factory

Creates, Destroys and Enumerates transport layers as well as their devices.

Member Function Documentation

virtual IPylonDevice* Pylon::CTlFactory::CreateDevice ( const String_t )
virtual

This method is deprecated. Use CreateDevice receiving a CDeviceInfo object containing the full name as property. example: IPylonDevice* device = TlFactory.CreateDevice( CDeviceInfo().SetFullName( fullname)); creates a device by its unique name (i.e. fullname)

Implements Pylon::IDeviceFactory.

static CTlFactory& Pylon::CTlFactory::GetInstance ( )
static

Retrieve the transport layer factory singleton. Throws an exception when Pylon::PylonInitialize() has not been called before.

virtual bool Pylon::CTlFactory::IsDeviceAccessible ( const CDeviceInfo deviceInfo,
AccessModeSet  mode = Control,
EDeviceAccessiblityInfo pAccessibilityInfo = NULL 
)
virtual

This method can be used to check if a camera device can be created and opened.

This method accepts either a device info object from a device enumeration or a user-provided device info object. User-provided device info objects can be preset with properties required for a device, e.g. the user-provided name or the serial number. The implementation tries to find a matching camera by using device enumeration. When the device class property is set, the search is limited to the required transport layer.

Parameters
[in]deviceInfoProperties of the camera device.
[in]modeUsed for defining how a device is accessed. The use of the mode information is transport layer-specific. For IIDC 1394 devices the mode information is ignored. For GigE devices the Exclusive and Control flags are used for defining how a device is accessed.
[in]pAccessibilityInfoOptionally provides more information about why a device is not accessible.
Returns
True if device can be opened with provided access mode.
Precondition
The deviceInfo object properties specify exactly one device. This is the case when the device info object has been obtained using device enumeration.
Error Safety:
Throws a C++ exception, if the preconditions are not met.

Implements Pylon::IDeviceFactory.


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

pylon 5.0.5
Copyright © 2006-2016 Basler AG (Thu Aug 11 2016 18:01:28)