Skip to content

Pylon::IDevice#

Module: Low Level API

Low Level API: The interface implemented by all device objects.

#include <pylon/Device.h>

Inherited by Pylon::IPylonDevice

Public Functions#

Name
virtual void Open(AccessModeSet mode =(Stream
virtual void Close()
Closes a device.
virtual bool IsOpen() const
Checks if a device already is opened.
virtual AccessModeSet AccessMode(void ) const
Returns the access mode used to open the device.
virtual const CDeviceInfo & GetDeviceInfo() const
Returns the device info object storing information like the device's name.

Public Functions Documentation#

Open#

virtual void Open(
    AccessModeSet mode =(Stream|Control|Event)
) 

Opens a device.

Parameters:

  • mode The desired device access mode

The open method initializes all involved drivers and establishes a connection to the device.

A device may support different access modes, e.g. EDeviceAccessMode::Exclusive providing an exclusive access to the device.

Close#

virtual void Close() 

Closes a device.

The close method closes all involved drivers and an existing connection to the device will be released. Other applications now can access the device.

IsOpen#

virtual bool IsOpen() const 

Checks if a device already is opened.

Return: true, when the device already has been opened by the calling application.

Note: When a device has been opened an application A, IsOpen() will return false when called by an application B not having called the device's open method.

AccessMode#

virtual AccessModeSet AccessMode(
    void 
) const 

Returns the access mode used to open the device.

GetDeviceInfo#

virtual const CDeviceInfo & GetDeviceInfo() const 

Returns the device info object storing information like the device's name.

Return: A reference to the device info object used to create the device by a device factory


Updated on 5 July 2022 at 15:30:01