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

Low Level API: The interface for Basler GigE camera devices. More...

#include <pylon/gige/PylonGigEDevice.h>

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

Public Member Functions

virtual void ChangeIpConfiguration (bool EnablePersistentIp, bool EnableDhcp)=0
 Enables/disables use of persistent IP address and DHCP usage.
 
virtual void GetPersistentIpAddress (String_t &IpAddress, String_t &SubnetMask, String_t &DefaultGateway)=0
 Reads the persistent IP address from the device.
 
virtual void SetPersistentIpAddress (const String_t &IpAddress, const String_t &SubnetMask, const String_t &DefaultGateway)=0
 Writes a persistent IP address to the device. More...
 
virtual uint32_t GetNumStreamGrabberChannels () const =0
 Returns the number of stream grabbers the camera object provides.
 
virtual IStreamGrabberGetStreamGrabber (uint32_t index)=0
 Returns a pointer to a stream grabber. More...
 
virtual IEventGrabberGetEventGrabber ()=0
 Returns a pointer to an event grabber. More...
 
virtual GenApi::INodeMapGetNodeMap ()=0
 Returns the set of camera parameters. More...
 
virtual GenApi::INodeMapGetTLNodeMap ()=0
 Returns the set of camera related transport layer parameters. More...
 
virtual Pylon::IChunkParserCreateChunkParser ()=0
 Creates a chunk parser used to update those camera object members reflecting the content of additional data chunks appended to the image data. More...
 
virtual void DestroyChunkParser (Pylon::IChunkParser *pChunkParser)=0
 Deletes a chunk parser. More...
 
virtual IEventAdapterCreateEventAdapter ()=0
 Creates an Event adapter.
 
virtual void DestroyEventAdapter (IEventAdapter *)=0
 Deletes an Event adapter.
 
virtual ISelfReliantChunkParserCreateSelfReliantChunkParser ()=0
 Creates a a self-reliant chunk parser, returns NULL if not supported.
 
virtual void DestroySelfReliantChunkParser (ISelfReliantChunkParser *)=0
 Deletes a self-reliant chunk parser.
 
virtual DeviceCallbackHandle RegisterRemovalCallback (DeviceCallback &d)=0
 Registers a surprise removal callback object. More...
 
virtual bool DeregisterRemovalCallback (DeviceCallbackHandle h)=0
 Deregisters a surprise removal callback object. More...
 
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 for Basler GigE camera devices.

This interface extends the IPylonDevice interface.

Member Function Documentation

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

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 Pylon::IChunkParser* Pylon::IPylonDevice::CreateChunkParser ( )
pure virtualinherited

Creates a chunk parser used to update those camera object members reflecting the content of additional data chunks appended to the image data.

Returns
Pointer to the created chunk parser
Note
Don't try to delete a chunk parser pointer by calling free or delete. Instead, use the DestroyChunkParser() method
virtual bool Pylon::IPylonDevice::DeregisterRemovalCallback ( DeviceCallbackHandle  h)
pure virtualinherited

Deregisters a surprise removal callback object.

Parameters
hHandle of the callback to be removed
virtual void Pylon::IPylonDevice::DestroyChunkParser ( Pylon::IChunkParser pChunkParser)
pure virtualinherited

Deletes a chunk parser.

Parameters
pChunkParserPointer to the chunk parser to be deleted
virtual const CDeviceInfo& Pylon::IDevice::GetDeviceInfo ( ) const
pure virtualinherited

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 IEventGrabber* Pylon::IPylonDevice::GetEventGrabber ( )
pure virtualinherited

Returns a pointer to an event grabber.

Event grabbers are used to handle events sent from a camera device.

virtual GenApi::INodeMap* Pylon::IPylonDevice::GetNodeMap ( )
pure virtualinherited

Returns the set of camera parameters.

Returns
Pointer to the GenApi node map holding the parameters
virtual IStreamGrabber* Pylon::IPylonDevice::GetStreamGrabber ( uint32_t  index)
pure virtualinherited

Returns a pointer to a stream grabber.

Stream grabbers (IStreamGrabber) are the objects used to grab images from a camera device. A camera device might be able to send image data over more than one logical channel called stream. A stream grabber grabs data from one single stream.

Parameters
indexThe number of the grabber to return
Returns
A pointer to a stream grabber, NULL if index is out of range
virtual GenApi::INodeMap* Pylon::IPylonDevice::GetTLNodeMap ( )
pure virtualinherited

Returns the set of camera related transport layer parameters.

Returns
Pointer to the GenApi node holding the transport layer parameter. If there are no transport layer parameters for the device, NULL is returned.
virtual bool Pylon::IDevice::IsOpen ( ) const
pure virtualinherited

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 virtualinherited

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
virtual DeviceCallbackHandle Pylon::IPylonDevice::RegisterRemovalCallback ( DeviceCallback d)
pure virtualinherited

Registers a surprise removal callback object.

Parameters
dreference to a device callback object
Returns
A handle which must be used to deregister a callback It is recommended to use one of the RegisterRemovalCallback() helper functions to register a callback.

Example how to register a C function

void MyRemovalCallback( Pylon::IPylonDevice* pDevice)
{
// handle removal
}
Pylon::RegisterRemovalCallback( m_pCamera, &MyRemovalCallback);

Example how to register a class member function

class C
{
void MyRemovalCallback( Pylon::IPylonDevice* pDevice )
{
// handle removal
}
} c;
Pylon::RegisterRemovalCallback( m_pCamera, c, &C::MyRemovalCallback);
virtual void Pylon::IPylonGigEDevice::SetPersistentIpAddress ( const String_t IpAddress,
const String_t SubnetMask,
const String_t DefaultGateway 
)
pure virtual

Writes a persistent IP address to the device.

Writing the persistent IP address does not change the IP configuration. Use the ChangeIpConfiguration() method to enable the usage of persistent IP addresses.


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

pylon 5.0.9
Copyright © 2006-2017 Basler AG (Tue May 30 2017 17:24:58)