All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | List of all members
Pylon::CAcquireSingleFrameConfiguration Class Reference

An instant camera configuration for single frame acquisition, Use together with CInstantCamera::GrabOne() only. More...

#include <pylon/AcquireSingleFrameConfiguration.h>

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

Public Member Functions

virtual void OnOpened (CInstantCamera &camera)
 This method is called after the attached Pylon Device has been opened. More...
 
virtual void OnAttach (CInstantCamera &camera)
 This method is called before a Pylon Device (Pylon::IPylonDevice) is attached by calling the Instant Camera object's Attach() method. More...
 
virtual void OnAttached (CInstantCamera &camera)
 This method is called after a Pylon Device (Pylon::IPylonDevice) has been attached by calling the Instant Camera object's Attach() method. More...
 
virtual void OnDetach (CInstantCamera &camera)
 This method is called before the attached Pylon Device is detached from the Instant Camera object. More...
 
virtual void OnDetached (CInstantCamera &camera)
 This method is called after the attached Pylon Device has been detached from the Instant Camera object. More...
 
virtual void OnDestroy (CInstantCamera &camera)
 This method is called before the attached Pylon Device is destroyed. More...
 
virtual void OnDestroyed (CInstantCamera &camera)
 This method is called after the attached Pylon Device has been destroyed. More...
 
virtual void OnOpen (CInstantCamera &camera)
 This method is called before the attached Pylon Device is opened. More...
 
virtual void OnClose (CInstantCamera &camera)
 This method is called before the attached Pylon Device is closed. More...
 
virtual void OnClosed (CInstantCamera &camera)
 This method is called after the attached Pylon Device has been closed. More...
 
virtual void OnGrabStart (CInstantCamera &camera)
 This method is called before a grab session is started. More...
 
virtual void OnGrabStarted (CInstantCamera &camera)
 This method is called after a grab session has been started. More...
 
virtual void OnGrabStop (CInstantCamera &camera)
 This method is called before a grab session is stopped. More...
 
virtual void OnGrabStopped (CInstantCamera &camera)
 This method is called after a grab session has been stopped. More...
 
virtual void OnGrabError (CInstantCamera &camera, const char *errorMessage)
 This method is called when an exception has been triggered during grabbing. More...
 
virtual void OnCameraDeviceRemoved (CInstantCamera &camera)
 This method is called when a camera device removal from the PC has been detected. More...
 
virtual void OnConfigurationRegistered (CInstantCamera &camera)
 This method is called when the configuration event handler has been registered. More...
 
virtual void OnConfigurationDeregistered (CInstantCamera &camera)
 This method is called when the configuration event handler has been deregistered. More...
 
virtual void DestroyConfiguration ()
 Destroys the configuration event handler. More...
 

Static Public Member Functions

static void ApplyConfiguration (GenApi::INodeMap &nodemap)
 Apply acquire single frame configuration.
 

Detailed Description

An instant camera configuration for single frame acquisition, Use together with CInstantCamera::GrabOne() only.

The CAcquireSingleFrameConfiguration is provided as header-only file. The code can be copied and modified for creating own configuration classes.

Note
Grabbing single images using Software Trigger (CSoftwareTriggerConfiguration) is recommended if you want to maximize frame rate. This is because the overhead per grabbed image is reduced compared to Single Frame Acquisition. The grabbing can be started using CInstantCamera::StartGrabbing(). Images are grabbed using the CInstantCamera::WaitForFrameTriggerReady(), CInstantCamera::ExecuteSoftwareTrigger() and CInstantCamera::RetrieveResult() methods instead of using CInstantCamera::GrabOne(). The grab can be stopped using CInstantCamera::StopGrabbing() when done.

Member Function Documentation

virtual void Pylon::CConfigurationEventHandler::DestroyConfiguration ( )
inlinevirtualinherited

Destroys the configuration event handler.

Error Safety:
C++ exceptions from this call will be caught and ignored.
virtual void Pylon::CConfigurationEventHandler::OnAttach ( CInstantCamera camera)
inlinevirtualinherited

This method is called before a Pylon Device (Pylon::IPylonDevice) is attached by calling the Instant Camera object's Attach() method.

This method can not be used for detecting that a camera device has been attached to the PC. The camera's Attach() method must not be called from here or from subsequent calls to avoid infinite recursion.

Parameters
[in]cameraThe source of the call.
Error Safety:
C++ exceptions from this call will be caught and ignored. All event handlers are notified.
Thread Safety:
This method is called inside the lock of the camera object.
virtual void Pylon::CConfigurationEventHandler::OnAttached ( CInstantCamera camera)
inlinevirtualinherited

This method is called after a Pylon Device (Pylon::IPylonDevice) has been attached by calling the Instant Camera object's Attach() method.

This method can not be used for detecting that a camera device has been attached to the PC. The camera's Attach() method must not be called from here or from subsequent calls to avoid infinite recursion.

Parameters
[in]cameraThe source of the call.
Error Safety:
C++ exceptions from this call will be caught and ignored. All event handlers are notified.
Thread Safety:
This method is called inside the lock of the camera object.
virtual void Pylon::CConfigurationEventHandler::OnCameraDeviceRemoved ( CInstantCamera camera)
inlinevirtualinherited

This method is called when a camera device removal from the PC has been detected.

The Pylon Device attached to the Instant Camera is not operable after this event. After it is made sure that no access to the Pylon Device or any of its node maps is made anymore the Pylon Device should be destroyed using InstantCamera::DeviceDestroy(). The access to the Pylon Device can be protected using the lock provided by GetLock(), e.g. when accessing parameters.

Parameters
[in]cameraThe source of the call.
Error Safety:
C++ exceptions from this call will be caught and ignored. All event handlers are notified.
Thread Safety:
This method is called inside the lock of the camera object from an additional thread.
virtual void Pylon::CConfigurationEventHandler::OnClose ( CInstantCamera camera)
inlinevirtualinherited

This method is called before the attached Pylon Device is closed.

Camera Close must not be called from here or from subsequent calls to avoid infinite recursion.

Parameters
[in]cameraThe source of the call.
Error Safety:
C++ exceptions from this call will be caught and ignored. All event handlers are notified.
Thread Safety:
This method is called inside the lock of the camera object.
virtual void Pylon::CConfigurationEventHandler::OnClosed ( CInstantCamera camera)
inlinevirtualinherited

This method is called after the attached Pylon Device has been closed.

Parameters
[in]cameraThe source of the call.
Error Safety:
C++ exceptions from this call will be caught and ignored. All event handlers are notified.
Thread Safety:
This method is called inside the lock of the camera object.
virtual void Pylon::CConfigurationEventHandler::OnConfigurationDeregistered ( CInstantCamera camera)
inlinevirtualinherited

This method is called when the configuration event handler has been deregistered.

The configuration event handler is automatically deregistered when the Instant Camera object is destroyed.

Parameters
[in]cameraThe source of the call.
Error Safety:
C++ exceptions from this call will be caught and ignored.
Thread Safety:
This method is called inside the lock of the camera object.
virtual void Pylon::CConfigurationEventHandler::OnConfigurationRegistered ( CInstantCamera camera)
inlinevirtualinherited

This method is called when the configuration event handler has been registered.

Parameters
[in]cameraThe source of the call.
Error Safety:
Exceptions from this call will propagate through.
Thread Safety:
This method is called inside the lock of the camera object.
virtual void Pylon::CConfigurationEventHandler::OnDestroy ( CInstantCamera camera)
inlinevirtualinherited

This method is called before the attached Pylon Device is destroyed.

Camera DestroyDevice must not be called from here or from subsequent calls to avoid infinite recursion.

Parameters
[in]cameraThe source of the call.
Error Safety:
C++ exceptions from this call will be caught and ignored. All event handlers are notified.
Thread Safety:
This method is called inside the lock of the camera object.
virtual void Pylon::CConfigurationEventHandler::OnDestroyed ( CInstantCamera camera)
inlinevirtualinherited

This method is called after the attached Pylon Device has been destroyed.

Parameters
[in]cameraThe source of the call.
Error Safety:
C++ exceptions from this call will be caught and ignored. All event handlers are notified.
Thread Safety:
This method is called inside the lock of the camera object.
virtual void Pylon::CConfigurationEventHandler::OnDetach ( CInstantCamera camera)
inlinevirtualinherited

This method is called before the attached Pylon Device is detached from the Instant Camera object.

The camera's Detach() method must not be called from here or from subsequent calls to avoid infinite recursion.

Parameters
[in]cameraThe source of the call.
Error Safety:
C++ exceptions from this call will be caught and ignored. All event handlers are notified.
Thread Safety:
This method is called inside the lock of the camera object.
virtual void Pylon::CConfigurationEventHandler::OnDetached ( CInstantCamera camera)
inlinevirtualinherited

This method is called after the attached Pylon Device has been detached from the Instant Camera object.

Parameters
[in]cameraThe source of the call.
Error Safety:
C++ exceptions from this call will be caught and ignored. All event handlers are notified.
Thread Safety:
This method is called inside the lock of the camera object.
virtual void Pylon::CConfigurationEventHandler::OnGrabError ( CInstantCamera camera,
const char *  errorMessage 
)
inlinevirtualinherited

This method is called when an exception has been triggered during grabbing.

An exception has been triggered by a grab thread. The grab will be stopped after this event call.

Parameters
[in]cameraThe source of the call.
[in]errorMessageThe message of the exception that signaled an error during grabbing.
Error Safety:
C++ exceptions from this call will be caught and ignored. All event handlers are notified.
Thread Safety:
This method is called inside the lock of the camera object.
virtual void Pylon::CConfigurationEventHandler::OnGrabStart ( CInstantCamera camera)
inlinevirtualinherited

This method is called before a grab session is started.

Camera StartGrabbing must not be called from here or from subsequent calls to avoid infinite recursion.

Parameters
[in]cameraThe source of the call.
Error Safety:
Exceptions from this call will propagate through. The notification of event handlers stops when an exception is triggered.
Thread Safety:
This method is called inside the lock of the camera object.
virtual void Pylon::CConfigurationEventHandler::OnGrabStarted ( CInstantCamera camera)
inlinevirtualinherited

This method is called after a grab session has been started.

Parameters
[in]cameraThe source of the call.
Error Safety:
Exceptions from this call will propagate through. The notification of event handlers stops when an exception is triggered.
Thread Safety:
This method is called inside the lock of the camera object.
virtual void Pylon::CConfigurationEventHandler::OnGrabStop ( CInstantCamera camera)
inlinevirtualinherited

This method is called before a grab session is stopped.

Camera StopGrabbing must not be called from here or from subsequent calls to avoid infinite recursion.

Parameters
[in]cameraThe source of the call.
Error Safety:
C++ exceptions from this call will be caught and ignored. All event handlers are notified.
Thread Safety:
This method is called inside the lock of the camera object.
virtual void Pylon::CConfigurationEventHandler::OnGrabStopped ( CInstantCamera camera)
inlinevirtualinherited

This method is called after a grab session has been stopped.

Parameters
[in]cameraThe source of the call.
Error Safety:
C++ exceptions from this call will be caught and ignored. All event handlers are notified.
Thread Safety:
This method is called inside the lock of the camera object.
virtual void Pylon::CConfigurationEventHandler::OnOpen ( CInstantCamera camera)
inlinevirtualinherited

This method is called before the attached Pylon Device is opened.

Parameters
[in]cameraThe source of the call.
Error Safety:
Exceptions from this call will propagate through. The notification of event handlers stops when an exception is triggered.
Thread Safety:
This method is called inside the lock of the camera object.
virtual void Pylon::CAcquireSingleFrameConfiguration::OnOpened ( CInstantCamera camera)
inlinevirtual

This method is called after the attached Pylon Device has been opened.

Parameters
[in]cameraThe source of the call.
Error Safety:
Exceptions from this call will propagate through. The notification of event handlers stops when an exception is triggered.
Thread Safety:
This method is called inside the lock of the camera object.

Reimplemented from Pylon::CConfigurationEventHandler.


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

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