Impact Acquire SDK C++
|
This namespace contains classes and functions belonging to the image acquisition module of this SDK. More...
Namespaces | |
namespace | display |
This namespace contains classes and functions that can be used to display images. | |
namespace | GenICam |
This namespace contains classes and functions belonging to the GenICam specific part of the image acquisition module of this SDK. | |
namespace | helper |
This namespace contains classes and functions providing convenience access to some or the otherwise more complicated API features. A C++11 or higher compliant compiler is required to use them! | |
namespace | labs |
This namespace contains classes and functions belonging to the general part of this SDK that are not yet final and might change in the future without further notice. Yet still we think code within this namespace might prove useful thus we encourage you to use it if beneficial for your application. However be prepared to apply changes when needed. Feedback that helps to improve or finalize code from this namespace will be highly appreciated! A migration guide will be provided and we will perform changes only if they make sense and improve the code. | |
Classes | |
class | AutoControlParameters |
A class to control the automatic control parameters of a device(Device specific interface layout only). More... | |
class | BasicDeviceSettings |
A base class for essential device related settings. More... | |
class | BasicDeviceSettingsWithAOI |
A base class for camera related settings(Device specific interface layout only). More... | |
class | BufferPart |
Contains information about a specific part of a captured buffer. More... | |
class | CameraDescriptionBase |
A base class to describe a camera (Device specific interface layout only) connected to a frame grabber (deprecated. More... | |
class | CameraDescriptionCameraLink |
A class to describe a CameraLink® compliant camera(Device specific interface layout only) (deprecated. More... | |
class | CameraDescriptionDigital |
A class to describe a non-standard digital video signal(Device specific interface layout only) (deprecated. More... | |
class | CameraDescriptionDigitalBase |
A base class to describe an arbitrary digital camera signal(Device specific interface layout only) (deprecated. More... | |
class | CameraDescriptionDigitalBase2 |
A base class to describe an arbitrary digital camera signal(Device specific interface layout only) (deprecated. More... | |
class | CameraDescriptionManager |
Grants access to camera description objects(Device specific interface layout only) (deprecated. More... | |
class | CameraDescriptionNonStandard |
A class describing non-standard video cameras(Device specific interface layout only) (deprecated. More... | |
class | CameraDescriptionSDI |
A base class to describe an SDI(Serial Digital Interface) camera signal (Device specific interface layout only) (deprecated. More... | |
class | CameraDescriptionStandard |
A class describing analogue standard compliant video cameras(Device specific interface layout only) (deprecated. More... | |
class | CameraDescriptionStandardBase |
An internal base class to describe standard analogue video cameras(Device specific interface layout only) (deprecated. More... | |
class | CameraSettingsBase |
A base class for camera related settings(Device specific interface layout only). More... | |
class | CameraSettingsBlueCOUGAR |
mvBlueCOUGAR related camera settings (Device specific interface layout only). More... | |
class | CameraSettingsBlueDevice |
A base class for camera related settings belonging to the mvBlueXXX-series (Device specific interface layout only). More... | |
class | CameraSettingsBlueFOX |
mvBlueFOX related camera settings(Device specific interface layout only). More... | |
class | CameraSettingsFrameGrabber |
A class to access frame grabber related camera settings(Device specific interface layout only) (deprecated. More... | |
class | CameraSettingsV4L2Device |
mvV4L2 related camera settings(Device specific interface layout only). More... | |
class | CameraSettingsVirtualDevice |
mvVirtualDevice related camera settings(Device specific interface layout only). More... | |
struct | ChannelData |
A structure for image buffer channel specific data. More... | |
class | Component |
A base class to implement access to internal driver components. More... | |
class | ComponentAccess |
A base class to implement access to internal driver objects. More... | |
class | ComponentCallback |
A simple helper class to wrap the creation of a callback object. More... | |
class | ComponentCollection |
A base class for sets of properties that can be modified by the user. More... | |
class | ComponentList |
A class to provide access to component lists. More... | |
class | ComponentLocator |
A class to locate components within the driver. More... | |
class | ComponentLocatorBase |
A base class to locate components within the driver. More... | |
class | Connector |
A class describing how a video signal source(e.g. a camera or image sensor) is connected to a video signal sink(e.g. a frame grabber)(Device specific interface layout only). More... | |
class | Device |
This class and its functions represent an actual device detected by this interface in the current system. More... | |
class | DeviceComponentLocator |
A class to locate components within the driver. More... | |
class | DeviceManager |
Grants access to devices that can be operated by this software interface. More... | |
class | DigitalInput |
A class to represent a digital input pin(Device specific interface layout only). More... | |
class | DigitalIOMeasurementControl |
Properties for configuring settings belonging to the digital I/O measurement(Device specific interface layout only). More... | |
class | DigitalOutput |
A class to represent a digital output pin(Device specific interface layout only). More... | |
class | ECantAccessData |
An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_LIST_CANT_ACCESS_DATA error. More... | |
class | ECantAllocateNewList |
An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_CANT_ALLOCATE_LIST error. More... | |
class | ECantRegisterComponent |
An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_CANT_REGISTER_COMPONENT error. More... | |
class | ECantSerializeData |
An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_CANT_SERIALIZE_DATA error. More... | |
class | EComponent |
A base class for mvIMPACT::acquire::Component object related exceptions from the property module. More... | |
class | EComponentIDInvalid |
An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_COMPONENT_ID_INVALID error. More... | |
class | EComponentNotFound |
An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_COMPONENT_NOT_FOUND error. More... | |
class | EDeviceManager |
A base class for device manager related exceptions. More... | |
class | EImplementationMissing |
An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_IMPLEMENTATION_MISSING error. More... | |
class | EIncompatibleComponents |
An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_INCOMPATIBLE_COMPONENTS error. More... | |
class | EInputBufferTooSmall |
An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_INPUT_BUFFER_TOO_SMALL error. More... | |
class | EInvalidFileContent |
An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_INVALID_FILE_CONTENT error. More... | |
class | EInvalidInputParameter |
An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_INVALID_INPUT_PARAMETER error. More... | |
class | EInvalidListID |
An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_LIST_ID_INVALID error. More... | |
class | EInvalidParameterList |
An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_METHOD_INVALID_PARAM_LIST error. More... | |
class | EInvalidValue |
An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_INVALID_PROP_VALUE error. More... | |
class | EInvalidValueType |
An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_INVALID_PROP_VALUE_TYPE error. More... | |
class | EListEntryOccupied |
An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_LIST_ENTRY_OCCUPIED error. More... | |
class | EMethod |
A base class for mvIMPACT::acquire::Method object related exceptions from the property module. More... | |
class | EMethodPtrInvalid |
An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_METHOD_PTR_INVALID error. More... | |
class | ENoModifySizeRights |
An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_NO_MODIFY_SIZE_RIGHTS error. More... | |
class | ENoReadRights |
An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_NO_READ_RIGHTS error. More... | |
class | ENotAList |
An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_NOT_A_LIST error. More... | |
class | ENotAMethod |
An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_NOT_A_METHOD error. More... | |
class | ENotAProperty |
An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_NOT_A_PROPERTY error. More... | |
class | ENoWriteRights |
An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_NO_WRITE_RIGHTS error. More... | |
class | EnumPropertyF |
A template class to represent float properties and enumerated float properties. More... | |
class | EnumPropertyI |
A template class to represent 32 bit integer properties and 32 bit enumerated integer properties. More... | |
class | EnumPropertyI64 |
A template class to represent 64 bit integer properties and enumerated 64 bit integer properties. More... | |
class | EProperty |
A base class for mvIMPACT::acquire::Property related exceptions from the property module. More... | |
class | EPropertyHandling |
A base class for exceptions related to the property module. More... | |
class | EPropertyList |
A base class for component list related exceptions from the property module. More... | |
class | ESizeMismatch |
An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_SIZE_MISMATCH error. More... | |
class | ETranslationTableCorrupted |
An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_PROP_TRANSLATION_TABLE_CORRUPTED error. More... | |
class | ETranslationTableNotDefined |
An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_PROP_TRANSLATION_TABLE_NOT_DEFINED error. More... | |
class | EUnsupportedOperation |
An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_UNSUPPORTED_OPERATION error. More... | |
class | EUnsupportedParameter |
An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_UNSUPPORTED_PARAMETER error. More... | |
class | EValidationFailed |
An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_PROP_VALIDATION_FAILED error. More... | |
class | EValIDOutOfBounds |
An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_PROP_VAL_ID_OUT_OF_BOUNDS error. More... | |
class | EValTooLarge |
An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_PROP_VAL_TOO_LARGE error. More... | |
class | EValTooSmall |
An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_PROP_VAL_TOO_SMALL error. More... | |
class | EWrongParamCount |
An exception thrown in case of a mvIMPACT::acquire::PROPHANDLING_WRONG_PARAM_COUNT error. More... | |
class | ExceptionFactory |
A factory class to raise Impact Acquire related exceptions. More... | |
class | FirmwareUpdater |
A class to perform a firmware update of a specific device. More... | |
class | FullSettingsBase |
A base class that provides access to the most common settings for a device. More... | |
class | FunctionInterface |
The function interface to devices supported by this interface. More... | |
class | GainOffsetKneeChannelParameters |
Properties for configuring settings belonging to a certain channel of the GainOffsetKnee filter. More... | |
class | HDRControl |
A class to control the HDR (High Dynamic Range) parameters of a device (Device specific interface layout only). More... | |
class | HDRKneePoint |
A class to configure a HDR (High Dynamic Range) knee point (Device specific interface layout only). More... | |
class | I2CControl |
Properties for accessing features belonging to the I2C control(Device specific interface layout only). More... | |
struct | ImageBuffer |
Fully describes a captured image. More... | |
class | ImageBufferDesc |
A wrapper class to handle mvIMPACT::acquire::ImageBuffer structures. More... | |
class | ImageDestination |
Properties to define the format of resulting images. More... | |
class | ImageMemoryManager |
An interface class to access DMA memory related properties(Device specific interface layout only). More... | |
class | ImageProcessing |
Base class for image processing related properties. More... | |
class | ImageRequestControl |
A helper class to control the way an image request will be processed. More... | |
class | ImpactAcquireException |
A base class for exceptions generated by Impact Acquire. More... | |
class | Info |
A base class to access various general information about the device and its driver. More... | |
class | InfoBlueCOUGAR |
A more specific class to query information about a mvBlueCOUGAR devices and its driver(Device specific interface layout only). More... | |
class | InfoBlueDevice |
A more specific class to query information about a mvBlueDevice device and its driver(Device specific interface layout only). More... | |
class | InfoBlueFOX |
A more specific class to query information about a mvBlueFOX device and its driver(Device specific interface layout only). More... | |
class | IOSubSystem |
A base class to handle digital inputs and outputs(Device specific interface layout only). More... | |
class | IOSubSystemBlueFOX |
A class to handle the digital inputs and outputs for mvBlueFOX USB cameras(Device specific interface layout only). More... | |
class | IOSubSystemCommon |
A base class to handle the digital inputs and outputs for devices (Device specific interface layout only). More... | |
class | IOSubSystemFrameGrabber |
A class to handle the digital inputs and outputs for frame grabber devices(Device specific interface layout only) (deprecated. More... | |
class | LUTParameters |
Properties for configuring settings belonging to a certain LUT (Look Up Table) to be applied to a captured image. More... | |
class | Method |
A class to call arbitrary driver functions. More... | |
class | MirrorParameters |
Properties for configuring settings belonging to the mirror filter that processes a certain channel of a captured image. More... | |
class | MotorFocusControl |
Properties for configuring settings belonging to the motor focus control (Device specific interface layout only). More... | |
class | OutputSignalGeneratorBlueDevice |
A class to create complex digital output signals(Device specific interface layout only). More... | |
class | OutputSignalGeneratorFrameGrabber |
A class to create complex digital output signals(Device specific interface layout only) (deprecated. More... | |
class | Property |
A base class for properties. More... | |
class | PropertyPtr |
A class to represent pointer properties. More... | |
class | PropertyS |
A class to represent string properties. More... | |
class | PulseStartConfiguration |
A class to configure the creation of digital signals passed to one or more of the digital outputs of a device(Device specific interface layout only). More... | |
class | Request |
Contains information about a captured buffer. More... | |
class | RequestFactory |
A default request factory. More... | |
class | RequestInfoConfiguration |
Properties to configure which information shall be attached to the resulting images. More... | |
class | RTCtrProgram |
A class to represent real time control programs(Device specific interface layout only). More... | |
class | RTCtrProgramStep |
A class to represent one step of a real time control(RTCtr) program (Device specific interface layout only). More... | |
class | SettingsBlueFOX |
This class provides access to general settings as well as to settings which are unique for the mvBlueFOX(Device specific interface layout only). More... | |
class | Statistics |
Contains basic statistical information. More... | |
class | SyncOutput |
A class to represent a sync. output pin(Device specific interface layout only). More... | |
class | SystemBlueFOX |
A class containing mvBlueFOX specific settings to control the overall behaviour of the driver(Device specific interface layout only). More... | |
class | SystemSettings |
A base class for accessing settings that control the overall behaviour of a device driver. More... | |
class | SystemV4L2 |
A class containing mvV4L2 specific settings to control the overall behaviour of the driver(Device specific interface layout only). More... | |
class | TriggerControl |
A class to configure the behaviour of trigger signals. More... | |
class | UserData |
A helper class to work with the device specific non-volatile memory(if available). More... | |
class | UserDataEntry |
A helper class that represents one entry in the devices non-volatile memory. More... | |
class | WhiteBalancer |
Convenience class to provide an easy way for a more precise white balance calibration. More... | |
class | WhiteBalanceSettings |
Properties for adjusting the colors during a Bayer conversion. More... | |
Variables | |
struct mvIMPACT::acquire::ChannelData | ATTR_PACK_8 |
const int | END_OF_LIST = -1 |
A constant defining that property values will be read from an array property until the last value. | |
const int | INVALID_ID = -1 |
A constant to check for an invalid ID returned from the property handling module. | |
const int | ROOT_LIST = 0 |
A constant defining the unique identifier for the root component list containing all other lists. | |
const unsigned int | smIgnoreLists = 0x2 |
When set lists are not taken into account during a search. | |
const unsigned int | smIgnoreMethods = 0x4 |
When set method objects are not taken into account during a search. | |
const unsigned int | smIgnoreProperties = 0x8 |
When set property objects are not taken into account during a search. | |
This namespace contains classes and functions belonging to the image acquisition module of this SDK.
typedef int HDEV |
A type for handles bound to a certain device.
As 'C' is not a strongly typed language this simply adds an alias for int
. Internally an int
with a unique value is used to identify properties, methods and lists. The type HDEV therefore is nothing special. It is an integer value identifying the list containing the device properties available before opening the device. A HDEV therefore can also be passed to all functions expecting a HLIST or HOBJ type.
typedef void* HDMR_VIDEO_STREAM |
A type for handles bound to a video stream.
As 'C' is not a strongly typed language this simply adds an alias for void*
. Internally this pointer however will be checked for validity in various ways.
typedef int HDRV |
A type for handles bound to an interface of a certain device.
As 'C' is not a strongly typed language this simply adds an alias for int
. Internally an int
with a unique value is used to identify properties, methods and lists. The type HDRV therefore is nothing special. It is an integer value identifying the list containing the device properties becoming available after opening the device. A HDRV therefore can also be passed to all functions expecting a HLIST or HOBJ type.
typedef int HLIST |
A type for handles bound to an object list.
As 'C' is not a strongly typed language this simply adds an alias for int
. Internally an int
with a unique value is used to identify properties, methods and lists. The type HDEV therefore is nothing special. It is an integer value identifying a list of features. A HLIST therefore can also be passed to all functions expecting a HOBJ, HDEV(when it is the correct list) or HDRV(when it is the correct list).
typedef int HOBJ |
A type for handles bound to an unspecified object.
As 'C' is not a strongly typed language this simply adds an alias for int
. Internally an int
with a unique value is used to identify properties, methods and lists. The type HOBJ therefore is nothing special. It is an integer value identifying a feature (either a list of features, a property or a method). A HOBJ therefore can also be passed to all functions expecting a HLIST(when referencing a list), HDEV(when it is the correct list) or HDRV(when it is the correct list).
enum TFirmwareUpdateStep |
Defines valid steps for the actual firmware update process.