FileAccessControl Class Reference

Category that contains the File Access control features. More...

Public Member Functions
	FileAccessControl (mv.impact.acquire.Device device)
	Constructs a new mv.impact.acquire.GenICam.FileAccessControl object.
	FileAccessControl (mv.impact.acquire.Device device, System.String settingName)
	Constructs a new mv.impact.acquire.GenICam.FileAccessControl object.

Public Attributes
readonly mv.impact.acquire.PropertyS	fileAccessBuffer = new mv.impact.acquire.PropertyS()
	A string property. Defines the intermediate access buffer that allows the exchange of data between the device file storage and the application.
readonly mv.impact.acquire.PropertyI64	fileAccessLength = new mv.impact.acquire.PropertyI64()
	An integer property. Controls the Length of the mapping between the device file storage and the FileAccessBuffer.
readonly mv.impact.acquire.PropertyI64	fileAccessOffset = new mv.impact.acquire.PropertyI64()
	An integer property. Controls the Offset of the mapping between the device file storage and the FileAccessBuffer.
readonly mv.impact.acquire.PropertyI64	fileOpenMode = new mv.impact.acquire.PropertyI64()
	An enumerated integer property. Selects the access mode in which a file is opened in the device.
readonly mv.impact.acquire.Method	fileOperationExecute = new mv.impact.acquire.Method()
	A method object. Executes the operation selected by FileOperationSelector on the selected file.
readonly mv.impact.acquire.PropertyI64	fileOperationResult = new mv.impact.acquire.PropertyI64()
	An integer property. Represents the file operation result.
readonly mv.impact.acquire.PropertyI64	fileOperationSelector = new mv.impact.acquire.PropertyI64()
	An enumerated integer property. Selects the target operation for the selected file in the device.
readonly mv.impact.acquire.PropertyI64	fileOperationStatus = new mv.impact.acquire.PropertyI64()
	An enumerated integer property. Represents the file operation execution status.
readonly mv.impact.acquire.PropertyI64	fileSelector = new mv.impact.acquire.PropertyI64()
	An enumerated integer property. Selects the target file in the device.
readonly mv.impact.acquire.PropertyI64	fileSize = new mv.impact.acquire.PropertyI64()
	An integer property. Represents the size of the selected file in bytes.

Detailed Description

Category that contains the File Access control features.

A category that contains the File Access control features.

Constructor & Destructor Documentation

FileAccessControl() [1/2]

FileAccessControl ( mv::impact::acquire::Device device )

inline

Constructs a new mv.impact.acquire.GenICam.FileAccessControl object.

Parameters

[in]

device

A pointer to a mv.impact.acquire.Device object obtained from a mv.impact.acquire.DeviceManager object.

FileAccessControl() [2/2]

FileAccessControl ( mv::impact::acquire::Device device, System::String settingName )

inline

Constructs a new mv.impact.acquire.GenICam.FileAccessControl object.

Parameters

[in]	device	A pointer to a mv.impact.acquire.Device object obtained from a mv.impact.acquire.DeviceManager object.
[in]	settingName	The name of the driver internal setting to access with this instance. A list of valid setting names can be obtained by a call to mv.impact.acquire.FunctionInterface.availableSettings, new settings can be created with the function mv.impact.acquire.FunctionInterface.createSetting

Member Data Documentation

fileAccessBuffer

readonly mv.impact.acquire.PropertyS fileAccessBuffer = new mv.impact.acquire.PropertyS()

A string property. Defines the intermediate access buffer that allows the exchange of data between the device file storage and the application.

Defines the intermediate access buffer that allows the exchange of data between the device file storage and the application.

fileAccessLength

readonly mv.impact.acquire.PropertyI64 fileAccessLength = new mv.impact.acquire.PropertyI64()

An integer property. Controls the Length of the mapping between the device file storage and the FileAccessBuffer.

Controls the Length of the mapping between the device file storage and the FileAccessBuffer.

fileAccessOffset

readonly mv.impact.acquire.PropertyI64 fileAccessOffset = new mv.impact.acquire.PropertyI64()

An integer property. Controls the Offset of the mapping between the device file storage and the FileAccessBuffer.

Controls the Offset of the mapping between the device file storage and the FileAccessBuffer.

fileOpenMode

readonly mv.impact.acquire.PropertyI64 fileOpenMode = new mv.impact.acquire.PropertyI64()

An enumerated integer property. Selects the access mode in which a file is opened in the device.

Selects the access mode in which a file is opened in the device.

The following string values might be valid for this feature:

• Read (Display string: 'Read'): This mode selects read-only open mode.
• Write (Display string: 'Write'): This mode selects write-only open mode.
• ReadWrite (Display string: 'Read Write'): This mode selects read and write open mode.

Note

Depending on the device some of these values might not be supported and especially when working with third party devices there might be custom values which are not listed here. To get a complete and reliable list of supported values at runtime an application should therefore call mv.impact.acquire.EnumPropertyI<T>.listOfValidStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

fileOperationExecute

readonly mv.impact.acquire.Method fileOperationExecute = new mv.impact.acquire.Method()

A method object. Executes the operation selected by FileOperationSelector on the selected file.

Executes the operation selected by FileOperationSelector on the selected file.

fileOperationResult

readonly mv.impact.acquire.PropertyI64 fileOperationResult = new mv.impact.acquire.PropertyI64()

An integer property. Represents the file operation result.

Represents the file operation result. For Read or Write operations, the number of successfully read/written bytes is returned.

fileOperationSelector

readonly mv.impact.acquire.PropertyI64 fileOperationSelector = new mv.impact.acquire.PropertyI64()

An enumerated integer property. Selects the target operation for the selected file in the device.

Selects the target operation for the selected file in the device. This Operation is executed when the FileOperationExecute feature is called.

The following string values might be valid for this feature:

• Open (Display string: 'Open'): Opens the file selected by FileSelector in the device. The access mode in which the file is opened is selected by FileOpenMode.
• Close (Display string: 'Close'): Closes the file selected by FileSelector in the device.
• Read (Display string: 'Read'): Reads FileAccessLength bytes from the device storage at the file relative offset FileAccessOffset into FileAccessBuffer.
• Write (Display string: 'Write'): Writes FileAccessLength bytes taken from the FileAccessBuffer into the device storage at the file relative offset FileAccessOffset.
• Delete (Display string: 'Delete'): Deletes the file selected by FileSelector in the device. Note that deleting a device file should not remove the associated FileSelector entry to allow future operation on this file.
• MvFlashWrite (Display string: 'Mv Flash Write')

Note

Depending on the device some of these values might not be supported and especially when working with third party devices there might be custom values which are not listed here. To get a complete and reliable list of supported values at runtime an application should therefore call mv.impact.acquire.EnumPropertyI<T>.listOfValidStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

fileOperationStatus

readonly mv.impact.acquire.PropertyI64 fileOperationStatus = new mv.impact.acquire.PropertyI64()

An enumerated integer property. Represents the file operation execution status.

Represents the file operation execution status.

The following string values might be valid for this feature:

• Success (Display string: 'Success'): File Operation was successful.
• Failure (Display string: 'Failure'): File Operation failed.

Note

Depending on the device some of these values might not be supported and especially when working with third party devices there might be custom values which are not listed here. To get a complete and reliable list of supported values at runtime an application should therefore call mv.impact.acquire.EnumPropertyI<T>.listOfValidStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

fileSelector

readonly mv.impact.acquire.PropertyI64 fileSelector = new mv.impact.acquire.PropertyI64()

An enumerated integer property. Selects the target file in the device.

Selects the target file in the device.

The following string values might be valid for this feature:

• DeviceFirmware (Display string: 'Device Firmware')
• LUTBlue (Display string: 'LUT Blue'): The Blue LUT of the camera.
• LUTGreen (Display string: 'LUT Green'): The Green LUT of the camera.
• LUTLuminance (Display string: 'LUT Luminance'): The Luminance LUT of the camera.
• LUTRed (Display string: 'LUT Red'): The Red LUT of the camera.
• UserFile (Display string: 'User File')
• UserSet1 (Display string: 'User Set 1'): The first user set of the device.
• UserSet2 (Display string: 'User Set 2'): The second user set of the device.
• UserSet3 (Display string: 'User Set 3'): The third user set of the device.
• UserSetDefault (Display string: 'User Set Default'): The default user set of the device.
• mvFFCImage (Display string: 'mv FFC Image')

Note

Depending on the device some of these values might not be supported and especially when working with third party devices there might be custom values which are not listed here. To get a complete and reliable list of supported values at runtime an application should therefore call mv.impact.acquire.EnumPropertyI<T>.listOfValidStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

fileSize

readonly mv.impact.acquire.PropertyI64 fileSize = new mv.impact.acquire.PropertyI64()

An integer property. Represents the size of the selected file in bytes.

Represents the size of the selected file in bytes.