All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
Pylon::IDevice Interface Referenceabstract

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

#include <pylon/Device.h>

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

Public Member Functions

virtual void Open (AccessModeSet mode=(Stream|Control|Event))=0
 Opens a device. More...
 
virtual void Close ()=0
 Closes a device. More...
 
virtual bool IsOpen () const =0
 Checks if a device already is opened. More...
 
virtual AccessModeSet AccessMode (void) const =0
 Returns the access mode used to open the device.
 
virtual const CDeviceInfoGetDeviceInfo () const =0
 Returns the device info object storing information like the device's name. More...
 

Detailed Description

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

Member Function Documentation

virtual void Pylon::IDevice::Close ( )
pure virtual

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.

virtual const CDeviceInfo& Pylon::IDevice::GetDeviceInfo ( ) const
pure virtual

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

Returns
A reference to the device info object used to create the device by a device factory
virtual bool Pylon::IDevice::IsOpen ( ) const
pure virtual

Checks if a device already is opened.

Returns
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.
virtual void Pylon::IDevice::Open ( AccessModeSet  mode = (Stream|Control|Event))
pure virtual

Opens a device.

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.

Parameters
modeThe desired device access mode

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

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