- Generated on Thu Jul 25 2024 18:58:53
|
Impact Acquire SDK .NET
|
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 some small helper classes and convenience functions belonging to the image acquisition module of this SDK. | |
| namespace | labs |
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 | 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. More... | |
| class | CameraDescriptionCameraLink |
| A class to describe a CameraLink® compliant camera (Device specific interface layout only). More... | |
| class | CameraDescriptionDigital |
| A class to describe a non-standard digital video signal (Device specific interface layout only). More... | |
| class | CameraDescriptionDigitalBase |
| A base class to describe an arbitrary digital camera signal (Device specific interface layout only). More... | |
| class | CameraDescriptionDigitalBase2 |
| A base class to describe an arbitrary digital camera signal (Device specific interface layout only). More... | |
| class | CameraDescriptionManager |
| Grants access to camera description objects (Device specific interface layout only). More... | |
| class | CameraDescriptionNonStandard |
| A class describing non-standard video cameras (Device specific interface layout only). More... | |
| class | CameraDescriptionSDI |
| A base class to describe a SDI (Serial Digital Interface) camera signal (Device specific interface layout only). More... | |
| class | CameraDescriptionStandard |
| A class describing analogue standard compliant video cameras (Device specific interface layout only). 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). More... | |
| class | CameraSettingsVirtualDevice |
| mvVirtualDevice related camera settings (Device specific interface layout only). 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 | ComponentChangedEventArgs |
| A class containing data generated by a component changed event. 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 | DeviceWillBeClosedEventArgs |
| A class containing data generated by an event triggered when a device is about to get closed. More... | |
| class | DigitalInput |
| A class to represent a digital input pin(Device specific interface layout only). More... | |
| class | DigitalIO |
| An abstract base class to represent a digital 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 mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_LIST_CANT_ACCESS_DATA error. More... | |
| class | ECantAllocateNewList |
| An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_CANT_ALLOCATE_LIST error. More... | |
| class | ECantRegisterComponent |
| An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_CANT_REGISTER_COMPONENT error. More... | |
| class | ECantSerializeData |
| An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_CANT_SERIALIZE_DATA error. More... | |
| class | EComponent |
| A base class for mv.impact.acquire.Component object related exceptions from the property module. More... | |
| class | EComponentIDInvalid |
| An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_COMPONENT_ID_INVALID error. More... | |
| class | EComponentNotFound |
| An exception thrown in case of a mv.impact.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 mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_IMPLEMENTATION_MISSING error. More... | |
| class | EIncompatibleComponents |
| An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_INCOMPATIBLE_COMPONENTS error. More... | |
| class | EInputBufferTooSmall |
| An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_INPUT_BUFFER_TOO_SMALL error. More... | |
| class | EInvalidFileContent |
| An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_INVALID_FILE_CONTENT error. More... | |
| class | EInvalidInputParameter |
| An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_INVALID_INPUT_PARAMETER error. More... | |
| class | EInvalidListID |
| An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_LIST_ID_INVALID error. More... | |
| class | EInvalidParameterList |
| An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_METHOD_INVALID_PARAM_LIST error. More... | |
| class | EInvalidValue |
| An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_INVALID_PROP_VALUE error. More... | |
| class | EInvalidValueType |
| An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_INVALID_PROP_VALUE_TYPE error. More... | |
| class | EListEntryOccupied |
| An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_LIST_ENTRY_OCCUPIED error. More... | |
| class | EMethod |
| A base class for mv.impact.acquire.Method object related exceptions from the property module. More... | |
| class | EMethodPtrInvalid |
| An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_METHOD_PTR_INVALID error. More... | |
| class | ENoModifySizeRights |
| An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_NO_MODIFY_SIZE_RIGHTS error. More... | |
| class | ENoReadRights |
| An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_NO_READ_RIGHTS error. More... | |
| class | ENotAList |
| An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_NOT_A_LIST error. More... | |
| class | ENotAMethod |
| An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_NOT_A_METHOD error. More... | |
| class | ENotAProperty |
| An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_NOT_A_PROPERTY error. More... | |
| class | ENoWriteRights |
| An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.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 mv.impact.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 mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_SIZE_MISMATCH error. More... | |
| class | ETranslationTableCorrupted |
| An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_PROP_TRANSLATION_TABLE_CORRUPTED error. More... | |
| class | ETranslationTableNotDefined |
| An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_PROP_TRANSLATION_TABLE_NOT_DEFINED error. More... | |
| class | EUnsupportedOperation |
| An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_UNSUPPORTED_OPERATION error. More... | |
| class | EUnsupportedParameter |
| An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_UNSUPPORTED_PARAMETER error. More... | |
| class | EValidationFailed |
| An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_PROP_VALIDATION_FAILED error. More... | |
| class | EValIDOutOfBounds |
| An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_PROP_VAL_ID_OUT_OF_BOUNDS error. More... | |
| class | EValTooLarge |
| An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_PROP_VAL_TOO_LARGE error. More... | |
| class | EValTooSmall |
| An exception thrown in case of a mv.impact.acquire.TPROPHANDLING_ERROR.PROPHANDLING_PROP_VAL_TOO_SMALL error. More... | |
| class | EWrongParamCount |
| An exception thrown in case of a mv.impact.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 | 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... | |
| 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 |
| An base class for exceptions generated by Impact Acquire. More... | |
| class | Info |
| A class to query various general information about the device, its driver and other information. 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). More... | |
| interface | IRequestFactory |
| A default request factory. More... | |
| class | LibraryPath |
| A small helper class to administer various library search path related variables and paths. 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). More... | |
| class | Property |
| A base class for properties. More... | |
| class | PropertyF |
| Provided for convenience only. This type represents a standard float property type. More... | |
| class | PropertyI |
| Provided for convenience only. This type represents a standard 32-bit integer property type. More... | |
| class | PropertyI64 |
| Provided for convenience only. This type represents a standard 64-bit integer property type. More... | |
| class | PropertyIBoolean |
| Provided for convenience only. This type represents a standard boolean property type. 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 | RequestBitmapData |
| A class containing a reference to a bitmap created from a request. 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 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 class for accessing general settings that control the overall behaviour of a device driver. More... | |
| class | TImageBufferPixelFormatExtension |
| Additional methods to extend the functionality of the mv.impact.acquire.TImageBufferPixelFormat enumeration. More... | |
| class | TImageDestinationPixelFormatExtension |
| Additional methods to extend the functionality of the mv.impact.acquire.TImageDestinationPixelFormat enumeration. 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 (if available). 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... | |
Enumerations | |
| enum | TAcquisitionField : uint { afAuto = 0 , afOdd = 1 , afEven = 2 , afAny = afOdd | afEven } |
| Defines which field triggers the start of the acquisition (deprecated. More... | |
| enum | TAcquisitionMode : int { amContinuous = 1 , amMultiFrame = 2 , amSingleFrame = 3 } |
| Defines valid acquisition modes. More... | |
| enum | TAcquisitionStartStopBehaviour : int { assbDefault , assbUser } |
| Defines valid modes for acquisition start/stop behaviour. More... | |
| enum | TAoiMode : int { amCentered = 0 , amFull , amUseAoi } |
| Defines valid Area Of Interest modes. More... | |
| enum | TAutoControlMode : int { acmStandard , acmDeviceSpecific } |
| Defines valid auto control modes. More... | |
| enum | TAutoControlSpeed : int { acsSlow = 0 , acsMedium , acsFast , acsUserDefined } |
| Defines valid auto-control speed modes. More... | |
| enum | TAutoExposureControl : int { aecOff = 0 , aecOn } |
| Defines valid AEC( Automatic Exposure Control ) modes. More... | |
| enum | TAutoGainControl : int { agcOff = 0 , agcOn } |
| Defines valid AGC( Automatic Gain Control ) modes. More... | |
| enum | TAutoOffsetCalibration : int { aocOff = 0 , aocOn } |
| Defines valid offset calibration modes. More... | |
| enum | TBayerConversionMode : uint { bcmLinearInterpolation , bcmAdaptiveEdgeSensing , bcmAuto , bcmPacked , bcmLinearPacked , bcmAdaptiveEdgeSensingPlus , bcmAdaptiveHomogeneityDirected } |
| Defines the Bayer conversion algorithm to use. More... | |
| enum | TBayerMosaicParity : int { bmpUndefined = -1 , bmpGR , bmpRG , bmpBG , bmpGB } |
| Defines valid Bayer formats. More... | |
| enum | TBayerWhiteBalanceResult : int { bwbrUnknown = 0 , bwbrOK = 1 , bwbrErrorUnknown = 2 , bwbrErrorTooDark = 3 , bwbrErrorTooBright = 4 } |
| Defines valid results of a white balance calibration. More... | |
| enum | TBlueFOXDigitalInputThreshold : int { bfdit2V = 2 , bfdit10V = 10 } |
| Defines valid thresholds( in Volt ) for the digital inputs of the mvBlueFOX cameras. More... | |
| enum | TBlueFOXFooterMode : int { bffmOff = 0 , bffm64B = 64 , bffm512B = 512 } |
| Defines the footer mode of the mvBlueFOX. More... | |
| enum | TBlueFOXInfoSensorCapabilities : uint { bfiscNone = 0x00000000 , bfiscExposure = 0x00000001 , bfiscExposureAuto = 0x00000002 , bfiscGain = 0x00000004 , bfiscGainAuto = 0x00000008 , bfiscOffset = 0x00000010 , bfiscOffsetAuto = 0x00000020 , bfiscBinning = 0x00000040 , bfiscTrigger = 0x00000080 , bfiscFlash = 0x00000100 , bfiscLineTrigger = 0x00000200 , bfiscShadingCorrection = 0x00000400 , bfiscOverlappedExposure = 0x00000800 , bfiscFrameDelay = 0x00001000 , bfiscLineDelay = 0x00002000 , bfiscAutoControlAOI = 0x00004000 , bfiscAutoControlSpeed = 0x00008000 , bfiscAutoControlDelay = 0x00010000 , bfiscTemperatureSensor = 0x00020000 , bfiscReverseX = 0x00040000 , bfiscReverseY = 0x00080000 , bfiscExposeToFlashDelay = 0x00100000 , bfiscFrameRate = 0x00200000 , bfiscAutoOffsetBlackLevel = 0x00400000 } |
| Defines valid image sensor capabilities. More... | |
| enum | TBlueFOXOffsetAutoBlackSpeed : int { bfoablFastest = 0 , bfoablVeryFast = 1 , bfoablFast = 2 , bfoablMedium = 3 , bfoablSlow = 4 , bfoablVerySlow = 6 , bfoablSlowest = 7 } |
| Defines Offset Auto Calibration Controller Speed. More... | |
| enum | TBlueFOXSensorTiming : int { bfstStandard = 0 , bfstFastLineSkip = 1 , bfstLowSmearLineSkip = 2 } |
| Sensor timing options. More... | |
| enum | TBlueFOXTransferSize : int { bfts16KB = 16 * 1024 , bfts32KB = 32 * 1024 , bfts64KB = 64 * 1024 , bfts128KB = 128 * 1024 , bfts256KB = 256 * 1024 , bfts512KB = 512 * 1024 , bfts1024KB = 1024 * 1024 , bfts2048KB = 2048 * 1024 } |
| Defines the block size used for the USB transfer of the mvBlueFOX. More... | |
| enum | TBoolean : int { bFalse = 0 , bTrue = 1 } |
| Defines a Boolean value type. More... | |
| enum | TBufferPartDataType : int { bpdtUnknown = 0 , bpdt2DImage = 1 , bpdt2DPlaneBiplanar = 2 , bpdt2DPlaneTriplanar = 3 , bpdt2DPlaneQuadplanar = 4 , bpdt3DImage = 5 , bpdt3DPlaneBiplanar = 6 , bpdt3DPlaneTriplanar = 7 , bpdt3DPlaneQuadplanar = 8 , bpdtConfidenceMap = 9 , bpdtGenICamChunkData = 10 , bpdtJPEG = 1000 , bpdtJPEG2000 , bpdtGDC_GenICamChunkData = 0x4000 , bpdtGDC_GenICamXML = 0x4001 , bpdtGDC_2DImage = 0x4200 , bpdtGDC_JPEG = 0x4201 , bpdtGDC_JPEG2000 = 0x4202 , bpdtGDC_H264 = 0x4203 } |
| Defines buffer part data types. More... | |
| enum | TCallbackType : int { ctOnChanged = 0 , ctOnReadData = 1 , ctOnWriteData = 2 , ctOnRefreshCache = 3 } |
| Defines the type of callback to register. More... | |
| enum | TCameraAoiMode : int { camFull = 0 , camUser } |
| Defines the camera Aoi modes. More... | |
| enum | TCameraBinningMode : uint { cbmOff = 0x0 , cbmBinningH = 0x1 , cbmBinningV = 0x2 , cbmBinningHV = cbmBinningH | cbmBinningV , cbmBinning3H = 0x10 , cbmBinning3V = 0x20 , cbmBinning3H3V = cbmBinning3H | cbmBinning3V , cbmBinningHAvg = 0x101 , cbmBinningVAvg = 0x102 , cbmBinningHVAvg = cbmBinningHAvg | cbmBinningVAvg , cbmBinning3HAvg = 0x110 , cbmBinning3VAvg = 0x120 , cbmBinning3H3VAvg = cbmBinning3HAvg | cbmBinning3VAvg , cbmDroppingH = 0x1001 , cbmDroppingV = 0x1002 , cbmDroppingHV = cbmDroppingH | cbmDroppingV , cbmDropping3H = 0x1010 , cbmDropping3V = 0x1020 , cbmDropping3H3V = cbmDropping3H | cbmDropping3V } |
| Defines valid binning modes for the camera. More... | |
| enum | TCameraDataFormat : int { cdfUnknown = 0 , cdfMono , cdfBayer , cdfBayerPacked , cdfRGB , cdfYUV } |
| Defines the data format the camera is sending (deprecated. More... | |
| enum | TCameraExposeMode : int { cemStandard = 0 , cemOverlapped , cemNoShutter } |
| Defines recognized camera sensor expose modes. More... | |
| enum | TCameraExternalSyncEdge : int { ceseNo = 0 , ceseFallingEdge = 1 , ceseRisingEdge = 2 } |
| Some grabbers are able to get the video signal and sync signals ( HD-IN, VD-IN ) on separate lines. The user can define this for non standard cameras (deprecated. More... | |
| enum | TCameraExternalSyncOutput : int { cesoAuto = 0 , cesoRed = 1 , cesoGreen = 2 , cesoBlue = 3 , cesoExtern = 4 } |
| Some grabbers are able to get the video signal and the sync signal on different input pins. The user can select this for non standard cameras (deprecated. More... | |
| enum | TCameraFlashMode : int { cfmOff = 0 , cfmDigout0 = 0x1 , cfmDigout1 = 0x2 } |
| Defines valid camera flash modes. More... | |
| enum | TCameraFlashType : int { cftStandard = 0 , cftRollingShutterFlash = 1 , cftVSync = 2 } |
| Defines valid camera flash control types. More... | |
| enum | TCameraHDRMode : int { cHDRmFixed0 = 0 , cHDRmFixed1 = 1 , cHDRmFixed2 = 2 , cHDRmFixed3 = 3 , cHDRmFixed4 = 4 , cHDRmFixed5 = 5 , cHDRmFixed6 = 6 , cHDRmUser = 100 } |
| Defines valid camera High Dynamic Range modes. More... | |
| enum | TCameraInterlacedType : int { citNone , citInterlaced , citInvertedInterlaced } |
| Defines how the camera transmits its video signal (deprecated. More... | |
| enum | TCameraLinkDataValidMode : int { cldvmActive = 0 , cldvmInactive } |
| Defines how the camera transmits the DVAL signal defined in the CameraLink® standard (deprecated. More... | |
| enum | TCameraOutput : int { coUndefined = -1 , coAuto = 0 , coComposite = 1 , coBase = 2 , coDigital = 3 , coSVideo = 4 , coMedium = 5 , coRGB = 6 , co2xComposite = 7 , co3xComposite = 8 , co4xComposite = 9 , coFull = 10 , coSDSDI = 11 , coHDSDI = 12 , co3GSDI = 13 } |
| Defines valid ways a camera can offer image data to a capture device (deprecated. More... | |
| enum | TCameraPixelClock : int { cpcStandard = 0 , cpcHighSpeed = 1 , cpc6000KHz = 6000 , cpc8000KHz = 8000 , cpc10000KHz = 10000 , cpc12000KHz = 12000 , cpc13500KHz = 13500 , cpc20000KHz = 20000 , cpc24000KHz = 24000 , cpc24540KHz = 24540 , cpc27000KHz = 27000 , cpc32000KHz = 32000 , cpc37600KHz = 37600 , cpc40000KHz = 40000 , cpc50000KHz = 50000 , cpc57600KHz = 57600 } |
| Defines valid camera pixel frequencies. More... | |
| enum | TCameraScanMode : int { csmArea = 0 , csmLine } |
| Defines valid scan modes for the a camera. More... | |
| enum | TCameraSerialPortBaudRate : int { cspbr9600 = 9600 , cspbr19200 = 19200 , cspbr38400 = 38400 , cspbr57600 = 57600 , cspbr115200 = 115200 , cspbr230400 = 230400 , cspbr460800 = 460800 , cspbr921600 = 921600 } |
| Defines valid baud rates for serial port communication between frame grabber and camera (deprecated. More... | |
| enum | TCameraShutterMode : int { csmFrameShutter = 0 , csmElectronicRollingShutter , csmGlobalResetRelease , csmFrameShutterWithFastCenterReadout } |
| Defines recognized camera sensor shutter modes. More... | |
| enum | TCameraTapsXGeometry : int { cltxg1X = 0 , cltxg1X2 = 1 , cltxg2X = 2 , cltxg2XE = 3 , cltxg2XM = 4 , cltxg1X3 = 5 , cltxg3X = 6 , cltxg1X4 = 7 , cltxg4X = 8 , cltxg2X2 = 9 , cltxg2X2E = 10 , cltxg2X2M = 11 , cltxg4XE = 12 , cltxg1X8 = 13 , cltxg8X = 14 , cltxg4X2 = 15 , cltxg4X2E = 16 } |
| Multitap cameras can transmit data in different ways. This enum can be used to define how the camera transmits a line of pixels. More... | |
| enum | TCameraTapsYGeometry : int { cltyg1Y = 0 , cltyg1Y2 = 1 , cltyg2YE = 2 } |
| Multi-tap cameras can transmit data in different ways. This enumeration can be used to define how the camera transmits the lines of pixels. More... | |
| enum | TCameraTestMode : int { ctmOff = 0 , ctmGreyRamp = 1 , ctmMovingColor = 2 , ctmWBTest = 3 } |
| Defines valid transmission modes for the camera. More... | |
| enum | TCameraTriggerMode : int { ctmContinuous = 0 , ctmOnDemand , ctmOnLowLevel , ctmOnHighLevel , ctmOnFallingEdge , ctmOnRisingEdge , ctmOnHighExpose , ctmOnLowExpose , ctmOnAnyEdge , ctmFramerateControlled } |
| Defines valid camera sensor trigger modes. More... | |
| enum | TCameraTriggerSource : int { ctsDigIn0 = 0 , ctsDigIn1 , ctsRTCtrl , ctsDigOut0 , ctsDigOut1 , ctsDigOut2 , ctsDigOut3 } |
| Defined valid camera sensor trigger source values. More... | |
| enum | TChannelSplitMode : int { csmVertical , csmHorizontal , csmExtractSingle } |
| Defines valid modes for channel split filters. More... | |
| enum | TClampMode : int { ecmAuto , ecmUser } |
| Clamp signal means, that an AC coupled video signal is clamped on the porch to get a signal transfer with less noise and independent from the d.c. voltage portion (deprecated. More... | |
| enum | TColorProcessingMode : int { cpmAuto = 0 , cpmRaw , cpmBayer , cpmBayerToMono , cpmRawToPlanes } |
| Defines the color processing mode. More... | |
| enum | TColorTwistInputCorrectionMatrixMode : int { cticmmUser = 0x00010000 | 0x1000 , cticmmDeviceSpecific = 0x00010000 | 0x2000 } |
| Defines valid values for input color correction matrices. More... | |
| enum | TColorTwistOutputCorrectionMatrixMode : int { ctocmmUser , ctocmmXYZToAdobeRGB_D50 , ctocmmXYZTosRGB_D50 , ctocmmXYZToWideGamutRGB_D50 , ctocmmXYZToAdobeRGB_D65 , ctocmmXYZTosRGB_D65 } |
| Defines valid values for output color correction matrices. More... | |
| enum | TComponentFlag : uint { cfUndefined = 0x0 , cfReadAccess = 0x1 , cfWriteAccess = 0x2 , cfRWAccess = cfReadAccess | cfWriteAccess , cfFixedSize = 0x4 , cfInvisible = 0x10 , cfAllowValueCombinations = 0x20 , cfShouldBeDisplayedAsList = 0x40 , cfDisallowSerialize = 0x80 , cfAlwaysForceClone = 0x100 , cfNotAvailable = 0x200 , cfNotImplemented = 0x400 , cfContainsBinaryData = 0x800 , cfShouldBeDisplayedAsEnumeration = 0x1000 , cfAlwaysForceUpdate = 0x2000 } |
| Flags defining access rights and other component properties. More... | |
| enum | TComponentRepresentation : int { crUndefined = 0 , crLinear , crLogarithmic , crBoolean , crPureNumber , crHexNumber , crIPv4Address , crMACAddress , crFileName , crDirectoryName } |
| Defines valid recommended representations for features. More... | |
| enum | TComponentType : uint { ctProp = 0x00010000 , ctList = 0x00020000 , ctMeth = 0x00040000 , ctPropInt = ctProp | TValueType.vtInt , ctPropFloat = ctProp | TValueType.vtFloat , ctPropString = ctProp | TValueType.vtString , ctPropPtr = ctProp | TValueType.vtPtr , ctPropInt64 = ctProp | TValueType.vtInt64 } |
| Allowed components handled by this module. More... | |
| enum | TComponentVisibility : int { cvBeginner = 0 , cvExpert = 1 , cvGuru = 2 , cvInvisible = 3 } |
| Defines valid recommended visibilities for features. More... | |
| enum | TDarkCurrentFilterMode : int { dcfmOff = 0 , dcfmOn , dcfmCalibrateDarkCurrent , dcfmTransmitCorrectionImage } |
| Defines valid modes for the dark current filter. More... | |
| enum | TDefectivePixelsFilterMode : int { dpfmOff = 0 , dpfm3x1Average , dpfm3x3Median , dpfmResetCalibration , dpfmCalibrateLeakyPixel , dpfmCalibrateColdPixel , dpfmCalibrateHotPixel , dpfmCalibrateHotAndColdPixel , dpfmReplaceDefectivePixelAfter3x3Filter } |
| Defines valid modes for defective pixels filter. More... | |
| enum | TDeviceAccessMode : int { damUnknown , damNone , damRead , damControl , damExclusive } |
| Defines valid device access modes. More... | |
| enum | TDeviceAdvancedOptions : uint { daoOff = 0 , daoLowLight = 0x1 , daoEmbeddedImageInfo = 0x2 , daoImageAverage = 0x4 , daoPipelinedGainExposeControl = 0x8 , daoOnDemandTriggerPreShot = 0x10 , daoLowFrameRateOptimization = 0x20 , daoEnablePerChannelOffsetCorrection = 0x40 , daoUseRawSensorGain = 0x80 , daoTriggerSensorColumnCalibration = 0x100 } |
| Defines valid advanced options. More... | |
| enum | TDeviceAutoNegotiatePacketSizeMode : int { danpsmHighToLow , danpsmLowToHigh } |
| Defines the way the packet size auto negotiation is handled for GigE Vision™ devices. More... | |
| enum | TDeviceCapability : uint { dcNone = 0x0 , dcHotplugable = 0x1 , dcSelectableVideoInputs = 0x2 , dcNonVolatileUserMemory = 0x4 , dcCameraDescriptionSupport = 0x8 , dcEventSupport = 0x10 } |
| Defines valid device capabilities. More... | |
| enum | TDeviceClass : int { dcGeneric , dcCamera , dcIntelligentCamera , dcFrameGrabber , dc3DCamera } |
| Defines valid generic device classes. More... | |
| enum | TDeviceDigitalOutputMode : int { ddomManual = 0 , ddomPulse , ddomUser , ddomExposureActive , ddomDigitalSignalPassThrough , ddomDigitalSignalPassThroughInv , ddomInternalVD , ddomRealTimeController , ddomExposureAndAcquisitionActive , ddomTemperatureOutOfRange } |
| Defines grabber specific digital output modes. More... | |
| enum | TDeviceImageTrigger : int { ditImmediately = 0 , ditAfterDigOutSignals } |
| Defines acquisition start event if using pulse sequences (deprecated. More... | |
| enum | TDeviceInterfaceLayout : int { dilDeviceSpecific = 1 , dilGenICam = 2 } |
| Defines valid interface layouts for the device. More... | |
| enum | TDeviceListType : int { dltUndefined = -1 , dltSetting = 0 , dltRequest = 1 , dltRequestCtrl = 2 , dltInfo = 3 , dltStatistics = 4 , dltSystemSettings = 5 , dltIOSubSystem = 6 , dltRTCtr = 7 , dltCameraDescriptions = 8 , dltDeviceSpecificData = 9 , dltImageMemoryManager = 12 , dltLast = 13 , dltDeviceDriverLib = dltLast } |
| Defines valid interface list types, which can be located using an instance of mv.impact.acquire.DeviceComponentLocator. More... | |
| enum | TDeviceLoadSettings : int { dlsAuto = 0 , dlsNoLoad } |
| Defines valid modes for the loading of settings during initialization. More... | |
| enum | TDevicePowerMode : int { dpmOn , dpmOff } |
| Defines the power mode for this device. More... | |
| enum | TDeviceScanRateMode : int { dsrmAuto , dsrmUser } |
| Defines valid device scan rate mode. More... | |
| enum | TDeviceSignalOutputStartEvent : int { dsoseFrame , dsoseTrigger , dsoseFrameAfterTrigger , dsoseSyncInRisingEdge , dsoseSyncInFallingEdge , dsoseSyncInPassThrough , dsoseSyncInPassThroughInv , dsosePeriodically , dsoseTriggerInPassThrough , dsoseTriggerInPassThroughInv , dsoseFVALPassThrough , dsoseFVALPassThroughInv , dsoseFVALRisingEdge } |
| Defines valid moments to start the signal generation on the digital outputs. More... | |
| enum | TDeviceState : int { dsAbsent = 0 , dsPresent , dsInitializing , dsUnreachable , dsPowerDown } |
| Defines valid Device states. More... | |
| enum | TDeviceSyncOutMode : int { dsomOff = 0 , dsomNonInterlaced , dsomInterlaced } |
| Valid sync. signal output modes for frame grabbers. More... | |
| enum | TDeviceTriggerInterface : int { dtiStandard = 0 , dtiAdvanced } |
| Defines which trigger interface is currently active for the device. More... | |
| enum | TDeviceTriggerMode : int { dtmOff = 0 , dtmOn , dtmFallingEdge , dtmRisingEdge , dtmPeriodically , dtmOnDemand , dtmStartRisingStopFalling , dtmStartFallingStopRising , dtmLevelHigh , dtmLevelLow } |
| Valid trigger modes for frame grabber boards. More... | |
| enum | TDeviceTriggerOverlap : long { dtoOff , dtoReadOut , dtoPreviousFrame } |
| Specifies the type trigger overlap permitted with the previous frame. More... | |
| enum | TDigIOState : int { digioOff = 0 , digioOn = 1 , digioIgnore = 2 , digioKeep = 3 } |
| Defines valid digital I/O states. More... | |
| enum | TDigitalIOMeasurementMode : int { diommFrequency_Hz_10ms = 0 , diommFrequency_Hz_100ms } |
| Defines valid IO Measurement Modes. More... | |
| enum | TDigitalIOMeasurementSource : int { diomsInput0 = 0 , diomsInput1 = 1 , diomsInput2 = 2 , diomsInput3 = 3 } |
| Defines valid IO Measurement Sources. More... | |
| enum | TDigitalOutputControlMode : int { docmSoftware = 0 , docmRTC } |
| Defines valid ways to create signals on a digital output (deprecated. More... | |
| enum | TDigitalSignal : uint { dsNone = 0x00000000 , dsSignal1 = 0x00000001 , dsSignal2 = 0x00000002 , dsSignal3 = 0x00000004 , dsSignal4 = 0x00000008 , dsSignal5 = 0x00000010 , dsSignal6 = 0x00000020 , dsSignal7 = 0x00000040 , dsSignal8 = 0x00000080 , dsSignal9 = 0x00000100 , dsSignal10 = 0x00000200 , dsSignal11 = 0x00000400 , dsSignal12 = 0x00000800 , dsSignal13 = 0x00001000 , dsSignal14 = 0x00002000 , dsSignal15 = 0x00004000 , dsSignal16 = 0x00008000 } |
| Defines valid digital source signal constants that can be used to configure a devices behaviour in certain digital I/O related modes (deprecated. More... | |
| enum | TDMR_ERROR : int { DMR_NO_ERROR = 0 , DMR_DEV_NOT_FOUND = -2100 , DMR_INIT_FAILED = -2101 , DMR_DRV_ALREADY_IN_USE = -2102 , DMR_DEV_CANNOT_OPEN = -2103 , DMR_NOT_INITIALIZED = -2104 , DMR_DRV_CANNOT_OPEN = -2105 , DMR_DEV_REQUEST_QUEUE_EMPTY = -2106 , DMR_DEV_REQUEST_CREATION_FAILED = -2107 , DMR_INVALID_PARAMETER = -2108 , DMR_EXPORTED_SYMBOL_NOT_FOUND = -2109 , DEV_UNKNOWN_ERROR = -2110 , DEV_HANDLE_INVALID = -2111 , DEV_INPUT_PARAM_INVALID = -2112 , DEV_WRONG_INPUT_PARAM_COUNT = -2113 , DEV_CREATE_SETTING_FAILED = -2114 , DEV_REQUEST_CANT_BE_UNLOCKED = -2115 , DEV_INVALID_REQUEST_NUMBER = -2116 , DEV_LOCKED_REQUEST_IN_QUEUE = -2117 , DEV_NO_FREE_REQUEST_AVAILABLE = -2118 , DEV_WAIT_FOR_REQUEST_FAILED = -2119 , DEV_UNSUPPORTED_PARAMETER = -2120 , DEV_INVALID_RTC_NUMBER = -2121 , DMR_INTERNAL_ERROR = -2122 , DMR_INPUT_BUFFER_TOO_SMALL = -2123 , DEV_INTERNAL_ERROR = -2124 , DMR_LIBRARY_NOT_FOUND = -2125 , DMR_FUNCTION_NOT_IMPLEMENTED = -2126 , DMR_FEATURE_NOT_AVAILABLE = -2127 , DMR_EXECUTION_PROHIBITED = -2128 , DMR_FILE_NOT_FOUND = -2129 , DMR_INVALID_LICENCE = -2130 , DEV_SENSOR_TYPE_ERROR = -2131 , DMR_CAMERA_DESCRIPTION_INVALID = -2132 , DMR_NEWER_LIBRARY_REQUIRED = -2133 , DMR_TIMEOUT = -2134 , DMR_WAIT_ABANDONED = -2135 , DMR_EXECUTION_FAILED = -2136 , DEV_REQUEST_ALREADY_IN_USE = -2137 , DEV_REQUEST_BUFFER_INVALID = -2138 , DEV_REQUEST_BUFFER_MISALIGNED = -2139 , DEV_ACCESS_DENIED = -2140 , DMR_PRELOAD_CHECK_FAILED = -2141 , DMR_CAMERA_DESCRIPTION_INVALID_PARAMETER = -2142 , DMR_FILE_ACCESS_ERROR = -2143 , DMR_INVALID_QUEUE_SELECTION = -2144 , DMR_ACQUISITION_ENGINE_BUSY = -2145 , DMR_BUSY = -2146 , DMR_OUT_OF_MEMORY = -2147 , DMR_LAST_VALID_ERROR_CODE = -2199 } |
| Errors reported by the device manager. More... | |
| enum | TFieldGateMode : int { efmAuto , efmUser } |
| The field gate is used to detect the field ( odd or even ) for interlaced video signals (deprecated. More... | |
| enum | TFirmwareUpdateAction : int { fuaContinue = 0 , fuaCancel } |
| enum | TFirmwareUpdateStep : int { fusErrorMessage = -1 , fusUnzippingFirmwareArchive = 5 , fusSavingUserSets = 10 , fusErasingFlash = 15 , fusUpdatingBootProgrammer = 20 , fusUploadingFirmware = 25 , fusHardResetRequired = 89 , fusRebootingDevice = 90 , fusLoadingUserSets = 95 } |
| enum | TFlatFieldFilterCorrectionMode : int { ffcmDefault = 0 , ffcmBrightPreserving } |
| Defines valid modes for the flat field correction. More... | |
| enum | TFlatFieldFilterMode : int { fffmOff = 0 , fffmOn , fffmCalibrateFlatField , fffmTransmitCorrectionImage } |
| Defines valid modes for the flat field filter. More... | |
| enum | THWUpdateResult : int { urNoUpdatePerformed = 0 , urUpdateFW , urUpdateFWError , urDevAlreadyInUse , urUpdateFWOK , urSetDevID , urSetDevIDError , urSetDevIDInvalidID , urSetDevIDOK , urSetUserDataSizeError , urSetUserDataWriteError , urSetUserDataWriteOK , urGetUserDataReadError , urVerifyFWError , urVerifyFWOK } |
| Defines valid Device HW update results. More... | |
| enum | TI2COperationMode : int { I2ComRead = 0 , I2ComWrite } |
| Valid I2C operation modes. More... | |
| enum | TI2COperationStatus : int { I2CosSuccess = 0 , I2CosFailure , I2CosInvalidDeviceAddress , I2CosInvalidDeviceSubAddress , I2CosTooMuchData , I2CosNotEnoughData } |
| Valid I2C operation status values. More... | |
| enum | TImageBufferFormatReinterpreterMode : int { ibfrmMono8_To_Mono8 = TImageBufferPixelFormat.ibpfMono8 << 16 | TImageBufferPixelFormat.ibpfMono8 , ibfrmMono8_To_RGB888Packed = TImageBufferPixelFormat.ibpfMono8 << 16 | TImageBufferPixelFormat.ibpfRGB888Packed , ibfrmMono8_To_BGR888Packed = TImageBufferPixelFormat.ibpfMono8 << 16 | TImageBufferPixelFormat.ibpfBGR888Packed , ibfrmMono10_To_Mono10 = TImageBufferPixelFormat.ibpfMono10 << 16 | TImageBufferPixelFormat.ibpfMono10 , ibfrmMono10_To_RGB101010Packed = TImageBufferPixelFormat.ibpfMono10 << 16 | TImageBufferPixelFormat.ibpfRGB101010Packed , ibfrmMono12_To_Mono12 = TImageBufferPixelFormat.ibpfMono12 << 16 | TImageBufferPixelFormat.ibpfMono12 , ibfrmMono12_To_RGB121212Packed = TImageBufferPixelFormat.ibpfMono12 << 16 | TImageBufferPixelFormat.ibpfRGB121212Packed , ibfrmMono14_To_Mono14 = TImageBufferPixelFormat.ibpfMono14 << 16 | TImageBufferPixelFormat.ibpfMono14 , ibfrmMono14_To_RGB141414Packed = TImageBufferPixelFormat.ibpfMono14 << 16 | TImageBufferPixelFormat.ibpfRGB141414Packed , ibfrmMono16_To_Mono16 = TImageBufferPixelFormat.ibpfMono16 << 16 | TImageBufferPixelFormat.ibpfMono16 , ibfrmMono16_To_RGB161616Packed = TImageBufferPixelFormat.ibpfMono16 << 16 | TImageBufferPixelFormat.ibpfRGB161616Packed } |
| Valid image buffer format reinterpreter modes. More... | |
| enum | TImageBufferPixelFormat : int { ibpfRaw = 0 , ibpfMono8 = 1 , ibpfMono16 = 2 , ibpfRGBx888Packed = 3 , ibpfYUV422Packed = 4 , ibpfRGBx888Planar = 5 , ibpfMono10 = 6 , ibpfMono12 = 7 , ibpfMono14 = 8 , ibpfRGB888Packed = 9 , ibpfYUV444Planar = 10 , ibpfMono32 = 11 , ibpfYUV422Planar = 12 , ibpfRGB101010Packed = 13 , ibpfRGB121212Packed = 14 , ibpfRGB141414Packed = 15 , ibpfRGB161616Packed = 16 , ibpfYUV422_UYVYPacked = 17 , ibpfMono12Packed_V2 = 18 , ibpfYUV422_10Packed = 20 , ibpfYUV422_UYVY_10Packed = 21 , ibpfBGR888Packed = 22 , ibpfBGR101010Packed_V2 = 23 , ibpfYUV444_UYVPacked = 24 , ibpfYUV444_UYV_10Packed = 25 , ibpfYUV444Packed = 26 , ibpfYUV444_10Packed = 27 , ibpfMono12Packed_V1 = 28 , ibpfYUV411_UYYVYY_Packed = 29 , ibpfRGB888Planar = 30 , ibpfAuto = -1 } |
| Valid image buffer pixel formats. More... | |
| enum | TImageDestinationPixelFormat : int { idpfAuto = 0 , idpfRaw = 1 , idpfMono8 = 2 , idpfRGBx888Packed = 3 , idpfYUV422Packed = 4 , idpfRGBx888Planar = 5 , idpfMono10 = 6 , idpfMono12 = 7 , idpfMono14 = 8 , idpfMono16 = 9 , idpfRGB888Packed = 10 , idpfYUV422Planar = 13 , idpfRGB101010Packed = 14 , idpfRGB121212Packed = 15 , idpfRGB141414Packed = 16 , idpfRGB161616Packed = 17 , idpfYUV422_UYVYPacked = 18 , idpfMono12Packed_V2 = 19 , idpfYUV422_10Packed = 20 , idpfYUV422_UYVY_10Packed = 21 , idpfBGR888Packed = 22 , idpfBGR101010Packed_V2 = 23 , idpfYUV444_UYVPacked = 24 , idpfYUV444_UYV_10Packed = 25 , idpfYUV444Packed = 26 , idpfYUV444_10Packed = 27 , idpfMono12Packed_V1 = 28 , idpfYUV411_UYYVYY_Packed = 29 , idpfRGB888Planar = 30 } |
| Defines the pixel format of the result image. More... | |
| enum | TImageFileFormat : int { iffAuto = -1 , iffBMP = 1 , iffJPEG = 2 , iffPNG = 13 , iffTIFF = 18 } |
| Defines valid image file formats. More... | |
| enum | TImageProcessingFilter : int { ipfOff = 0 , ipfSharpen } |
| Defines valid filters which can be applied to the captured image before it is transferred to the user. More... | |
| enum | TImageProcessingMode : int { ipmDefault = 0 , ipmProcessLatestOnly = 1 } |
| Defines valid modes the internal image processing pipeline can be operated in. More... | |
| enum | TImageProcessingOptimization : int { ipoMaximizeSpeed = 0 , ipoMinimizeMemoryUsage = 1 } |
| Defines valid modes the internal image processing algorithms can be operated in. More... | |
| enum | TImageProcessingResult : int { iprNotActive = 0 , iprApplied , iprFailure , iprSkipped , iprNotApplicable } |
| Defines valid values for the result of a certain image processing algorithm applied to a request. More... | |
| enum | TImageRequestControlMode : int { ircmManual , ircmLive , ircmCounting , ircmTrial , ircmUpdateBufferLayout } |
| Defines the behaviour of an mv.impact.acquire.ImageRequestControl. More... | |
| enum | TImpactBufferFlag : uint { ibfNone = 0x0 , ibfUseRequestMemory = 0x1 , ibfRecycleBufHandle = 0x2 } |
| Flags to define the way an mvIMPACT buffer is created and handled. More... | |
| enum | TInfoSensorColorMode : int { iscmUnknown = 0 , iscmMono , iscmBayer , iscmColor , iscmNIR } |
| Defines the type of camera sensor. More... | |
| enum | TInfoSensorColorPattern : int { iscpGreenRed , iscpRedGreen , iscpBlueGreen , iscpGreenBlue , iscpUnknown } |
| Defines the bayer pattern of the sensor. More... | |
| enum | TInfoSensorType : int { istUnknown = 0 , istCCD = 0x1 , istCMOS = 0x2 } |
| Defines the type of camera sensor. More... | |
| enum | TInterfaceEnumerationBehaviour : int { iebNotConfigured = 0 , iebForceIgnore = 1 , iebForceEnumerate = 2 } |
| Defines the enumeration behaviour of a certain interface of a third party GenTL producer. More... | |
| enum | TInterlacedMode : int { imOn = 0 , imOff = 1 } |
| Defines how to handle interlaced image data (deprecated. More... | |
| enum | TLibraryQuery : int { lqDeviceManager = 0 , lqPropHandling = 1 } |
| Defines valid libraries to query information from. More... | |
| enum | TLineCounter : int { lcOff = 0 , lcOn = 1 } |
| Currently available for mvTITAN/mvGAMMA-CL (deprecated. More... | |
| enum | TLUTGammaMode : int { LUTgmStandard , LUTgmLinearStart } |
| Defines valid LUT(LookUp Table) gamma modes. More... | |
| enum | TLUTImplementation : int { LUTiHardware , LUTiSoftware } |
| Defines valid LUT(LookUp Table) implementations. More... | |
| enum | TLUTInterpolationMode : int { LUTimThreshold , LUTimLinear , LUTimCubic } |
| Defines valid LUT(LookUp Table) interpolation modes. More... | |
| enum | TLUTMapping : uint { LUTm8To8 = ( 8 << 16 ) | 8 , LUTm10To8 = ( 10 << 16 ) | 8 , LUTm10To10 = ( 10 << 16 ) | 10 , LUTm12To10 = ( 12 << 16 ) | 10 , LUTm12To12 = ( 12 << 16 ) | 12 , LUTm14To14 = ( 14 << 16 ) | 14 , LUTm16To16 = ( 16 << 16 ) | 16 } |
| Defines valid LUT(LookUp Table) mapping modes. More... | |
| enum | TLUTMode : int { LUTmInterpolated , LUTmGamma , LUTmDirect } |
| Defines valid LUT(LookUp Table) modes. More... | |
| enum | TMemoryManagerMode : int { mmmAuto = 0 , mmmPool = 1 } |
| Defines valid modes to operate the memory manager in. More... | |
| enum | TMemoryManagerPoolMode : int { mmpmOff = 0 , mmpmFixed = 1 , mmpmAuto = 2 } |
| Defines the pool mode of memory manager. More... | |
| enum | TMirrorMode : uint { mmOff = 0 , mmTopDown = 0x1 , mmLeftRight = 0x2 , mmTopDownAndLeftRight = mmTopDown | mmLeftRight } |
| Defines valid mirror modes. More... | |
| enum | TMirrorOperationMode : int { momGlobal , momChannelBased } |
| Defines valid mirror operation modes. More... | |
| enum | TOnBoardMemoryMode : int { obmmDefault , obmmUser } |
| Defines valid modes for the handling of the device' on board memory (if available) (deprecated. More... | |
| enum | TPayloadType : int { ptUnknown = 0 , pt2DImage = 1 , ptJPEG = 5 , ptJPEG2000 = 6 , ptH264 = 7 , ptChunkOnly = 8 , ptMultiPart = 10 , ptGenDC = 11 } |
| Defines supported payload types. More... | |
| enum | TPolarizedDataExtractionInterpolationMode : int { primOff , primLinear } |
| Defines valid modes for the interpolation mode of polarization data extraction filters. More... | |
| enum | TPolarizedDataExtractionMode : int { prmVertical , prmHorizontal , prmExtractSingle , prmMinimumValue , prmMeanValue , prm2By2 , prmExtractAngle , prmExtractDegree , prmPseudoColorRepresentation } |
| Defines valid modes for polarization data extraction filters. More... | |
| enum | TPropertyLimits { plMaxValue = -1 , plMinValue = -2 , plStepWidth = -3 } |
| Defines valid limits which can be queried for a mv.impact.acquire.Property object. More... | |
| enum | TPROPHANDLING_ERROR : int { PROPHANDLING_NO_ERROR = 0 , PROPHANDLING_NOT_A_LIST = -2000 , PROPHANDLING_NOT_A_PROPERTY = -2001 , PROPHANDLING_NOT_A_METHOD = -2002 , PROPHANDLING_NO_READ_RIGHTS = -2003 , PROPHANDLING_NO_WRITE_RIGHTS = -2004 , PROPHANDLING_NO_MODIFY_SIZE_RIGHTS = -2005 , PROPHANDLING_INCOMPATIBLE_COMPONENTS = -2006 , PROPHANDLING_UNSUPPORTED_PARAMETER = -2008 , PROPHANDLING_SIZE_MISMATCH = -2009 , PROPHANDLING_IMPLEMENTATION_MISSING = -2010 , PROPHANDLING_ACCESSTOKEN_CREATION_FAILED = -2011 , PROPHANDLING_INVALID_PROP_VALUE = -2012 , PROPHANDLING_PROP_TRANSLATION_TABLE_CORRUPTED = -2013 , PROPHANDLING_PROP_VAL_ID_OUT_OF_BOUNDS = -2014 , PROPHANDLING_PROP_TRANSLATION_TABLE_NOT_DEFINED = -2015 , PROPHANDLING_INVALID_PROP_VALUE_TYPE = -2016 , PROPHANDLING_PROP_VAL_TOO_LARGE = -2017 , PROPHANDLING_PROP_VAL_TOO_SMALL = -2018 , PROPHANDLING_COMPONENT_NOT_FOUND = -2019 , PROPHANDLING_LIST_ID_INVALID = -2020 , PROPHANDLING_COMPONENT_ID_INVALID = -2021 , PROPHANDLING_LIST_ENTRY_OCCUPIED = -2022 , PROPHANDLING_COMPONENT_HAS_OWNER_ALREADY = -2023 , PROPHANDLING_COMPONENT_ALREADY_REGISTERED = -2024 , PROPHANDLING_LIST_CANT_ACCESS_DATA = -2025 , PROPHANDLING_METHOD_PTR_INVALID = -2026 , PROPHANDLING_METHOD_INVALID_PARAM_LIST = -2027 , PROPHANDLING_SWIG_ERROR = -2028 , PROPHANDLING_INVALID_INPUT_PARAMETER = -2029 , PROPHANDLING_COMPONENT_NO_CALLBACK_REGISTERED = -2030 , PROPHANDLING_INPUT_BUFFER_TOO_SMALL = -2031 , PROPHANDLING_WRONG_PARAM_COUNT = -2032 , PROPHANDLING_UNSUPPORTED_OPERATION = -2033 , PROPHANDLING_CANT_SERIALIZE_DATA = -2034 , PROPHANDLING_INVALID_FILE_CONTENT = -2035 , PROPHANDLING_CANT_ALLOCATE_LIST = -2036 , PROPHANDLING_CANT_REGISTER_COMPONENT = -2037 , PROPHANDLING_PROP_VALIDATION_FAILED = -2038 , PROPHANDLING_LAST_VALID_ERROR_CODE = -2099 } |
| Error codes of the module handling everything related to properties. More... | |
| enum | TPulseStartTrigger : int { pstDigitalSignal = 0 , pstPeriodically , pstRotaryDecoder } |
| Defines valid pulse start trigger values. More... | |
| enum | TRequestImageMemoryMode : int { rimmAuto , rimmUser } |
| Defines valid image modes for request objects. More... | |
| enum | TRequestResult : uint { rrOK = 0 , rrTimeout = 1 , rrError = 2 , rrRequestAborted = 3 , rrFrameIncomplete = 4 , rrDeviceAccessLost = 5 , rrInconsistentBufferContent = 6 , rrFrameCorrupt = 7 , rrUnprocessibleRequest = 0x80000000 , rrNoBufferAvailable = rrUnprocessibleRequest | 1 , rrNotEnoughMemory = rrUnprocessibleRequest | 2 , rrCameraNotSupported = rrUnprocessibleRequest | 5 , rrDataAcquisitionNotSupported = rrUnprocessibleRequest | 7 } |
| Defines valid result of an image request. More... | |
| enum | TRequestState : int { rsIdle , rsWaiting , rsCapturing , rsReady , rsBeingConfigured } |
| Defines the current state of this mv.impact.acquire.Request. More... | |
| enum | TRTCtrlModes : int { rtctrlModeStop , rtctrlModeRun , rtctrlModeRunRestart } |
| Defines valid RTCtrl Modes. More... | |
| enum | TRTProgOpCodes : int { rtctrlProgNop , rtctrlProgSetDigout , rtctrlProgWaitDigin , rtctrlProgWaitClocks , rtctrlProgJumpLoc , rtctrlProgTriggerSet , rtctrlProgTriggerReset , rtctrlProgExposeSet , rtctrlProgExposeReset , rtctrlProgFrameNrReset , rtctrlProgJumpLocOnZero , rtctrlProgJumpLocOnNotZero , rtctrlProgRegisterSet , rtctrlProgRegisterAdd , rtctrlProgRegisterSub } |
| Defines valid RTProg OpCodes. More... | |
| enum | TScalerInterpolationMode : int { simNearestNeighbor , simLinear , simCubic } |
| Defines valid scaler interpolation modes. More... | |
| enum | TScalerMode : int { smOff , smOn } |
| Defines valid scaler modes. More... | |
| enum | TScanClock : int { scAuto , scAnalogue , scDigital } |
| Analogue grabbers generate its scan clock on different ways (deprecated. More... | |
| enum | TScanStandard : int { ssITU601 , ssSquare , ssUser } |
| Defines valid scan modes for standard cameras (deprecated. More... | |
| enum | TScope : int { sGlobal = 0 , sUser = 1 } |
| Defines the scope for data import/export operations. More... | |
| enum | TStorageFlag : uint { sfDefault = 0x00000000 , sfNative = 0x00000001 , sfRaw = 0x00000002 , sfVolatile = 0x00000004 , sfProcessPropTranslationDict = 0x00000008 , sfCreateMissingEntries = 0x00000010 , sfProcessReadOnlyComponents = 0x00000020 , sfIgnorePropData = 0x00000040 , sfProcessDocString = 0x00000080 , sfProcessPropConstantsDict = 0x00000100 , sfProcessInheritance = 0x00000200 , sfIgnoreBasicData = 0x00000400 , sfIgnoreInvisible = 0x00000800 , sfFile = 0x00001000 , sfProcessDisplayName = 0x00002000 , sfRAM = 0x4000 , sfDontProcessDefault = 0x00020000 , sfProcessGenICamSequencerData = 0x00040000 , sfProcessGenICamUserSetData = 0x00080000 } |
| Defines the way component lists are imported and exported. More... | |
| enum | TStorageLocation : uint { slNative = 0x1 , slNative_Raw = 0x3 , slFile = 0x1000 , slRAM = 0x4000 } |
| Defines valid storage locations for component list import, export and delete operations. More... | |
| enum | TTriggerMoment : int { tmOnFallingEdge = 0 , tmOnRisingEdge } |
| Defines a trigger moment for a digital signal. More... | |
| enum | TUserDataAccessRight : uint { udarRead = 0x1 , udarWrite = 0x2 , udarRW = udarRead | udarWrite , udarPassword = 0x4 , udarFull = udarRW | udarPassword } |
| Defines valid flags for controlling the user access rights to the user data that can be stored in the devices non-volatile memory. More... | |
| enum | TUserDataReconnectBehaviour : int { udrbKeepCachedData , udrbUpdateFromDeviceData } |
| Defined valid values for the behaviour of the user data when a device has been disconnected and reconnected within a running process. More... | |
| enum | TValueType : uint { vtInt = 0x1 , vtFloat , vtPtr , vtString , vtInt64 } |
| Allowed values types for property objects. More... | |
| enum | TVideoCodec : int { vcMPEG2 = 2 , vcH264 = 27 , vcH265 = 173 } |
| Defines valid video codecs that might be supported by the underlying video compression engine. More... | |
| enum | TVideoStandard : int { vsCCIR , vsRS170 , vsPALBGH , vsNTSCM , vsSDI480i , vsSDI576i , vsSDI720p , vsSDI1080i , vsSDI1080p } |
| Defines valid video standards that might be supported by a video capture device. More... | |
| enum | TVirtualDeviceImageType : uint { vditNone = 0x00000000 , vditBMP = 0x000000001 , vditPGM = 0x000000002 , vditPNG = 0x000000004 , vditJPG = 0x000000008 , vditTIFF = 0x000000010 , vditALL = vditBMP | vditPGM | vditPNG | vditJPG | vditTIFF } |
| Defines valid image types used when capturing data from a certain directory. More... | |
| enum | TVirtualDeviceTestMode : int { vdtmMovingRGBx888PackedImage , vdtmMovingRGB888PackedImage , vdtmMovingRGBx888PlanarImage , vdtmMovingMonoRamp , vdtmMovingYUV422PackedRamp , vdtmMovingYUV422PlanarRamp , vdtmMovingRGB101010PackedImage , vdtmMovingRGB121212PackedImage , vdtmMovingRGB141414PackedImage , vdtmMovingRGB161616PackedImage , vdtmMovingBayerDataRamp , vdtmBayerWhiteBalanceTestImage , vdtmImageDirectory , vdtmLeakyPixelTestImageMono8Bayer , vdtmMovingYUV422_UYVYPackedRamp , vdtmHorizontalMonoRamp , vdtmVerticalMonoRamp , vdtmMovingVerticalMonoRamp , vdtmHorizontalMono12Packed_V2Ramp , vdtmMovingBGR888PackedImage , vdtmMovingYUV444PackedRamp , vdtmMovingYUV444_UYVPackedRamp , vdtmMovingBGRPacked_V2Image , vdtmEmptyMonoBuffer , vdtmHorizontalMono12Packed_V1Ramp , vdtmHorizontalBayer12Packed_V1Ramp , vdtmHorizontalBayer12Packed_V2Ramp , vdtmMovingYUV411_UYYVYY_PackedRamp , vdtmMovingRGB888PlanarImage , vdtmHotAndColdPixelTestImageBayer , vdtmHotAndColdPixelTestImageRGB888Packed } |
| Defines valid test modes for virtual devices. More... | |
| enum | TWhiteBalanceCalibrationMode : int { wbcmOff = 0 , wbcmNextFrame , wbcmContinuous } |
| Defines valid white balance calibration modes. More... | |
| enum | TWhiteBalanceParameter : int { wbpTungsten = 0 , wbpHalogen , wbpFluorescent , wbpDayLight , wbpPhotoFlash , wbpBlueSky , wbpUser1 , wbpUser2 , wbpUser3 , wbpUser4 } |
| Defines valid parameter sets selectable via the WhiteBalance property. More... | |
Functions | |
| delegate void | ComponentChangedEventHandler (Object sender, ComponentChangedEventArgs args) |
| A function prototype for component changed events as generated by instances of mv.impact.acquire.ComponentCallback. | |
| delegate void | DeviceWillBeClosedEventHandler (Object sender, DeviceWillBeClosedEventArgs args) |
| A function prototype for handling events triggered when a device is about to get closed. | |
This namespace contains classes and functions belonging to the image acquisition module of this SDK.
| enum TCallbackType : int |
Defines the type of callback to register.
| enum TComponentFlag : uint |
Flags defining access rights and other component properties.
Flags defining access rights and other component properties
| Enumerator | |
|---|---|
| cfUndefined | This is used to define an inconsistent/invalid flag. This e.g. can be used as a return value for a function, that could not calculate a valid flag mask. |
| cfReadAccess | This component can be accessed for reading. If this flag is set this component can be accessed for reading. This involves reading a property's data, reading a component list's elements reading the size of a component list and so on. |
| cfWriteAccess | This component can be accessed for writing. If this flag is set this component can be accessed for writing or modifying its data. This involves writing values to a property, adding components to a list and so on. |
| cfRWAccess | This component can be accessed for both reading and writing. This just combines mv.impact.acquire.TComponentFlag.cfReadAccess and mv.impact.acquire.TComponentFlag.cfWriteAccess |
| cfFixedSize | This components element count can be modified. If this flag is set this components element count can't be modified. For a list this would mean, that the number of elements stored in this list can't be modified. For a property this means, that the number of values stored in the property can't be modified. |
| cfInvisible | The component is shadowed by other settings currently if set. This flag is used to specify that this component currently has no effect on the behaviour of the system. This flag is just meant as a hint for the user. The property module itself does NOT use this flag for anything. |
| cfAllowValueCombinations | Allows combinations of translation dictionary entry as valid values. If this flag is set for a property that defines a translation dictionary not only values, which are registered in the translation dictionary are allowed values for this property, but also values logical OR-ed together with values from the translation dictionary (these obviously can't be set as strings). A property defines two entries ("one", 1) and ("two", 2) then 1 | 2 = 3 will be a valid value as well, but "three" obviously won't. In a GUI application a property specifying this flag should be displayed as a set of check-box controls (one for each dictionary entry) or something similar.
|
| cfShouldBeDisplayedAsList | Informs a displaying GUI that this component should be displayed as a list. This flag e.g. can be set for an array property to inform a displaying GUI, that this property is best displayed as a list with a entry for each element. This flag is just meant as a hint for the user. The property module itself does NOT use this flag for anything. |
| cfDisallowSerialize | If set this component or derived components can't be stored as external data. |
| cfAlwaysForceClone | If set this component is always cloned completely. This results in the component being completely independent from its parent no matter whether it has been built while deriving or cloning a list and thus the components within this list and its sub-lists. This will change the behaviour to that effect that changing the parent component will no longer affect the 'derived' component. So different default values, constants and translation dictionaries for properties within an inheritance hierarchy can be defined.
|
| cfNotAvailable | If set, this component is currently not available due to the setting of another feature. In this case this feature can't be written to nor can it be read. |
| cfNotImplemented | If set, this feature has been defined, but so far has not been implemented. |
| cfContainsBinaryData | Specifies a property, which contains binary data. This flag is used to specify a property that contains data in binary format |
| cfShouldBeDisplayedAsEnumeration | Informs a displaying GUI that this component should be displayed as an enumeration(e.g. with a combo box). This flag e.g. can be set for a property to inform a displaying GUI, that this property is best displayed as a combo box or something similar. This flag is just meant as a hint for the user. The property module itself does NOT use this flag for anything.
|
| cfAlwaysForceUpdate | This feature will ALWAYS execute internal update callbacks and will treat each write attempt to this feature as a value different from the current one.
|
| enum TComponentRepresentation : int |
Defines valid recommended representations for features.
These representations can be used to create a suitable GUI editor for a features.
| enum TComponentType : uint |
Allowed components handled by this module.
This module can handle the types listed in this enumeration only.
| enum TComponentVisibility : int |
Defines valid recommended visibilities for features.
These visibilities can be used to create GUIs in which the user can select the amount of features he wants to access.
| enum TFirmwareUpdateAction : int |
| enum TFirmwareUpdateStep : int |
| enum TPROPHANDLING_ERROR : int |
Error codes of the module handling everything related to properties.
| Enumerator | |
|---|---|
| PROPHANDLING_NO_ERROR | The operation has been executed successfully. |
| PROPHANDLING_NOT_A_LIST | This component is not a list. A list operation for this component has been called but this component does not reference a list. |
| PROPHANDLING_NOT_A_PROPERTY | This component is not a property. A property operation for this component has been called but this component does not reference a property. |
| PROPHANDLING_NOT_A_METHOD | This component is not a method. A method operation for this component has been called but this component does not reference a method. |
| PROPHANDLING_NO_READ_RIGHTS | The caller has no read rights for this component. It has been tried to read data from this component, but the caller has no read rights for this component. |
| PROPHANDLING_NO_WRITE_RIGHTS | The caller has no write rights for this component. It has been tried to modify data of this component, but the caller has no write rights for this component. |
| PROPHANDLING_NO_MODIFY_SIZE_RIGHTS | The caller can't modify the size of this component. It has been tried to modify the size of this list or the number of values stored by a property, but the caller doesn't have the required right to do this. This error will also be reported if the user tried to increase the number of values handled by a property above the maximum number of values it can handle. Therefore before resizing a property check if the new size might exceeds this maximum value by calling the appropriate function. |
| PROPHANDLING_INCOMPATIBLE_COMPONENTS | The two involved components are not compatible. An operation requiring two compatible components has been called with two components, which are not compatible. |
| PROPHANDLING_UNSUPPORTED_PARAMETER | One or more of the specified parameters are not supported by the function. This error might also be generated if a certain feature is not available on the current platform. |
| PROPHANDLING_SIZE_MISMATCH | Different sized value buffers have been passed. While trying to read value pairs the caller passed two different sized value buffers to a function while one is too small to hold all the information. |
| PROPHANDLING_IMPLEMENTATION_MISSING | A feature that is not implemented so far has been requested. The caller requested a feature, that hasn't been implemented so far. This error code is only provided for compatibility and will be set in very rare cases only. |
| PROPHANDLING_ACCESSTOKEN_CREATION_FAILED | An access token object couldn't be created. This can either happen, because the caller has not the rights required to create an access token or because the system runs very low on memory. |
| PROPHANDLING_INVALID_PROP_VALUE | It has been tried to assign an invalid value to a property. This can either happen if the value lies above or below the min. or max. value for a property or when it has been tried to write a value to a property, which is not in the properties translation dictionary (if it defines one). |
| PROPHANDLING_PROP_TRANSLATION_TABLE_CORRUPTED | The properties translation table has been corrupted. The properties translation table has been corrupted for an unknown reason and can't be used anymore. |
| PROPHANDLING_PROP_VAL_ID_OUT_OF_BOUNDS | Invalid value index. The caller tried to read a value from an invalid index from a property. Most properties store one value only, thus the only valid positive value index will be 0 (some negative index values are reserved for special values like e.g. the min/max value of a property). However some properties might store more than one value, thus the max. allowed index might be higher. The highest index allowed will always be the value count of a property minus one for properties with the mv.impact.acquire.TComponentFlag.cfFixedSize flag set. Other properties will automatically adjust the size once the user writes to an index out of bounds. |
| PROPHANDLING_PROP_TRANSLATION_TABLE_NOT_DEFINED | This property doesn't define a translation table. The caller tried to modify a translation table, that hasn't been defined for this property. |
| PROPHANDLING_INVALID_PROP_VALUE_TYPE | An invalid value has been passed to the property. Although properties are quite tolerant regarding the allowed assignment for them some value types can't be used to write all properties. As an example assigning a float value to an integer property would result in this error. |
| PROPHANDLING_PROP_VAL_TOO_LARGE | A too large value has been passed. One or more of the values the caller tried to write to the property are larger than the max. allowed value for this property. |
| PROPHANDLING_PROP_VAL_TOO_SMALL | A too small value has been passed. One or more of the values the caller tried to write to the property are smaller than the min. allowed value for this property. |
| PROPHANDLING_COMPONENT_NOT_FOUND | The specified component could not be found. |
| PROPHANDLING_LIST_ID_INVALID | An invalid list has been referenced. |
| PROPHANDLING_COMPONENT_ID_INVALID | An invalid component within a list has been referenced. |
| PROPHANDLING_LIST_ENTRY_OCCUPIED | The specified list index is occupied. During the creation of a new component the caller tried the insert the newly created component into a list at a position already used to store another component. |
| PROPHANDLING_COMPONENT_HAS_OWNER_ALREADY | The specified component already has an owner. The caller tried to assign an owner to a component that already has an owner. An owner once defined can't be modified anymore. |
| PROPHANDLING_COMPONENT_ALREADY_REGISTERED | It has been tried to register the same component at twice in the same list. |
| PROPHANDLING_LIST_CANT_ACCESS_DATA | The desired data can't be accessed or found. During loading or saving data this error can occur e.g. if it has been tried to import a setting from a location where the desired setting couldn't be found. Another reason for this error might be that the current user is not allowed to perform a certain operation on the desired data (e.g. a user tries to delete a setting that is stored with global scope but does not have elevated access rights). |
| PROPHANDLING_METHOD_PTR_INVALID | The function pointer of the referenced method object is invalid. |
| PROPHANDLING_METHOD_INVALID_PARAM_LIST | A method object has an invalid parameter list. |
| PROPHANDLING_SWIG_ERROR | This indicates an internal error occurred within the SWIG generated wrapper code, when working under Python. |
| PROPHANDLING_INVALID_INPUT_PARAMETER | A invalid input parameter has been passed to a function of this module. In most cases this might be a unassigned pointer, where a valid pointer to a user defined storage location was expected. |
| PROPHANDLING_COMPONENT_NO_CALLBACK_REGISTERED | The user tried to modify a registered callback, but no callback has been registered for this component. |
| PROPHANDLING_INPUT_BUFFER_TOO_SMALL | The user tried to read data into a user supplied storage location, but the buffer was too small to accommodate the result. |
| PROPHANDLING_WRONG_PARAM_COUNT | The number of parameters is incorrect. This error might occur if the user called a function with a variable number of input or output parameters and the number of parameters passed to the function does not match the number of required parameters. |
| PROPHANDLING_UNSUPPORTED_OPERATION | The user tried to execute an operation, which is not supported by the component he is referring to. |
| PROPHANDLING_CANT_SERIALIZE_DATA | The user tried to save(serialize) a property list without having the right to do this. |
| PROPHANDLING_INVALID_FILE_CONTENT | The user tried to use a file to update or create a component list, that does not contain valid data for this operation. This e.g. might happen, if the file does not contain valid XML data or XML data that is not well formed. |
| PROPHANDLING_CANT_ALLOCATE_LIST | This error will occur when the modules internal representation of the tree structure does not allow the allocation of a new list. In this case either new list can't be allocated. The only way to solve this problem is to delete another list. |
| PROPHANDLING_CANT_REGISTER_COMPONENT | The referenced list has no space left to register this component at the desired position. There might however be an empty space within the list where this element could be registered, but no more components can be registered at the end of this list. |
| PROPHANDLING_PROP_VALIDATION_FAILED | The user tried to assign a value to a property, that is invalid. This will result in a detailed error message in the log-file. This error might arise e.g. when a string property doesn't allow the string to contain numbers. In this case trying to set the properties value to 'blabla7bla' would cause this error. |
| PROPHANDLING_LAST_VALID_ERROR_CODE | Defines the last valid error code value for the property module. |
| enum TScope : int |
| enum TStorageFlag : uint |
Defines the way component lists are imported and exported.
Component lists can be imported and exported from/to XML files and (under Windows©) from/into the Registry. These flags define how this is done.
| Enumerator | |
|---|---|
| sfDefault | A dummy flag to specify the default behaviour. Store/load operations will done in XML format in this case. |
| sfNative | Stores/loads the setting in/from a platform dependent location. Under Windows© the Registry will be used to as a platform dependent location, while under other platforms an XML file will be processed in the path specified as the settings name.
|
| sfRaw | Stores/loads the setting in raw mode.
|
| sfVolatile | Stores lists volatile. under Windows© when the mv.impact.acquire.TStorageFlag.sfNative flag is set this will store the component list as a volatile key in the Registry. This means that the data will remain in the Registry until the system is shut down. |
| sfProcessPropTranslationDict | If set properties translation dictionaries will be processed for this import/export operation. This option forces the function to process the translation dictionaries, which might be assigned to properties. |
| sfCreateMissingEntries | If set ALL entries in the store data will be created. When loading a setting not only the current lists data will be updated, but also properties, lists or data, which is found in the storage location but not in the setting to update will be added to the setting as well. |
| sfProcessReadOnlyComponents | If set read-only components will be processed for this import/export operation. When importing, exporting or updating a component list components with the mv.impact.acquire.TComponentFlag.cfWriteAccess not set will be ignored. |
| sfIgnorePropData | If set data for properties will no be updated. If this flag is set the values stored by the property will be ignored for this import/export operation.
|
| sfProcessDocString | If set the documentation string will be processed. If this flag is set the documentation string will be processed for this import/export operation.
|
| sfProcessPropConstantsDict | If set the defined constants for properties will be processed. If this flag is set the defined constants for properties will be processed for this import/export operation. |
| sfProcessInheritance | If set the lists inheritance relationship will be processed. If this flag is set the inheritance relationship between lists will be processed for the current import/export operation.
|
| sfIgnoreBasicData | Specifies if basic data shall be processed. For e.g. settings it's not necessary to import/export information about the value type for properties or the size of lists etc. as this information is available internally anyway. So interface functions dealing with settings should specify this flag in any case. |
| sfIgnoreInvisible | Specifies if invisible components shall be processed. When invisible data doesn't need to be processed this flag can be specified. Invisible components do not influence the current systems behaviour.
|
| sfFile | Stores/loads the setting in/from an XML file. If this flag is specified the data will be imported/exported from/to an XML file. |
| sfProcessDisplayName | If set the display name will be processed. If this flag is set the display name will be processed for this import/export operation.
|
| sfRAM | Stores/loads the setting in/from RAM file. If this flag is specified the data will be imported/exported from/to RAM. Data stored this way should be freed when no longer needed to avoid a waste of memory. However when shutting down Impact Acquire completely (e.g. when unloading the mvPropHandling library from memory all memory allocated by settings stored this way will be freed automatically).
|
| sfDontProcessDefault | Specifies if the 'is-default' flag for components shall be ignored during import/export operations. If this flag is set the 'is-default' flag will not be processed during this import/export operation.
|
| sfProcessGenICamSequencerData | Processes GenICam sequencer set related data during a storage operation.
|
| sfProcessGenICamUserSetData | Processes GenICam user set related data during a storage operation.
|
| enum TStorageLocation : uint |
Defines valid storage locations for component list import, export and delete operations.
Component lists can be imported and exported from/to XML files, process RAM and (under Windows©) from/into the Registry.
|
package |