- Generated on Thu Nov 14 2024 18:44:33
|
Impact Acquire SDK Java
|
A base class for accessing settings that control the overall behaviour of a device driver. More...
Public Member Functions | |
| synchronized void | delete () |
| PropertyI | getAcquisitionIdleTimeMax_ms () |
| An integer property defining the maximum time in ms the driver waits for new requests being queued until streaming by the device will automatically be stopped. | |
| PropertyI | getAcquisitionMode () |
| An enumerated integer property defining the acquisition mode of the device. | |
| PropertyI | getFeaturePollingEnable () |
| An enumerated integer property defining whether features defining a polling time shall be updated automatically or not. | |
| PropertyI | getFeaturePollingInterval_ms () |
| An integer property defining the polling interval in ms the driver waits for each iteration before running through update loop again. | |
| PropertyI | getGenDCParserEnable () |
| An enumerated integer property which can be used to enable/disable automatic GenICam™ GenDC Container parsing. | |
| PropertyI | getImageProcessingMaximumThreadCount () |
| An integer property influencing the number of parallel threads used by the internal image processing pipeline. | |
| PropertyI | getImageProcessingMode () |
| An enumerated integer property influencing the behaviour of the internal image processing pipeline. | |
| PropertyI | getImageProcessingOptimization () |
| An enumerated integer property influencing the behaviour of the internal image processing algorithms. | |
| PropertyI | getMethodPollingInterval_ms () |
| An integer property defining the polling interval in ms the driver waits during each iteration before checking a methods execution state again. | |
| PropertyI | getMethodPollingMaxRetryCount () |
| An integer property defining the polling interval in ms the driver waits during each iteration before checking a methods execution state again. | |
| PropertyI | getRequestCount () |
| An integer property defining the number of requests allocated by the driver. | |
| int | hObj () |
| Returns a unique identifier for the component collection referenced by this object. | |
| ComponentCollection | restoreDefault () |
| Restores the default for every component of this collection. | |
| SystemSettings (Device pDev) | |
| Constructs a new mvIMPACT.acquire.SystemSettings object. | |
Protected Member Functions | |
| void | finalize () |
| SystemSettings (long cPtr, boolean cMemoryOwn) | |
Static Protected Member Functions | |
| static long | swigRelease (ComponentCollection obj) |
| static long | swigRelease (SystemSettings obj) |
Protected Attributes | |
| transient boolean | swigCMemOwn |
A base class for accessing settings that control the overall behaviour of a device driver.
Instances of this class can't be constructed directly. Use one of the derived types.
|
protected |
| SystemSettings | ( | Device | pDev | ) |
Constructs a new mvIMPACT.acquire.SystemSettings object.
| pDev | [in] A pointer to a mvIMPACT.acquire.Device object obtained from a mvIMPACT.acquire.DeviceManager object. |
| synchronized void delete | ( | ) |
Reimplemented from ComponentCollection.
Reimplemented in SystemBlueFOX, and SystemV4L2.
|
protected |
Reimplemented from ComponentCollection.
Reimplemented in SystemBlueFOX, and SystemV4L2.
| PropertyI getAcquisitionIdleTimeMax_ms | ( | ) |
An integer property defining the maximum time in ms the driver waits for new requests being queued until streaming by the device will automatically be stopped.
This property defines the maximum time in milliseconds the driver waits for new mvIMPACT.acquire.Request objects being queued by calling mvIMPACT.acquire.FunctionInterface.imageRequestSingle once the driver will automatically send an acquisition stop command to a streaming device (such as a GigE Vision or USB3 Vision device) when the driver's request queue has run empty (thus the driver has no more buffers to capture data into).
This property will only be taken into account when mvIMPACT.acquire.Device.getAcquisitionStartStopBehaviour() has been set to mvIMPACT.acquire.TAcquisitionStartStopBehaviour.assbDefault.
| PropertyI getAcquisitionMode | ( | ) |
An enumerated integer property defining the acquisition mode of the device.
Valid values for this property are defined by the enumeration mvIMPACT.acquire.TAcquisitionMode.
| PropertyI getFeaturePollingEnable | ( | ) |
An enumerated integer property defining whether features defining a polling time shall be updated automatically or not.
Valid values for this property are defined by the enumeration mvIMPACT.acquire.TBoolean.
| PropertyI getFeaturePollingInterval_ms | ( | ) |
An integer property defining the polling interval in ms the driver waits for each iteration before running through update loop again.
Some features define a so called polling time. This is a recommendation by the device/driver stating that this property might change its value without user interaction act a certain rate (e.g. the device temperature could be one example for a feature with such a behaviour). When mvIMPACT.acquire.SystemSettings.getFeaturePollingEnable() is set to mvIMPACT.acquire.TBoolean.bTrue a thread will check every featurePollingInterval_ms if features need to be updated. This will only cause communication with a device for each feature whose polling time has elapsed.
| PropertyI getGenDCParserEnable | ( | ) |
An enumerated integer property which can be used to enable/disable automatic GenICam™ GenDC Container parsing.
When working with a GenICam™ compliant device, that transmits data using the GenDC format this property can be used to switch on/off the automatic parsing of the received containers. The default value of this property will be mvIMPACT.acquire.TBoolean.bTrue, so a GenDC container will be parsed upon reception and will be reported as the individual components like described here. This results in slightly more CPU time being consumed which sometimes might not be desirable since the GenDC Containers shall be processed later by another entity of the application or shall just be written to some storage location for off-line processing at a later moment in time. When this property is set to mvIMPACT.acquire.TBoolean.bFalse the data buffer will reported as a raw GenDC Container. mvIMPACT.acquire.Request.getPayloadType() will return mvIMPACT.acquire.TPayloadType.ptGenDC then and mvIMPACT.acquire.Request.getImagePixelFormat() will be mvIMPACT.acquire.TImageBufferPixelFormat.ibpfRaw then. mvIMPACT.acquire.Request.getImageData() and mvIMPACT.acquire.Request.getImageSize() however can directly be fed into any GenDC capable algorithm.
Valid values for this property are defined by the enumeration mvIMPACT.acquire.TBoolean.
| PropertyI getImageProcessingMaximumThreadCount | ( | ) |
An integer property influencing the number of parallel threads used by the internal image processing pipeline.
This property can be used to control the size of the internal thread pool used for image processing tasks. Using a value higher than the number of physical CPU cores usually has a negative impact on the performance. Use with care!
| PropertyI getImageProcessingMode | ( | ) |
An enumerated integer property influencing the behaviour of the internal image processing pipeline.
Valid values for this property are defined by the enumeration mvIMPACT.acquire.TImageProcessingMode.
| PropertyI getImageProcessingOptimization | ( | ) |
An enumerated integer property influencing the behaviour of the internal image processing algorithms.
Valid values for this property are defined by the enumeration mvIMPACT.acquire.TImageProcessingOptimization.
| PropertyI getMethodPollingInterval_ms | ( | ) |
An integer property defining the polling interval in ms the driver waits during each iteration before checking a methods execution state again.
When working with a GenICam™ compliant device, GenICam™ method objects need to be checked for their completion status every now and then. This parameter defines how often this shall be done.
| PropertyI getMethodPollingMaxRetryCount | ( | ) |
An integer property defining the polling interval in ms the driver waits during each iteration before checking a methods execution state again.
When working with a GenICam™ compliant device, GenICam™ method objects need to be checked for their completion status every now and then. This parameter defines how often this shall be done at all. A method is checked for completion methodPollingMaxRetryCount * methodPollingInterval_ms at max. Until then either the device starts to inform the driver that it needs more time OR the execution of the method has completed successfully or an error will be generated.
| PropertyI getRequestCount | ( | ) |
An integer property defining the number of requests allocated by the driver.
Each request object can be used to capture data into. Multiple requests can be processed by a device driver as background tasks.
Setting this property to a value at least allowing a driver to capture data for up to 500ms without user interaction (thus 0.5 times the expected frame rate) is highly recommended. Increasing this value will NOT introduce additional latency to your application. The only drawback will be additional RAM consumption by the driver but applications that do not need to copy the request buffers can even benefit from that as the overall memory fragmentation is likely to go down then. Values smaller than 3 most likely result in undesired behaviour and should be avoided unless absolutely needed.
There are not too many reasons to modify the default request count suggested by the device driver. Good reasons include:
|
inherited |
Returns a unique identifier for the component collection referenced by this object.
This handle will always reference an object of type mvIMPACT.acquire.ComponentList.
|
inherited |
Restores the default for every component of this collection.
Calling this function will restore the default value for every component belonging to this collection.
|
staticprotectedinherited |
|
staticprotected |
|
protectedinherited |