The interface of Transport Layer objects. More...
#include <pylon/TransportLayer.h>
Public Member Functions | |
virtual CDeviceInfo | CreateDeviceInfo ()=0 |
Creates and returns an 'empty' Device Info object appropriate for the transport layer. More... | |
virtual GenApi::INodeMap * | GetNodeMap ()=0 |
Returns the GenApi node map used for accessing parameters provided by the transport layer. More... | |
virtual int | EnumerateInterfaces (InterfaceInfoList_t &list, bool addToList=false)=0 |
Retrieves a list of available interfaces. More... | |
virtual int | EnumerateDevices (DeviceInfoList_t &list, bool addToList=false)=0 |
Retrieves a list of available devices. More... | |
virtual int | EnumerateDevices (DeviceInfoList_t &list, const DeviceInfoList_t &filter, bool addToList=false)=0 |
Retrieves a list of available devices filtered by given properties, usable for looking for specific devices. More... | |
virtual IPylonDevice * | CreateDevice (const CDeviceInfo &di)=0 |
Creates a camera object from a device info object. More... | |
virtual IPylonDevice * | CreateDevice (const CDeviceInfo &di, const StringList_t &InjectedXmlStrings)=0 |
virtual IPylonDevice * | CreateDevice (const String_t &)=0 |
virtual IPylonDevice * | CreateFirstDevice (const CDeviceInfo &di=CDeviceInfo())=0 |
virtual IPylonDevice * | CreateFirstDevice (const CDeviceInfo &di, const StringList_t &InjectedXmlStrings)=0 |
virtual void | DestroyDevice (IPylonDevice *)=0 |
Destroys a device. More... | |
virtual bool | IsDeviceAccessible (const CDeviceInfo &deviceInfo, AccessModeSet mode=Control, EDeviceAccessiblityInfo *pAccessibilityInfo=NULL)=0 |
This method can be used to check if a camera device can be created and opened. More... | |
The interface of Transport Layer objects.
Transport Layer objects are used for enumerating and creating devices accessible by a specific transport layer (like the Pylon1394 or the PylonGigE transport layer).
|
pure virtualinherited |
Creates a camera object from a device info object.
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.
If the device creation fails, a GenApi::GenericException will be thrown.
di | Device info object containing all information needed to identify exactly one device. |
Implemented in Pylon::CTlFactory.
|
pure virtualinherited |
Creates a camera object from a device info object, injecting additional GenICam XML definition strings. Currently only one injected xml string is supported.
Implemented in Pylon::CTlFactory.
|
pure virtualinherited |
This method is deprecated. Use CreateDevice receiving a CDeviceInfo object that contains the full name as property. Example: IPylonDevice* device = TlFactory.CreateDevice( CDeviceInfo().SetFullName( fullname)); Creates a device by its unique name (i.e. fullname as returned by CDeviceInfo::GetFullName ).
Implemented in Pylon::CTlFactory.
|
pure virtual |
Creates and returns an 'empty' Device Info object appropriate for the transport layer.
Device Info objects returned by the CreateDeviceInfo() method are used to create devices from device info objects that are not the result of a device enumeration process but are provided by the user. The user is responsible for filling in the fields of the Device Info object that are needed to identify and create a device.
Example: To open a GigE device for which the IP address is known, the user lets the Transport Layer object create a Device Info object, specifies the IP address and passes the device info object to the CreateDevice() method.
|
pure virtualinherited |
If multiple devices match the provided properties, the first device found is created. The order in which the devices are found can vary from call to call.
Implemented in Pylon::CTlFactory.
|
pure virtualinherited |
Creates the first found camera device matching the provided properties, injecting additional GenICam XML definition strings. Currently only one injected xml string is supported.
Implemented in Pylon::CTlFactory.
|
pure virtualinherited |
Destroys a device.
Implemented in Pylon::CTlFactory.
|
pure virtualinherited |
Retrieves a list of available devices.
The list contains Pylon::CDeviceInfo objects used for the device creation and is ordered by device class and serial number using the operator Pylon::CDeviceInfo::operator<(). By default, the list will be cleared before the device discovery is started.
list | List to be filled with device info objects. |
addToList | If true, the devices found will be appended to the list instead of deleting the list. Only newly discovered devices are sorted and not the entire list. |
Implemented in Pylon::CTlFactory.
|
pure virtualinherited |
Retrieves a list of available devices filtered by given properties, usable for looking for specific devices.
The list contains Pylon::CDeviceInfo objects used for the device creation and is ordered by device class and serial number using the operator Pylon::CDeviceInfo::operator<(). By default, the list will be cleared before the device discovery is started. The filter list can contain a list of device info objects containing properties a device must have, e.g., the user-provided name or the serial number. A device is returned if it matches the properties of any of the device info objects on the filter list. If the device class property is set in the filter device info objects, the search is limited to the required transport layers.
list | List to be filled with device info objects. |
filter | A list of device info objects with user-provided properties that a device can match. |
addToList | If true, the devices found will be appended to the list instead of deleting the list. Only newly discovered devices are sorted and not the entire list. |
Implemented in Pylon::CTlFactory.
|
pure virtual |
Retrieves a list of available interfaces.
The concept of interfaces is not supported by all transport layers. Depending on the transport layer, an interface may represent a frame grabber board, a network card, etc.
By default, the list passed in will be cleared.
If the transport layer doesn't support the interface concept, EnumerateInterfaces() always returns 0.
list | The list to be filled with interface info objects |
addToList | If true, found devices will be added to the list instead of deleting the list |
|
pure virtual |
Returns the GenApi node map used for accessing parameters provided by the transport layer.
|
pure virtualinherited |
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.
[in] | deviceInfo | Properties of the camera device. |
[in] | mode | Used 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] | pAccessibilityInfo | Optionally provides more information about why a device is not accessible. |
deviceInfo
object properties specify exactly one device. This is the case when the device info object has been obtained using device enumeration.Implemented in Pylon::CTlFactory.