mvIMPACT Acquire SDK C++

An interface class to model a internal driver event that the user can wait for(Device specific interface layout only)(deprecated). More...

Public Member Functions

const EventDatagetData (void) const
 Returns a const reference to the mvIMPACT::acquire::EventData structure of this event(deprecated). More...
 

Public Attributes

PropertyIDeviceEventMode mode
 An enumerated integer property (read-only) defining the mode this event is currently operated in. More...
 
PropertyI queueDepth
 Currently unsupported. More...
 
PropertyIDeviceEventType type
 An enumerated integer property (read-only) containing the type of this event. More...
 

Friends

class EventSubSystem
 

Detailed Description

An interface class to model a internal driver event that the user can wait for(Device specific interface layout only)(deprecated).

Deprecated:
This class has been declared deprecated and will be removed in future versions of this interface. A more flexible way of getting informed about changes in driver features has been added to the interface and should be used instead. An example for this new method can be found here: Callback.cpp

An event can be anything that occurs at a certain time within the driver or something that can be reported by the hardware. Typical examples might be the detection of an external trigger signal, a change at one of the digital inputs of a device or the start of a VD pulse send from a camera and detected by a capture device.

Sometimes one or more of these events might be important for an application. E.g. the user might want to get a notification each time the state of one of the digital inputs of a device changes in order to read the current state from the device.

Events will return a timestamp that can be used to synchronize the event with a certain chronology of other events.

Note
Instances of this class can't be constructed directly. Valid objects must be obtained via the class mvIMPACT::acquire::EventSubSystem.
This class will only be available if mvIMPACT::acquire::Device::interfaceLayout is set to mvIMPACT::acquire::dilDeviceSpecific before the device is opened.

Member Function Documentation

◆ getData()

const EventData& getData ( void  ) const

Returns a const reference to the mvIMPACT::acquire::EventData structure of this event(deprecated).

Deprecated:
All functions belonging to this class have been declared deprecated. See detailed description of mvIMPACT::acquire::Event.

The referenced mvIMPACT::acquire::EventData structure contains additional information about the image, e.g. a timestamp that defines the time this event has been reported by the device.

Note
Please do NOT store this reference in some variable to use it for the evaluation of the next notification you get for this event as well, as this will NOT update the referenced data. Whenever mvIMPACT::acquire::Event::getData is called the function will make sure that the data in the returned structure is up to date while when working with an old reference to the mvIMPACT::acquire::EventData structure the data in the structure will refer to the previous result.

Friends And Related Function Documentation

◆ EventSubSystem

friend class EventSubSystem
friend

Member Data Documentation

◆ mode

An enumerated integer property (read-only) defining the mode this event is currently operated in.

Deprecated:
All functions belonging to this class have been declared deprecated. See detailed description of mvIMPACT::acquire::Event.

This property must be used whenever the user wants to receive notification from this event Valid values for this property are defined by the enumeration mvIMPACT::acquire::TDeviceEventMode.

◆ queueDepth

PropertyI queueDepth

Currently unsupported.

Deprecated:
All functions belonging to this class have been declared deprecated. See detailed description of mvIMPACT::acquire::Event.
Note
This feature is subject to change! Don't use it!

◆ type

An enumerated integer property (read-only) containing the type of this event.

Deprecated:
All functions belonging to this class have been declared deprecated. See detailed description of mvIMPACT::acquire::Event.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TDeviceEventType.


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