![]() |
![]() |
An interface is used to represent a frame grabber board, a network card, etc. More...
#include <pylon/Interface.h>
Public Member Functions | |
virtual void | Open ()=0 |
Opens an interface to be able access it's parameters via GetNodeMap(). More... | |
virtual void | Close ()=0 |
Closes an interface. More... | |
virtual bool | IsOpen () const =0 |
Checks if the interface is open. More... | |
virtual const CInterfaceInfo & | GetInterfaceInfo () const =0 |
Returns the interface info object storing information like the Interface ID property. More... | |
virtual GenApi::INodeMap * | GetNodeMap ()=0 |
Returns the GenApi node map used for accessing parameters provided by the interface. 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... | |
An interface is used to represent a frame grabber board, a network card, etc.
Currently, this object type is mainly used for the pylon GenTL Consumer Transport Layer, e.g., for CoaXPress. All other pylon transport layers currently return one default interface.
The 'open' status of an interface instance won't change even if an attached camera is used, e.g., opened or closed.
|
pure virtual |
Closes an interface.
Implemented in Pylon::CInstantInterface< T >.
|
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::CInstantInterface< T >, and 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::CInstantInterface< T >, and Pylon::CTlFactory.
|
pure virtualinherited |
This method is deprecated. Use CreateDevice and pass a CDeviceInfo object containing the full name as a property. Example: IPylonDevice* device = TlFactory.CreateDevice( CDeviceInfo().SetFullName( fullname)); creates a device that matches its full name (i.e., as returned by CDeviceInfo::GetFullName).
Implemented in Pylon::CInstantInterface< T >, and Pylon::CTlFactory.
|
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::CInstantInterface< T >, and 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::CInstantInterface< T >, and Pylon::CTlFactory.
|
pure virtualinherited |
Destroys a device.
Implemented in Pylon::CInstantInterface< T >, and 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::CInstantInterface< T >, and 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::CInstantInterface< T >, and Pylon::CTlFactory.
|
pure virtual |
Returns the interface info object storing information like the Interface ID property.
This information is available at all times regardless of whether the interface is open or closed.
Implemented in Pylon::CInstantInterface< T >.
|
pure virtual |
Returns the GenApi node map used for accessing parameters provided by the interface.
Implemented in Pylon::CInstantInterface< T >.
|
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, see DeviceClass.h header file, the search is limited to the required transport layer. For more information, see Applying a Filter when Enumerating Cameras.
[in] | deviceInfo | Properties to find/identify the camera device to check. |
[in] | mode | Used for defining how a device is accessed. The use of the mode information is transport layer-specific.
|
[out] | pAccessibilityInfo | Optional parameter that provides more information about whether a device is accessible or not. |
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::CInstantInterface< T >, and Pylon::CTlFactory.
|
pure virtual |
Checks if the interface is open.
Implemented in Pylon::CInstantInterface< T >.
|
pure virtual |
Opens an interface to be able access it's parameters via GetNodeMap().
Implemented in Pylon::CInstantInterface< T >.