Defines the way component lists are imported and exported. More...

Static Public Attributes
static final int	sfCreateMissingEntries = acquireJNI.sfCreateMissingEntries_get()
	If set ALL entries in the store data will be created.

static final int	sfDefault = acquireJNI.sfDefault_get()
	A dummy flag to specify the default behaviour.

static final int	sfDontProcessDefault = acquireJNI.sfDontProcessDefault_get()
	Specifies if the 'is-default' flag for components shall be ignored during import/export operations.

static final int	sfFile = acquireJNI.sfFile_get()
	Stores/loads the setting in/from an XML file.

static final int	sfIgnoreBasicData = acquireJNI.sfIgnoreBasicData_get()
	Specifies if basic data shall be processed.

static final int	sfIgnoreInvisible = acquireJNI.sfIgnoreInvisible_get()
	Specifies if invisible components shall be processed.

static final int	sfIgnorePropData = acquireJNI.sfIgnorePropData_get()
	If set data for properties will no be updated.

static final int	sfNative = acquireJNI.sfNative_get()
	Stores/loads the setting in/from a platform dependent location.

static final int	sfProcessDisplayName = acquireJNI.sfProcessDisplayName_get()
	If set the display name will be processed.

static final int	sfProcessDocString = acquireJNI.sfProcessDocString_get()
	If set the documentation string will be processed.

static final int	sfProcessGenICamSequencerData = acquireJNI.sfProcessGenICamSequencerData_get()
	Processes GenICam sequencer set related data during a storage operation.

static final int	sfProcessGenICamUserSetData = acquireJNI.sfProcessGenICamUserSetData_get()
	Processes GenICam user set related data during a storage operation.

static final int	sfProcessInheritance = acquireJNI.sfProcessInheritance_get()
	If set the lists inheritance relationship will be processed.

static final int	sfProcessPropConstantsDict = acquireJNI.sfProcessPropConstantsDict_get()
	If set the defined constants for properties will be processed.

static final int	sfProcessPropTranslationDict = acquireJNI.sfProcessPropTranslationDict_get()
	If set properties translation dictionaries will be processed for this import/export operation.

static final int	sfProcessReadOnlyComponents = acquireJNI.sfProcessReadOnlyComponents_get()
	If set read-only components will be processed for this import/export operation.

static final int	sfRAM = acquireJNI.sfRAM_get()
	Stores/loads the setting in/from RAM file.

static final int	sfRaw = acquireJNI.sfRaw_get()
	Stores/loads the setting in raw mode.

static final int	sfVolatile = acquireJNI.sfVolatile_get()
	Stores lists volatile.

Detailed Description

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.

Member Data Documentation

◆ sfCreateMissingEntries

final int sfCreateMissingEntries = acquireJNI.sfCreateMissingEntries_get()

static

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.

◆ sfDefault

final int sfDefault = acquireJNI.sfDefault_get()

static

A dummy flag to specify the default behaviour.

Store/load operations will done in XML format in this case.

◆ sfDontProcessDefault

final int sfDontProcessDefault = acquireJNI.sfDontProcessDefault_get()

static

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.

Note: This flag is ignored, if mvIMPACT.acquire.TStorageFlag.sfNative is specified.

◆ sfFile

final int sfFile = acquireJNI.sfFile_get()

static

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.

◆ sfIgnoreBasicData

final int sfIgnoreBasicData = acquireJNI.sfIgnoreBasicData_get()

static

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

final int sfIgnoreInvisible = acquireJNI.sfIgnoreInvisible_get()

static

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.

Note: This feature is currently only supported for output operations and is ignored for input operations.

◆ sfIgnorePropData

final int sfIgnorePropData = acquireJNI.sfIgnorePropData_get()

static

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.

Note: This flag is ignored, if mvIMPACT.acquire.TStorageFlag.sfNative is specified.

◆ sfNative

final int sfNative = acquireJNI.sfNative_get()

static

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.

Note: Please note, that using this flag will introduce platform dependency. E.g. specifying this flag under Linux will process XML data, while under Windows© the Registry will be used. This is why A call to a load function with this flag with the corresponding XML file in the applications directory might succeed under Linux while it fails under Windows©.

◆ sfProcessDisplayName

final int sfProcessDisplayName = acquireJNI.sfProcessDisplayName_get()

static

If set the display name will be processed.

If this flag is set the display name will be processed for this import/export operation.

Note: This flag is ignored, if mvIMPACT.acquire.TStorageFlag.sfNative is specified.

◆ sfProcessDocString

final int sfProcessDocString = acquireJNI.sfProcessDocString_get()

static

If set the documentation string will be processed.

If this flag is set the documentation string will be processed for this import/export operation.

Note: This flag is ignored, if mvIMPACT.acquire.TStorageFlag.sfNative is specified.

◆ sfProcessGenICamSequencerData

final int sfProcessGenICamSequencerData = acquireJNI.sfProcessGenICamSequencerData_get()

static

Processes GenICam sequencer set related data during a storage operation.

Note: This flag will affect devices operated in GenICam interface layout only!

Attention: Settings stored this way cannot be loaded on systems running Impact Acquire versions smaller than 2.28.0.

Since: 2.28.0

◆ sfProcessGenICamUserSetData

final int sfProcessGenICamUserSetData = acquireJNI.sfProcessGenICamUserSetData_get()

static

Processes GenICam user set related data during a storage operation.

Note: This flag will affect devices operated in GenICam interface layout only!

Attention: Settings stored this way cannot be loaded on systems running Impact Acquire versions smaller than 2.28.0.

Since: 2.28.0

◆ sfProcessInheritance

final int sfProcessInheritance = acquireJNI.sfProcessInheritance_get()

static

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.

Note

Limitations:

derived lists must appear in a list after the parent list. So if a list is derived from another list, it has to be registered with a higher index either in the same list as the parent or in a list with a higher index then the list holding the parent in a top level list.

Example for a legal structure:
A

|-B

| |-parent

| |-child

|-C

| |-child

|-child

Example for illegal structures:
A

|-child

|-parent

or
A

|-B

| |-child

|-parent
this feature is not available when mvIMPACT.acquire.TStorageFlag.sfNative is specified.

◆ sfProcessPropConstantsDict

final int sfProcessPropConstantsDict = acquireJNI.sfProcessPropConstantsDict_get()

static

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.

◆ sfProcessPropTranslationDict

final int sfProcessPropTranslationDict = acquireJNI.sfProcessPropTranslationDict_get()

static

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.

◆ sfProcessReadOnlyComponents

final int sfProcessReadOnlyComponents = acquireJNI.sfProcessReadOnlyComponents_get()

static

If set read-only components will be processed for this import/export operation.

When importing, exporting or updating a component list components with the mvIMPACT.acquire.TComponentFlag.cfWriteAccess not set will be ignored.

◆ sfRAM

final int sfRAM = acquireJNI.sfRAM_get()

static

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).

Note: This flag must not be combined with mvIMPACT.acquire.TStorageFlag.sfNative or mvIMPACT.acquire.TStorageFlag.sfFile.

Since: 2.19.0

◆ sfRaw

final int sfRaw = acquireJNI.sfRaw_get()

static

Stores/loads the setting in raw mode.

Note: Under Windows© this mode only works in connection with the mvIMPACT.acquire.TStorageFlag.sfNative flag. In that case an arbitrary hive from the registry can be used to create a tree of lists and properties. This only makes sense for very special applications and therefore is not needed to write applications, that load and store current settings.

◆ sfVolatile

final int sfVolatile = acquireJNI.sfVolatile_get()

static

Stores lists volatile.

under Windows© when the mvIMPACT.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.

Static Public Attributes

Detailed Description

Member Data Documentation

◆ sfCreateMissingEntries

◆ sfDefault

◆ sfDontProcessDefault

◆ sfFile

◆ sfIgnoreBasicData

◆ sfIgnoreInvisible

◆ sfIgnorePropData

◆ sfNative

◆ sfProcessDisplayName

◆ sfProcessDocString

◆ sfProcessGenICamSequencerData

◆ sfProcessGenICamUserSetData

◆ sfProcessInheritance

◆ sfProcessPropConstantsDict

◆ sfProcessPropTranslationDict

◆ sfProcessReadOnlyComponents

◆ sfRAM

◆ sfRaw

◆ sfVolatile