TransportLayerControl Class Reference

Category that contains the transport Layer control features. More...

Public Member Functions
synchronized void	delete ()
PropertyI64	getAPAUSEMACCtrlFramesReceived ()
	An integer property.
PropertyI64	getAPAUSEMACCtrlFramesTransmitted ()
	An integer property.
PropertyI64	getClConfiguration ()
	An enumerated integer property.
PropertyI64	getClTimeSlotsCount ()
	An enumerated integer property.
PropertyI64	getCxpConnectionSelector ()
	An integer property.
PropertyI64	getCxpConnectionTestErrorCount ()
	An integer property.
PropertyI64	getCxpConnectionTestMode ()
	An enumerated integer property.
PropertyI64	getCxpConnectionTestPacketCount ()
	An integer property.
Method	getCxpErrorCounterReset ()
	A method object.
PropertyI64	getCxpErrorCounterSelector ()
	An enumerated integer property.
PropertyI64	getCxpErrorCounterStatus ()
	An enumerated integer property.
PropertyI64	getCxpErrorCounterValue ()
	An integer property.
PropertyI	getCxpFirstLineTriggerWithFrameStart ()
	A boolean property.
PropertyI64	getCxpLinkConfiguration ()
	An enumerated integer property.
PropertyI64	getCxpLinkConfigurationPreferred ()
	An enumerated integer property.
PropertyI64	getCxpLinkConfigurationStatus ()
	An enumerated integer property.
PropertyI64	getCxpLinkSharingDuplicateStripe ()
	An integer property.
PropertyI	getCxpLinkSharingEnable ()
	A boolean property.
PropertyI64	getCxpLinkSharingHorizontalOverlap ()
	An integer property.
PropertyI64	getCxpLinkSharingHorizontalStripeCount ()
	An integer property.
PropertyI64	getCxpLinkSharingSubDeviceSelector ()
	An integer property.
PropertyI64	getCxpLinkSharingSubDeviceType ()
	An enumerated integer property.
PropertyI64	getCxpLinkSharingVerticalOverlap ()
	An integer property.
PropertyI64	getCxpLinkSharingVerticalStripeCount ()
	An integer property.
Method	getCxpPoCxpAuto ()
	A method object.
PropertyI64	getCxpPoCxpStatus ()
	An enumerated integer property.
Method	getCxpPoCxpTripReset ()
	A method object.
Method	getCxpPoCxpTurnOff ()
	A method object.
PropertyI64	getCxpSendReceiveSelector ()
	An enumerated integer property.
PropertyI64	getDeviceTapGeometry ()
	An enumerated integer property.
PropertyS	getGenDCDescriptor ()
	A string property.
PropertyS	getGenDCFlowMappingTable ()
	A string property.
PropertyI64	getGenDCStreamingMode ()
	An enumerated integer property.
PropertyI64	getGenDCStreamingStatus ()
	An enumerated integer property.
PropertyI64	getGevActiveLinkCount ()
	An integer property.
PropertyI64	getGevCCP ()
	An enumerated integer property.
PropertyI64	getGevCurrentDefaultGateway ()
	An integer property.
PropertyI64	getGevCurrentIPAddress ()
	An integer property.
PropertyI	getGevCurrentIPConfigurationDHCP ()
	A boolean property.
PropertyI	getGevCurrentIPConfigurationLLA ()
	A boolean property.
PropertyI	getGevCurrentIPConfigurationPersistentIP ()
	A boolean property.
PropertyI64	getGevCurrentPhysicalLinkConfiguration ()
	An enumerated integer property.
PropertyI64	getGevCurrentSubnetMask ()
	An integer property.
PropertyI64	getGevDeviceClass ()
	An enumerated integer property.
PropertyI64	getGevDeviceModeCharacterSet ()
	An enumerated integer property.
PropertyI	getGevDeviceModeIsBigEndian ()
	A boolean property.
PropertyI64	getGevDiscoveryAckDelay ()
	An integer property.
PropertyS	getGevFirstURL ()
	A string property.
PropertyI	getGevGVCPExtendedStatusCodes ()
	A boolean property.
PropertyI64	getGevGVCPExtendedStatusCodesSelector ()
	An enumerated integer property.
PropertyI	getGevGVCPHeartbeatDisable ()
	A boolean property.
PropertyI	getGevGVCPPendingAck ()
	A boolean property.
PropertyI64	getGevGVCPPendingTimeout ()
	An integer property.
PropertyI64	getGevGVSPExtendedIDMode ()
	An enumerated integer property.
PropertyI64	getGevHeartbeatTimeout ()
	An integer property.
PropertyI	getGevIEEE1588 ()
	A boolean property.
PropertyI64	getGevIEEE1588ClockAccuracy ()
	An enumerated integer property.
PropertyI64	getGevIEEE1588Status ()
	An enumerated integer property.
PropertyI64	getGevInterfaceSelector ()
	An integer property.
PropertyI64	getGevIPConfigurationStatus ()
	An enumerated integer property.
PropertyI64	getGevLinkSpeed ()
	An integer property.
PropertyI64	getGevMACAddress ()
	An integer property.
PropertyI64	getGevMCDA ()
	An integer property.
PropertyI64	getGevMCPHostPort ()
	An integer property.
PropertyI64	getGevMCRC ()
	An integer property.
PropertyI64	getGevMCSP ()
	An integer property.
PropertyI64	getGevMCTT ()
	An integer property.
PropertyI64	getGevMessageChannelCount ()
	An integer property.
PropertyI64	getGevNumberOfInterfaces ()
	An integer property.
PropertyI	getGevPAUSEFrameReception ()
	A boolean property.
PropertyI	getGevPAUSEFrameTransmission ()
	A boolean property.
PropertyI64	getGevPersistentDefaultGateway ()
	An integer property.
PropertyI64	getGevPersistentIPAddress ()
	An integer property.
PropertyI64	getGevPersistentSubnetMask ()
	An integer property.
PropertyI64	getGevPhysicalLinkConfiguration ()
	An enumerated integer property.
PropertyI64	getGevPrimaryApplicationIPAddress ()
	An integer property.
PropertyI64	getGevPrimaryApplicationSocket ()
	An integer property.
PropertyI64	getGevPrimaryApplicationSwitchoverKey ()
	An integer property.
PropertyI	getGevSCCFGAllInTransmission ()
	A boolean property.
PropertyI	getGevSCCFGExtendedChunkData ()
	A boolean property.
PropertyI	getGevSCCFGPacketResendDestination ()
	A boolean property.
PropertyI	getGevSCCFGUnconditionalStreaming ()
	A boolean property.
PropertyI64	getGevSCDA ()
	An integer property.
PropertyI64	getGevSCPD ()
	An integer property.
PropertyI64	getGevSCPDirection ()
	An enumerated integer property.
PropertyI64	getGevSCPHostPort ()
	An integer property.
PropertyI64	getGevSCPInterfaceIndex ()
	An integer property.
PropertyI	getGevSCPSBigEndian ()
	A boolean property.
PropertyI	getGevSCPSDoNotFragment ()
	A boolean property.
PropertyI	getGevSCPSFireTestPacket ()
	A boolean property.
PropertyI64	getGevSCPSPacketSize ()
	An integer property.
PropertyI64	getGevSCSP ()
	An integer property.
PropertyI	getGevSCZoneConfigurationLock ()
	A boolean property.
PropertyI64	getGevSCZoneCount ()
	An integer property.
PropertyI64	getGevSCZoneDirectionAll ()
	An integer property.
PropertyS	getGevSecondURL ()
	A string property.
PropertyI64	getGevStreamChannelCount ()
	An integer property.
PropertyI64	getGevStreamChannelSelector ()
	An integer property.
PropertyI	getGevSupportedOption ()
	A boolean property.
PropertyI64	getGevSupportedOptionSelector ()
	An enumerated integer property.
Method	getGevTimestampControlLatch ()
	A method object.
Method	getGevTimestampControlReset ()
	A method object.
PropertyI64	getGevTimestampTickFrequency ()
	An integer property.
PropertyI64	getGevTimestampValue ()
	An integer property.
PropertyI64	getGevVersionMajor ()
	An integer property.
PropertyI64	getGevVersionMinor ()
	An integer property.
PropertyI64	getMvCurrentUtcOffset ()
	An integer property.
PropertyI64	getMvGevSCBW ()
	An integer property.
PropertyI64	getMvGevSCBWControl ()
	An enumerated integer property.
PropertyI64	getMvPtpClockMode ()
	An enumerated integer property.
PropertyI64	getMvPtpTimescale ()
	An enumerated integer property.
PropertyI64	getMvU3VEndpointResetEventCount ()
	An integer property.
PropertyI64	getMvU3VEndpointRetryEventCount ()
	An integer property.
PropertyI64	getMvU3VEndpointSelector ()
	An enumerated integer property.
Method	getMvU3VErrorCounterReset ()
	A method object.
PropertyI64	getMvU3VLNKErrorCount ()
	An integer property.
PropertyI64	getMvU3VPHYErrorCount ()
	An integer property.
Method	getMvU3VSpreadSpectrumClockingSupportDisable ()
	A method object.
PropertyI64	getPayloadSize ()
	An integer property.
PropertyI64	getPtpClockAccuracy ()
	An enumerated integer property.
PropertyI64	getPtpClockID ()
	An integer property.
Method	getPtpDataSetLatch ()
	A method object.
PropertyI	getPtpEnable ()
	A boolean property.
PropertyI64	getPtpGrandmasterClockID ()
	An integer property.
PropertyI64	getPtpMeanPropagationDelay ()
	An integer property.
PropertyI64	getPtpOffsetFromMaster ()
	An integer property.
PropertyI64	getPtpParentClockID ()
	An integer property.
PropertyI64	getPtpServoStatus ()
	An enumerated integer property.
PropertyI64	getPtpStatus ()
	An enumerated integer property.
long	gevGetEffectiveBytesPerImage (long gevSCPSPacketSizeValue)
	Calculates the effective bytes per block of data (e.g.
long	gevGetEffectiveBytesPerImage (long gevSCPSPacketSizeValue, boolean boExtendedID)
	Calculates the effective bytes per block of data (e.g.
long	gevGetEffectivePayloadPacketsPerImage (long gevSCPSPacketSizeValue)
long	gevGetEffectivePayloadPacketsPerImage (long gevSCPSPacketSizeValue, boolean boExtendedID)
long	gevGetResultingBandwidth (double acquisitionFrameRateValue, long gevSCPSPacketSizeValue)
	Calculates the overall resulting bandwidth (in bytes) needed for GigE Vision data streams when transferring the payload type image.
long	gevGetResultingBandwidth (double acquisitionFrameRateValue, long gevSCPSPacketSizeValue, boolean boExtendedID)
	Calculates the overall resulting bandwidth (in bytes) needed for GigE Vision data streams when transferring the payload type image.
long	gevGetResultingPacketDelay (double acquisitionFrameRateValue, long gevSCPSPacketSizeValue, long gevTimestampTickFrequencyValue, long bandwidthAvailable)
	Calculates the inter-packet delay needed to achieve a uniform packet and thus payload distribution for GigE Vision data streams when transferring the payload type image.
long	gevGetResultingPacketDelay (double acquisitionFrameRateValue, long gevSCPSPacketSizeValue, long gevTimestampTickFrequencyValue, long bandwidthAvailable, boolean boExtendedID)
	Calculates the inter-packet delay needed to achieve a uniform packet and thus payload distribution for GigE Vision data streams when transferring the payload type image.
	TransportLayerControl (Device pDev)
	Constructs a new mvIMPACT.acquire.TransportLayerControl object.
	TransportLayerControl (Device pDev, String settingName)
	Constructs a new mvIMPACT.acquire.TransportLayerControl object.

Static Public Member Functions
static long	gevGetEffectiveBytesPerImage (long gevSCPSPacketSizeValue, long payloadSizeValue)
	Calculates the effective bytes per block of data (e.g.
static long	gevGetEffectiveBytesPerImage (long gevSCPSPacketSizeValue, long payloadSizeValue, boolean boExtendedID)
	Calculates the effective bytes per block of data (e.g.
static long	gevGetEffectivePayloadPacketsPerImage (long gevSCPSPacketSizeValue, long payloadSizeValue)
	Calculates the effective number of payload packets (not including leader and trailer) per block of data (e.g.
static long	gevGetEffectivePayloadPacketsPerImage (long gevSCPSPacketSizeValue, long payloadSizeValue, boolean boExtendedID)
	Calculates the effective number of payload packets (not including leader and trailer) per block of data (e.g.
static long	gevGetResultingBandwidth (double acquisitionFrameRateValue, long gevSCPSPacketSizeValue, long payloadSizeValue)
	Calculates the overall resulting bandwidth (in bytes) needed for GigE Vision data streams when transferring the payload type image.
static long	gevGetResultingBandwidth (double acquisitionFrameRateValue, long gevSCPSPacketSizeValue, long payloadSizeValue, boolean boExtendedID)
	Calculates the overall resulting bandwidth (in bytes) needed for GigE Vision data streams when transferring the payload type image.
static long	gevGetResultingPacketDelay (double acquisitionFrameRateValue, long gevSCPSPacketSizeValue, long payloadSizeValue, long gevTimestampTickFrequencyValue, long bandwidthAvailable)
	Calculates the inter-packet delay needed to achieve a uniform packet and thus payload distribution for GigE Vision data streams when transferring the payload type image.
static long	gevGetResultingPacketDelay (double acquisitionFrameRateValue, long gevSCPSPacketSizeValue, long payloadSizeValue, long gevTimestampTickFrequencyValue, long bandwidthAvailable, boolean boExtendedID)
	Calculates the inter-packet delay needed to achieve a uniform packet and thus payload distribution for GigE Vision data streams when transferring the payload type image.

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

Static Protected Member Functions
static long	swigRelease (TransportLayerControl obj)

Protected Attributes
transient boolean	swigCMemOwn

Detailed Description

Category that contains the transport Layer control features.

A category that contains the transport Layer control features.

Constructor & Destructor Documentation

TransportLayerControl() [1/3]

TransportLayerControl ( long cPtr, boolean cMemoryOwn )

protected

TransportLayerControl() [2/3]

TransportLayerControl	(	Device	pDev,
		String	settingName )

Constructs a new mvIMPACT.acquire.TransportLayerControl object.

Parameters

pDev	[in] A pointer to a mvIMPACT.acquire.Device object obtained from a mvIMPACT.acquire.DeviceManager object.
settingName	[in] 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 mvIMPACT.acquire.FunctionInterface.getAvailableSettings, new settings can be created with the function mvIMPACT.acquire.FunctionInterface.createSetting

TransportLayerControl() [3/3]

TransportLayerControl

(

Device

pDev

)

Constructs a new mvIMPACT.acquire.TransportLayerControl object.

Parameters

pDev

[in] A pointer to a mvIMPACT.acquire.Device object obtained from a mvIMPACT.acquire.DeviceManager object. A list of valid setting names can be obtained by a call to mvIMPACT.acquire.FunctionInterface.getAvailableSettings, new settings can be created with the function mvIMPACT.acquire.FunctionInterface.createSetting

Member Function Documentation

delete()

synchronized void delete

(

)

finalize()

void finalize ( )

protected

getAPAUSEMACCtrlFramesReceived()

PropertyI64 getAPAUSEMACCtrlFramesReceived

(

)

An integer property.

Reports the number of received PAUSE frames.

Reports the number of received PAUSE frames.

getAPAUSEMACCtrlFramesTransmitted()

PropertyI64 getAPAUSEMACCtrlFramesTransmitted

(

)

An integer property.

Reports the number of transmitted PAUSE frames.

Reports the number of transmitted PAUSE frames.

getClConfiguration()

PropertyI64 getClConfiguration

(

)

An enumerated integer property.

This Camera Link specific feature describes the configuration used by the camera.

This Camera Link specific feature describes the configuration used by the camera. It helps especially when a camera is capable of operation in a non-standard configuration, and when the features PixelSize, SensorDigitizationTaps, and DeviceTapGeometry do not provide enough information for interpretation of the image data provided by the camera.

The following string values might be valid for this feature:

• Base (Display string: 'Base'): Standard base configuration described by the Camera Link standard.
• Medium (Display string: 'Medium'): Standard medium configuration described by the Camera Link standard.
• Full (Display string: 'Full'): Standard full configuration described by the Camera Link standard.
• DualBase (Display string: 'Dual Base'): The camera streams the data from multiple taps (that do not fit in the standard base configuration) through two Camera Link base ports. It is responsibility of the application or frame grabber to reconstruct the full image. Only one of the ports (fixed) serves as the 'master' for serial communication and triggering.
• EightyBit (Display string: 'Eighty Bit'): Standard 80-bit configuration with 10 taps of 8 bits or 8 taps of 10 bits, as described by the Camera Link standard.
• Deca (Display string: 'Deca'): This enumeration entry is deprecated. It was used for Deca configuration with 10 taps of 8-bit. Use EightyBit instead.
• Deca (Display string: 'Deca'): This enumeration entry is deprecated. It was used for Deca configuration with 10 taps of 8-bit. Use EightyBit instead.

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.

getClTimeSlotsCount()

PropertyI64 getClTimeSlotsCount

(

)

An enumerated integer property.

This Camera Link specific feature describes the time multiplexing of the camera link connection to transfer more than the configuration allows, in one single clock.

This Camera Link specific feature describes the time multiplexing of the camera link connection to transfer more than the configuration allows, in one single clock.

The following string values might be valid for this feature:

• One (Display string: 'One'): One
• Two (Display string: 'Two'): Two
• Three (Display string: 'Three'): Three

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.

getCxpConnectionSelector()

PropertyI64 getCxpConnectionSelector

(

)

An integer property.

Selects the CoaXPress physical connection to control.

Selects the CoaXPress physical connection to control.

getCxpConnectionTestErrorCount()

PropertyI64 getCxpConnectionTestErrorCount

(

)

An integer property.

Reports the current connection error count for test packets received by the device on the connection selected by CxpConnectionSelector.

Reports the current connection error count for test packets received by the device on the connection selected by CxpConnectionSelector.

getCxpConnectionTestMode()

PropertyI64 getCxpConnectionTestMode

(

)

An enumerated integer property.

Enables the test mode for an individual physical connection of the Device.

Enables the test mode for an individual physical connection of the Device.

The following string values might be valid for this feature:

• Off (Display string: 'Off'): Off
• Mode1 (Display string: 'Mode 1'): Mode 1

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.

getCxpConnectionTestPacketCount()

PropertyI64 getCxpConnectionTestPacketCount

(

)

An integer property.

Reports the current count for the test packets on the connection selected by CxpConnectionSelector.

Reports the current count for the test packets on the connection selected by CxpConnectionSelector.

getCxpErrorCounterReset()

Method getCxpErrorCounterReset

(

)

A method object.

Resets the selected Cxp Error Counter on the connection selected by CxpConnectionSelector.

Resets the selected Cxp Error Counter on the connection selected by CxpConnectionSelector. The counter starts counting events immediately after the reset.

getCxpErrorCounterSelector()

PropertyI64 getCxpErrorCounterSelector

(

)

An enumerated integer property.

Selects which Cxp Error Counter to read or reset.

Selects which Cxp Error Counter to read or reset.

The following string values might be valid for this feature:

• ConnectionLockLoss (Display string: 'Connection Lock Loss'): Counts the number of times the lock was lost.
• Encoding (Display string: 'Encoding'): Counts the number of protocol encoding errors detected.
• StreamDataPacketCrc (Display string: 'Stream Data Packet Crc'): Counts the number of CRC errors detected in a data packet. This counter is only available on the CoaXpress host.
• ControlPacketCrc (Display string: 'Control Packet Crc'): Counts the number of CRC errors detected in a control packet.
• EventPacketCrc (Display string: 'Event Packet Crc'): Counts the number of CRC errors detected in an event packet.
• DuplicatedCharactersCorrected (Display string: 'Duplicated Characters Corrected'): Counts the number of corrected errors in the duplicated characters in CXP control words.
• DuplicatedCharactersUncorrected (Display string: 'Duplicated Characters Uncorrected'): Counts the number of uncorrected errors in the duplicated characters in CXP control words.

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.

getCxpErrorCounterStatus()

PropertyI64 getCxpErrorCounterStatus

(

)

An enumerated integer property.

Returns the current status of the selected Cxp Error Counter on the connection selected by CxpConnectionSelector.

Returns the current status of the selected Cxp Error Counter on the connection selected by CxpConnectionSelector.

The following string values might be valid for this feature:

• CounterActive (Display string: 'Counter Active'): The counter is actively counting errors.
• CounterOverflow (Display string: 'Counter Overflow'): The counter exceeded its maximum error count.

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.

getCxpErrorCounterValue()

PropertyI64 getCxpErrorCounterValue

(

)

An integer property.

Reads the current value of the selected Cxp Error Counter on the connection selected by CxpConnectionSelector.

Reads the current value of the selected Cxp Error Counter on the connection selected by CxpConnectionSelector.

getCxpFirstLineTriggerWithFrameStart()

PropertyI getCxpFirstLineTriggerWithFrameStart

(

)

A boolean property.

Specifies if a FrameStart trigger also triggers the first LineStart at the same time.

Specifies if a FrameStart trigger also triggers the first LineStart at the same time.

getCxpLinkConfiguration()

PropertyI64 getCxpLinkConfiguration

(

)

An enumerated integer property.

This feature allows specifying the Link configuration for the communication between the Receiver and Transmitter Device.

This feature allows specifying the Link configuration for the communication between the Receiver and Transmitter Device. In most cases this feature does not need to be written because automatic discovery will set configuration correctly to the value returned by CxpLinkConfigurationPreferred. Note that the currently active configuration of the Link can be read using CxpLinkConfigurationStatus.

The following string values might be valid for this feature:

• Auto (Display string: 'Auto'): Sets Automatic discovery for the Link Configuration.
• CXP1_X1 (Display string: 'CXP 1 X 1'): Force the Link to 1 Connection operating at CXP-1 speed (1.25 Gbps).
• CXP2_X1 (Display string: 'CXP 2 X 1'): Force the Link to 1 Connection operating at CXP-2 speed (2.50 Gbps).
• CXP3_X1 (Display string: 'CXP 3 X 1'): Force the Link to 1 Connection operating at CXP-3 speed (3.125 Gbps).
• CXP5_X1 (Display string: 'CXP 5 X 1'): Force the Link to 1 Connection operating at CXP-5 speed (5.00 Gbps).
• CXP6_X1 (Display string: 'CXP 6 X 1'): Force the Link to 1 Connection operating at CXP-6 speed (6.25 Gbps).
• CXP10_X1 (Display string: 'CXP 10 X 1'): Force the Link to 1 Connection operating at CXP-10 speed (10.00 Gbps).
• CXP12_X1 (Display string: 'CXP 12 X 1'): Force the Link to 1 Connection operating at CXP-12 speed (12.50 Gbps).
• CXP25_X1 (Display string: 'CXP 25 X 1'): Force the Link to 1 Connection operating at CXP-25 speed (25.78125 Gbps).
• CXP1_X2 (Display string: 'CXP 1 X 2'): Force the Link to 2 Connections operating at CXP-1 speed (1.25 Gbps).
• CXP2_X2 (Display string: 'CXP 2 X 2'): Force the Link to 2 Connections operating at CXP-2 speed (2.50 Gbps).
• CXP3_X2 (Display string: 'CXP 3 X 2'): Force the Link to 2 Connections operating at CXP-3 speed (3.125 Gbps).
• CXP5_X2 (Display string: 'CXP 5 X 2'): Force the Link to 2 Connections operating at CXP-5 speed (5.00 Gbps).
• CXP6_X2 (Display string: 'CXP 6 X 2'): Force the Link to 2 Connections operating at CXP-6 speed (6.25 Gbps).
• CXP10_X2 (Display string: 'CXP 10 X 2'): Force the Link to 2 Connections operating at CXP-10 speed (10.00 Gbps).
• CXP12_X2 (Display string: 'CXP 12 X 2'): Force the Link to 2 Connections operating at CXP-12 speed (12.50 Gbps).
• CXP25_X2 (Display string: 'CXP 25 X 2'): Force the Link to 2 Connections operating at CXP-25 speed (25.78125 Gbps).
• CXP1_X4 (Display string: 'CXP 1 X 4'): Force the Link to 4 Connections operating at CXP-1 speed (1.25 Gbps).
• CXP2_X4 (Display string: 'CXP 2 X 4'): Force the Link to 4 Connections operating at CXP-2 speed (2.50 Gbps).
• CXP3_X4 (Display string: 'CXP 3 X 4'): Force the Link to 4 Connections operating at CXP-3 speed (3.125 Gbps).
• CXP5_X4 (Display string: 'CXP 5 X 4'): Force the Link to 4 Connections operating at CXP-5 speed (5.00 Gbps).
• CXP6_X4 (Display string: 'CXP 6 X 4'): Force the Link to 4 Connections operating at CXP-6 speed (6.25 Gbps).
• CXP10_X4 (Display string: 'CXP 10 X 4'): Force the Link to 4 Connections operating at CXP-10 speed (10.00 Gbps).
• CXP12_X4 (Display string: 'CXP 12 X 4'): Force the Link to 4 Connections operating at CXP-12 speed (12.50 Gbps).
• CXP25_X4 (Display string: 'CXP 25 X 4'): Force the Link to 4 Connections operating at CXP-25 speed (25.78125 Gbps).
• CXP1_X8 (Display string: 'CXP 1 X 8'): Force the Link to 8 Connections operating at CXP-1 speed (1.25 Gbps).
• CXP2_X8 (Display string: 'CXP 2 X 8'): Force the Link to 8 Connections operating at CXP-2 speed (2.50 Gbps).
• CXP3_X8 (Display string: 'CXP 3 X 8'): Force the Link to 8 Connections operating at CXP-3 speed (3.125 Gbps).
• CXP5_X8 (Display string: 'CXP 5 X 8'): Force the Link to 8 Connections operating at CXP-5 speed (5.00 Gbps).
• CXP6_X8 (Display string: 'CXP 6 X 8'): Force the Link to 8 Connections operating at CXP-6 speed (6.25 Gbps).
• CXP10_X8 (Display string: 'CXP 10 X 8'): Force the Link to 8 Connections operating at CXP-10 speed (10.00 Gbps).
• CXP12_X8 (Display string: 'CXP 12 X 8'): Force the Link to 8 Connections operating at CXP-12 speed (12.50 Gbps).
• CXP25_X8 (Display string: 'CXP 25 X 8'): Force the Link to 8 Connections operating at CXP-25 speed (25.78125 Gbps).
• CXP1_X3 (Display string: 'CXP 1 X 3')
• CXP2_X3 (Display string: 'CXP 2 X 3')
• CXP3_X3 (Display string: 'CXP 3 X 3')
• CXP5_X3 (Display string: 'CXP 5 X 3')
• CXP6_X3 (Display string: 'CXP 6 X 3')
• CXP10_X3 (Display string: 'CXP 10 X 3')
• CXP12_X3 (Display string: 'CXP 12 X 3')
• CXP1_X5 (Display string: 'CXP 1 X 5')
• CXP2_X5 (Display string: 'CXP 2 X 5')
• CXP3_X5 (Display string: 'CXP 3 X 5')
• CXP5_X5 (Display string: 'CXP 5 X 5')
• CXP6_X5 (Display string: 'CXP 6 X 5')
• CXP10_X5 (Display string: 'CXP 10 X 5')
• CXP12_X5 (Display string: 'CXP 12 X 5')
• CXP1_X6 (Display string: 'CXP 1 X 6')
• CXP2_X6 (Display string: 'CXP 2 X 6')
• CXP3_X6 (Display string: 'CXP 3 X 6')
• CXP5_X6 (Display string: 'CXP 5 X 6')
• CXP6_X6 (Display string: 'CXP 6 X 6')
• CXP10_X6 (Display string: 'CXP 10 X 6')
• CXP12_X6 (Display string: 'CXP 12 X 6')

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.

getCxpLinkConfigurationPreferred()

PropertyI64 getCxpLinkConfigurationPreferred

(

)

An enumerated integer property.

Provides the Link configuration that allows the Transmitter Device to operate in its default mode.

Provides the Link configuration that allows the Transmitter Device to operate in its default mode.

The following string values might be valid for this feature:

• CXP1_X1 (Display string: 'CXP 1 X 1'): 1 Connection operating at CXP-1 speed (1.25 Gbps).
• CXP2_X1 (Display string: 'CXP 2 X 1'): 1 Connection operating at CXP-2 speed (2.50 Gbps).
• CXP3_X1 (Display string: 'CXP 3 X 1'): 1 Connection operating at CXP-3 speed (3.125 Gbps).
• CXP5_X1 (Display string: 'CXP 5 X 1'): 1 Connection operating at CXP-5 speed (5.00 Gbps).
• CXP6_X1 (Display string: 'CXP 6 X 1'): 1 Connection operating at CXP-6 speed (6.25 Gbps).
• CXP10_X1 (Display string: 'CXP 10 X 1'): 1 Connection operating at CXP-10 speed (10.00 Gbps).
• CXP12_X1 (Display string: 'CXP 12 X 1'): 1 Connection operating at CXP-12 speed (12.50 Gbps).
• CXP25_X1 (Display string: 'CXP 25 X 1'): 1 Connection operating at CXP-25 speed (25.78125 Gbps).
• CXP1_X2 (Display string: 'CXP 1 X 2'): 2 Connections operating at CXP-1 speed (1.25 Gbps).
• CXP2_X2 (Display string: 'CXP 2 X 2'): 2 Connections operating at CXP-2 speed (2.50 Gbps).
• CXP3_X2 (Display string: 'CXP 3 X 2'): 2 Connections operating at CXP-3 speed (3.125 Gbps).
• CXP5_X2 (Display string: 'CXP 5 X 2'): 2 Connections operating at CXP-5 speed (5.00 Gbps).
• CXP6_X2 (Display string: 'CXP 6 X 2'): 2 Connections operating at CXP-6 speed (6.25 Gbps).
• CXP10_X2 (Display string: 'CXP 10 X 2'): 2 Connections operating at CXP-10 speed (10.00 Gbps).
• CXP12_X2 (Display string: 'CXP 12 X 2'): 2 Connections operating at CXP-12 speed (12.50 Gbps).
• CXP25_X2 (Display string: 'CXP 25 X 2'): 2 Connections operating at CXP-25 speed (25.78125 Gbps).
• CXP1_X4 (Display string: 'CXP 1 X 4'): 4 Connections operating at CXP-1 speed (1.25 Gbps).
• CXP2_X4 (Display string: 'CXP 2 X 4'): 4 Connections operating at CXP-2 speed (2.50 Gbps).
• CXP3_X4 (Display string: 'CXP 3 X 4'): 4 Connections operating at CXP-3 speed (3.125 Gbps).
• CXP5_X4 (Display string: 'CXP 5 X 4'): 4 Connections operating at CXP-5 speed (5.00 Gbps).
• CXP6_X4 (Display string: 'CXP 6 X 4'): 4 Connections operating at CXP-6 speed (6.25 Gbps).
• CXP10_X4 (Display string: 'CXP 10 X 4'): 4 Connections operating at CXP-10 speed (10.00 Gbps).
• CXP12_X4 (Display string: 'CXP 12 X 4'): 4 Connections operating at CXP-12 speed (12.50 Gbps).
• CXP25_X4 (Display string: 'CXP 25 X 4'): 4 Connections operating at CXP-25 speed (25.78125 Gbps).
• CXP1_X8 (Display string: 'CXP 1 X 8'): 8 Connections operating at CXP-1 speed (1.25 Gbps).
• CXP2_X8 (Display string: 'CXP 2 X 8'): 8 Connections operating at CXP-2 speed (2.50 Gbps).
• CXP3_X8 (Display string: 'CXP 3 X 8'): 8 Connections operating at CXP-3 speed (3.125 Gbps).
• CXP5_X8 (Display string: 'CXP 5 X 8'): 8 Connections operating at CXP-5 speed (5.00 Gbps).
• CXP6_X8 (Display string: 'CXP 6 X 8'): 8 Connections operating at CXP-6 speed (6.25 Gbps).
• CXP10_X8 (Display string: 'CXP 10 X 8'): 8 Connections operating at CXP-10 speed (10.00 Gbps).
• CXP12_X8 (Display string: 'CXP 12 X 8'): 8 Connections operating at CXP-12 speed (12.50 Gbps).
• CXP25_X8 (Display string: 'CXP 25 X 8'): 8 Connections operating at CXP-25 speed (25.78125 Gbps).
• CXP1_X3 (Display string: 'CXP 1 X 3')
• CXP2_X3 (Display string: 'CXP 2 X 3')
• CXP3_X3 (Display string: 'CXP 3 X 3')
• CXP5_X3 (Display string: 'CXP 5 X 3')
• CXP6_X3 (Display string: 'CXP 6 X 3')
• CXP10_X3 (Display string: 'CXP 10 X 3')
• CXP12_X3 (Display string: 'CXP 12 X 3')
• CXP1_X5 (Display string: 'CXP 1 X 5')
• CXP2_X5 (Display string: 'CXP 2 X 5')
• CXP3_X5 (Display string: 'CXP 3 X 5')
• CXP5_X5 (Display string: 'CXP 5 X 5')
• CXP6_X5 (Display string: 'CXP 6 X 5')
• CXP10_X5 (Display string: 'CXP 10 X 5')
• CXP12_X5 (Display string: 'CXP 12 X 5')
• CXP1_X6 (Display string: 'CXP 1 X 6')
• CXP2_X6 (Display string: 'CXP 2 X 6')
• CXP3_X6 (Display string: 'CXP 3 X 6')
• CXP5_X6 (Display string: 'CXP 5 X 6')
• CXP6_X6 (Display string: 'CXP 6 X 6')
• CXP10_X6 (Display string: 'CXP 10 X 6')
• CXP12_X6 (Display string: 'CXP 12 X 6')

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.

getCxpLinkConfigurationStatus()

PropertyI64 getCxpLinkConfigurationStatus

(

)

An enumerated integer property.

This feature indicates the current and active Link configuration used by the Device.

This feature indicates the current and active Link configuration used by the Device.

The following string values might be valid for this feature:

• None (Display string: 'None'): The Link configuration of the Device is unknown. Either the configuration operation has failed or there is nothing connected.
• Pending (Display string: 'Pending'): The Device is in the process of configuring the Link. The Link cannot be used yet.
• CXP1_X1 (Display string: 'CXP 1 X 1'): 1 Connection operating at CXP-1 speed (1.25 Gbps).
• CXP2_X1 (Display string: 'CXP 2 X 1'): 1 Connection operating at CXP-2 speed (2.50 Gbps).
• CXP3_X1 (Display string: 'CXP 3 X 1'): 1 Connection operating at CXP-3 speed (3.125 Gbps).
• CXP5_X1 (Display string: 'CXP 5 X 1'): 1 Connection operating at CXP-5 speed (5.00 Gbps).
• CXP6_X1 (Display string: 'CXP 6 X 1'): 1 Connection operating at CXP-6 speed (6.25 Gbps).
• CXP10_X1 (Display string: 'CXP 10 X 1'): 1 Connection operating at CXP-10 speed (10.00 Gbps).
• CXP12_X1 (Display string: 'CXP 12 X 1'): 1 Connection operating at CXP-12 speed (12.50 Gbps).
• CXP25_X1 (Display string: 'CXP 25 X 1'): 1 Connection operating at CXP-25 speed (25.78125 Gbps).
• CXP1_X2 (Display string: 'CXP 1 X 2'): 2 Connections operating at CXP-1 speed (1.25 Gbps).
• CXP2_X2 (Display string: 'CXP 2 X 2'): 2 Connections operating at CXP-2 speed (2.50 Gbps).
• CXP3_X2 (Display string: 'CXP 3 X 2'): 2 Connections operating at CXP-3 speed (3.125 Gbps).
• CXP5_X2 (Display string: 'CXP 5 X 2'): 2 Connections operating at CXP-5 speed (5.00 Gbps).
• CXP6_X2 (Display string: 'CXP 6 X 2'): 2 Connections operating at CXP-6 speed (6.25 Gbps).
• CXP10_X2 (Display string: 'CXP 10 X 2'): 2 Connections operating at CXP-10 speed (10.00 Gbps).
• CXP12_X2 (Display string: 'CXP 12 X 2'): 2 Connections operating at CXP-12 speed (12.50 Gbps).
• CXP25_X2 (Display string: 'CXP 25 X 2'): 2 Connections operating at CXP-25 speed (25.78125 Gbps).
• CXP1_X4 (Display string: 'CXP 1 X 4'): 4 Connections operating at CXP-1 speed (1.25 Gbps).
• CXP2_X4 (Display string: 'CXP 2 X 4'): 4 Connections operating at CXP-2 speed (2.50 Gbps).
• CXP3_X4 (Display string: 'CXP 3 X 4'): 4 Connections operating at CXP-3 speed (3.125 Gbps).
• CXP5_X4 (Display string: 'CXP 5 X 4'): 4 Connections operating at CXP-5 speed (5.00 Gbps).
• CXP6_X4 (Display string: 'CXP 6 X 4'): 4 Connections operating at CXP-6 speed (6.25 Gbps).
• CXP10_X4 (Display string: 'CXP 10 X 4'): 4 Connections operating at CXP-10 speed (10.00 Gbps).
• CXP12_X4 (Display string: 'CXP 12 X 4'): 4 Connections operating at CXP-12 speed (12.50 Gbps).
• CXP25_X4 (Display string: 'CXP 25 X 4'): 4 Connections operating at CXP-25 speed (25.78125 Gbps).
• CXP1_X8 (Display string: 'CXP 1 X 8'): 8 Connections operating at CXP-1 speed (1.25 Gbps).
• CXP2_X8 (Display string: 'CXP 2 X 8'): 8 Connections operating at CXP-2 speed (2.50 Gbps).
• CXP3_X8 (Display string: 'CXP 3 X 8'): 8 Connections operating at CXP-3 speed (3.125 Gbps).
• CXP5_X8 (Display string: 'CXP 5 X 8'): 8 Connections operating at CXP-5 speed (5.00 Gbps).
• CXP6_X8 (Display string: 'CXP 6 X 8'): 8 Connections operating at CXP-6 speed (6.25 Gbps).
• CXP10_X8 (Display string: 'CXP 10 X 8'): 8 Connections operating at CXP-10 speed (10.00 Gbps).
• CXP12_X8 (Display string: 'CXP 12 X 8'): 8 Connections operating at CXP-12 speed (12.50 Gbps).
• CXP25_X8 (Display string: 'CXP 25 X 8'): 8 Connections operating at CXP-25 speed (25.78125 Gbps).

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.

getCxpLinkSharingDuplicateStripe()

PropertyI64 getCxpLinkSharingDuplicateStripe

(

)

An integer property.

This feature provides the duplicate count in striped system.

This feature provides the duplicate count in striped system. A non-zero value sets the number of duplicate images sent to sub-Devices.

getCxpLinkSharingEnable()

PropertyI getCxpLinkSharingEnable

(

)

A boolean property.

Enable or disable the link sharing functionality of the device.

Enable or disable the link sharing functionality of the device.

getCxpLinkSharingHorizontalOverlap()

PropertyI64 getCxpLinkSharingHorizontalOverlap

(

)

An integer property.

This feature provides the number of pixel overlap in the horizontal stripes that the device implements.

This feature provides the number of pixel overlap in the horizontal stripes that the device implements.

getCxpLinkSharingHorizontalStripeCount()

PropertyI64 getCxpLinkSharingHorizontalStripeCount

(

)

An integer property.

This feature provides the number of horizontal stripes that the device implements.

This feature provides the number of horizontal stripes that the device implements.

getCxpLinkSharingSubDeviceSelector()

PropertyI64 getCxpLinkSharingSubDeviceSelector

(

)

An integer property.

Index of the sub device used in the Link Sharing.

Index of the sub device used in the Link Sharing.

getCxpLinkSharingSubDeviceType()

PropertyI64 getCxpLinkSharingSubDeviceType

(

)

An enumerated integer property.

This feature provides the type of sub device.

This feature provides the type of sub device.

The following string values might be valid for this feature:

• Master (Display string: 'Master'): The sub device is the master.
• Slave (Display string: 'Slave'): The sub device is a slave.

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.

getCxpLinkSharingVerticalOverlap()

PropertyI64 getCxpLinkSharingVerticalOverlap

(

)

An integer property.

This feature provides the number of pixel overlap in the vertical stripes that the device implements.

This feature provides the number of pixel overlap in the vertical stripes that the device implements.

getCxpLinkSharingVerticalStripeCount()

PropertyI64 getCxpLinkSharingVerticalStripeCount

(

)

An integer property.

This feature provides the number of vertical stripes that the device implements.

This feature provides the number of vertical stripes that the device implements.

getCxpPoCxpAuto()

Method getCxpPoCxpAuto

(

)

A method object.

Activate automatic control of the Power over CoaXPress (PoCXP) for the Link.

Activate automatic control of the Power over CoaXPress (PoCXP) for the Link.

getCxpPoCxpStatus()

PropertyI64 getCxpPoCxpStatus

(

)

An enumerated integer property.

Returns the Power over CoaXPress (PoCXP) status of the Device.

Returns the Power over CoaXPress (PoCXP) status of the Device.

The following string values might be valid for this feature:

• Auto (Display string: 'Auto'): Normal automatic PoCXP operation.
• Off (Display string: 'Off'): PoCXP is forced off.
• Tripped (Display string: 'Tripped'): The Link has shut down because of an over-current trip.

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.

getCxpPoCxpTripReset()

Method getCxpPoCxpTripReset

(

)

A method object.

Reset the Power over CoaXPress (PoCXP) Link after an over-current trip on the Device connection(s).

Reset the Power over CoaXPress (PoCXP) Link after an over-current trip on the Device connection(s).

getCxpPoCxpTurnOff()

Method getCxpPoCxpTurnOff

(

)

A method object.

Disable Power over CoaXPress (PoCXP) for the Link.

Disable Power over CoaXPress (PoCXP) for the Link.

getCxpSendReceiveSelector()

PropertyI64 getCxpSendReceiveSelector

(

)

An enumerated integer property.

Selects which one of the send or receive features to control.

Selects which one of the send or receive features to control.

The following string values might be valid for this feature:

• Send (Display string: 'Send'): Send
• Receive (Display string: 'Receive'): Receive

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.

getDeviceTapGeometry()

PropertyI64 getDeviceTapGeometry

(

)

An enumerated integer property.

This device tap geometry feature describes the geometrical properties characterizing the taps of a camera as presented at the output of the device.

This device tap geometry feature describes the geometrical properties characterizing the taps of a camera as presented at the output of the device.

The following string values might be valid for this feature:

• Geometry_1X_1Y (Display string: 'Geometry_1X_1Y'): Geometry_1X_1Y
• Geometry_1X2_1Y (Display string: 'Geometry_1X2_1Y'): Geometry_1X2_1Y
• Geometry_1X2_1Y2 (Display string: 'Geometry_1X2_1Y2'): Geometry_1X2_1Y2
• Geometry_2X_1Y (Display string: 'Geometry_2X_1Y'): Geometry_2X_1Y
• Geometry_2X_1Y2 (Display string: 'Geometry_2X_1Y2'): Geometry_2X_1Y2
• Geometry_2XE_1Y (Display string: 'Geometry_2XE_1Y'): Geometry_2XE_1Y
• Geometry_2XE_1Y2 (Display string: 'Geometry_2XE_1Y2'): Geometry_2XE_1Y2
• Geometry_2XM_1Y (Display string: 'Geometry_2XM_1Y'): Geometry_2XM_1Y
• Geometry_2XM_1Y2 (Display string: 'Geometry_2XM_1Y2'): Geometry_2XM_1Y2
• Geometry_1X_1Y2 (Display string: 'Geometry_1X_1Y2'): Geometry_1X_1Y2
• Geometry_1X_2YE (Display string: 'Geometry_1X_2YE'): Geometry_1X_2YE
• Geometry_1X3_1Y (Display string: 'Geometry_1X3_1Y'): Geometry_1X3_1Y
• Geometry_3X_1Y (Display string: 'Geometry_3X_1Y'): Geometry_3X_1Y
• Geometry_1X (Display string: 'Geometry_1X'): Geometry_1X
• Geometry_1X2 (Display string: 'Geometry_1X2'): Geometry_1X2
• Geometry_2X (Display string: 'Geometry_2X'): Geometry_2X
• Geometry_2XE (Display string: 'Geometry_2XE'): Geometry_2XE
• Geometry_2XM (Display string: 'Geometry_2XM'): Geometry_2XM
• Geometry_1X3 (Display string: 'Geometry_1X3'): Geometry_1X3
• Geometry_3X (Display string: 'Geometry_3X'): Geometry_3X
• Geometry_1X4_1Y (Display string: 'Geometry_1X4_1Y'): Geometry_1X4_1Y
• Geometry_4X_1Y (Display string: 'Geometry_4X_1Y'): Geometry_4X_1Y
• Geometry_2X2_1Y (Display string: 'Geometry_2X2_1Y'): Geometry_2X2_1Y
• Geometry_2X2E_1Y (Display string: 'Geometry_2X2E_1Y'): Geometry_2X2E_1Y
• Geometry_2X2M_1Y (Display string: 'Geometry_2X2M_1Y'): Geometry_2X2M_1Y
• Geometry_1X2_2YE (Display string: 'Geometry_1X2_2YE'): Geometry_1X2_2YE
• Geometry_2X_2YE (Display string: 'Geometry_2X_2YE'): Geometry_2X_2YE
• Geometry_2XE_2YE (Display string: 'Geometry_2XE_2YE'): Geometry_2XE_2YE
• Geometry_2XM_2YE (Display string: 'Geometry_2XM_2YE'): Geometry_2XM_2YE
• Geometry_1X4 (Display string: 'Geometry_1X4'): Geometry_1X4
• Geometry_4X (Display string: 'Geometry_4X'): Geometry_4X
• Geometry_2X2 (Display string: 'Geometry_2X2'): Geometry_2X2
• Geometry_2X2E (Display string: 'Geometry_2X2E'): Geometry_2X2E
• Geometry_2X2M (Display string: 'Geometry_2X2M'): Geometry_2X2M
• Geometry_1X8_1Y (Display string: 'Geometry_1X8_1Y'): Geometry_1X8_1Y
• Geometry_8X_1Y (Display string: 'Geometry_8X_1Y'): Geometry_8X_1Y
• Geometry_4X2_1Y (Display string: 'Geometry_4X2_1Y'): Geometry_4X2_1Y
• Geometry_2X2E_2YE (Display string: 'Geometry_2X2E_2YE'): Geometry_2X2E_2YE
• Geometry_1X8 (Display string: 'Geometry_1X8'): Geometry_1X8
• Geometry_8X (Display string: 'Geometry_8X'): Geometry_8X
• Geometry_4X2 (Display string: 'Geometry_4X2'): Geometry_4X2
• Geometry_4X2E (Display string: 'Geometry_4X2E'): Geometry_4X2E
• Geometry_4X2E_1Y (Display string: 'Geometry_4X2E_1Y'): Geometry_4X2E_1Y
• Geometry_1X10_1Y (Display string: 'Geometry_1X10_1Y'): Geometry_1X10_1Y
• Geometry_10X_1Y (Display string: 'Geometry_10X_1Y'): Geometry_10X_1Y
• Geometry_1X10 (Display string: 'Geometry_1X10'): Geometry_1X10
• Geometry_10X (Display string: 'Geometry_10X'): Geometry_10X

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.

getGenDCDescriptor()

PropertyS getGenDCDescriptor

(

)

A string property.

Returns a preliminary GenDC Descriptor that can be used as reference for the data Container to be streamed out by the device in its current configuration.

Returns a preliminary GenDC Descriptor that can be used as reference for the data Container to be streamed out by the device in its current configuration. This information can be used to set up the receiver in advance to be ready for the data Containers to come.

getGenDCFlowMappingTable()

PropertyS getGenDCFlowMappingTable

(

)

A string property.

Returns the GenDC Container data Flow mapping table that will be used to transport the GenDC Container.

Returns the GenDC Container data Flow mapping table that will be used to transport the GenDC Container.

getGenDCStreamingMode()

PropertyI64 getGenDCStreamingMode

(

)

An enumerated integer property.

Controls the device's streaming format.

Controls the device's streaming format.

The following string values might be valid for this feature:

• Off (Display string: 'Off'): The device will only stream data in its native format.
• On (Display string: 'On'): The device will stream all its data in the generic GenDC format.
• Automatic (Display string: 'Automatic'): The device will automatically choose in which format it streams its data.

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.

getGenDCStreamingStatus()

PropertyI64 getGenDCStreamingStatus

(

)

An enumerated integer property.

Returns whether the current device data streaming format is GenDC.

Returns whether the current device data streaming format is GenDC. This value is conditioned by the GenDCStreamingMode.

The following string values might be valid for this feature:

• Off (Display string: 'Off'): The device will only stream data in its native format.
• On (Display string: 'On'): The device will stream all its data in the generic GenDC format.

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.

getGevActiveLinkCount()

PropertyI64 getGevActiveLinkCount

(

)

An integer property.

Indicates the current number of active logical links.

Indicates the current number of active logical links.

getGevCCP()

PropertyI64 getGevCCP

(

)

An enumerated integer property.

Controls the device access privilege of an application.

Controls the device access privilege of an application.

The following string values might be valid for this feature:

• OpenAccess (Display string: 'Open Access'): Open Access
• ExclusiveAccess (Display string: 'Exclusive Access'): Exclusive Access
• ControlAccess (Display string: 'Control Access'): Control Access
• ControlAccessSwitchoverActive (Display string: 'Control Access Switchover Active'): Control Access Switchover Active

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.

getGevCurrentDefaultGateway()

PropertyI64 getGevCurrentDefaultGateway

(

)

An integer property.

Reports the default gateway IP address of the given logical link.

Reports the default gateway IP address of the given logical link.

getGevCurrentIPAddress()

PropertyI64 getGevCurrentIPAddress

(

)

An integer property.

Reports the IP address for the given logical link.

Reports the IP address for the given logical link.

getGevCurrentIPConfigurationDHCP()

PropertyI getGevCurrentIPConfigurationDHCP

(

)

A boolean property.

Controls whether the DHCP IP configuration scheme is activated on the given logical link.

Controls whether the DHCP IP configuration scheme is activated on the given logical link.

getGevCurrentIPConfigurationLLA()

PropertyI getGevCurrentIPConfigurationLLA

(

)

A boolean property.

Controls whether the Link Local Address IP configuration scheme is activated on the given logical link.

Controls whether the Link Local Address IP configuration scheme is activated on the given logical link.

getGevCurrentIPConfigurationPersistentIP()

PropertyI getGevCurrentIPConfigurationPersistentIP

(

)

A boolean property.

Controls whether the PersistentIP configuration scheme is activated on the given logical link.

Controls whether the PersistentIP configuration scheme is activated on the given logical link.

getGevCurrentPhysicalLinkConfiguration()

PropertyI64 getGevCurrentPhysicalLinkConfiguration

(

)

An enumerated integer property.

Indicates the current physical link configuration of the device.

Indicates the current physical link configuration of the device.

The following string values might be valid for this feature:

• SingleLink (Display string: 'Single Link'): Single Link
• MultiLink (Display string: 'Multi Link'): Multi Link
• StaticLAG (Display string: 'Static LAG'): Static LAG
• DynamicLAG (Display string: 'Dynamic LAG'): Dynamic LAG

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.

getGevCurrentSubnetMask()

PropertyI64 getGevCurrentSubnetMask

(

)

An integer property.

Reports the subnet mask of the given logical link.

Reports the subnet mask of the given logical link.

getGevDeviceClass()

PropertyI64 getGevDeviceClass

(

)

An enumerated integer property.

This feature is deprecated (See DeviceType).

Deprecated

This feature is deprecated (See DeviceType). It was representing the class of the device.

The following string values might be valid for this feature:

• Transmitter (Display string: 'Transmitter'): Transmitter
• Receiver (Display string: 'Receiver'): Receiver
• Transceiver (Display string: 'Transceiver'): Transceiver
• Peripheral (Display string: 'Peripheral'): Peripheral

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.

getGevDeviceModeCharacterSet()

PropertyI64 getGevDeviceModeCharacterSet

(

)

An enumerated integer property.

This feature is deprecated (See DeviceCharacterSet).

Deprecated

This feature is deprecated (See DeviceCharacterSet). It was representing the character set used by all the strings of the device.

The following string values might be valid for this feature:

• UTF8 (Display string: 'UTF 8'): UTF 8

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.

getGevDeviceModeIsBigEndian()

PropertyI getGevDeviceModeIsBigEndian

(

)

A boolean property.

This feature is deprecated (See DeviceRegistersEndianness).

Deprecated

This feature is deprecated (See DeviceRegistersEndianness). It was representing the Endianness of the device registers.

getGevDiscoveryAckDelay()

PropertyI64 getGevDiscoveryAckDelay

(

)

An integer property.

Indicates the maximum randomized delay the device will wait to acknowledge a discovery command.

Indicates the maximum randomized delay the device will wait to acknowledge a discovery command.

getGevFirstURL()

PropertyS getGevFirstURL

(

)

A string property.

Indicates the first URL to the GenICam XML device description file.

Indicates the first URL to the GenICam XML device description file. The First URL is used as the first choice by the application to retrieve the GenICam XML device description file.

getGevGVCPExtendedStatusCodes()

PropertyI getGevGVCPExtendedStatusCodes

(

)

A boolean property.

Enables the generation of extended status codes.

Enables the generation of extended status codes.

getGevGVCPExtendedStatusCodesSelector()

PropertyI64 getGevGVCPExtendedStatusCodesSelector

(

)

An enumerated integer property.

Selects the GigE Vision version to control extended status codes for.

Selects the GigE Vision version to control extended status codes for.

The following string values might be valid for this feature:

• Version1_1 (Display string: 'Version 1 1'): Version 1 1
• Version2_0 (Display string: 'Version 2 0'): Version 2 0

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.

getGevGVCPHeartbeatDisable()

PropertyI getGevGVCPHeartbeatDisable

(

)

A boolean property.

This feature is deprecated (See DeviceLinkHeartbeatMode).

Deprecated

This feature is deprecated (See DeviceLinkHeartbeatMode). It was used to disable the GVCP heartbeat.

getGevGVCPPendingAck()

PropertyI getGevGVCPPendingAck

(

)

A boolean property.

Enables the generation of PENDING_ACK.

Enables the generation of PENDING_ACK.

getGevGVCPPendingTimeout()

PropertyI64 getGevGVCPPendingTimeout

(

)

An integer property.

This feature is deprecated (See DeviceLinkCommandTimeout).

Deprecated

This feature is deprecated (See DeviceLinkCommandTimeout). It was used to indicate the longest GVCP command execution time before a device returns a PENDING_ACK.

getGevGVSPExtendedIDMode()

PropertyI64 getGevGVSPExtendedIDMode

(

)

An enumerated integer property.

Enables the extended IDs mode.

Enables the extended IDs mode.

The following string values might be valid for this feature:

• Off (Display string: 'Off'): Off
• On (Display string: 'On'): On

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.

getGevHeartbeatTimeout()

PropertyI64 getGevHeartbeatTimeout

(

)

An integer property.

This feature is deprecated (See DeviceLinkHeartbeatTimeout).

Deprecated

This feature is deprecated (See DeviceLinkHeartbeatTimeout). It was controlling the current heartbeat timeout in milliseconds.

getGevIEEE1588()

PropertyI getGevIEEE1588

(

)

A boolean property.

This feature is deprecated (See PtpEnable).

Deprecated

This feature is deprecated (See PtpEnable). It was used to enable the IEEE 1588 Precision Time Protocol to control the timestamp register.

getGevIEEE1588ClockAccuracy()

PropertyI64 getGevIEEE1588ClockAccuracy

(

)

An enumerated integer property.

This feature is deprecated (See PtpClockAccurarcy).

Deprecated

This feature is deprecated (See PtpClockAccurarcy). It was used to indicate the expected accuracy of the device clock when it is the grandmaster, or in the event it becomes the grandmaster.

The following string values might be valid for this feature:

• Within25ns (Display string: 'Within 25ns'): Within 25ns
• Within100ns (Display string: 'Within 100ns'): Within 100ns
• Within250ns (Display string: 'Within 250ns'): Within 250ns
• Within1us (Display string: 'Within 1us'): Within 1us
• Within2p5us (Display string: 'Within 2p 5us'): Within 2p 5us
• Within10us (Display string: 'Within 10us'): Within 10us
• Within25us (Display string: 'Within 25us'): Within 25us
• Within100us (Display string: 'Within 100us'): Within 100us
• Within250us (Display string: 'Within 250us'): Within 250us
• Within1ms (Display string: 'Within 1ms'): Within 1ms
• Within2p5ms (Display string: 'Within 2p 5ms'): Within 2p 5ms
• Within10ms (Display string: 'Within 10ms'): Within 10ms
• Within25ms (Display string: 'Within 25ms'): Within 25ms
• Within100ms (Display string: 'Within 100ms'): Within 100ms
• Within250ms (Display string: 'Within 250ms'): Within 250ms
• Within1s (Display string: 'Within 1s'): Within 1s
• Within10s (Display string: 'Within 10s'): Within 10s
• GreaterThan10s (Display string: 'Greater Than 10s'): Greater Than 10s
• AlternatePTPProfile (Display string: 'Alternate PTP Profile'): Alternate PTP Profile
• Unknown (Display string: 'Unknown'): Unknown
• Reserved (Display string: 'Reserved'): Reserved

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.

getGevIEEE1588Status()

PropertyI64 getGevIEEE1588Status

(

)

An enumerated integer property.

This feature is deprecated (See PtpStatus).

Deprecated

This feature is deprecated (See PtpStatus). It was used to Provide the status of the IEEE 1588 clock.

The following string values might be valid for this feature:

• Initializing (Display string: 'Initializing'): Initializing
• Faulty (Display string: 'Faulty'): Faulty
• Disabled (Display string: 'Disabled'): Disabled
• Listening (Display string: 'Listening'): Listening
• PreMaster (Display string: 'Pre Master'): Pre Master
• Master (Display string: 'Master'): Master
• Passive (Display string: 'Passive'): Passive
• Uncalibrated (Display string: 'Uncalibrated'): Uncalibrated
• Slave (Display string: 'Slave'): Slave

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.

getGevInterfaceSelector()

PropertyI64 getGevInterfaceSelector

(

)

An integer property.

Selects which logical link to control.

Selects which logical link to control.

getGevIPConfigurationStatus()

PropertyI64 getGevIPConfigurationStatus

(

)

An enumerated integer property.

Reports the current IP configuration status.

Reports the current IP configuration status.

The following string values might be valid for this feature:

• None (Display string: 'None'): None
• PersistentIP (Display string: 'Persistent IP'): Persistent IP
• DHCP (Display string: 'DHCP'): DHCP
• LLA (Display string: 'LLA'): LLA
• ForceIP (Display string: 'Force IP'): Force IP

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.

getGevLinkSpeed()

PropertyI64 getGevLinkSpeed

(

)

An integer property.

This feature is deprecated (See DeviceLinkSpeed).

Deprecated

This feature is deprecated (See DeviceLinkSpeed). It was representing the speed of transmission negotiated by the given logical link.

getGevMACAddress()

PropertyI64 getGevMACAddress

(

)

An integer property.

MAC address of the logical link.

MAC address of the logical link.

getGevMCDA()

PropertyI64 getGevMCDA

(

)

An integer property.

Controls the destination IP address for the message channel.

Controls the destination IP address for the message channel.

getGevMCPHostPort()

PropertyI64 getGevMCPHostPort

(

)

An integer property.

Controls the port to which the device must send messages.

Controls the port to which the device must send messages. Setting this value to 0 closes the message channel.

getGevMCRC()

PropertyI64 getGevMCRC

(

)

An integer property.

Controls the number of retransmissions allowed when a message channel message times out.

Controls the number of retransmissions allowed when a message channel message times out.

getGevMCSP()

PropertyI64 getGevMCSP

(

)

An integer property.

This feature indicates the source port for the message channel.

This feature indicates the source port for the message channel.

getGevMCTT()

PropertyI64 getGevMCTT

(

)

An integer property.

Provides the transmission timeout value in milliseconds.

Provides the transmission timeout value in milliseconds.

getGevMessageChannelCount()

PropertyI64 getGevMessageChannelCount

(

)

An integer property.

This feature is deprecated (See DeviceEventChannelCount).

Deprecated

This feature is deprecated (See DeviceEventChannelCount). It was representing the number of message channels supported by this device.

getGevNumberOfInterfaces()

PropertyI64 getGevNumberOfInterfaces

(

)

An integer property.

This feature is deprecated (See DeviceLinkSelector).

Deprecated

This feature is deprecated (See DeviceLinkSelector). It was representing the number of logical links supported by this device.

getGevPAUSEFrameReception()

PropertyI getGevPAUSEFrameReception

(

)

A boolean property.

Controls whether incoming PAUSE Frames are handled on the given logical link.

Controls whether incoming PAUSE Frames are handled on the given logical link.

getGevPAUSEFrameTransmission()

PropertyI getGevPAUSEFrameTransmission

(

)

A boolean property.

Controls whether PAUSE Frames can be generated on the given logical link.

Controls whether PAUSE Frames can be generated on the given logical link.

getGevPersistentDefaultGateway()

PropertyI64 getGevPersistentDefaultGateway

(

)

An integer property.

Controls the persistent default gateway for this logical link.

Controls the persistent default gateway for this logical link. It is only used when the device boots with the Persistent IP configuration scheme.

getGevPersistentIPAddress()

PropertyI64 getGevPersistentIPAddress

(

)

An integer property.

Controls the Persistent IP address for this logical link.

Controls the Persistent IP address for this logical link. It is only used when the device boots with the Persistent IP configuration scheme.

getGevPersistentSubnetMask()

PropertyI64 getGevPersistentSubnetMask

(

)

An integer property.

Controls the Persistent subnet mask associated with the Persistent IP address on this logical link.

Controls the Persistent subnet mask associated with the Persistent IP address on this logical link. It is only used when the device boots with the Persistent IP configuration scheme.

getGevPhysicalLinkConfiguration()

PropertyI64 getGevPhysicalLinkConfiguration

(

)

An enumerated integer property.

Controls the principal physical link configuration to use on next restart/power-up of the device.

Controls the principal physical link configuration to use on next restart/power-up of the device.

The following string values might be valid for this feature:

• SingleLink (Display string: 'Single Link'): Single Link
• MultiLink (Display string: 'Multi Link'): Multi Link
• StaticLAG (Display string: 'Static LAG'): Static LAG
• DynamicLAG (Display string: 'Dynamic LAG'): Dynamic LAG

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.

getGevPrimaryApplicationIPAddress()

PropertyI64 getGevPrimaryApplicationIPAddress

(

)

An integer property.

Returns the address of the primary application.

Returns the address of the primary application.

getGevPrimaryApplicationSocket()

PropertyI64 getGevPrimaryApplicationSocket

(

)

An integer property.

Returns the UDP source port of the primary application.

Returns the UDP source port of the primary application.

getGevPrimaryApplicationSwitchoverKey()

PropertyI64 getGevPrimaryApplicationSwitchoverKey

(

)

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.

getGevSCCFGAllInTransmission()

PropertyI getGevSCCFGAllInTransmission

(

)

A boolean property.

Enables the selected GVSP transmitter to use the single packet per data block All-in Transmission mode.

Enables the selected GVSP transmitter to use the single packet per data block All-in Transmission mode.

getGevSCCFGExtendedChunkData()

PropertyI getGevSCCFGExtendedChunkData

(

)

A boolean property.

Enables cameras to use the extended chunk data payload type for this stream channel.

Enables cameras to use the extended chunk data payload type for this stream channel.

getGevSCCFGPacketResendDestination()

PropertyI getGevSCCFGPacketResendDestination

(

)

A boolean property.

Enables the alternate IP destination for stream packets resent due to a packet resend request.

Enables the alternate IP destination for stream packets resent due to a packet resend request. When True, the source IP address provided in the packet resend command packet is used. When False, the value set in the GevSCDA[GevStreamChannelSelector] feature is used.

getGevSCCFGUnconditionalStreaming()

PropertyI getGevSCCFGUnconditionalStreaming

(

)

A boolean property.

Enables the camera to continue to stream, for this stream channel, if its control channel is closed or regardless of the reception of any ICMP messages (such as destination unreachable messages).

Enables the camera to continue to stream, for this stream channel, if its control channel is closed or regardless of the reception of any ICMP messages (such as destination unreachable messages).

getGevSCDA()

PropertyI64 getGevSCDA

(

)

An integer property.

Controls the destination IP address of the selected stream channel to which a GVSP transmitter must send data stream or the destination IP address from which a GVSP receiver may receive data stream.

Controls the destination IP address of the selected stream channel to which a GVSP transmitter must send data stream or the destination IP address from which a GVSP receiver may receive data stream.

getGevSCPD()

PropertyI64 getGevSCPD

(

)

An integer property.

Controls the delay (in GEV timestamp counter unit) to insert between each packet for this stream channel.

Controls the delay (in GEV timestamp counter unit) to insert between each packet for this stream channel. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.

getGevSCPDirection()

PropertyI64 getGevSCPDirection

(

)

An enumerated integer property.

This feature is deprecated (See DeviceStreamChannelType).

Deprecated

This feature is deprecated (See DeviceStreamChannelType). It was used to report the direction of the stream channel.

The following string values might be valid for this feature:

• Transmitter (Display string: 'Transmitter'): Transmitter
• Receiver (Display string: 'Receiver'): Receiver

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.

getGevSCPHostPort()

PropertyI64 getGevSCPHostPort

(

)

An integer property.

Controls the port of the selected channel to which a GVSP transmitter must send data stream or the port from which a GVSP receiver may receive data stream.

Controls the port of the selected channel to which a GVSP transmitter must send data stream or the port from which a GVSP receiver may receive data stream. Setting this value to 0 closes the stream channel.

getGevSCPInterfaceIndex()

PropertyI64 getGevSCPInterfaceIndex

(

)

An integer property.

Index of the logical link to use.

Index of the logical link to use.

getGevSCPSBigEndian()

PropertyI getGevSCPSBigEndian

(

)

A boolean property.

This feature is deprecated (See DeviceStreamChannelEndianness).

Deprecated

This feature is deprecated (See DeviceStreamChannelEndianness). It was used to control the endianness of multi-byte pixel data for this stream.

getGevSCPSDoNotFragment()

PropertyI getGevSCPSDoNotFragment

(

)

A boolean property.

The state of this feature is copied into the 'do not fragment' bit of IP header of each stream packet.

The state of this feature is copied into the 'do not fragment' bit of IP header of each stream packet. It can be used by the application to prevent IP fragmentation of packets on the stream channel.

getGevSCPSFireTestPacket()

PropertyI getGevSCPSFireTestPacket

(

)

A boolean property.

Sends a test packet.

Sends a test packet. When this feature is set, the device will fire one test packet.

getGevSCPSPacketSize()

PropertyI64 getGevSCPSPacketSize

(

)

An integer property.

This GigE Vision specific feature corresponds to DeviceStreamChannelPacketSize and should be kept in sync with it.

This GigE Vision specific feature corresponds to DeviceStreamChannelPacketSize and should be kept in sync with it. It specifies the stream packet size, in bytes, to send on the selected channel for a GVSP transmitter or specifies the maximum packet size supported by a GVSP receiver.

getGevSCSP()

PropertyI64 getGevSCSP

(

)

An integer property.

Indicates the source port of the stream channel.

Indicates the source port of the stream channel.

getGevSCZoneConfigurationLock()

PropertyI getGevSCZoneConfigurationLock

(

)

A boolean property.

Controls whether the selected stream channel multi-zone configuration is locked.

Controls whether the selected stream channel multi-zone configuration is locked. When locked, the GVSP transmitter is not allowed to change the number of zones and their direction during block acquisition and transmission.

getGevSCZoneCount()

PropertyI64 getGevSCZoneCount

(

)

An integer property.

Reports the number of zones per block transmitted on the selected stream channel.

Reports the number of zones per block transmitted on the selected stream channel.

getGevSCZoneDirectionAll()

PropertyI64 getGevSCZoneDirectionAll

(

)

An integer property.

Reports the transmission direction of each zone transmitted on the selected stream channel.

Reports the transmission direction of each zone transmitted on the selected stream channel.

getGevSecondURL()

PropertyS getGevSecondURL

(

)

A string property.

Indicates the second URL to the GenICam XML device description file.

Indicates the second URL to the GenICam XML device description file. This URL is an alternative if the application was unsuccessful to retrieve the device description file using the first URL.

getGevStreamChannelCount()

PropertyI64 getGevStreamChannelCount

(

)

An integer property.

This feature is deprecated (See DeviceStreamChannelCount).

Deprecated

This feature is deprecated (See DeviceStreamChannelCount). It was representing the number of stream channels supported by this device.

getGevStreamChannelSelector()

PropertyI64 getGevStreamChannelSelector

(

)

An integer property.

Selects the stream channel to control.

Selects the stream channel to control.

getGevSupportedOption()

PropertyI getGevSupportedOption

(

)

A boolean property.

Returns if the selected GEV option is supported.

Returns if the selected GEV option is supported.

getGevSupportedOptionSelector()

PropertyI64 getGevSupportedOptionSelector

(

)

An enumerated integer property.

Selects the GEV option to interrogate for existing support.

Selects the GEV option to interrogate for existing support.

The following string values might be valid for this feature:

• Action (Display string: 'Action'): Action
• CCPApplicationSocket (Display string: 'CCP Application Socket'): CCP Application Socket
• CommandsConcatenation (Display string: 'Commands Concatenation'): Commands Concatenation
• DiscoveryAckDelay (Display string: 'Discovery Ack Delay'): Discovery Ack Delay
• DiscoveryAckDelayWritable (Display string: 'Discovery Ack Delay Writable'): Discovery Ack Delay Writable
• DynamicLAG (Display string: 'Dynamic LAG'): Dynamic LAG
• Event (Display string: 'Event'): Event
• EventData (Display string: 'Event Data'): Event Data
• ExtendedStatusCodes (Display string: 'Extended Status Codes'): Extended Status Codes
• ExtendedStatusCodesVersion2_0 (Display string: 'Extended Status Codes Version 2 0'): Extended Status Codes Version 2 0
• HeartbeatDisable (Display string: 'Heartbeat Disable'): Heartbeat Disable
• IEEE1588 (Display string: 'IEEE 1588'): IEEE 1588
• IPConfigurationDHCP (Display string: 'IP Configuration DHCP'): IP Configuration DHCP
• IPConfigurationLLA (Display string: 'IP Configuration LLA'): IP Configuration LLA
• IPConfigurationPersistentIP (Display string: 'IP Configuration Persistent IP'): IP Configuration Persistent IP
• LinkSpeed (Display string: 'Link Speed'): Link Speed
• ManifestTable (Display string: 'Manifest Table'): Manifest Table
• MessageChannelSourceSocket (Display string: 'Message Channel Source Socket'): Message Channel Source Socket
• MultiLink (Display string: 'Multi Link'): Multi Link
• PAUSEFrameGeneration (Display string: 'PAUSE Frame Generation'): PAUSE Frame Generation
• PAUSEFrameReception (Display string: 'PAUSE Frame Reception'): PAUSE Frame Reception
• PacketResend (Display string: 'Packet Resend'): Packet Resend
• PendingAck (Display string: 'Pending Ack'): Pending Ack
• PrimaryApplicationSwitchover (Display string: 'Primary Application Switchover'): Primary Application Switchover
• Ptp (Display string: 'Ptp'): Ptp
• ScheduledAction (Display string: 'Scheduled Action'): Scheduled Action
• SerialNumber (Display string: 'Serial Number'): Serial Number
• SingleLink (Display string: 'Single Link'): Single Link
• StandardIDMode (Display string: 'Standard ID Mode'): Standard ID Mode
• StaticLAG (Display string: 'Static LAG'): Static LAG
• StreamChannel0AllInTransmission (Display string: 'Stream Channel 0 All In Transmission'): Stream Channel 0 All In Transmission
• StreamChannel0BigAndLittleEndian (Display string: 'Stream Channel 0 Big And Little Endian'): Stream Channel 0 Big And Little Endian
• StreamChannel0ExtendedChunkData (Display string: 'Stream Channel 0 Extended Chunk Data'): Stream Channel 0 Extended Chunk Data
• StreamChannel0IPReassembly (Display string: 'Stream Channel 0 IP Reassembly'): Stream Channel 0 IP Reassembly
• StreamChannel0MultiZone (Display string: 'Stream Channel 0 Multi Zone'): Stream Channel 0 Multi Zone
• StreamChannel0PacketResendDestination (Display string: 'Stream Channel 0 Packet Resend Destination'): Stream Channel 0 Packet Resend Destination
• StreamChannel0UnconditionalStreaming (Display string: 'Stream Channel 0 Unconditional Streaming'): Stream Channel 0 Unconditional Streaming
• StreamChannel1AllInTransmission (Display string: 'Stream Channel 1 All In Transmission'): Stream Channel 1 All In Transmission
• StreamChannel1BigAndLittleEndian (Display string: 'Stream Channel 1 Big And Little Endian'): Stream Channel 1 Big And Little Endian
• StreamChannel1ExtendedChunkData (Display string: 'Stream Channel 1 Extended Chunk Data'): Stream Channel 1 Extended Chunk Data
• StreamChannel1IPReassembly (Display string: 'Stream Channel 1 IP Reassembly'): Stream Channel 1 IP Reassembly
• StreamChannel1MultiZone (Display string: 'Stream Channel 1 Multi Zone'): Stream Channel 1 Multi Zone
• StreamChannel1PacketResendDestination (Display string: 'Stream Channel 1 Packet Resend Destination'): Stream Channel 1 Packet Resend Destination
• StreamChannel1UnconditionalStreaming (Display string: 'Stream Channel 1 Unconditional Streaming'): Stream Channel 1 Unconditional Streaming
• StreamChannel2AllInTransmission (Display string: 'Stream Channel 2 All In Transmission'): Stream Channel 2 All In Transmission
• StreamChannel2BigAndLittleEndian (Display string: 'Stream Channel 2 Big And Little Endian'): Stream Channel 2 Big And Little Endian
• StreamChannel2ExtendedChunkData (Display string: 'Stream Channel 2 Extended Chunk Data'): Stream Channel 2 Extended Chunk Data
• StreamChannel2IPReassembly (Display string: 'Stream Channel 2 IP Reassembly'): Stream Channel 2 IP Reassembly
• StreamChannel2MultiZone (Display string: 'Stream Channel 2 Multi Zone'): Stream Channel 2 Multi Zone
• StreamChannel2PacketResendDestination (Display string: 'Stream Channel 2 Packet Resend Destination'): Stream Channel 2 Packet Resend Destination
• StreamChannel2UnconditionalStreaming (Display string: 'Stream Channel 2 Unconditional Streaming'): Stream Channel 2 Unconditional Streaming
• StreamChannelSourceSocket (Display string: 'Stream Channel Source Socket'): Stream Channel Source Socket
• TestData (Display string: 'Test Data'): Test Data
• UnconditionalAction (Display string: 'Unconditional Action'): Unconditional Action
• UserDefinedName (Display string: 'User Defined Name'): User Defined Name
• WriteMem (Display string: 'Write Mem'): Write Mem

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.

getGevTimestampControlLatch()

Method getGevTimestampControlLatch

(

)

A method object.

This feature is deprecated (See TimestampLatch).

Deprecated

This feature is deprecated (See TimestampLatch). It was used to latche the current timestamp counter into GevTimestampValue.

getGevTimestampControlReset()

Method getGevTimestampControlReset

(

)

A method object.

This feature is deprecated (See TimestampReset).

Deprecated

This feature is deprecated (See TimestampReset). It was used to reset the timestamp counter to 0. This feature is not available or as no effect when PTP is used.

getGevTimestampTickFrequency()

PropertyI64 getGevTimestampTickFrequency

(

)

An integer property.

This feature is deprecated (See the increment of the TimestampLatchValue feature).

Deprecated

This feature is deprecated (See the increment of the TimestampLatchValue feature). It was used to indicate the number of timestamp ticks in 1 second (frequency in Hz). If PTP is used, this feature must return 1,000,000,000 (1 GHz).

getGevTimestampValue()

PropertyI64 getGevTimestampValue

(

)

An integer property.

This feature is deprecated (See TimestampLatchValue).

Deprecated

This feature is deprecated (See TimestampLatchValue). It was used to return the latched 64-bit value of the timestamp counter.

getGevVersionMajor()

PropertyI64 getGevVersionMajor

(

)

An integer property.

This feature is deprecated (See DeviceTLVersionMajor).

Deprecated

This feature is deprecated (See DeviceTLVersionMajor). It was representing the major version of the specification.

getGevVersionMinor()

PropertyI64 getGevVersionMinor

(

)

An integer property.

This feature is deprecated (See DeviceTLVersionMinor).

Deprecated

This feature is deprecated (See DeviceTLVersionMinor). It was representing the minor version of the specification.

getMvCurrentUtcOffset()

PropertyI64 getMvCurrentUtcOffset

(

)

An integer property.

Indicates the number of leap seconds of the epoch, if the IEEE1588 timescale is 'PTP'.

Indicates the number of leap seconds of the epoch, if the IEEE1588 timescale is 'PTP'. Refer to the IEEE 1588-2008 specification for additional information.

getMvGevSCBW()

PropertyI64 getMvGevSCBW

(

)

An integer property.

Sets the stream channels max. bandwidth in KBps

This value sets the stream channels max. bandwidth in KBps.

getMvGevSCBWControl()

PropertyI64 getMvGevSCBWControl

(

)

An enumerated integer property.

Selects the bandwidth control for the selected stream channel.

This enumeration selects the bandwidth control for the selected stream channel.

The following string values might be valid for this feature:

• GevSCPD (Display string: 'Gev SCPD')
• mvGevSCBW (Display string: 'mv Gev SCBW')

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.

getMvPtpClockMode()

PropertyI64 getMvPtpClockMode

(

)

An enumerated integer property.

Selects the preferred Ptp Clock Mode for this device.

Selects the preferred Ptp Clock Mode for this device. Refer to the IEEE 1588-2008 specification for additional information.

The following string values might be valid for this feature:

• Auto (Display string: 'Auto'): The PTP Best Master Clock Algorithm (BMCA) will determinate if the device should be the master or the slave clock.
• Slave (Display string: 'Slave'): The device can only assume the 'Slave' 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 mvIMPACT.acquire.PropertyI.getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

getMvPtpTimescale()

PropertyI64 getMvPtpTimescale

(

)

An enumerated integer property.

Returns the latched PTP timescale.

This is a read only element. The timescale is indicated by values 0 or 1, corresponding to ARB or PTP. Refer to the IEEE 1588-2008 specification for additional information.

The following string values might be valid for this feature:

• ARB (Display string: 'ARB'): Indicates that the IEEE1588 timescale is arbitrary.
• PTP (Display string: 'PTP'): Indicates that the IEEE1588 timescale is UTC.

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.

getMvU3VEndpointResetEventCount()

PropertyI64 getMvU3VEndpointResetEventCount

(

)

An integer property.

Counts the number of reset events received on all endpoints.

Counts the number of reset events received on all endpoints.

getMvU3VEndpointRetryEventCount()

PropertyI64 getMvU3VEndpointRetryEventCount

(

)

An integer property.

Counts the number of retry events received on all endpoints.

Counts the number of retry events received on all endpoints.

getMvU3VEndpointSelector()

PropertyI64 getMvU3VEndpointSelector

(

)

An enumerated integer property.

Selects the endpoint for the event counters.

Selects the endpoint for the event counters.

The following string values might be valid for this feature:

• mvControl (Display string: 'mv Control'): The control endpoint of the camera.
• mvEvent (Display string: 'mv Event'): The event endpoint of the camera.
• mvStreaming (Display string: 'mv Streaming'): The streaming endpoint of the camera.
• mvDebug (Display string: 'mv Debug'): The debug endpoint of the camera.
• mvAll (Display string: 'mv All'): Sums up data from all endpoints.
• mvReserved (Display string: 'mv Reserved'): Reserved.

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.

getMvU3VErrorCounterReset()

Method getMvU3VErrorCounterReset

(

)

A method object.

Resets the 'mvU3VPHYErrorCount' and 'mvU3VLNKErrorCount' registers.

Resets the 'mvU3VPHYErrorCount' and 'mvU3VLNKErrorCount' registers.

getMvU3VLNKErrorCount()

PropertyI64 getMvU3VLNKErrorCount

(

)

An integer property.

Counts the number of errors on the USB3 link.

Counts the number of errors on the USB3 link.

getMvU3VPHYErrorCount()

PropertyI64 getMvU3VPHYErrorCount

(

)

An integer property.

Counts the number of errors on the PHY interface.

Counts the number of errors on the PHY interface.

getMvU3VSpreadSpectrumClockingSupportDisable()

Method getMvU3VSpreadSpectrumClockingSupportDisable

(

)

A method object.

Disable the spread spectrum clocking support.

Disable the spread spectrum clocking support.

getPayloadSize()

PropertyI64 getPayloadSize

(

)

An integer property.

Provides the number of bytes transferred for each data buffer or chunk on the stream channel.

Provides the number of bytes transferred for each data buffer or chunk on the stream channel. This includes any end-of-line, end-of-frame statistics or other stamp data. This is the total size of data payload for a data block.

getPtpClockAccuracy()

PropertyI64 getPtpClockAccuracy

(

)

An enumerated integer property.

Indicates the expected accuracy of the device PTP clock when it is the grandmaster, or in the event it becomes the grandmaster.

Indicates the expected accuracy of the device PTP clock when it is the grandmaster, or in the event it becomes the grandmaster.

The following string values might be valid for this feature:

• Within25ns (Display string: 'Within 25ns'): Within 25ns
• Within100ns (Display string: 'Within 100ns'): Within 100ns
• Within250ns (Display string: 'Within 250ns'): Within 250ns
• Within1us (Display string: 'Within 1us'): Within 1us
• Within2p5us (Display string: 'Within 2p 5us'): Within 2p 5us
• Within10us (Display string: 'Within 10us'): Within 10us
• Within25us (Display string: 'Within 25us'): Within 25us
• Within100us (Display string: 'Within 100us'): Within 100us
• Within250us (Display string: 'Within 250us'): Within 250us
• Within1ms (Display string: 'Within 1ms'): Within 1ms
• Within2p5ms (Display string: 'Within 2p 5ms'): Within 2p 5ms
• Within10ms (Display string: 'Within 10ms'): Within 10ms
• Within25ms (Display string: 'Within 25ms'): Within 25ms
• Within100ms (Display string: 'Within 100ms'): Within 100ms
• Within250ms (Display string: 'Within 250ms'): Within 250ms
• Within1s (Display string: 'Within 1s'): Within 1s
• Within10s (Display string: 'Within 10s'): Within 10s
• GreaterThan10s (Display string: 'Greater Than 10s'): Greater Than 10s
• AlternatePTPProfile (Display string: 'Alternate PTP Profile'): Alternate PTP Profile
• Unknown (Display string: 'Unknown'): Unknown
• Reserved (Display string: 'Reserved'): Reserved

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.

getPtpClockID()

PropertyI64 getPtpClockID

(

)

An integer property.

Returns the latched clock ID of the PTP device.

Returns the latched clock ID of the PTP device.

getPtpDataSetLatch()

Method getPtpDataSetLatch

(

)

A method object.

Latches the current values from the device's PTP clock data set.

Latches the current values from the device's PTP clock data set.

getPtpEnable()

PropertyI getPtpEnable

(

)

A boolean property.

Enables the Precision Time Protocol (PTP).

Enables the Precision Time Protocol (PTP).

getPtpGrandmasterClockID()

PropertyI64 getPtpGrandmasterClockID

(

)

An integer property.

Returns the latched grandmaster clock ID of the PTP device.

Returns the latched grandmaster clock ID of the PTP device. The grandmaster clock ID is the clock ID of the current grandmaster clock.

getPtpMeanPropagationDelay()

PropertyI64 getPtpMeanPropagationDelay

(

)

An integer property.

Returns the latched mean propagation delay from the current PTP master clock in nanoseconds.

Returns the latched mean propagation delay from the current PTP master clock in nanoseconds. The value is valid only when the PtpStatus is Slave.

getPtpOffsetFromMaster()

PropertyI64 getPtpOffsetFromMaster

(

)

An integer property.

Returns the latched offset from the PTP master clock in nanoseconds.

Returns the latched offset from the PTP master clock in nanoseconds.

getPtpParentClockID()

PropertyI64 getPtpParentClockID

(

)

An integer property.

Returns the latched parent clock ID of the PTP device.

Returns the latched parent clock ID of the PTP device. The parent clock ID is the clock ID of the current master clock.

getPtpServoStatus()

PropertyI64 getPtpServoStatus

(

)

An enumerated integer property.

Returns the latched state of the clock servo.

Returns the latched state of the clock servo. When the servo is in a locked state, the value returned is 'Locked'. When the servo is in a non-locked state, a device-specific value can be returned to give specific information. If no device-specific value is available to describe the current state of the clock servo, the value should be 'Unknown'.

The following string values might be valid for this feature:

• Unknown (Display string: 'Unknown'): Servo state is unknown.
• Locked (Display string: 'Locked'): Servo is locked
• Device-specific (Display string: 'Device-specific')

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.

getPtpStatus()

PropertyI64 getPtpStatus

(

)

An enumerated integer property.

Returns the latched state of the PTP clock.

Returns the latched state of the PTP clock.

The following string values might be valid for this feature:

• Initializing (Display string: 'Initializing'): Initializing
• Faulty (Display string: 'Faulty'): Faulty
• Disabled (Display string: 'Disabled'): Disabled
• Listening (Display string: 'Listening'): Listening
• PreMaster (Display string: 'Pre Master'): Pre Master
• Master (Display string: 'Master'): Master
• Passive (Display string: 'Passive'): Passive
• Uncalibrated (Display string: 'Uncalibrated'): Uncalibrated
• Slave (Display string: 'Slave'): Slave

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.

gevGetEffectiveBytesPerImage() [1/4]

long gevGetEffectiveBytesPerImage

(

long

gevSCPSPacketSizeValue

)

Calculates the effective bytes per block of data (e.g.

an image) for a GigE Vision data stream when transferring the payload type image.

This will include all overhead introduced by the network protocol. The value will be correct for payload type image only, thus e.g. when transferring chunk data the result will not be 100 per cent accurate as then some packets will use a slightly different layout. However these differences are negligible when working in modes, where individual images are not smaller than roughly 64 by 64 pixels.

Since

2.5.7

Returns

The effective bytes per block of data (e.g. an image) transferred by a GigE Vision device with the current parameters.

Parameters

gevSCPSPacketSizeValue

[in] The current or desired gevSCPSPacketSizeValue. This value depends e.g. on the MTU of the NIC the stream has been created on. See network configuration chapters for details. With boExtendedID the protocol overhead will increase slightly.

gevGetEffectiveBytesPerImage() [2/4]

long gevGetEffectiveBytesPerImage	(	long	gevSCPSPacketSizeValue,
		boolean	boExtendedID )

Calculates the effective bytes per block of data (e.g.

an image) for a GigE Vision data stream when transferring the payload type image.

This will include all overhead introduced by the network protocol. The value will be correct for payload type image only, thus e.g. when transferring chunk data the result will not be 100 per cent accurate as then some packets will use a slightly different layout. However these differences are negligible when working in modes, where individual images are not smaller than roughly 64 by 64 pixels.

Since

2.5.7

Returns

The effective bytes per block of data (e.g. an image) transferred by a GigE Vision device with the current parameters.

Parameters

gevSCPSPacketSizeValue	[in] The current or desired gevSCPSPacketSizeValue. This value depends e.g. on the MTU of the NIC the stream has been created on. See network configuration chapters for details.
boExtendedID	[in] Indicates whether the bandwidth shall be calculated for the extended ID mode (introduced in GigE Vision 2.0) or not. With boExtendedID the protocol overhead will increase slightly.

gevGetEffectiveBytesPerImage() [3/4]

static long gevGetEffectiveBytesPerImage ( long gevSCPSPacketSizeValue, long payloadSizeValue )

static

Calculates the effective bytes per block of data (e.g.

an image) for a GigE Vision data stream when transferring the payload type image.

This will include all overhead introduced by the network protocol. The value will be correct for payload type image only, thus e.g. when transferring chunk data the result will not be 100 per cent accurate as then some packets will use a slightly different layout. However these differences are negligible when working in modes, where individual images are not smaller than roughly 64 by 64 pixels.

Since

2.5.11

Returns

The effective bytes per block of data (e.g. an image) transferred by a GigE Vision device with the current parameters.

Parameters

gevSCPSPacketSizeValue	[in] The current or desired gevSCPSPacketSizeValue. This value depends e.g. on the MTU of the NIC the stream has been created on. See network configuration chapters for details.
payloadSizeValue	[in] The current value of the payloadSize property. With boExtendedID the protocol overhead will increase slightly.

gevGetEffectiveBytesPerImage() [4/4]

static long gevGetEffectiveBytesPerImage ( long gevSCPSPacketSizeValue, long payloadSizeValue, boolean boExtendedID )

static

Calculates the effective bytes per block of data (e.g.

an image) for a GigE Vision data stream when transferring the payload type image.

This will include all overhead introduced by the network protocol. The value will be correct for payload type image only, thus e.g. when transferring chunk data the result will not be 100 per cent accurate as then some packets will use a slightly different layout. However these differences are negligible when working in modes, where individual images are not smaller than roughly 64 by 64 pixels.

Since

2.5.11

Returns

The effective bytes per block of data (e.g. an image) transferred by a GigE Vision device with the current parameters.

Parameters

gevSCPSPacketSizeValue	[in] The current or desired gevSCPSPacketSizeValue. This value depends e.g. on the MTU of the NIC the stream has been created on. See network configuration chapters for details.
payloadSizeValue	[in] The current value of the payloadSize property.
boExtendedID	[in] Indicates whether the bandwidth shall be calculated for the extended ID mode (introduced in GigE Vision 2.0) or not. With boExtendedID the protocol overhead will increase slightly.

gevGetEffectivePayloadPacketsPerImage() [1/4]

long gevGetEffectivePayloadPacketsPerImage

(

long

gevSCPSPacketSizeValue

)

  This will include all overhead introduced by the network protocol. The value will be correct for payload type image only, thus e.g. when
  transferring chunk data the result will not be 100 per cent accurate as then some packets will use a slightly different layout. However
  these differences are negligible when working in modes, where individual images are not smaller than roughly 64 by 64 pixels.
  \since 2.5.7
  \return The effective number of payload packets (not including leader and trailer) per block of data (e.g. an image) transferred by a GigE Vision device with the current parameters.

Parameters

gevSCPSPacketSizeValue

[in] The current or desired gevSCPSPacketSizeValue. This value depends e.g. on the MTU of the NIC the stream has been created on. See network configuration chapters for details. With boExtendedID the protocol overhead will increase slightly.

gevGetEffectivePayloadPacketsPerImage() [2/4]

long gevGetEffectivePayloadPacketsPerImage	(	long	gevSCPSPacketSizeValue,
		boolean	boExtendedID )

  This will include all overhead introduced by the network protocol. The value will be correct for payload type image only, thus e.g. when
  transferring chunk data the result will not be 100 per cent accurate as then some packets will use a slightly different layout. However
  these differences are negligible when working in modes, where individual images are not smaller than roughly 64 by 64 pixels.
  \since 2.5.7
  \return The effective number of payload packets (not including leader and trailer) per block of data (e.g. an image) transferred by a GigE Vision device with the current parameters.

Parameters

gevSCPSPacketSizeValue	[in] The current or desired gevSCPSPacketSizeValue. This value depends e.g. on the MTU of the NIC the stream has been created on. See network configuration chapters for details.
boExtendedID	[in] Indicates whether the bandwidth shall be calculated for the extended ID mode (introduced in GigE Vision 2.0) or not. With boExtendedID the protocol overhead will increase slightly.

gevGetEffectivePayloadPacketsPerImage() [3/4]

static long gevGetEffectivePayloadPacketsPerImage ( long gevSCPSPacketSizeValue, long payloadSizeValue )

static

Calculates the effective number of payload packets (not including leader and trailer) per block of data (e.g.

an image) for a GigE Vision data stream when transferring the payload type image.

This will include all overhead introduced by the network protocol. The value will be correct for payload type image only, thus e.g. when transferring chunk data the result will not be 100 per cent accurate as then some packets will use a slightly different layout. However these differences are negligible when working in modes, where individual images are not smaller than roughly 64 by 64 pixels.

Since

2.5.11

Returns

The effective number of payload packets (not including leader and trailer) per block of data (e.g. an image) transferred by a GigE Vision device with the current parameters.

Parameters

gevSCPSPacketSizeValue	[in] The current or desired gevSCPSPacketSizeValue. This value depends e.g. on the MTU of the NIC the stream has been created on. See network configuration chapters for details.
payloadSizeValue	[in] The current value of the payloadSize property. With boExtendedID the protocol overhead will increase slightly.

gevGetEffectivePayloadPacketsPerImage() [4/4]

static long gevGetEffectivePayloadPacketsPerImage ( long gevSCPSPacketSizeValue, long payloadSizeValue, boolean boExtendedID )

static

Calculates the effective number of payload packets (not including leader and trailer) per block of data (e.g.

an image) for a GigE Vision data stream when transferring the payload type image.

This will include all overhead introduced by the network protocol. The value will be correct for payload type image only, thus e.g. when transferring chunk data the result will not be 100 per cent accurate as then some packets will use a slightly different layout. However these differences are negligible when working in modes, where individual images are not smaller than roughly 64 by 64 pixels.

Since

2.5.11

Returns

The effective number of payload packets (not including leader and trailer) per block of data (e.g. an image) transferred by a GigE Vision device with the current parameters.

Parameters

gevSCPSPacketSizeValue	[in] The current or desired gevSCPSPacketSizeValue. This value depends e.g. on the MTU of the NIC the stream has been created on. See network configuration chapters for details.
payloadSizeValue	[in] The current value of the payloadSize property.
boExtendedID	[in] Indicates whether the bandwidth shall be calculated for the extended ID mode (introduced in GigE Vision 2.0) or not. With boExtendedID the protocol overhead will increase slightly.

gevGetResultingBandwidth() [1/4]

long gevGetResultingBandwidth	(	double	acquisitionFrameRateValue,
		long	gevSCPSPacketSizeValue )

Calculates the overall resulting bandwidth (in bytes) needed for GigE Vision data streams when transferring the payload type image.

This will include all overhead introduced by the network protocol. The value will be correct for payload type image only, thus e.g. when transferring chunk data the result will not be 100 per cent precise as then some packets will use a slightly different layout. However these differences are negligible when working in modes, where individual images are not smaller than roughly 64 by 64 pixels.

Since

2.5.7

Returns

The overall resulting bandwidth (in bytes) needed for GigE Vision data streams when transferring the payload type image.

Parameters

acquisitionFrameRateValue	[in] The overall current or desired frame rate.
gevSCPSPacketSizeValue	[in] The current or desired gevSCPSPacketSizeValue. This value depends e.g. on the MTU of the NIC the stream has been created on. See network configuration chapters for details. With boExtendedID the protocol overhead will increase slightly.

gevGetResultingBandwidth() [2/4]

long gevGetResultingBandwidth	(	double	acquisitionFrameRateValue,
		long	gevSCPSPacketSizeValue,
		boolean	boExtendedID )

Calculates the overall resulting bandwidth (in bytes) needed for GigE Vision data streams when transferring the payload type image.

This will include all overhead introduced by the network protocol. The value will be correct for payload type image only, thus e.g. when transferring chunk data the result will not be 100 per cent precise as then some packets will use a slightly different layout. However these differences are negligible when working in modes, where individual images are not smaller than roughly 64 by 64 pixels.

Since

2.5.7

Returns

The overall resulting bandwidth (in bytes) needed for GigE Vision data streams when transferring the payload type image.

Parameters

acquisitionFrameRateValue	[in] The overall current or desired frame rate.
gevSCPSPacketSizeValue	[in] The current or desired gevSCPSPacketSizeValue. This value depends e.g. on the MTU of the NIC the stream has been created on. See network configuration chapters for details.
boExtendedID	[in] Indicates whether the bandwidth shall be calculated for the extended ID mode (introduced in GigE Vision 2.0) or not. With boExtendedID the protocol overhead will increase slightly.

gevGetResultingBandwidth() [3/4]

static long gevGetResultingBandwidth ( double acquisitionFrameRateValue, long gevSCPSPacketSizeValue, long payloadSizeValue )

static

Calculates the overall resulting bandwidth (in bytes) needed for GigE Vision data streams when transferring the payload type image.

This will include all overhead introduced by the network protocol. The value will be correct for payload type image only, thus e.g. when transferring chunk data the result will not be 100 per cent precise as then some packets will use a slightly different layout. However these differences are negligible when working in modes, where individual images are not smaller than roughly 64 by 64 pixels.

Since

2.5.11

Returns

The overall resulting bandwidth (in bytes) needed for GigE Vision data streams when transferring the payload type image.

Parameters

acquisitionFrameRateValue	[in] The overall current or desired frame rate.
gevSCPSPacketSizeValue	[in] The current or desired gevSCPSPacketSizeValue. This value depends e.g. on the MTU of the NIC the stream has been created on. See network configuration chapters for details.
payloadSizeValue	[in] The current value of the payloadSize property. With boExtendedID the protocol overhead will increase slightly.

gevGetResultingBandwidth() [4/4]

static long gevGetResultingBandwidth ( double acquisitionFrameRateValue, long gevSCPSPacketSizeValue, long payloadSizeValue, boolean boExtendedID )

static

Calculates the overall resulting bandwidth (in bytes) needed for GigE Vision data streams when transferring the payload type image.

This will include all overhead introduced by the network protocol. The value will be correct for payload type image only, thus e.g. when transferring chunk data the result will not be 100 per cent precise as then some packets will use a slightly different layout. However these differences are negligible when working in modes, where individual images are not smaller than roughly 64 by 64 pixels.

Since

2.5.11

Returns

The overall resulting bandwidth (in bytes) needed for GigE Vision data streams when transferring the payload type image.

Parameters

acquisitionFrameRateValue	[in] The overall current or desired frame rate.
gevSCPSPacketSizeValue	[in] The current or desired gevSCPSPacketSizeValue. This value depends e.g. on the MTU of the NIC the stream has been created on. See network configuration chapters for details.
payloadSizeValue	[in] The current value of the payloadSize property.
boExtendedID	[in] Indicates whether the bandwidth shall be calculated for the extended ID mode (introduced in GigE Vision 2.0) or not. With boExtendedID the protocol overhead will increase slightly.

gevGetResultingPacketDelay() [1/4]

long gevGetResultingPacketDelay	(	double	acquisitionFrameRateValue,
		long	gevSCPSPacketSizeValue,
		long	gevTimestampTickFrequencyValue,
		long	bandwidthAvailable )

Calculates the inter-packet delay needed to achieve a uniform packet and thus payload distribution for GigE Vision data streams when transferring the payload type image.

This will include all overhead introduced by the network protocol. The value will be correct for payload type image only, thus e.g. when transferring chunk data the result will not be 100 per cent accurate as then some packets will use a slightly different layout. However these differences are negligible when working in modes, where individual images are not smaller than roughly 64 by 64 pixels.

The result of this function should be written to the property mvIMPACT.acquire.TransportLayerControl.gevSCPD if supported by the device.

Since

2.5.7

Returns

The GevSCPD value for the given input parameters. If this value is negative, this indicates that the overall bandwidth resulting from the given input parameters is higher than stated by bandwidthAvailable. In such a case the inter-packet delay must be set to 0 and it should be noted that the desired frame rate cannot be reached in this configuration.

Parameters

acquisitionFrameRateValue	[in] The overall current or desired frame rate.
gevSCPSPacketSizeValue	[in] The current or desired gevSCPSPacketSizeValue. This value depends e.g. on the MTU of the NIC the stream has been created on. See network configuration chapters for details.
gevTimestampTickFrequencyValue	[in] The timestamp tick frequency of the GEV remote device.
bandwidthAvailable	[in] The overall bandwidth in bytes that is available on the given link. With boExtendedID the protocol overhead will increase slightly.

gevGetResultingPacketDelay() [2/4]

long gevGetResultingPacketDelay	(	double	acquisitionFrameRateValue,
		long	gevSCPSPacketSizeValue,
		long	gevTimestampTickFrequencyValue,
		long	bandwidthAvailable,
		boolean	boExtendedID )

Calculates the inter-packet delay needed to achieve a uniform packet and thus payload distribution for GigE Vision data streams when transferring the payload type image.

This will include all overhead introduced by the network protocol. The value will be correct for payload type image only, thus e.g. when transferring chunk data the result will not be 100 per cent accurate as then some packets will use a slightly different layout. However these differences are negligible when working in modes, where individual images are not smaller than roughly 64 by 64 pixels.

The result of this function should be written to the property mvIMPACT.acquire.TransportLayerControl.gevSCPD if supported by the device.

Since

2.5.7

Returns

The GevSCPD value for the given input parameters. If this value is negative, this indicates that the overall bandwidth resulting from the given input parameters is higher than stated by bandwidthAvailable. In such a case the inter-packet delay must be set to 0 and it should be noted that the desired frame rate cannot be reached in this configuration.

Parameters

acquisitionFrameRateValue	[in] The overall current or desired frame rate.
gevSCPSPacketSizeValue	[in] The current or desired gevSCPSPacketSizeValue. This value depends e.g. on the MTU of the NIC the stream has been created on. See network configuration chapters for details.
gevTimestampTickFrequencyValue	[in] The timestamp tick frequency of the GEV remote device.
bandwidthAvailable	[in] The overall bandwidth in bytes that is available on the given link.
boExtendedID	[in] Indicates whether the bandwidth shall be calculated for the extended ID mode (introduced in GigE Vision 2.0) or not. With boExtendedID the protocol overhead will increase slightly.

gevGetResultingPacketDelay() [3/4]

static long gevGetResultingPacketDelay ( double acquisitionFrameRateValue, long gevSCPSPacketSizeValue, long payloadSizeValue, long gevTimestampTickFrequencyValue, long bandwidthAvailable )

static

Calculates the inter-packet delay needed to achieve a uniform packet and thus payload distribution for GigE Vision data streams when transferring the payload type image.

This will include all overhead introduced by the network protocol. The value will be correct for payload type image only, thus e.g. when transferring chunk data the result will not be 100 per cent accurate as then some packets will use a slightly different layout. However these differences are negligible when working in modes, where individual images are not smaller than roughly 64 by 64 pixels.

The result of this function should be written to the property mvIMPACT.acquire.TransportLayerControl.gevSCPD if supported by the device.

Since

2.5.11

Returns

The GevSCPD value for the given input parameters. If this value is negative, this indicates that the overall bandwidth resulting from the given input parameters is higher than stated by bandwidthAvailable. In such a case the inter-packet delay must be set to 0 and it should be noted that the desired frame rate cannot be reached in this configuration.

Parameters

acquisitionFrameRateValue	[in] The overall current or desired frame rate.
gevSCPSPacketSizeValue	[in] The current or desired gevSCPSPacketSizeValue. This value depends e.g. on the MTU of the NIC the stream has been created on. See network configuration chapters for details.
payloadSizeValue	[in] The current value of the payloadSize property.
gevTimestampTickFrequencyValue	[in] The timestamp tick frequency of the GEV remote device.
bandwidthAvailable	[in] The overall bandwidth in bytes that is available on the given link. With boExtendedID the protocol overhead will increase slightly.

gevGetResultingPacketDelay() [4/4]

static long gevGetResultingPacketDelay ( double acquisitionFrameRateValue, long gevSCPSPacketSizeValue, long payloadSizeValue, long gevTimestampTickFrequencyValue, long bandwidthAvailable, boolean boExtendedID )

static

Calculates the inter-packet delay needed to achieve a uniform packet and thus payload distribution for GigE Vision data streams when transferring the payload type image.

This will include all overhead introduced by the network protocol. The value will be correct for payload type image only, thus e.g. when transferring chunk data the result will not be 100 per cent accurate as then some packets will use a slightly different layout. However these differences are negligible when working in modes, where individual images are not smaller than roughly 64 by 64 pixels.

The result of this function should be written to the property mvIMPACT.acquire.TransportLayerControl.gevSCPD if supported by the device.

Since

2.5.11

Returns

The GevSCPD value for the given input parameters. If this value is negative, this indicates that the overall bandwidth resulting from the given input parameters is higher than stated by bandwidthAvailable. In such a case the inter-packet delay must be set to 0 and it should be noted that the desired frame rate cannot be reached in this configuration.

Parameters

acquisitionFrameRateValue	[in] The overall current or desired frame rate.
gevSCPSPacketSizeValue	[in] The current or desired gevSCPSPacketSizeValue. This value depends e.g. on the MTU of the NIC the stream has been created on. See network configuration chapters for details.
payloadSizeValue	[in] The current value of the payloadSize property.
gevTimestampTickFrequencyValue	[in] The timestamp tick frequency of the GEV remote device.
bandwidthAvailable	[in] The overall bandwidth in bytes that is available on the given link.
boExtendedID	[in] Indicates whether the bandwidth shall be calculated for the extended ID mode (introduced in GigE Vision 2.0) or not. With boExtendedID the protocol overhead will increase slightly.

swigRelease()

static long swigRelease ( TransportLayerControl obj )

staticprotected

Member Data Documentation

swigCMemOwn

transient boolean swigCMemOwn

protected