InterfaceModule Class Reference

Category that contains items that belong to the interface module of the transport layer. More...

Inheritance diagram for InterfaceModule:

Public Member Functions
synchronized void	delete ()
Method	getActionCommand ()
	A method object.
PropertyI64	getActionDeviceKey ()
	An integer property.
PropertyI64	getActionGroupKey ()
	An integer property.
PropertyI64	getActionGroupMask ()
	An integer property.
PropertyI64	getActionScheduledTime ()
	An integer property.
PropertyI	getActionScheduledTimeEnable ()
	A boolean property.
PropertyI64	getDeviceAccessStatus ()
	An enumerated integer property.
PropertyS	getDeviceID ()
	A string property.
PropertyI64	getDeviceLinkSpeed ()
	An integer property.
PropertyS	getDeviceModelName ()
	A string property.
PropertyI64	getDeviceSelector ()
	An integer property.
PropertyS	getDeviceSerialNumber ()
	A string property.
PropertyI64	getDeviceTLVersionMajor ()
	An integer property.
PropertyI64	getDeviceTLVersionMinor ()
	An integer property.
PropertyI64	getDeviceType ()
	An enumerated integer property.
Method	getDeviceUpdateList ()
	A method object.
PropertyI64	getDeviceUpdateTimeout ()
	An integer property.
PropertyS	getDeviceUserID ()
	A string property.
PropertyS	getDeviceVendorName ()
	A string property.
PropertyI64	getEventNotification ()
	An enumerated integer property.
PropertyI64	getEventSelector ()
	An enumerated integer property.
PropertyI64	getGenCPVersionMajor ()
	An integer property.
PropertyI64	getGenCPVersionMinor ()
	An integer property.
PropertyI64	getGevActionDestinationIPAddress ()
	An integer property.
PropertyI64	getGevApplicationSwitchoverKey ()
	An integer property.
PropertyI64	getGevCurrentControlMode ()
	An enumerated integer property.
PropertyI64	getGevDeviceForceGateway ()
	An integer property.
Method	getGevDeviceForceIP ()
	A method object.
PropertyI64	getGevDeviceForceIPAddress ()
	An integer property.
PropertyI64	getGevDeviceForceSubnetMask ()
	An integer property.
PropertyI64	getGevDeviceGateway ()
	An integer property.
PropertyI64	getGevDeviceIPAddress ()
	An integer property.
PropertyI64	getGevDeviceIPConfigurationStatus ()
	An enumerated integer property.
PropertyI64	getGevDeviceMACAddress ()
	An integer property.
PropertyI64	getGevDeviceSubnetMask ()
	An integer property.
PropertyI64	getGevInterfaceGateway ()
	An integer property.
PropertyI64	getGevInterfaceGatewaySelector ()
	An integer property.
PropertyI64	getGevInterfaceMACAddress ()
	An integer property.
PropertyI64	getGevInterfaceSubnetIPAddress ()
	An integer property.
PropertyI64	getGevInterfaceSubnetMask ()
	An integer property.
PropertyI64	getGevInterfaceSubnetSelector ()
	An integer property.
PropertyI64	getGevVersionMajor ()
	An integer property.
PropertyI64	getGevVersionMinor ()
	An integer property.
PropertyS	getInterfaceDisplayName ()
	A string property.
PropertyS	getInterfaceID ()
	A string property.
PropertyI64	getInterfaceTLVersionMajor ()
	An integer property.
PropertyI64	getInterfaceTLVersionMinor ()
	An integer property.
PropertyI64	getInterfaceType ()
	An enumerated integer property.
PropertyI	getMvActionAcknowledgeEnable ()
	A boolean property.
PropertyI64	getMvActionAcknowledgesExpected ()
	An integer property.
PropertyI64	getMvActionAcknowledgesFailed ()
	An integer property.
PropertyI64	getMvActionAcknowledgesReceived ()
	An integer property.
PropertyI64	getMvActionAcknowledgeTimeout ()
	An integer property.
PropertyI64	getMvActionDestinationPort ()
	An integer property.
PropertyI64	getMvDeviceCommandChannelRetryCount ()
	An integer property.
PropertyI64	getMvDeviceCommandChannelTransmissionTimeout ()
	An integer property.
PropertyS	getMvDeviceLicenseDetails ()
	A string property.
PropertyI	getMvDeviceLicenseValid ()
	A boolean property.
PropertyI64	getMvDeviceNetworkInterfaceCount ()
	An integer property.
PropertyI	getMvDevicePrimaryApplicationSwitchoverEnable ()
	A boolean property.
PropertyI	getMvDevicePrimaryApplicationSwitchoverSupported ()
	A boolean property.
Method	getMvDeviceUpdateFirmware ()
	A method object.
PropertyI	getMvGevAdvancedDeviceDiscoveryEnable ()
	A boolean property.
PropertyI64	getMvGevDeviceCCSP ()
	An integer property.
PropertyI64	getMvGevInterfaceLinkSpeed ()
	An integer property.
PropertyI64	getMvGevInterfaceMTU ()
	An integer property.
PropertyS	getMvInterfaceLicenseFile ()
	A string property.
PropertyS	getMvU3VDeviceGUID ()
	A string property.
PropertyI64	getMvUnicastDeviceDiscoveryCommandCount ()
	An integer property.
PropertyI64	getMvUnicastDeviceDiscoveryCommandSelector ()
	An integer property.
PropertyI64	getMvUnicastDeviceDiscoveryDestinationIPAddress ()
	An integer property.
PropertyI64	getMvUnicastDeviceDiscoveryDestinationPort ()
	An integer property.
PropertyI64	getU3vVersionMajor ()
	An integer property.
PropertyI64	getU3vVersionMinor ()
	An integer property.
int	hObj ()
	Returns a unique identifier for the component collection referenced by this object.
	InterfaceModule (SystemModule parent, long index)
	Constructs a new mvIMPACT.acquire.InterfaceModule object.
ComponentCollection	restoreDefault ()
	Restores the default for every component of this collection.

Protected Member Functions
void	finalize ()
	InterfaceModule (long cPtr, boolean cMemoryOwn)

Static Protected Member Functions
static long	swigRelease (ComponentCollection obj)
static long	swigRelease (InterfaceModule obj)

Protected Attributes
transient boolean	swigCMemOwn

Detailed Description

Category that contains items that belong to the interface module of the transport layer.

The Interface category contains items that belong to the interface module of the transport layer.

Constructor & Destructor Documentation

InterfaceModule() [1/2]

InterfaceModule ( long cPtr, boolean cMemoryOwn )

protected

InterfaceModule() [2/2]

InterfaceModule	(	SystemModule	parent,
		long	index )

Constructs a new mvIMPACT.acquire.InterfaceModule object.

Since

2.32.0

Parameters

parent	[in] The mvIMPACT.acquire.SystemModule instance providing access to the interface module to be created.
index	[in] The index of the instance this object shall be created for. Passing an invalid index will raise an exception.

Member Function Documentation

delete()

synchronized void delete

(

)

Reimplemented from ComponentCollection.

finalize()

void finalize ( )

protected

Reimplemented from ComponentCollection.

getActionCommand()

Method getActionCommand

(

)

A method object.

Sends the action command

It either sends an action command unicast packet to the IP address specified by the 'mvActionDestinationIPAddress' property, or broadcasts an action command broadcast packet on the broadcast domain specified by the 'mvActionDestinationIPAddress' property

getActionDeviceKey()

PropertyI64 getActionDeviceKey

(

)

An integer property.

The device key for the action command

The device key is one of the three main components that constitute an action command packet. It partly defines which device(s) will positively assert the action command packet.

getActionGroupKey()

PropertyI64 getActionGroupKey

(

)

An integer property.

The group key for the action command

The group key is one of the three main components that constitute an action command packet. It partly defines which device(s) will positively assert the action command packet.

getActionGroupMask()

PropertyI64 getActionGroupMask

(

)

An integer property.

The group mask for the action command

The group mask is one of the three main components that constitute an action command packet. It partly defines which device(s) will positively assert the action command packet.

getActionScheduledTime()

PropertyI64 getActionScheduledTime

(

)

An integer property.

Sets the time in which the action command will be executed

Sets the time in which the action command will be executed

getActionScheduledTimeEnable()

PropertyI getActionScheduledTimeEnable

(

)

A boolean property.

Enables or disables action command scheduling

Action commands can be scheduled to execute at a particular moment in time, defined by the 'mvActionScheduledTime' property. If this is disabled the action command takes place immediately after it is received and asserted by each device.

getDeviceAccessStatus()

PropertyI64 getDeviceAccessStatus

(

)

An enumerated integer property.

Indicates the current access status for the device.

This is a read only feature. This enumeration gives the device's access status at the moment of the last execution of the DeviceUpdateList command. This value only changes on execution of the DeviceUpdateList command.

The following string values might be valid for this feature:

• Unknown (Display string: 'Unknown'): This enumeration value indicates that the device accessibility is not known.
• ReadWrite (Display string: 'Read/Write'): This enumeration value indicates that full access to the device is available.
• ReadOnly (Display string: 'Read Only'): This enumeration value indicates that read access to the device is available.
• NoAccess (Display string: 'No Access'): This enumeration value indicates that no access to the device is available.
• Busy (Display string: 'Busy'): This enumeration value indicates that the device is already opened by another entity.
• OpenReadWrite (Display string: 'Open Read Write'): This enumeration value indicates that the device is open in Read/Write mode by this GenTL host.
• OpenReadOnly (Display string: 'Open Read Only'): This enumeration value indicates that the device is open in Read only mode by this GenTL host.

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 mvIMPACT.acquire.PropertyI.getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

getDeviceID()

PropertyS getDeviceID

(

)

A string property.

This feature is deprecated (See DeviceSerialNumber).

Deprecated

This feature is deprecated (See DeviceSerialNumber). It was representing the Device unique identifier (serial number).

getDeviceLinkSpeed()

PropertyI64 getDeviceLinkSpeed

(

)

An integer property.

Indicates the speed of transmission negotiated on the specified Link.

Indicates the speed of transmission negotiated on the specified Link.

getDeviceModelName()

PropertyS getDeviceModelName

(

)

A string property.

Model of the device.

Model of the device.

getDeviceSelector()

PropertyI64 getDeviceSelector

(

)

An integer property.

Selector for the different devices on this interface.

Selector for the different devices on this interface. The limits of this feature might change upon execution of DeviceUpdateList.

getDeviceSerialNumber()

PropertyS getDeviceSerialNumber

(

)

A string property.

Device's serial number.

Device's serial number. This string is a unique identifier of the device.

getDeviceTLVersionMajor()

PropertyI64 getDeviceTLVersionMajor

(

)

An integer property.

Major version of the Transport Layer of the device.

Major version of the Transport Layer of the device.

getDeviceTLVersionMinor()

PropertyI64 getDeviceTLVersionMinor

(

)

An integer property.

Minor version of the Transport Layer of the device.

Minor version of the Transport Layer of the device.

getDeviceType()

PropertyI64 getDeviceType

(

)

An enumerated integer property.

Returns the device type.

Returns the device type.

The following string values might be valid for this feature:

• Transmitter (Display string: 'Transmitter'): Data stream transmitter device.
• Receiver (Display string: 'Receiver'): Data stream receiver device.
• Transceiver (Display string: 'Transceiver'): Data stream receiver and transmitter device.
• Peripheral (Display string: 'Peripheral'): Controllable device (with no data stream handling).
• Mixed (Display string: 'Mixed'): This enumeration value indicates that this is a device for a mixed protocol.
• Custom (Display string: 'Custom'): This enumeration value indicates that this is a device for a custom protocol.
• GEV (Display string: 'GigE Vision'): This enumeration value indicates that this is a device for the GigE Vision protocol.
• CameraLink (Display string: 'CameraLink'): This enumeration value indicates that this is a device for the CameraLink protocol.
• CoaXPress (Display string: 'CoaXPress'): This enumeration value indicates that this is a device for the CoaXPress protocol.
• CameraLinkHS (Display string: 'CameraLink HS'): This enumeration value indicates that this is a device for the CameraLink HS protocol.
• U3V (Display string: 'USB3 Vision'): This enumeration value indicates that this is a device for the USB3 Vision protocol.

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 mvIMPACT.acquire.PropertyI.getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

getDeviceUpdateList()

Method getDeviceUpdateList

(

)

A method object.

Updates the internal device list of this interface.

This command updates the internal device list of this interface.

getDeviceUpdateTimeout()

PropertyI64 getDeviceUpdateTimeout

(

)

An integer property.

Specifies timeout for the DeviceUpdateList Command.

Specifies timeout for the DeviceUpdateList Command.

getDeviceUserID()

PropertyS getDeviceUserID

(

)

A string property.

User-programmable device identifier.

User-programmable device identifier.

getDeviceVendorName()

PropertyS getDeviceVendorName

(

)

A string property.

Name of the manufacturer of the device.

Name of the manufacturer of the device.

getEventNotification()

PropertyI64 getEventNotification

(

)

An enumerated integer property.

Activate or deactivate the notification to the host application of the occurrence of the selected Event.

Activate or deactivate the notification to the host application of the occurrence of the selected Event.

The following string values might be valid for this feature:

• Off (Display string: 'Off'): The selected Event notification is disabled.
• On (Display string: 'On'): The selected Event notification is enabled.
• Once (Display string: 'Once'): The selected Event notification is enabled for one event then return to Off state.
• GigEVisionEvent (Display string: 'Gig E Vision Event')

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 mvIMPACT.acquire.PropertyI.getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

getEventSelector()

PropertyI64 getEventSelector

(

)

An enumerated integer property.

Selects which Event to signal to the host application.

Selects which Event to signal to the host application.

The following string values might be valid for this feature:

• AcquisitionEnd (Display string: 'Acquisition End'): Device just completed the Acquisition of one or many Frames.
• AcquisitionError (Display string: 'Acquisition Error'): Device just detected an error during the active Acquisition.
• AcquisitionStart (Display string: 'Acquisition Start'): Device just started the Acquisition of one or many Frames.
• AcquisitionTransferEnd (Display string: 'Acquisition Transfer End'): Device just completed the transfer of one or many Frames.
• AcquisitionTransferStart (Display string: 'Acquisition Transfer Start'): Device just started the transfer of one or many Frames.
• AcquisitionTrigger (Display string: 'Acquisition Trigger'): Device just received a trigger for the Acquisition of one or many Frames.
• AcquisitionTriggerMissed (Display string: 'Acquisition Trigger Missed'): Device just missed a trigger for the Acquisition of one or many Frames.
• ActionLate (Display string: 'Action Late'): The event will be generated when a valid scheduled action command is received and is scheduled to be executed at a time that is already past.
• BufferTooSmall (Display string: 'Buffer Too Small'): This enumeration value indicates an event that is raised when the buffer was too small to receive the expected amount of data.
• BuffersDiscarded (Display string: 'Buffers Discarded'): This enumeration value indicates an event that is raised when buffers discared by GenTL or device. This event could optionally carry two numeric child data fields EventBuffersDiscardedDeviceCount and EventBuffersDiscardedProducerCount.
• BuffersDiscardedDeviceCount (Display string: 'Buffers Discarded Device Count'): This enumeration value indicates the number of buffers discarded by the device since last fired instance of this event (the producer would get to know about this for example by observing a gap in the block_id sequence).
• BuffersDiscardedProducerCount (Display string: 'Buffers Discarded Producer Count'): This enumeration value indicates the number of buffers discarded by the producer since last fired instance of this event (this would happen e.g. if there are no free buffers available or if given buffer handling mode requires discarding old buffers etc.).
• Counter0End (Display string: 'Counter 0 End'): The event will be generated when counter 0 ends counting.
• Counter0Start (Display string: 'Counter 0 Start'): The event will be generated when counter 0 starts counting.
• Counter1End (Display string: 'Counter 1 End'): The event will be generated when counter 1 ends counting.
• Counter1Start (Display string: 'Counter 1 Start'): The event will be generated when counter 1 starts counting.
• Counter2End (Display string: 'Counter 2 End'): The event will be generated when counter 2 ends counting.
• Counter2Start (Display string: 'Counter 2 Start'): The event will be generated when counter 2 starts counting.
• Counter3End (Display string: 'Counter 3 End'): The event will be generated when counter 3 ends counting.
• Counter3Start (Display string: 'Counter 3 Start'): The event will be generated when counter 3 starts counting.
• Counter4End (Display string: 'Counter 4 End'): The event will be generated when counter 4 ends counting.
• Counter4Start (Display string: 'Counter 4 Start'): The event will be generated when counter 4 starts counting.
• Counter5End (Display string: 'Counter 5 End'): The event will be generated when counter 5 ends counting.
• Counter5Start (Display string: 'Counter 5 Start'): The event will be generated when counter 5 starts counting.
• Counter6End (Display string: 'Counter 6 End'): The event will be generated when counter 6 ends counting.
• Counter6Start (Display string: 'Counter 6 Start'): The event will be generated when counter 6 starts counting.
• Counter7End (Display string: 'Counter 7 End'): The event will be generated when counter 7 ends counting.
• Counter7Start (Display string: 'Counter 7 Start'): The event will be generated when counter 7 starts counting.
• Counter8End (Display string: 'Counter 8 End'): The event will be generated when counter 8 ends counting.
• Counter8Start (Display string: 'Counter 8 Start'): The event will be generated when counter 8 starts counting.
• Counter9End (Display string: 'Counter 9 End'): The event will be generated when counter 9 ends counting.
• Counter9Start (Display string: 'Counter 9 Start'): The event will be generated when counter 9 starts counting.
• Counter10End (Display string: 'Counter 10 End'): The event will be generated when counter 10 ends counting.
• Counter10Start (Display string: 'Counter 10 Start'): The event will be generated when counter 10 starts counting.
• Counter11End (Display string: 'Counter 11 End'): The event will be generated when counter 11 ends counting.
• Counter11Start (Display string: 'Counter 11 Start'): The event will be generated when counter 11 starts counting.
• Counter12End (Display string: 'Counter 12 End'): The event will be generated when counter 12 ends counting.
• Counter12Start (Display string: 'Counter 12 Start'): The event will be generated when counter 12 starts counting.
• Counter13End (Display string: 'Counter 13 End'): The event will be generated when counter 13 ends counting.
• Counter13Start (Display string: 'Counter 13 Start'): The event will be generated when counter 13 starts counting.
• Counter14End (Display string: 'Counter 14 End'): The event will be generated when counter 14 ends counting.
• Counter14Start (Display string: 'Counter 14 Start'): The event will be generated when counter 14 starts counting.
• Counter15End (Display string: 'Counter 15 End'): The event will be generated when counter 15 ends counting.
• Counter15Start (Display string: 'Counter 15 Start'): The event will be generated when counter 15 starts counting.
• DeviceListChanged (Display string: 'Device List Changed'): This enumeration value indicates an event that is fired when the list of devices has been updated.
• DeviceLost (Display string: 'Device Lost'): This enumeration value indicates an event that is raised when the local host looses connection to the physical(remote) device.
• DeviceTemperatureStateCritical (Display string: 'Device Temperature State Critical')
• DeviceTemperatureStateNormal (Display string: 'Device Temperature State Normal')
• DeviceTemperatureStateOverTemperature (Display string: 'Device Temperature State Over Temperature')
• Encoder0Restarted (Display string: 'Encoder 0 Restarted'): The event will be generated when the Encoder 0 restarts moving.
• Encoder0Stopped (Display string: 'Encoder 0 Stopped'): The event will be generated when the Encoder 0 stops for longer than EncoderTimeout.
• Encoder1Restarted (Display string: 'Encoder 1 Restarted'): The event will be generated when the Encoder 1 restarts moving.
• Encoder1Stopped (Display string: 'Encoder 1 Stopped'): The event will be generated when the Encoder 1 stops for longer than EncoderTimeout.
• Encoder2Restarted (Display string: 'Encoder 2 Restarted'): The event will be generated when the Encoder 2 restarts moving.
• Encoder2Stopped (Display string: 'Encoder 2 Stopped'): The event will be generated when the Encoder 2 stops for longer than EncoderTimeout.
• Encoder3Restarted (Display string: 'Encoder 3 Restarted'): The event will be generated when the Encoder 3 restarts moving.
• Encoder3Stopped (Display string: 'Encoder 3 Stopped'): The event will be generated when the Encoder 3 stops for longer than EncoderTimeout.
• Encoder4Restarted (Display string: 'Encoder 4 Restarted'): The event will be generated when the Encoder 4 restarts moving.
• Encoder4Stopped (Display string: 'Encoder 4 Stopped'): The event will be generated when the Encoder 4 stops for longer than EncoderTimeout.
• Encoder5Restarted (Display string: 'Encoder 5 Restarted'): The event will be generated when the Encoder 5 restarts moving.
• Encoder5Stopped (Display string: 'Encoder 5 Stopped'): The event will be generated when the Encoder 5 stops for longer than EncoderTimeout.
• Encoder6Restarted (Display string: 'Encoder 6 Restarted'): The event will be generated when the Encoder 6 restarts moving.
• Encoder6Stopped (Display string: 'Encoder 6 Stopped'): The event will be generated when the Encoder 6 stops for longer than EncoderTimeout.
• Encoder7Restarted (Display string: 'Encoder 7 Restarted'): The event will be generated when the Encoder 7 restarts moving.
• Encoder7Stopped (Display string: 'Encoder 7 Stopped'): The event will be generated when the Encoder 7 stops for longer than EncoderTimeout.
• Encoder8Restarted (Display string: 'Encoder 8 Restarted'): The event will be generated when the Encoder 8 restarts moving.
• Encoder8Stopped (Display string: 'Encoder 8 Stopped'): The event will be generated when the Encoder 8 stops for longer than EncoderTimeout.
• Encoder9Restarted (Display string: 'Encoder 9 Restarted'): The event will be generated when the Encoder 9 restarts moving.
• Encoder9Stopped (Display string: 'Encoder 9 Stopped'): The event will be generated when the Encoder 9 stops for longer than EncoderTimeout.
• Encoder10Restarted (Display string: 'Encoder 10 Restarted'): The event will be generated when the Encoder 10 restarts moving.
• Encoder10Stopped (Display string: 'Encoder 10 Stopped'): The event will be generated when the Encoder 10 stops for longer than EncoderTimeout.
• Encoder11Restarted (Display string: 'Encoder 11 Restarted'): The event will be generated when the Encoder 11 restarts moving.
• Encoder11Stopped (Display string: 'Encoder 11 Stopped'): The event will be generated when the Encoder 11 stops for longer than EncoderTimeout.
• Encoder12Restarted (Display string: 'Encoder 12 Restarted'): The event will be generated when the Encoder 12 restarts moving.
• Encoder12Stopped (Display string: 'Encoder 12 Stopped'): The event will be generated when the Encoder 12 stops for longer than EncoderTimeout.
• Encoder13Restarted (Display string: 'Encoder 13 Restarted'): The event will be generated when the Encoder 13 restarts moving.
• Encoder13Stopped (Display string: 'Encoder 13 Stopped'): The event will be generated when the Encoder 13 stops for longer than EncoderTimeout.
• Encoder14Restarted (Display string: 'Encoder 14 Restarted'): The event will be generated when the Encoder 14 restarts moving.
• Encoder14Stopped (Display string: 'Encoder 14 Stopped'): The event will be generated when the Encoder 14 stops for longer than EncoderTimeout.
• Encoder15Restarted (Display string: 'Encoder 15 Restarted'): The event will be generated when the Encoder 15 restarts moving.
• Encoder15Stopped (Display string: 'Encoder 15 Stopped'): The event will be generated when the Encoder 15 stops for longer than EncoderTimeout.
• Error (Display string: 'Error'): Device just detected an error during the active Acquisition.
• ExposureEnd (Display string: 'Exposure End'): Device just completed the exposure of one Frame (or Line).
• ExposureStart (Display string: 'Exposure Start'): Device just started the exposure of one Frame (or Line).
• FrameBurstEnd (Display string: 'Frame Burst End'): Device just completed the capture of a burst of Frames.
• FrameBurstStart (Display string: 'Frame Burst Start'): Device just started the capture of a burst of Frames.
• FrameEnd (Display string: 'Frame End'): Device just completed the capture of one Frame.
• FrameStart (Display string: 'Frame Start'): Device just started the capture of one Frame.
• FrameTransferEnd (Display string: 'Frame Transfer End'): Device just completed the transfer of one Frame.
• FrameTransferStart (Display string: 'Frame Transfer Start'): Device just started the transfer of one Frame.
• FrameTrigger (Display string: 'Frame Trigger'): Device just received a trigger to start the capture of one Frame.
• FrameTriggerMissed (Display string: 'Frame Trigger Missed'): Device just missed a trigger to start the capture of one Frame.
• InterfaceListChanged (Display string: 'Interface List Changed'): This enumeration value indicates an event that is fired when the list of interfaces has been updated.
• InterfaceLost (Display string: 'Interface Lost'): This enumeration value indicates an event that is raised when the interface connection is lost.
• Line0AnyEdge (Display string: 'Line 0 Any Edge'): The event will be generated when a Falling or Rising Edge is detected on the Line 0.
• Line0FallingEdge (Display string: 'Line 0 Falling Edge'): The event will be generated when a Falling Edge is detected on the Line 0.
• Line0RisingEdge (Display string: 'Line 0 Rising Edge'): The event will be generated when a Rising Edge is detected on the Line 0.
• Line1AnyEdge (Display string: 'Line 1 Any Edge'): The event will be generated when a Falling or Rising Edge is detected on the Line 1.
• Line1FallingEdge (Display string: 'Line 1 Falling Edge'): The event will be generated when a Falling Edge is detected on the Line 1.
• Line1RisingEdge (Display string: 'Line 1 Rising Edge'): The event will be generated when a Rising Edge is detected on the Line 1.
• Line2AnyEdge (Display string: 'Line 2 Any Edge'): The event will be generated when a Falling or Rising Edge is detected on the Line 2.
• Line2FallingEdge (Display string: 'Line 2 Falling Edge'): The event will be generated when a Falling Edge is detected on the Line 2.
• Line2RisingEdge (Display string: 'Line 2 Rising Edge'): The event will be generated when a Rising Edge is detected on the Line 2.
• Line3AnyEdge (Display string: 'Line 3 Any Edge'): The event will be generated when a Falling or Rising Edge is detected on the Line 3.
• Line3FallingEdge (Display string: 'Line 3 Falling Edge'): The event will be generated when a Falling Edge is detected on the Line 3.
• Line3RisingEdge (Display string: 'Line 3 Rising Edge'): The event will be generated when a Rising Edge is detected on the Line 3.
• Line4AnyEdge (Display string: 'Line 4 Any Edge'): The event will be generated when a Falling or Rising Edge is detected on the Line 4.
• Line4FallingEdge (Display string: 'Line 4 Falling Edge'): The event will be generated when a Falling Edge is detected on the Line 4.
• Line4RisingEdge (Display string: 'Line 4 Rising Edge'): The event will be generated when a Rising Edge is detected on the Line 4.
• Line5AnyEdge (Display string: 'Line 5 Any Edge'): The event will be generated when a Falling or Rising Edge is detected on the Line 5.
• Line5FallingEdge (Display string: 'Line 5 Falling Edge'): The event will be generated when a Falling Edge is detected on the Line 5.
• Line5RisingEdge (Display string: 'Line 5 Rising Edge'): The event will be generated when a Rising Edge is detected on the Line 5.
• Line6AnyEdge (Display string: 'Line 6 Any Edge'): The event will be generated when a Falling or Rising Edge is detected on the Line 6.
• Line6FallingEdge (Display string: 'Line 6 Falling Edge'): The event will be generated when a Falling Edge is detected on the Line 6.
• Line6RisingEdge (Display string: 'Line 6 Rising Edge'): The event will be generated when a Rising Edge is detected on the Line 6.
• Line7AnyEdge (Display string: 'Line 7 Any Edge'): The event will be generated when a Falling or Rising Edge is detected on the Line 7.
• Line7FallingEdge (Display string: 'Line 7 Falling Edge'): The event will be generated when a Falling Edge is detected on the Line 7.
• Line7RisingEdge (Display string: 'Line 7 Rising Edge'): The event will be generated when a Rising Edge is detected on the Line 7.
• Line8AnyEdge (Display string: 'Line 8 Any Edge'): The event will be generated when a Falling or Rising Edge is detected on the Line 8.
• Line8FallingEdge (Display string: 'Line 8 Falling Edge'): The event will be generated when a Falling Edge is detected on the Line 8.
• Line8RisingEdge (Display string: 'Line 8 Rising Edge'): The event will be generated when a Rising Edge is detected on the Line 8.
• Line9AnyEdge (Display string: 'Line 9 Any Edge'): The event will be generated when a Falling or Rising Edge is detected on the Line 9.
• Line9FallingEdge (Display string: 'Line 9 Falling Edge'): The event will be generated when a Falling Edge is detected on the Line 9.
• Line9RisingEdge (Display string: 'Line 9 Rising Edge'): The event will be generated when a Rising Edge is detected on the Line 9.
• Line10AnyEdge (Display string: 'Line 10 Any Edge'): The event will be generated when a Falling or Rising Edge is detected on the Line 10.
• Line10FallingEdge (Display string: 'Line 10 Falling Edge'): The event will be generated when a Falling Edge is detected on the Line 10.
• Line10RisingEdge (Display string: 'Line 10 Rising Edge'): The event will be generated when a Rising Edge is detected on the Line 10.
• Line11AnyEdge (Display string: 'Line 11 Any Edge'): The event will be generated when a Falling or Rising Edge is detected on the Line 11.
• Line11FallingEdge (Display string: 'Line 11 Falling Edge'): The event will be generated when a Falling Edge is detected on the Line 11.
• Line11RisingEdge (Display string: 'Line 11 Rising Edge'): The event will be generated when a Rising Edge is detected on the Line 11.
• Line12AnyEdge (Display string: 'Line 12 Any Edge'): The event will be generated when a Falling or Rising Edge is detected on the Line 12.
• Line12FallingEdge (Display string: 'Line 12 Falling Edge'): The event will be generated when a Falling Edge is detected on the Line 12.
• Line12RisingEdge (Display string: 'Line 12 Rising Edge'): The event will be generated when a Rising Edge is detected on the Line 12.
• Line13AnyEdge (Display string: 'Line 13 Any Edge'): The event will be generated when a Falling or Rising Edge is detected on the Line 13.
• Line13FallingEdge (Display string: 'Line 13 Falling Edge'): The event will be generated when a Falling Edge is detected on the Line 13.
• Line13RisingEdge (Display string: 'Line 13 Rising Edge'): The event will be generated when a Rising Edge is detected on the Line 13.
• Line14AnyEdge (Display string: 'Line 14 Any Edge'): The event will be generated when a Falling or Rising Edge is detected on the Line 14.
• Line14FallingEdge (Display string: 'Line 14 Falling Edge'): The event will be generated when a Falling Edge is detected on the Line 14.
• Line14RisingEdge (Display string: 'Line 14 Rising Edge'): The event will be generated when a Rising Edge is detected on the Line 14.
• Line15AnyEdge (Display string: 'Line 15 Any Edge'): The event will be generated when a Falling or Rising Edge is detected on the Line 15.
• Line15FallingEdge (Display string: 'Line 15 Falling Edge'): The event will be generated when a Falling Edge is detected on the Line 15.
• Line15RisingEdge (Display string: 'Line 15 Rising Edge'): The event will be generated when a Rising Edge is detected on the Line 15.
• LineEnd (Display string: 'Line End'): Device just completed the capture of one Line.
• LineStart (Display string: 'Line Start'): Device just started the capture of one Line.
• LineTrigger (Display string: 'Line Trigger'): Device just received a trigger to start the capture of one Line.
• LineTriggerMissed (Display string: 'Line Trigger Missed'): Device just missed a trigger to start the capture of one Line.
• Link0Trigger (Display string: 'Link 0 Trigger')
• Link1Trigger (Display string: 'Link 1 Trigger')
• Link2Trigger (Display string: 'Link 2 Trigger')
• Link3Trigger (Display string: 'Link 3 Trigger')
• Link4Trigger (Display string: 'Link 4 Trigger')
• Link5Trigger (Display string: 'Link 5 Trigger')
• Link6Trigger (Display string: 'Link 6 Trigger')
• Link7Trigger (Display string: 'Link 7 Trigger')
• Link8Trigger (Display string: 'Link 8 Trigger')
• Link9Trigger (Display string: 'Link 9 Trigger')
• Link10Trigger (Display string: 'Link 10 Trigger')
• Link11Trigger (Display string: 'Link 11 Trigger')
• Link12Trigger (Display string: 'Link 12 Trigger')
• Link13Trigger (Display string: 'Link 13 Trigger')
• Link14Trigger (Display string: 'Link 14 Trigger')
• Link15Trigger (Display string: 'Link 15 Trigger')
• LinkSpeedChange (Display string: 'Link Speed Change'): The event will be generated when the link speed has changed.
• LinkTrigger0 (Display string: 'Link Trigger 0'): The event will be generated when a Rising Edge is detected on the LinkTrigger 0.
• LinkTrigger1 (Display string: 'Link Trigger 1'): The event will be generated when a Rising Edge is detected on the LinkTrigger 1.
• PrimaryApplicationSwitch (Display string: 'Primary Application Switch'): The event will be generated when a primary application switchover has been granted (GigE Vision Specific).
• SequencerSetChange (Display string: 'Sequencer Set Change'): Device sequencer set has changed.
• Stream0TransferBlockEnd (Display string: 'Stream 0 Transfer Block End'): Device just completed the transfer of one Block.
• Stream0TransferBlockStart (Display string: 'Stream 0 Transfer Block Start'): Device just started the transfer of one Block.
• Stream0TransferBlockTrigger (Display string: 'Stream 0 Transfer Block Trigger'): Device just received a trigger to start the transfer of one Block.
• Stream0TransferBurstEnd (Display string: 'Stream 0 Transfer Burst End'): Device just completed the transfer of a burst of Blocks.
• Stream0TransferBurstStart (Display string: 'Stream 0 Transfer Burst Start'): Device just started the transfer of a burst of Blocks.
• Stream0TransferEnd (Display string: 'Stream 0 Transfer End'): Device just completed the transfer of one or many Blocks.
• Stream0TransferOverflow (Display string: 'Stream 0 Transfer Overflow'): Device transfer queue overflowed.
• Stream0TransferPause (Display string: 'Stream 0 Transfer Pause'): Device just paused the transfer.
• Stream0TransferResume (Display string: 'Stream 0 Transfer Resume'): Device just resumed the transfer.
• Stream0TransferStart (Display string: 'Stream 0 Transfer Start'): Device just started the transfer of one or many Blocks.
• Test (Display string: 'Test'): The test event will be generated when the device receives the TestEventGenerate command (EventNotification for the Test event is always On).
• Timer0End (Display string: 'Timer 0 End'): The event will be generated when Timer 0 ends counting.
• Timer0Start (Display string: 'Timer 0 Start'): The event will be generated when Timer 0 starts counting.
• Timer1End (Display string: 'Timer 1 End'): The event will be generated when Timer 1 ends counting.
• Timer1Start (Display string: 'Timer 1 Start'): The event will be generated when Timer 1 starts counting.
• Timer2End (Display string: 'Timer 2 End'): The event will be generated when Timer 2 ends counting.
• Timer2Start (Display string: 'Timer 2 Start'): The event will be generated when Timer 2 starts counting.
• Timer3End (Display string: 'Timer 3 End'): The event will be generated when Timer 3 ends counting.
• Timer3Start (Display string: 'Timer 3 Start'): The event will be generated when Timer 3 starts counting.
• Timer4End (Display string: 'Timer 4 End'): The event will be generated when Timer 4 ends counting.
• Timer4Start (Display string: 'Timer 4 Start'): The event will be generated when Timer 4 starts counting.
• Timer5End (Display string: 'Timer 5 End'): The event will be generated when Timer 5 ends counting.
• Timer5Start (Display string: 'Timer 5 Start'): The event will be generated when Timer 5 starts counting.
• Timer6End (Display string: 'Timer 6 End'): The event will be generated when Timer 6 ends counting.
• Timer6Start (Display string: 'Timer 6 Start'): The event will be generated when Timer 6 starts counting.
• Timer7End (Display string: 'Timer 7 End'): The event will be generated when Timer 7 ends counting.
• Timer7Start (Display string: 'Timer 7 Start'): The event will be generated when Timer 7 starts counting.
• Timer8End (Display string: 'Timer 8 End'): The event will be generated when Timer 8 ends counting.
• Timer8Start (Display string: 'Timer 8 Start'): The event will be generated when Timer 8 starts counting.
• Timer9End (Display string: 'Timer 9 End'): The event will be generated when Timer 9 ends counting.
• Timer9Start (Display string: 'Timer 9 Start'): The event will be generated when Timer 9 starts counting.
• Timer10End (Display string: 'Timer 10 End'): The event will be generated when Timer 10 ends counting.
• Timer10Start (Display string: 'Timer 10 Start'): The event will be generated when Timer 10 starts counting.
• Timer11End (Display string: 'Timer 11 End'): The event will be generated when Timer 11 ends counting.
• Timer11Start (Display string: 'Timer 11 Start'): The event will be generated when Timer 11 starts counting.
• Timer12End (Display string: 'Timer 12 End'): The event will be generated when Timer 12 ends counting.
• Timer12Start (Display string: 'Timer 12 Start'): The event will be generated when Timer 12 starts counting.
• Timer13End (Display string: 'Timer 13 End'): The event will be generated when Timer 13 ends counting.
• Timer13Start (Display string: 'Timer 13 Start'): The event will be generated when Timer 13 starts counting.
• Timer14End (Display string: 'Timer 14 End'): The event will be generated when Timer 14 ends counting.
• Timer14Start (Display string: 'Timer 14 Start'): The event will be generated when Timer 14 starts counting.
• Timer15End (Display string: 'Timer 15 End'): The event will be generated when Timer 15 ends counting.
• Timer15Start (Display string: 'Timer 15 Start'): The event will be generated when Timer 15 starts counting.

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 mvIMPACT.acquire.PropertyI.getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

getGenCPVersionMajor()

PropertyI64 getGenCPVersionMajor

(

)

An integer property.

Indicates the major version number of the GenCP specification this device complies with.

This is a read only element. It indicates the major version number of the GenCP specification this device complies with.

getGenCPVersionMinor()

PropertyI64 getGenCPVersionMinor

(

)

An integer property.

Indicates the minor version number of the GenCP specification this device complies with.

This is a read only element. It indicates the minor version number of the GenCP specification this device complies with.

getGevActionDestinationIPAddress()

PropertyI64 getGevActionDestinationIPAddress

(

)

An integer property.

The IP address of the action command recipient

A valid IP address if the action command shall be unicast. A broadcast subnet if the action command shall be broadcast.

getGevApplicationSwitchoverKey()

PropertyI64 getGevApplicationSwitchoverKey

(

)

An integer property.

Controls the key to use to authenticate primary application switchover requests.

Controls the key to use to authenticate primary application switchover requests. If the device to take over has 'mvDevicePrimaryApplicationSwitchoverEnable' set to true and this key matches the devices internal key control access will be granted.

getGevCurrentControlMode()

PropertyI64 getGevCurrentControlMode

(

)

An enumerated integer property.

The current control mode of the device.

This enumeration provides a value that indicates the current control mode of the device.

The following string values might be valid for this feature:

• Open (Display string: 'Open'): This enumeration value indicates that the device is open for control or exclusive access.
• ControlAccess (Display string: 'Control Access'): This enumeration value indicates that the device is controlled by another host, but switchover or read-only access is possible.
• ExclusiveAccess (Display string: 'Exclusive Access'): This enumeration value indicates that the device is under exclusive access by a host and cannot be accessed by another.
• NoAccess (Display string: 'No Access'): This enumeration value indicates that the device cannot be accessed, for instance it may be a GigE Vision device on a subnet different from the interface.

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 mvIMPACT.acquire.PropertyI.getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

getGevDeviceForceGateway()

PropertyI64 getGevDeviceForceGateway

(

)

An integer property.

Static gateway IP address to set for the GVCP interface of the selected remote device.

Static gateway IP address to set for the GVCP interface of the selected remote device.

getGevDeviceForceIP()

Method getGevDeviceForceIP

(

)

A method object.

Apply the force IP settings (GevDeviceForceIPAddress, GevDeviceForceSubnetMask and GevDeviceForceGateway) in the Device using ForceIP command.

Apply the force IP settings (GevDeviceForceIPAddress, GevDeviceForceSubnetMask and GevDeviceForceGateway) in the Device using ForceIP command.

getGevDeviceForceIPAddress()

PropertyI64 getGevDeviceForceIPAddress

(

)

An integer property.

Static IP address to set for the GVCP interface of the selected remote device.

Static IP address to set for the GVCP interface of the selected remote device.

getGevDeviceForceSubnetMask()

PropertyI64 getGevDeviceForceSubnetMask

(

)

An integer property.

Static subnet mask to set for the GVCP interface of the selected remote device.

Static subnet mask to set for the GVCP interface of the selected remote device.

getGevDeviceGateway()

PropertyI64 getGevDeviceGateway

(

)

An integer property.

Indicates the current gateway of the GVCP interface of the selected remote device.

This is a read only element. It indicates the current gateway of the GVCP interface of the selected remote device.

getGevDeviceIPAddress()

PropertyI64 getGevDeviceIPAddress

(

)

An integer property.

Indicates the current IP address of the GVCP interface of the selected remote device.

This is a read only element. It indicates the current IP address of the GVCP interface of the selected remote device.

getGevDeviceIPConfigurationStatus()

PropertyI64 getGevDeviceIPConfigurationStatus

(

)

An enumerated integer property.

Identifies the IP configuration of the GVCP interface of the selected remote device.

This is a read only feature. This enumeration provides a value that indicates the Device IP configuration of the GVCP interface of the selected remote device. This value only changes on execution of the DeviceUpdateList command.

The following string values might be valid for this feature:

• DHCP (Display string: 'DHCP')
• PersistentIP (Display string: 'Persistent IP')
• LinkLocal (Display string: 'Link Local')

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 mvIMPACT.acquire.PropertyI.getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

getGevDeviceMACAddress()

PropertyI64 getGevDeviceMACAddress

(

)

An integer property.

Indicates the 48-bit MAC address of the GVCP interface of the selected remote device.

This is a read only element. It indicates the 48-bit MAC address of the GVCP interface of the selected remote device.

getGevDeviceSubnetMask()

PropertyI64 getGevDeviceSubnetMask

(

)

An integer property.

Indicates the current subnet mask of the GVCP interface of the selected remote device.

This is a read only element. It indicates the current subnet mask of the GVCP interface of the selected remote device.

getGevInterfaceGateway()

PropertyI64 getGevInterfaceGateway

(

)

An integer property.

Indicates the IP address of the selected gateway entry of this interface.

This is a read only element. It indicates the IP address of the selected gateway entry of this interface.

getGevInterfaceGatewaySelector()

PropertyI64 getGevInterfaceGatewaySelector

(

)

An integer property.

Selector for the different gateway entries for this interface.

Selector for the different gateway entries for this interface. The selector is 0-based in order to match the index of the C interface.

getGevInterfaceMACAddress()

PropertyI64 getGevInterfaceMACAddress

(

)

An integer property.

Indicates the 48-bit MAC address of the selected interface.

This is a read only element. It indicates the 48-bit MAC address of the selected interface.

getGevInterfaceSubnetIPAddress()

PropertyI64 getGevInterfaceSubnetIPAddress

(

)

An integer property.

Indicates the IP address of the selected subnet entry of this interface.

This is a read only element. It indicates the IP address of the selected subnet entry of this interface.

getGevInterfaceSubnetMask()

PropertyI64 getGevInterfaceSubnetMask

(

)

An integer property.

Indicates the subnet mask of the selected subnet entry of this interface.

This is a read only element. It indicates the subnet mask of the selected subnet entry of this interface.

getGevInterfaceSubnetSelector()

PropertyI64 getGevInterfaceSubnetSelector

(

)

An integer property.

Selector for the different subnet entries for this interface.

Selector for the different subnet entries for this interface. The selector is 0-based in order to match the index of the C interface.

getGevVersionMajor()

PropertyI64 getGevVersionMajor

(

)

An integer property.

Indicates the major version number of the GigE Vision specification this device complies with.

This is a read only element. It indicates the major version number of the GigE Vision specification this device complies with.

getGevVersionMinor()

PropertyI64 getGevVersionMinor

(

)

An integer property.

Indicates the minor version number of the GigE Vision specification this device complies with.

This is a read only element. It indicates the minor version number of the GigE Vision specification this device complies with.

getInterfaceDisplayName()

PropertyS getInterfaceDisplayName

(

)

A string property.

A user-friendly name of the Interface.

This is a read only element. It is a string that indicates a user-friendly name of the Interface.

getInterfaceID()

PropertyS getInterfaceID

(

)

A string property.

GenTL producer wide unique identifier of the selected interface.

This is a read only element. It is a string that indicates a GenTL producer wide unique identifier of the selected interface.

getInterfaceTLVersionMajor()

PropertyI64 getInterfaceTLVersionMajor

(

)

An integer property.

Indicates the major version number of the transport layer specification the GenTL Producer complies with.

This is a read only element. It indicates the major version number of the transport layer specification the GenTL Producer complies with.

getInterfaceTLVersionMinor()

PropertyI64 getInterfaceTLVersionMinor

(

)

An integer property.

Indicates the minor version number of the transport layer specification the GenTL Producer complies with.

This is a read only element. It indicates the minor version number of the transport layer specification the GenTL Producer complies with.

getInterfaceType()

PropertyI64 getInterfaceType

(

)

An enumerated integer property.

Identifies the interfaces technology of the GenTL Producer implementation.

This is a read only feature. This enumeration provides a value that indicates interfaces technology of the GenTL Producer implementation.

The following string values might be valid for this feature:

• Mixed (Display string: 'Mixed'): This enumeration value indicates that this is an interface for a mixed protocol.
• Custom (Display string: 'Custom'): This enumeration value indicates that this is an interface for a custom protocol.
• GEV (Display string: 'GigE Vision'): This enumeration value indicates that this is an interface for the GigE Vision protocol.
• CameraLink (Display string: 'CameraLink'): This enumeration value indicates that this is an interface for the CameraLink protocol.
• CoaXPress (Display string: 'CoaXPress'): This enumeration value indicates that this is an interface for the CoaXPress protocol.
• CameraLinkHS (Display string: 'CameraLink HS'): This enumeration value indicates that this is an interface for the CameraLink HS protocol.
• U3V (Display string: 'USB3 Vision'): This enumeration value indicates that this is an interface for the USB3 Vision protocol.

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 mvIMPACT.acquire.PropertyI.getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

getMvActionAcknowledgeEnable()

PropertyI getMvActionAcknowledgeEnable

(

)

A boolean property.

Enables or disables the ACK response for the action command

Enables or disables the ACK response packet for an action command by setting the corresponding flag in the command. Typically, invokers of an action command don't wait for an acknowledge which is why this flag is usually not set in the command.

getMvActionAcknowledgesExpected()

PropertyI64 getMvActionAcknowledgesExpected

(

)

An integer property.

Number of devices to send an acknowledge to the action command generated in the current setup

An unsigned integer containing the number of devices that are expected to send an acknowledge to the action command generated in the current setup.

getMvActionAcknowledgesFailed()

PropertyI64 getMvActionAcknowledgesFailed

(

)

An integer property.

Number of devices that sent an acknowledge with an error code to the recent action command

Number of devices that sent an acknowledge with an error code as a response to the recent action command generated in the current setup.

getMvActionAcknowledgesReceived()

PropertyI64 getMvActionAcknowledgesReceived

(

)

An integer property.

Number of devices that sent an acknowledge to the recent action command

Number of devices that sent an acknowledge as a response to the recent action command generated in the current setup.

getMvActionAcknowledgeTimeout()

PropertyI64 getMvActionAcknowledgeTimeout

(

)

An integer property.

Maximum wait time for the acknowledge o an action command(ms)

Maximum wait time for the acknowledge to the action command generated in the current setup(ms).

getMvActionDestinationPort()

PropertyI64 getMvActionDestinationPort

(

)

An integer property.

The GVCP port of the action command recipient (usually 3956).

The GVCP port of the action command recipient (usually 3956).

getMvDeviceCommandChannelRetryCount()

PropertyI64 getMvDeviceCommandChannelRetryCount

(

)

An integer property.

Indicates the number of retransmissions allowed when command channel message timed out (no ACK was received from the device)(deprecated).

Deprecated

Indicates the number of retransmissions allowed when command channel message timed out (no ACK was received from the device). This feature has been declared deprecated. Use 'LinkCommandRetryCount' of the DeviceModule instead.

getMvDeviceCommandChannelTransmissionTimeout()

PropertyI64 getMvDeviceCommandChannelTransmissionTimeout

(

)

An integer property.

Defines the maximum time in milli-seconds the host driver will wait for an ACK from the device to a previously sent command(deprecated).

Deprecated

Defines the maximum time in milli-seconds the host driver will wait for an ACK from the device to a previously sent command. This feature has been declared deprecated. Use 'LinkCommandTimeout' of the DeviceModule instead.

getMvDeviceLicenseDetails()

PropertyS getMvDeviceLicenseDetails

(

)

A string property.

Details about the granted license.

This is a read only element. It indicates details whether or not this device can be operated without limitations using this driver stack.

getMvDeviceLicenseValid()

PropertyI getMvDeviceLicenseValid

(

)

A boolean property.

True if the current device has a valid license.

True if the current device has a valid license. This is the case for all Balluff/MATRIX VISION devices and devices for which a license file has been provided.

getMvDeviceNetworkInterfaceCount()

PropertyI64 getMvDeviceNetworkInterfaceCount

(

)

An integer property.

The number of physical network interfaces supported by this device.

This is an integer feature. It contains the number of physical network interfaces supported by this device.

getMvDevicePrimaryApplicationSwitchoverEnable()

PropertyI getMvDevicePrimaryApplicationSwitchoverEnable

(

)

A boolean property.

Enables or disables primary application switchover.

Enables or disables primary application switchover.

getMvDevicePrimaryApplicationSwitchoverSupported()

PropertyI getMvDevicePrimaryApplicationSwitchoverSupported

(

)

A boolean property.

Reports the availability of the primary application switchover feature.

Reports the availability of the primary application switchover feature.

getMvDeviceUpdateFirmware()

Method getMvDeviceUpdateFirmware

(

)

A method object.

Updates the device's firmware.

Updates the device using the firmware images embedded into this producer library.

getMvGevAdvancedDeviceDiscoveryEnable()

PropertyI getMvGevAdvancedDeviceDiscoveryEnable

(

)

A boolean property.

Enables or disables the advanced device discovery.

Enables or disables the advanced device discovery. When enabled also devices, which currently use an incorrect IP configuration for the network they are connected to might be detectable. However depending on the operating system this may result in devices showing up on interfaces to which they are not physically connected.

getMvGevDeviceCCSP()

PropertyI64 getMvGevDeviceCCSP

(

)

An integer property.

The port of the control channel the device is using (usually 3956).

The port of the control channel the device is using (usually 3956).

getMvGevInterfaceLinkSpeed()

PropertyI64 getMvGevInterfaceLinkSpeed

(

)

An integer property.

Indicates the link speed of this interface.

This is a read only element. It indicates the link speed(in Mbits per second) of this interface.

getMvGevInterfaceMTU()

PropertyI64 getMvGevInterfaceMTU

(

)

An integer property.

Indicates the MTU of this interface.

This is a read only element. It indicates the MTU(Maximum Transmission Unit) of this interface.

getMvInterfaceLicenseFile()

PropertyS getMvInterfaceLicenseFile

(

)

A string property.

Indicates the path of the license file.

This string register indicates the path of the file that will be used for extracting licenses for devices on this interface.

getMvU3VDeviceGUID()

PropertyS getMvU3VDeviceGUID

(

)

A string property.

Indicates the USB3 Vision GUID of the device.

This is a read only element. It indicates the USB3 Vision GUID of the device.

getMvUnicastDeviceDiscoveryCommandCount()

PropertyI64 getMvUnicastDeviceDiscoveryCommandCount

(

)

An integer property.

Specifies the number of discovery commands which will be sent to destinations defined by 'mvUnicastDeviceDiscoveryCommandSelector', 'mvUnicastDeviceDiscoveryDestinationIPAddress' and 'mvUnicastDeviceDiscoveryDestinationPort'.

Specifies the number of discovery commands which will be sent to destinations defined by 'mvUnicastDeviceDiscoveryCommandSelector', 'mvUnicastDeviceDiscoveryDestinationIPAddress' and 'mvUnicastDeviceDiscoveryDestinationPort'. No unicast device discovery will be performed once set to '0'. The mvUnicastDeviceDiscoveryCommandCount specifies the maximum value of the mvUnicastDeviceDiscoveryCommandSelector property.

getMvUnicastDeviceDiscoveryCommandSelector()

PropertyI64 getMvUnicastDeviceDiscoveryCommandSelector

(

)

An integer property.

Selects unicast discovery command to configure.

Selects unicast discovery command to configure.

getMvUnicastDeviceDiscoveryDestinationIPAddress()

PropertyI64 getMvUnicastDeviceDiscoveryDestinationIPAddress

(

)

An integer property.

Controls the destination IP address of the selected unicast device discovery command.

Controls the destination IP address of the selected unicast device discovery command.

getMvUnicastDeviceDiscoveryDestinationPort()

PropertyI64 getMvUnicastDeviceDiscoveryDestinationPort

(

)

An integer property.

Controls the destination port of the selected unicast device discovery command (usually 3956).

Controls the destination port of the selected unicast device discovery command (usually 3956).

getU3vVersionMajor()

PropertyI64 getU3vVersionMajor

(

)

An integer property.

Indicates the major version number of the USB3 Vision specification this device complies with.

This is a read only element. It indicates the major version number of the USB3 Vision specification this device complies with.

getU3vVersionMinor()

PropertyI64 getU3vVersionMinor

(

)

An integer property.

Indicates the minor version number of the USB3 Vision specification this device complies with.

This is a read only element. It indicates the minor version number of the USB3 Vision specification this device complies with.

hObj()

int hObj ( )

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.

Returns

A unique identifier for the component referenced by this object.

restoreDefault()

ComponentCollection restoreDefault ( )

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.

Note

The caller must have the right to modify the component. Otherwise an exception will be thrown.

Returns

A const reference to the component.

swigRelease() [1/2]

static long swigRelease ( ComponentCollection obj )

staticprotectedinherited

swigRelease() [2/2]

static long swigRelease ( InterfaceModule obj )

staticprotected

Member Data Documentation

swigCMemOwn

transient boolean swigCMemOwn

protectedinherited