Impact Acquire SDK Java
Common

Classes

class  BasicDeviceSettings
 A base class for essential device related settings. More...
 
class  BufferPart
 Contains information about a specific part of a captured buffer. More...
 
class  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  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  ECantAccessData
 An exception thrown in case of a mvIMPACT.acquire.TPROPHANDLING_ERROR.PROPHANDLING_LIST_CANT_ACCESS_DATA error. More...
 
class  ECantAllocateNewList
 An exception thrown in case of a mvIMPACT.acquire.TPROPHANDLING_ERROR.PROPHANDLING_CANT_ALLOCATE_LIST error. More...
 
class  ECantRegisterComponent
 An exception thrown in case of a mvIMPACT.acquire.TPROPHANDLING_ERROR.PROPHANDLING_CANT_REGISTER_COMPONENT error. More...
 
class  ECantSerializeData
 An exception thrown in case of a mvIMPACT.acquire.TPROPHANDLING_ERROR.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.TPROPHANDLING_ERROR.PROPHANDLING_COMPONENT_ID_INVALID error. More...
 
class  EComponentNotFound
 An exception thrown in case of a mvIMPACT.acquire.TPROPHANDLING_ERROR.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.TPROPHANDLING_ERROR.PROPHANDLING_IMPLEMENTATION_MISSING error. More...
 
class  EIncompatibleComponents
 An exception thrown in case of a mvIMPACT.acquire.TPROPHANDLING_ERROR.PROPHANDLING_INCOMPATIBLE_COMPONENTS error. More...
 
class  EInputBufferTooSmall
 An exception thrown in case of a mvIMPACT.acquire.TPROPHANDLING_ERROR.PROPHANDLING_INPUT_BUFFER_TOO_SMALL error. More...
 
class  EInvalidFileContent
 An exception thrown in case of a mvIMPACT.acquire.TPROPHANDLING_ERROR.PROPHANDLING_INVALID_FILE_CONTENT error. More...
 
class  EInvalidInputParameter
 An exception thrown in case of a mvIMPACT.acquire.TPROPHANDLING_ERROR.PROPHANDLING_INVALID_INPUT_PARAMETER error. More...
 
class  EInvalidListID
 An exception thrown in case of a mvIMPACT.acquire.TPROPHANDLING_ERROR.PROPHANDLING_LIST_ID_INVALID error. More...
 
class  EInvalidParameterList
 An exception thrown in case of a mvIMPACT.acquire.TPROPHANDLING_ERROR.PROPHANDLING_METHOD_INVALID_PARAM_LIST error. More...
 
class  EInvalidValue
 An exception thrown in case of a mvIMPACT.acquire.TPROPHANDLING_ERROR.PROPHANDLING_INVALID_PROP_VALUE error. More...
 
class  EInvalidValueType
 An exception thrown in case of a mvIMPACT.acquire.TPROPHANDLING_ERROR.PROPHANDLING_INVALID_PROP_VALUE_TYPE error. More...
 
class  EListEntryOccupied
 An exception thrown in case of a mvIMPACT.acquire.TPROPHANDLING_ERROR.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.TPROPHANDLING_ERROR.PROPHANDLING_METHOD_PTR_INVALID error. More...
 
class  ENoModifySizeRights
 An exception thrown in case of a mvIMPACT.acquire.TPROPHANDLING_ERROR.PROPHANDLING_NO_MODIFY_SIZE_RIGHTS error. More...
 
class  ENoReadRights
 An exception thrown in case of a mvIMPACT.acquire.TPROPHANDLING_ERROR.PROPHANDLING_NO_READ_RIGHTS error. More...
 
class  ENotAList
 An exception thrown in case of a mvIMPACT.acquire.TPROPHANDLING_ERROR.PROPHANDLING_NOT_A_LIST error. More...
 
class  ENotAMethod
 An exception thrown in case of a mvIMPACT.acquire.TPROPHANDLING_ERROR.PROPHANDLING_NOT_A_METHOD error. More...
 
class  ENotAProperty
 An exception thrown in case of a mvIMPACT.acquire.TPROPHANDLING_ERROR.PROPHANDLING_NOT_A_PROPERTY error. More...
 
class  ENoWriteRights
 An exception thrown in case of a mvIMPACT.acquire.TPROPHANDLING_ERROR.PROPHANDLING_NO_WRITE_RIGHTS error. 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.TPROPHANDLING_ERROR.PROPHANDLING_SIZE_MISMATCH error. More...
 
class  ETranslationTableCorrupted
 An exception thrown in case of a mvIMPACT.acquire.TPROPHANDLING_ERROR.PROPHANDLING_PROP_TRANSLATION_TABLE_CORRUPTED error. More...
 
class  ETranslationTableNotDefined
 An exception thrown in case of a mvIMPACT.acquire.TPROPHANDLING_ERROR.PROPHANDLING_PROP_TRANSLATION_TABLE_NOT_DEFINED error. More...
 
class  EUnsupportedOperation
 An exception thrown in case of a mvIMPACT.acquire.TPROPHANDLING_ERROR.PROPHANDLING_UNSUPPORTED_OPERATION error. More...
 
class  EUnsupportedParameter
 An exception thrown in case of a mvIMPACT.acquire.TPROPHANDLING_ERROR.PROPHANDLING_UNSUPPORTED_PARAMETER error. More...
 
class  EValidationFailed
 An exception thrown in case of a mvIMPACT.acquire.TPROPHANDLING_ERROR.PROPHANDLING_PROP_VALIDATION_FAILED error. More...
 
class  EValIDOutOfBounds
 An exception thrown in case of a mvIMPACT.acquire.TPROPHANDLING_ERROR.PROPHANDLING_PROP_VAL_ID_OUT_OF_BOUNDS error. More...
 
class  EValTooLarge
 An exception thrown in case of a mvIMPACT.acquire.TPROPHANDLING_ERROR.PROPHANDLING_PROP_VAL_TOO_LARGE error. More...
 
class  EValTooSmall
 An exception thrown in case of a mvIMPACT.acquire.TPROPHANDLING_ERROR.PROPHANDLING_PROP_VAL_TOO_SMALL error. More...
 
class  EWrongParamCount
 An exception thrown in case of a mvIMPACT.acquire.TPROPHANDLING_ERROR.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  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  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  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  Property
 A base class for properties. More...
 
class  PropertyF
 A template class to represent float properties and enumerated float properties. More...
 
class  PropertyI
 A template class to represent 32 bit integer properties and 32 bit enumerated integer properties. More...
 
class  PropertyI64
 A template class to represent 64 bit integer properties and enumerated 64 bit integer properties. More...
 
class  PropertyPtr
 A class to represent pointer properties. 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  Statistics
 Contains basic statistical information. More...
 
class  SystemSettings
 A base class for accessing settings that control the overall behaviour of a device driver. More...
 
class  TAcquisitionMode
 Defines valid acquisition modes. More...
 
class  TAcquisitionStartStopBehaviour
 Defines valid modes for acquisition start/stop behaviour. More...
 
class  TAoiMode
 Defines valid Area Of Interest modes. More...
 
class  TBayerConversionMode
 Defines the Bayer conversion algorithm to use. More...
 
class  TBayerMosaicParity
 Defines valid Bayer formats. More...
 
class  TBayerWhiteBalanceResult
 Defines valid results of a white balance calibration. More...
 
class  TBoolean
 Defines a Boolean value type. More...
 
class  TBufferPartDataType
 Defines buffer part data types. More...
 
class  TCameraDataFormat
 Defines the data format the camera is sending (deprecated. More...
 
class  TCameraOutput
 Defines valid ways a camera can offer image data to a capture device (deprecated. More...
 
class  TChannelSplitMode
 Defines valid modes for channel split filters. More...
 
class  TColorProcessingMode
 Defines the color processing mode. More...
 
class  TColorTwistInputCorrectionMatrixMode
 Defines valid values for input color correction matrices. More...
 
class  TColorTwistOutputCorrectionMatrixMode
 Defines valid values for output color correction matrices. More...
 
class  TDarkCurrentFilterMode
 Defines valid modes for the dark current filter. More...
 
class  TDefectivePixelsFilterMode
 Defines valid modes for defective pixels filter. More...
 
class  TDeviceAccessMode
 Defines valid device access modes. More...
 
class  TDeviceAutoNegotiatePacketSizeMode
 Defines the way the packet size auto negotiation is handled for GigE Vision™ devices. More...
 
class  TDeviceCapability
 Defines valid device capabilities. More...
 
class  TDeviceClass
 Defines valid generic device classes. More...
 
class  TDeviceInterfaceLayout
 Defines valid interface layouts for the device. More...
 
class  TDeviceListType
 Defines valid interface list types, which can be located using an instance of mvIMPACT.acquire.DeviceComponentLocator. More...
 
class  TDeviceLoadSettings
 Defines valid modes for the loading of settings during initialization. More...
 
class  TDeviceState
 Defines valid Device states. More...
 
class  TDMR_ERROR
 Errors reported by the device manager. More...
 
class  TFlatFieldFilterCorrectionMode
 Defines valid modes for the flat field correction. More...
 
class  TFlatFieldFilterMode
 Defines valid modes for the flat field filter. More...
 
class  THWUpdateResult
 Defines valid Device HW update results. More...
 
class  TImageBufferFormatReinterpreterMode
 Valid image buffer format reinterpreter modes. More...
 
class  TImageBufferPixelFormat
 Valid image buffer pixel formats. More...
 
class  TImageDestinationPixelFormat
 Defines the pixel format of the result image. More...
 
class  TImageFileFormat
 Defines valid image file formats. More...
 
class  TImageProcessingFilter
 Defines valid filters which can be applied to the captured image before it is transferred to the user. More...
 
class  TImageProcessingMode
 Defines valid modes the internal image processing pipeline can be operated in. More...
 
class  TImageProcessingOptimization
 Defines valid modes the internal image processing algorithms can be operated in. More...
 
class  TImageProcessingResult
 Defines valid values for the result of a certain image processing algorithm applied to a request. More...
 
class  TImageRequestControlMode
 Defines the behaviour of an mvIMPACT.acquire.ImageRequestControl. More...
 
class  TImageRequestParam
 Defines valid image request parameters. More...
 
class  TImpactBufferFlag
 Flags to define the way an mvIMPACT buffer is created and handled. More...
 
class  TInterfaceEnumerationBehaviour
 Defines the enumeration behaviour of a certain interface of a third party GenTL producer. More...
 
class  TLibraryQuery
 Defines valid libraries to query information from. More...
 
class  TLUTGammaMode
 Defines valid LUT(LookUp Table) gamma modes. More...
 
class  TLUTImplementation
 Defines valid LUT(LookUp Table) implementations. More...
 
class  TLUTInterpolationMode
 Defines valid LUT(LookUp Table) interpolation modes. More...
 
class  TLUTMapping
 Defines valid LUT(LookUp Table) mapping modes. More...
 
class  TLUTMode
 Defines valid LUT(LookUp Table) modes. More...
 
class  TMemoryManagerMode
 Defines valid modes to operate the memory manager in. More...
 
class  TMemoryManagerPoolMode
 Defines the pool mode of memory manager. More...
 
class  TMirrorMode
 Defines valid mirror modes. More...
 
class  TMirrorOperationMode
 Defines valid mirror operation modes. More...
 
class  TPayloadType
 Defines supported payload types. More...
 
class  TPolarizedDataExtractionInterpolationMode
 Defines valid modes for the interpolation mode of polarization data extraction filters. More...
 
class  TPolarizedDataExtractionMode
 Defines valid modes for polarization data extraction filters. More...
 
class  TPropertyLimits
 Defines valid limits which can be queried for a mvIMPACT.acquire.Property object. More...
 
class  TRequestImageMemoryMode
 Defines valid image modes for request objects. More...
 
class  TRequestResult
 Defines valid result of an image request. More...
 
class  TRequestState
 Defines the current state of this mvIMPACT.acquire.Request. More...
 
class  TriggerControl
 A class to configure the behaviour of trigger signals. More...
 
class  TScalerInterpolationMode
 Defines valid scaler interpolation modes. More...
 
class  TScalerMode
 Defines valid scaler modes. More...
 
class  TUserDataAccessRight
 Defines valid flags for controlling the user access rights to the user data that can be stored in the devices non-volatile memory. More...
 
class  TUserDataReconnectBehaviour
 Defined valid values for the behaviour of the user data when a device has been disconnected and reconnected within a running process. More...
 
class  TVideoCodec
 Defines valid video codecs that might be supported by the underlying video compression engine. More...
 
class  TVideoStandard
 Defines valid video standards that might be supported by a video capture device. More...
 
class  TWhiteBalanceCalibrationMode
 Defines valid white balance calibration modes. More...
 
class  TWhiteBalanceParameter
 Defines valid parameter sets selectable via the WhiteBalance property. 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 (if available). More...
 
class  VideoStream
 A class to create compressed video stream from images captured or loaded using the Impact Acquire API. More...
 
class  VideoStreamPauseScope
 A smaller helper class for pausing a video stream for a defined time. 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

static final int MVIMPACT_ACQUIRE_BUILD_VERSION = acquireJNI.MVIMPACT_ACQUIRE_BUILD_VERSION_get()
 Returns the build version number of the current Impact Acquire release.
 
static final int MVIMPACT_ACQUIRE_MAJOR_VERSION = acquireJNI.MVIMPACT_ACQUIRE_MAJOR_VERSION_get()
 Returns the major version number of the current Impact Acquire release.
 
static final int MVIMPACT_ACQUIRE_MINOR_VERSION = acquireJNI.MVIMPACT_ACQUIRE_MINOR_VERSION_get()
 Returns the minor version number of the current Impact Acquire release.
 
static final int MVIMPACT_ACQUIRE_RELEASE_VERSION = acquireJNI.MVIMPACT_ACQUIRE_RELEASE_VERSION_get()
 Returns the release version number of the current Impact Acquire release.
 
static final String MVIMPACT_ACQUIRE_VERSION_STRING = acquireJNI.MVIMPACT_ACQUIRE_VERSION_STRING_get()
 Returns the full version number of the current Impact Acquire release as a string ("3.5.0.4101").
 

Detailed Description

Classes and functions that are available for all interface layouts.

This group contains classes and functions that are available for all interface layouts.

Variable Documentation

◆ MVIMPACT_ACQUIRE_BUILD_VERSION

final int MVIMPACT_ACQUIRE_BUILD_VERSION = acquireJNI.MVIMPACT_ACQUIRE_BUILD_VERSION_get()
static

Returns the build version number of the current Impact Acquire release.

Returns
The build version number of Impact Acquire

◆ MVIMPACT_ACQUIRE_MAJOR_VERSION

final int MVIMPACT_ACQUIRE_MAJOR_VERSION = acquireJNI.MVIMPACT_ACQUIRE_MAJOR_VERSION_get()
static

Returns the major version number of the current Impact Acquire release.

Returns
The major version number of Impact Acquire

◆ MVIMPACT_ACQUIRE_MINOR_VERSION

final int MVIMPACT_ACQUIRE_MINOR_VERSION = acquireJNI.MVIMPACT_ACQUIRE_MINOR_VERSION_get()
static

Returns the minor version number of the current Impact Acquire release.

Returns
The minor version number of Impact Acquire

◆ MVIMPACT_ACQUIRE_RELEASE_VERSION

final int MVIMPACT_ACQUIRE_RELEASE_VERSION = acquireJNI.MVIMPACT_ACQUIRE_RELEASE_VERSION_get()
static

Returns the release version number of the current Impact Acquire release.

Returns
The release version number of Impact Acquire

◆ MVIMPACT_ACQUIRE_VERSION_STRING

final String MVIMPACT_ACQUIRE_VERSION_STRING = acquireJNI.MVIMPACT_ACQUIRE_VERSION_STRING_get()
static

Returns the full version number of the current Impact Acquire release as a string ("3.5.0.4101").

Returns
The full version string of Impact Acquire