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

#include <mvIMPACT_acquire_GenICam.h>

Public Member Functions
int64_type	gevGetEffectiveBytesPerImage (const int64_type gevSCPSPacketSizeValue, const bool boExtendedID=false) const
	Calculates the effective bytes per block of data (e.g. an image) for a GigE Vision data stream when transferring the payload type image.

int64_type	gevGetEffectivePayloadPacketsPerImage (const int64_type gevSCPSPacketSizeValue, const bool boExtendedID=false) const

int64_type	gevGetResultingBandwidth (const double acquisitionFrameRateValue, const int64_type gevSCPSPacketSizeValue, const bool boExtendedID=false) const
	Calculates the overall resulting bandwidth (in bytes) needed for GigE Vision data streams when transferring the payload type image.

int64_type	gevGetResultingPacketDelay (const double acquisitionFrameRateValue, const int64_type gevSCPSPacketSizeValue, const int64_type gevTimestampTickFrequencyValue, const int64_type bandwidthAvailable, const bool boExtendedID=false) const
	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 (mvIMPACT::acquire::Device *pDev, const std::string &settingName="Base")
	Constructs a new mvIMPACT::acquire::GenICam::TransportLayerControl object.

Static Public Member Functions
static int64_type	gevGetEffectiveBytesPerImage (const int64_type gevSCPSPacketSizeValue, const int64_type payloadSizeValue, const bool boExtendedID=false)
	Calculates the effective bytes per block of data (e.g. an image) for a GigE Vision data stream when transferring the payload type image.

static int64_type	gevGetEffectivePayloadPacketsPerImage (const int64_type gevSCPSPacketSizeValue, const int64_type payloadSizeValue, const bool boExtendedID=false)
	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.

static int64_type	gevGetResultingBandwidth (const double acquisitionFrameRateValue, const int64_type gevSCPSPacketSizeValue, const int64_type payloadSizeValue, const bool boExtendedID=false)
	Calculates the overall resulting bandwidth (in bytes) needed for GigE Vision data streams when transferring the payload type image.

static int64_type	gevGetResultingPacketDelay (const double acquisitionFrameRateValue, const int64_type gevSCPSPacketSizeValue, const int64_type payloadSizeValue, const int64_type gevTimestampTickFrequencyValue, const int64_type bandwidthAvailable, const bool boExtendedID=false)
	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.

Public Attributes
PropertyI64	aPAUSEMACCtrlFramesReceived
	An integer property. Reports the number of received PAUSE frames.

PropertyI64	aPAUSEMACCtrlFramesTransmitted
	An integer property. Reports the number of transmitted PAUSE frames.

PropertyI64	clConfiguration
	An enumerated integer property. This Camera Link specific feature describes the configuration used by the camera.

PropertyI64	clTimeSlotsCount
	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.

PropertyI64	cxpConnectionSelector
	An integer property. Selects the CoaXPress physical connection to control.

PropertyI64	cxpConnectionTestErrorCount
	An integer property. Reports the current connection error count for test packets received by the device on the connection selected by CxpConnectionSelector.

PropertyI64	cxpConnectionTestMode
	An enumerated integer property. Enables the test mode for an individual physical connection of the Device.

PropertyI64	cxpConnectionTestPacketCount
	An integer property. Reports the current count for the test packets on the connection selected by CxpConnectionSelector.

Method	cxpErrorCounterReset
	A method object. Resets the selected Cxp Error Counter on the connection selected by CxpConnectionSelector.

PropertyI64	cxpErrorCounterSelector
	An enumerated integer property. Selects which Cxp Error Counter to read or reset.

PropertyI64	cxpErrorCounterStatus
	An enumerated integer property. Returns the current status of the selected Cxp Error Counter on the connection selected by CxpConnectionSelector.

PropertyI64	cxpErrorCounterValue
	An integer property. Reads the current value of the selected Cxp Error Counter on the connection selected by CxpConnectionSelector.

PropertyIBoolean	cxpFirstLineTriggerWithFrameStart
	A boolean property. Specifies if a FrameStart trigger also triggers the first LineStart at the same time.

PropertyI64	cxpLinkConfiguration
	An enumerated integer property. This feature allows specifying the Link configuration for the communication between the Receiver and Transmitter Device.

PropertyI64	cxpLinkConfigurationPreferred
	An enumerated integer property. Provides the Link configuration that allows the Transmitter Device to operate in its default mode.

PropertyI64	cxpLinkConfigurationStatus
	An enumerated integer property. This feature indicates the current and active Link configuration used by the Device.

PropertyI64	cxpLinkSharingDuplicateStripe
	An integer property. This feature provides the duplicate count in striped system.

PropertyIBoolean	cxpLinkSharingEnable
	A boolean property. Enable or disable the link sharing functionality of the device.

PropertyI64	cxpLinkSharingHorizontalOverlap
	An integer property. This feature provides the number of pixel overlap in the horizontal stripes that the device implements.

PropertyI64	cxpLinkSharingHorizontalStripeCount
	An integer property. This feature provides the number of horizontal stripes that the device implements.

PropertyI64	cxpLinkSharingSubDeviceSelector
	An integer property. Index of the sub device used in the Link Sharing.

PropertyI64	cxpLinkSharingSubDeviceType
	An enumerated integer property. This feature provides the type of sub device.

PropertyI64	cxpLinkSharingVerticalOverlap
	An integer property. This feature provides the number of pixel overlap in the vertical stripes that the device implements.

PropertyI64	cxpLinkSharingVerticalStripeCount
	An integer property. This feature provides the number of vertical stripes that the device implements.

Method	cxpPoCxpAuto
	A method object. Activate automatic control of the Power over CoaXPress (PoCXP) for the Link.

PropertyI64	cxpPoCxpStatus
	An enumerated integer property. Returns the Power over CoaXPress (PoCXP) status of the Device.

Method	cxpPoCxpTripReset
	A method object. Reset the Power over CoaXPress (PoCXP) Link after an over-current trip on the Device connection(s).

Method	cxpPoCxpTurnOff
	A method object. Disable Power over CoaXPress (PoCXP) for the Link.

PropertyI64	cxpSendReceiveSelector
	An enumerated integer property. Selects which one of the send or receive features to control.

PropertyI64	deviceTapGeometry
	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.

PropertyS	genDCDescriptor
	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.

PropertyS	genDCFlowMappingTable
	A string property. Returns the GenDC Container data Flow mapping table that will be used to transport the GenDC Container.

PropertyI64	genDCStreamingMode
	An enumerated integer property. Controls the device's streaming format.

PropertyI64	genDCStreamingStatus
	An enumerated integer property. Returns whether the current device data streaming format is GenDC.

PropertyI64	gevActiveLinkCount
	An integer property. Indicates the current number of active logical links.

PropertyI64	gevCCP
	An enumerated integer property. Controls the device access privilege of an application.

PropertyI64	gevCurrentDefaultGateway
	An integer property. Reports the default gateway IP address of the given logical link.

PropertyI64	gevCurrentIPAddress
	An integer property. Reports the IP address for the given logical link.

PropertyIBoolean	gevCurrentIPConfigurationDHCP
	A boolean property. Controls whether the DHCP IP configuration scheme is activated on the given logical link.

PropertyIBoolean	gevCurrentIPConfigurationLLA
	A boolean property. Controls whether the Link Local Address IP configuration scheme is activated on the given logical link.

PropertyIBoolean	gevCurrentIPConfigurationPersistentIP
	A boolean property. Controls whether the PersistentIP configuration scheme is activated on the given logical link.

PropertyI64	gevCurrentPhysicalLinkConfiguration
	An enumerated integer property. Indicates the current physical link configuration of the device.

PropertyI64	gevCurrentSubnetMask
	An integer property. Reports the subnet mask of the given logical link.

PropertyI64	gevDeviceClass
	An enumerated integer property. This feature is deprecated (See DeviceType).

PropertyI64	gevDeviceModeCharacterSet
	An enumerated integer property. This feature is deprecated (See DeviceCharacterSet).

PropertyIBoolean	gevDeviceModeIsBigEndian
	A boolean property. This feature is deprecated (See DeviceRegistersEndianness).

PropertyI64	gevDiscoveryAckDelay
	An integer property. Indicates the maximum randomized delay the device will wait to acknowledge a discovery command.

PropertyS	gevFirstURL
	A string property. Indicates the first URL to the GenICam XML device description file.

PropertyIBoolean	gevGVCPExtendedStatusCodes
	A boolean property. Enables the generation of extended status codes.

PropertyI64	gevGVCPExtendedStatusCodesSelector
	An enumerated integer property. Selects the GigE Vision version to control extended status codes for.

PropertyIBoolean	gevGVCPHeartbeatDisable
	A boolean property. This feature is deprecated (See DeviceLinkHeartbeatMode).

PropertyIBoolean	gevGVCPPendingAck
	A boolean property. Enables the generation of PENDING_ACK.

PropertyI64	gevGVCPPendingTimeout
	An integer property. This feature is deprecated (See DeviceLinkCommandTimeout).

PropertyI64	gevGVSPExtendedIDMode
	An enumerated integer property. Enables the extended IDs mode.

PropertyI64	gevHeartbeatTimeout
	An integer property. This feature is deprecated (See DeviceLinkHeartbeatTimeout).

PropertyIBoolean	gevIEEE1588
	A boolean property. This feature is deprecated (See PtpEnable).

PropertyI64	gevIEEE1588ClockAccuracy
	An enumerated integer property. This feature is deprecated (See PtpClockAccurarcy).

PropertyI64	gevIEEE1588Status
	An enumerated integer property. This feature is deprecated (See PtpStatus).

PropertyI64	gevInterfaceSelector
	An integer property. Selects which logical link to control.

PropertyI64	gevIPConfigurationStatus
	An enumerated integer property. Reports the current IP configuration status.

PropertyI64	gevLinkSpeed
	An integer property. This feature is deprecated (See DeviceLinkSpeed).

PropertyI64	gevMACAddress
	An integer property. MAC address of the logical link.

PropertyI64	gevMCDA
	An integer property. Controls the destination IP address for the message channel.

PropertyI64	gevMCPHostPort
	An integer property. Controls the port to which the device must send messages.

PropertyI64	gevMCRC
	An integer property. Controls the number of retransmissions allowed when a message channel message times out.

PropertyI64	gevMCSP
	An integer property. This feature indicates the source port for the message channel.

PropertyI64	gevMCTT
	An integer property. Provides the transmission timeout value in milliseconds.

PropertyI64	gevMessageChannelCount
	An integer property. This feature is deprecated (See DeviceEventChannelCount).

PropertyI64	gevNumberOfInterfaces
	An integer property. This feature is deprecated (See DeviceLinkSelector).

PropertyIBoolean	gevPAUSEFrameReception
	A boolean property. Controls whether incoming PAUSE Frames are handled on the given logical link.

PropertyIBoolean	gevPAUSEFrameTransmission
	A boolean property. Controls whether PAUSE Frames can be generated on the given logical link.

PropertyI64	gevPersistentDefaultGateway
	An integer property. Controls the persistent default gateway for this logical link.

PropertyI64	gevPersistentIPAddress
	An integer property. Controls the Persistent IP address for this logical link.

PropertyI64	gevPersistentSubnetMask
	An integer property. Controls the Persistent subnet mask associated with the Persistent IP address on this logical link.

PropertyI64	gevPhysicalLinkConfiguration
	An enumerated integer property. Controls the principal physical link configuration to use on next restart/power-up of the device.

PropertyI64	gevPrimaryApplicationIPAddress
	An integer property. Returns the address of the primary application.

PropertyI64	gevPrimaryApplicationSocket
	An integer property. Returns the UDP source port of the primary application.

PropertyI64	gevPrimaryApplicationSwitchoverKey
	An integer property. Controls the key to use to authenticate primary application switchover requests.

PropertyIBoolean	gevSCCFGAllInTransmission
	A boolean property. Enables the selected GVSP transmitter to use the single packet per data block All-in Transmission mode.

PropertyIBoolean	gevSCCFGExtendedChunkData
	A boolean property. Enables cameras to use the extended chunk data payload type for this stream channel.

PropertyIBoolean	gevSCCFGPacketResendDestination
	A boolean property. Enables the alternate IP destination for stream packets resent due to a packet resend request.

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

PropertyI64	gevSCDA
	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.

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

PropertyI64	gevSCPDirection
	An enumerated integer property. This feature is deprecated (See DeviceStreamChannelType).

PropertyI64	gevSCPHostPort
	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.

PropertyI64	gevSCPInterfaceIndex
	An integer property. Index of the logical link to use.

PropertyIBoolean	gevSCPSBigEndian
	A boolean property. This feature is deprecated (See DeviceStreamChannelEndianness).

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

PropertyIBoolean	gevSCPSFireTestPacket
	A boolean property. Sends a test packet.

PropertyI64	gevSCPSPacketSize
	An integer property. This GigE Vision specific feature corresponds to DeviceStreamChannelPacketSize and should be kept in sync with it.

PropertyI64	gevSCSP
	An integer property. Indicates the source port of the stream channel.

PropertyIBoolean	gevSCZoneConfigurationLock
	A boolean property. Controls whether the selected stream channel multi-zone configuration is locked.

PropertyI64	gevSCZoneCount
	An integer property. Reports the number of zones per block transmitted on the selected stream channel.

PropertyI64	gevSCZoneDirectionAll
	An integer property. Reports the transmission direction of each zone transmitted on the selected stream channel.

PropertyS	gevSecondURL
	A string property. Indicates the second URL to the GenICam XML device description file.

PropertyI64	gevStreamChannelCount
	An integer property. This feature is deprecated (See DeviceStreamChannelCount).

PropertyI64	gevStreamChannelSelector
	An integer property. Selects the stream channel to control.

PropertyIBoolean	gevSupportedOption
	A boolean property. Returns if the selected GEV option is supported.

PropertyI64	gevSupportedOptionSelector
	An enumerated integer property. Selects the GEV option to interrogate for existing support.

Method	gevTimestampControlLatch
	A method object. This feature is deprecated (See TimestampLatch).

Method	gevTimestampControlReset
	A method object. This feature is deprecated (See TimestampReset).

PropertyI64	gevTimestampTickFrequency
	An integer property. This feature is deprecated (See the increment of the TimestampLatchValue feature).

PropertyI64	gevTimestampValue
	An integer property. This feature is deprecated (See TimestampLatchValue).

PropertyI64	gevVersionMajor
	An integer property. This feature is deprecated (See DeviceTLVersionMajor).

PropertyI64	gevVersionMinor
	An integer property. This feature is deprecated (See DeviceTLVersionMinor).

PropertyI64	mvCurrentUtcOffset
	An integer property. Indicates the number of leap seconds of the epoch, if the IEEE1588 timescale is 'PTP'.

PropertyI64	mvGevSCBW
	An integer property. Sets the stream channels max. bandwidth in KBps.

PropertyI64	mvGevSCBWControl
	An enumerated integer property. Selects the bandwidth control for the selected stream channel.

PropertyI64	mvPtpClockMode
	An enumerated integer property. Selects the preferred Ptp Clock Mode for this device.

PropertyI64	mvPtpTimescale
	An enumerated integer property. Returns the latched PTP timescale.

PropertyI64	mvU3VEndpointResetEventCount
	An integer property. Counts the number of reset events received on all endpoints.

PropertyI64	mvU3VEndpointRetryEventCount
	An integer property. Counts the number of retry events received on all endpoints.

PropertyI64	mvU3VEndpointSelector
	An enumerated integer property. Selects the endpoint for the event counters.

Method	mvU3VErrorCounterReset
	A method object. Resets the 'mvU3VPHYErrorCount' and 'mvU3VLNKErrorCount' registers.

PropertyI64	mvU3VLNKErrorCount
	An integer property. Counts the number of errors on the USB3 link.

PropertyI64	mvU3VPHYErrorCount
	An integer property. Counts the number of errors on the PHY interface.

Method	mvU3VSpreadSpectrumClockingSupportDisable
	A method object. Disable the spread spectrum clocking support.

PropertyI64	payloadSize
	An integer property. Provides the number of bytes transferred for each data buffer or chunk on the stream channel.

PropertyI64	ptpClockAccuracy
	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.

PropertyI64	ptpClockID
	An integer property. Returns the latched clock ID of the PTP device.

Method	ptpDataSetLatch
	A method object. Latches the current values from the device's PTP clock data set.

PropertyIBoolean	ptpEnable
	A boolean property. Enables the Precision Time Protocol (PTP).

PropertyI64	ptpGrandmasterClockID
	An integer property. Returns the latched grandmaster clock ID of the PTP device.

PropertyI64	ptpMeanPropagationDelay
	An integer property. Returns the latched mean propagation delay from the current PTP master clock in nanoseconds.

PropertyI64	ptpOffsetFromMaster
	An integer property. Returns the latched offset from the PTP master clock in nanoseconds.

PropertyI64	ptpParentClockID
	An integer property. Returns the latched parent clock ID of the PTP device.

PropertyI64	ptpServoStatus
	An enumerated integer property. Returns the latched state of the clock servo.

PropertyI64	ptpStatus
	An enumerated integer property. Returns the latched state of the PTP clock.

Detailed Description

Category that contains the transport Layer control features.

A category that contains the transport Layer control features.

Examples: ContinuousCaptureGenDC.cpp, ContinuousCaptureMultiPart.cpp, ContinuousCaptureMultiPart.legacy.cpp, ContinuousCaptureOnlyProcessLatest.cpp, ContinuousCaptureOnlyProcessLatest.legacy.cpp, and TimestampFeatures.cpp.

Constructor & Destructor Documentation

◆ TransportLayerControl()

TransportLayerControl	(	mvIMPACT::acquire::Device *	pDev,
		const std::string &	settingName = "Base" )

inlineexplicit

Constructs a new mvIMPACT::acquire::GenICam::TransportLayerControl object.

Parameters

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

Member Function Documentation

◆ gevGetEffectiveBytesPerImage() [1/2]

int64_type gevGetEffectiveBytesPerImage	(	const int64_type	gevSCPSPacketSizeValue,
		const bool	boExtendedID = false ) const

inline

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

[in]	gevSCPSPacketSizeValue	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.
[in]	boExtendedID	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() [2/2]

static int64_type gevGetEffectiveBytesPerImage	(	const int64_type	gevSCPSPacketSizeValue,
		const int64_type	payloadSizeValue,
		const bool	boExtendedID = false )

inlinestatic

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

[in]	gevSCPSPacketSizeValue	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.
[in]	payloadSizeValue	The current value of the payloadSize property.
[in]	boExtendedID	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/2]

int64_type gevGetEffectivePayloadPacketsPerImage	(	const int64_type	gevSCPSPacketSizeValue,
		const bool	boExtendedID = false ) const

inline

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

[in]	gevSCPSPacketSizeValue	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.
[in]	boExtendedID	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() [2/2]

static int64_type gevGetEffectivePayloadPacketsPerImage	(	const int64_type	gevSCPSPacketSizeValue,
		const int64_type	payloadSizeValue,
		const bool	boExtendedID = false )

inlinestatic

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

[in]	gevSCPSPacketSizeValue	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.
[in]	payloadSizeValue	The current value of the payloadSize property.
[in]	boExtendedID	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/2]

int64_type gevGetResultingBandwidth	(	const double	acquisitionFrameRateValue,
		const int64_type	gevSCPSPacketSizeValue,
		const bool	boExtendedID = false ) const

inline

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

[in]	acquisitionFrameRateValue	The overall current or desired frame rate.
[in]	gevSCPSPacketSizeValue	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.
[in]	boExtendedID	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() [2/2]

static int64_type gevGetResultingBandwidth	(	const double	acquisitionFrameRateValue,
		const int64_type	gevSCPSPacketSizeValue,
		const int64_type	payloadSizeValue,
		const bool	boExtendedID = false )

inlinestatic

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

[in]	acquisitionFrameRateValue	The overall current or desired frame rate.
[in]	gevSCPSPacketSizeValue	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.
[in]	payloadSizeValue	The current value of the payloadSize property.
[in]	boExtendedID	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/2]

int64_type gevGetResultingPacketDelay	(	const double	acquisitionFrameRateValue,
		const int64_type	gevSCPSPacketSizeValue,
		const int64_type	gevTimestampTickFrequencyValue,
		const int64_type	bandwidthAvailable,
		const bool	boExtendedID = false ) const

inline

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

[in]	acquisitionFrameRateValue	The overall current or desired frame rate.
[in]	gevSCPSPacketSizeValue	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.
[in]	gevTimestampTickFrequencyValue	The timestamp tick frequency of the GEV remote device.
[in]	bandwidthAvailable	The overall bandwidth in bytes that is available on the given link.
[in]	boExtendedID	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() [2/2]

static int64_type gevGetResultingPacketDelay	(	const double	acquisitionFrameRateValue,
		const int64_type	gevSCPSPacketSizeValue,
		const int64_type	payloadSizeValue,
		const int64_type	gevTimestampTickFrequencyValue,
		const int64_type	bandwidthAvailable,
		const bool	boExtendedID = false )

inlinestatic

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

[in]	acquisitionFrameRateValue	The overall current or desired frame rate.
[in]	gevSCPSPacketSizeValue	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.
[in]	payloadSizeValue	The current value of the payloadSize property.
[in]	gevTimestampTickFrequencyValue	The timestamp tick frequency of the GEV remote device.
[in]	bandwidthAvailable	The overall bandwidth in bytes that is available on the given link.
[in]	boExtendedID	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.

Member Data Documentation

◆ aPAUSEMACCtrlFramesReceived

PropertyI64 aPAUSEMACCtrlFramesReceived

An integer property. Reports the number of received PAUSE frames.

Reports the number of received PAUSE frames.

◆ aPAUSEMACCtrlFramesTransmitted

PropertyI64 aPAUSEMACCtrlFramesTransmitted

An integer property. Reports the number of transmitted PAUSE frames.

Reports the number of transmitted PAUSE frames.

◆ clConfiguration

PropertyI64 clConfiguration

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

◆ clTimeSlotsCount

PropertyI64 clTimeSlotsCount

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

◆ cxpConnectionSelector

PropertyI64 cxpConnectionSelector

An integer property. Selects the CoaXPress physical connection to control.

Selects the CoaXPress physical connection to control.

◆ cxpConnectionTestErrorCount

PropertyI64 cxpConnectionTestErrorCount

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.

◆ cxpConnectionTestMode

PropertyI64 cxpConnectionTestMode

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

◆ cxpConnectionTestPacketCount

PropertyI64 cxpConnectionTestPacketCount

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.

◆ cxpErrorCounterReset

Method cxpErrorCounterReset

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.

◆ cxpErrorCounterSelector

PropertyI64 cxpErrorCounterSelector

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

◆ cxpErrorCounterStatus

PropertyI64 cxpErrorCounterStatus

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

◆ cxpErrorCounterValue

PropertyI64 cxpErrorCounterValue

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.

◆ cxpFirstLineTriggerWithFrameStart

PropertyIBoolean cxpFirstLineTriggerWithFrameStart

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.

◆ cxpLinkConfiguration

PropertyI64 cxpLinkConfiguration

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

◆ cxpLinkConfigurationPreferred

PropertyI64 cxpLinkConfigurationPreferred

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

◆ cxpLinkConfigurationStatus

PropertyI64 cxpLinkConfigurationStatus

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

◆ cxpLinkSharingDuplicateStripe

PropertyI64 cxpLinkSharingDuplicateStripe

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.

◆ cxpLinkSharingEnable

PropertyIBoolean cxpLinkSharingEnable

A boolean property. Enable or disable the link sharing functionality of the device.

Enable or disable the link sharing functionality of the device.

◆ cxpLinkSharingHorizontalOverlap

PropertyI64 cxpLinkSharingHorizontalOverlap

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.

◆ cxpLinkSharingHorizontalStripeCount

PropertyI64 cxpLinkSharingHorizontalStripeCount

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.

◆ cxpLinkSharingSubDeviceSelector

PropertyI64 cxpLinkSharingSubDeviceSelector

An integer property. Index of the sub device used in the Link Sharing.

Index of the sub device used in the Link Sharing.

◆ cxpLinkSharingSubDeviceType

PropertyI64 cxpLinkSharingSubDeviceType

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

◆ cxpLinkSharingVerticalOverlap

PropertyI64 cxpLinkSharingVerticalOverlap

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.

◆ cxpLinkSharingVerticalStripeCount

PropertyI64 cxpLinkSharingVerticalStripeCount

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.

◆ cxpPoCxpAuto

Method cxpPoCxpAuto

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.

◆ cxpPoCxpStatus

PropertyI64 cxpPoCxpStatus

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

◆ cxpPoCxpTripReset

Method cxpPoCxpTripReset

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

◆ cxpPoCxpTurnOff

Method cxpPoCxpTurnOff

A method object. Disable Power over CoaXPress (PoCXP) for the Link.

Disable Power over CoaXPress (PoCXP) for the Link.

◆ cxpSendReceiveSelector

PropertyI64 cxpSendReceiveSelector

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

◆ deviceTapGeometry

PropertyI64 deviceTapGeometry

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

◆ genDCDescriptor

PropertyS genDCDescriptor

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.

◆ genDCFlowMappingTable

PropertyS genDCFlowMappingTable

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.

◆ genDCStreamingMode

PropertyI64 genDCStreamingMode

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

◆ genDCStreamingStatus

PropertyI64 genDCStreamingStatus

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

◆ gevActiveLinkCount

PropertyI64 gevActiveLinkCount

An integer property. Indicates the current number of active logical links.

Indicates the current number of active logical links.

◆ gevCCP

PropertyI64 gevCCP

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

◆ gevCurrentDefaultGateway

PropertyI64 gevCurrentDefaultGateway

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.

◆ gevCurrentIPAddress

PropertyI64 gevCurrentIPAddress

An integer property. Reports the IP address for the given logical link.

Reports the IP address for the given logical link.

◆ gevCurrentIPConfigurationDHCP

PropertyIBoolean gevCurrentIPConfigurationDHCP

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.

◆ gevCurrentIPConfigurationLLA

PropertyIBoolean gevCurrentIPConfigurationLLA

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.

◆ gevCurrentIPConfigurationPersistentIP

PropertyIBoolean gevCurrentIPConfigurationPersistentIP

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.

◆ gevCurrentPhysicalLinkConfiguration

PropertyI64 gevCurrentPhysicalLinkConfiguration

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

◆ gevCurrentSubnetMask

PropertyI64 gevCurrentSubnetMask

An integer property. Reports the subnet mask of the given logical link.

Reports the subnet mask of the given logical link.

◆ gevDeviceClass

PropertyI64 gevDeviceClass

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

◆ gevDeviceModeCharacterSet

PropertyI64 gevDeviceModeCharacterSet

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

◆ gevDeviceModeIsBigEndian

PropertyIBoolean gevDeviceModeIsBigEndian

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.

◆ gevDiscoveryAckDelay

PropertyI64 gevDiscoveryAckDelay

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.

◆ gevFirstURL

PropertyS gevFirstURL

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.

◆ gevGVCPExtendedStatusCodes

PropertyIBoolean gevGVCPExtendedStatusCodes

A boolean property. Enables the generation of extended status codes.

Enables the generation of extended status codes.

◆ gevGVCPExtendedStatusCodesSelector

PropertyI64 gevGVCPExtendedStatusCodesSelector

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

◆ gevGVCPHeartbeatDisable

PropertyIBoolean gevGVCPHeartbeatDisable

A boolean property. This feature is deprecated (See DeviceLinkHeartbeatMode).

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

◆ gevGVCPPendingAck

PropertyIBoolean gevGVCPPendingAck

A boolean property. Enables the generation of PENDING_ACK.

Enables the generation of PENDING_ACK.

◆ gevGVCPPendingTimeout

PropertyI64 gevGVCPPendingTimeout

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.

◆ gevGVSPExtendedIDMode

PropertyI64 gevGVSPExtendedIDMode

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

◆ gevHeartbeatTimeout

PropertyI64 gevHeartbeatTimeout

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.

◆ gevIEEE1588

PropertyIBoolean gevIEEE1588

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.

◆ gevIEEE1588ClockAccuracy

PropertyI64 gevIEEE1588ClockAccuracy

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

◆ gevIEEE1588Status

PropertyI64 gevIEEE1588Status

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

◆ gevInterfaceSelector

PropertyI64 gevInterfaceSelector

An integer property. Selects which logical link to control.

Selects which logical link to control.

◆ gevIPConfigurationStatus

PropertyI64 gevIPConfigurationStatus

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

◆ gevLinkSpeed

PropertyI64 gevLinkSpeed

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.

◆ gevMACAddress

PropertyI64 gevMACAddress

An integer property. MAC address of the logical link.

MAC address of the logical link.

◆ gevMCDA

PropertyI64 gevMCDA

An integer property. Controls the destination IP address for the message channel.

Controls the destination IP address for the message channel.

◆ gevMCPHostPort

PropertyI64 gevMCPHostPort

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.

◆ gevMCRC

PropertyI64 gevMCRC

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.

◆ gevMCSP

PropertyI64 gevMCSP

An integer property. This feature indicates the source port for the message channel.

This feature indicates the source port for the message channel.

◆ gevMCTT

PropertyI64 gevMCTT

An integer property. Provides the transmission timeout value in milliseconds.

Provides the transmission timeout value in milliseconds.

◆ gevMessageChannelCount

PropertyI64 gevMessageChannelCount

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.

◆ gevNumberOfInterfaces

PropertyI64 gevNumberOfInterfaces

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.

◆ gevPAUSEFrameReception

PropertyIBoolean gevPAUSEFrameReception

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.

◆ gevPAUSEFrameTransmission

PropertyIBoolean gevPAUSEFrameTransmission

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.

◆ gevPersistentDefaultGateway

PropertyI64 gevPersistentDefaultGateway

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.

◆ gevPersistentIPAddress

PropertyI64 gevPersistentIPAddress

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.

◆ gevPersistentSubnetMask

PropertyI64 gevPersistentSubnetMask

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.

◆ gevPhysicalLinkConfiguration

PropertyI64 gevPhysicalLinkConfiguration

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

◆ gevPrimaryApplicationIPAddress

PropertyI64 gevPrimaryApplicationIPAddress

An integer property. Returns the address of the primary application.

Returns the address of the primary application.

◆ gevPrimaryApplicationSocket

PropertyI64 gevPrimaryApplicationSocket

An integer property. Returns the UDP source port of the primary application.

Returns the UDP source port of the primary application.

◆ gevPrimaryApplicationSwitchoverKey

PropertyI64 gevPrimaryApplicationSwitchoverKey

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.

◆ gevSCCFGAllInTransmission

PropertyIBoolean gevSCCFGAllInTransmission

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.

◆ gevSCCFGExtendedChunkData

PropertyIBoolean gevSCCFGExtendedChunkData

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.

◆ gevSCCFGPacketResendDestination

PropertyIBoolean gevSCCFGPacketResendDestination

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.

◆ gevSCCFGUnconditionalStreaming

PropertyIBoolean gevSCCFGUnconditionalStreaming

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

◆ gevSCDA

PropertyI64 gevSCDA

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.

◆ gevSCPD

PropertyI64 gevSCPD

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.

◆ gevSCPDirection

PropertyI64 gevSCPDirection

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

◆ gevSCPHostPort

PropertyI64 gevSCPHostPort

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.

◆ gevSCPInterfaceIndex

PropertyI64 gevSCPInterfaceIndex

An integer property. Index of the logical link to use.

Index of the logical link to use.

◆ gevSCPSBigEndian

PropertyIBoolean gevSCPSBigEndian

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.

◆ gevSCPSDoNotFragment

PropertyIBoolean gevSCPSDoNotFragment

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.

◆ gevSCPSFireTestPacket

PropertyIBoolean gevSCPSFireTestPacket

A boolean property. Sends a test packet.

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

◆ gevSCPSPacketSize

PropertyI64 gevSCPSPacketSize

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.

◆ gevSCSP

PropertyI64 gevSCSP

An integer property. Indicates the source port of the stream channel.

Indicates the source port of the stream channel.

◆ gevSCZoneConfigurationLock

PropertyIBoolean gevSCZoneConfigurationLock

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.

◆ gevSCZoneCount

PropertyI64 gevSCZoneCount

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.

◆ gevSCZoneDirectionAll

PropertyI64 gevSCZoneDirectionAll

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.

◆ gevSecondURL

PropertyS gevSecondURL

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.

◆ gevStreamChannelCount

PropertyI64 gevStreamChannelCount

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.

◆ gevStreamChannelSelector

PropertyI64 gevStreamChannelSelector

An integer property. Selects the stream channel to control.

Selects the stream channel to control.

◆ gevSupportedOption

PropertyIBoolean gevSupportedOption

A boolean property. Returns if the selected GEV option is supported.

Returns if the selected GEV option is supported.

◆ gevSupportedOptionSelector

PropertyI64 gevSupportedOptionSelector

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

◆ gevTimestampControlLatch

Method gevTimestampControlLatch

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.

◆ gevTimestampControlReset

Method gevTimestampControlReset

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.

◆ gevTimestampTickFrequency

PropertyI64 gevTimestampTickFrequency

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

◆ gevTimestampValue

PropertyI64 gevTimestampValue

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.

◆ gevVersionMajor

PropertyI64 gevVersionMajor

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.

◆ gevVersionMinor

PropertyI64 gevVersionMinor

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.

◆ mvCurrentUtcOffset

PropertyI64 mvCurrentUtcOffset

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.

◆ mvGevSCBW

PropertyI64 mvGevSCBW

An integer property. Sets the stream channels max. bandwidth in KBps.

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

◆ mvGevSCBWControl

PropertyI64 mvGevSCBWControl

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

◆ mvPtpClockMode

PropertyI64 mvPtpClockMode

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

◆ mvPtpTimescale

PropertyI64 mvPtpTimescale

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

◆ mvU3VEndpointResetEventCount

PropertyI64 mvU3VEndpointResetEventCount

An integer property. Counts the number of reset events received on all endpoints.

Counts the number of reset events received on all endpoints.

◆ mvU3VEndpointRetryEventCount

PropertyI64 mvU3VEndpointRetryEventCount

An integer property. Counts the number of retry events received on all endpoints.

Counts the number of retry events received on all endpoints.

◆ mvU3VEndpointSelector

PropertyI64 mvU3VEndpointSelector

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

◆ mvU3VErrorCounterReset

Method mvU3VErrorCounterReset

A method object. Resets the 'mvU3VPHYErrorCount' and 'mvU3VLNKErrorCount' registers.

Resets the 'mvU3VPHYErrorCount' and 'mvU3VLNKErrorCount' registers.

◆ mvU3VLNKErrorCount

PropertyI64 mvU3VLNKErrorCount

An integer property. Counts the number of errors on the USB3 link.

Counts the number of errors on the USB3 link.

◆ mvU3VPHYErrorCount

PropertyI64 mvU3VPHYErrorCount

An integer property. Counts the number of errors on the PHY interface.

Counts the number of errors on the PHY interface.

◆ mvU3VSpreadSpectrumClockingSupportDisable

Method mvU3VSpreadSpectrumClockingSupportDisable

A method object. Disable the spread spectrum clocking support.

Disable the spread spectrum clocking support.

◆ payloadSize

PropertyI64 payloadSize

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.

◆ ptpClockAccuracy

PropertyI64 ptpClockAccuracy

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

◆ ptpClockID

PropertyI64 ptpClockID

An integer property. Returns the latched clock ID of the PTP device.

Returns the latched clock ID of the PTP device.

◆ ptpDataSetLatch

Method ptpDataSetLatch

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.

◆ ptpEnable

PropertyIBoolean ptpEnable

A boolean property. Enables the Precision Time Protocol (PTP).

Enables the Precision Time Protocol (PTP).

◆ ptpGrandmasterClockID

PropertyI64 ptpGrandmasterClockID

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.

◆ ptpMeanPropagationDelay

PropertyI64 ptpMeanPropagationDelay

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.

◆ ptpOffsetFromMaster

PropertyI64 ptpOffsetFromMaster

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.

◆ ptpParentClockID

PropertyI64 ptpParentClockID

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.

◆ ptpServoStatus

PropertyI64 ptpServoStatus

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

◆ ptpStatus

PropertyI64 ptpStatus

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

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TransportLayerControl()

Member Function Documentation

◆ gevGetEffectiveBytesPerImage() [1/2]

◆ gevGetEffectiveBytesPerImage() [2/2]

◆ gevGetEffectivePayloadPacketsPerImage() [1/2]

◆ gevGetEffectivePayloadPacketsPerImage() [2/2]

◆ gevGetResultingBandwidth() [1/2]

◆ gevGetResultingBandwidth() [2/2]

◆ gevGetResultingPacketDelay() [1/2]

◆ gevGetResultingPacketDelay() [2/2]

Member Data Documentation

◆ aPAUSEMACCtrlFramesReceived

◆ aPAUSEMACCtrlFramesTransmitted

◆ clConfiguration

◆ clTimeSlotsCount

◆ cxpConnectionSelector

◆ cxpConnectionTestErrorCount

◆ cxpConnectionTestMode

◆ cxpConnectionTestPacketCount

◆ cxpErrorCounterReset

◆ cxpErrorCounterSelector

◆ cxpErrorCounterStatus

◆ cxpErrorCounterValue

◆ cxpFirstLineTriggerWithFrameStart

◆ cxpLinkConfiguration

◆ cxpLinkConfigurationPreferred

◆ cxpLinkConfigurationStatus

◆ cxpLinkSharingDuplicateStripe

◆ cxpLinkSharingEnable

◆ cxpLinkSharingHorizontalOverlap

◆ cxpLinkSharingHorizontalStripeCount

◆ cxpLinkSharingSubDeviceSelector

◆ cxpLinkSharingSubDeviceType

◆ cxpLinkSharingVerticalOverlap

◆ cxpLinkSharingVerticalStripeCount

◆ cxpPoCxpAuto

◆ cxpPoCxpStatus

◆ cxpPoCxpTripReset

◆ cxpPoCxpTurnOff

◆ cxpSendReceiveSelector

◆ deviceTapGeometry

◆ genDCDescriptor

◆ genDCFlowMappingTable

◆ genDCStreamingMode

◆ genDCStreamingStatus

◆ gevActiveLinkCount

◆ gevCCP

◆ gevCurrentDefaultGateway

◆ gevCurrentIPAddress

◆ gevCurrentIPConfigurationDHCP

◆ gevCurrentIPConfigurationLLA

◆ gevCurrentIPConfigurationPersistentIP

◆ gevCurrentPhysicalLinkConfiguration

◆ gevCurrentSubnetMask

◆ gevDeviceClass

◆ gevDeviceModeCharacterSet

◆ gevDeviceModeIsBigEndian

◆ gevDiscoveryAckDelay

◆ gevFirstURL

◆ gevGVCPExtendedStatusCodes

◆ gevGVCPExtendedStatusCodesSelector

◆ gevGVCPHeartbeatDisable

◆ gevGVCPPendingAck

◆ gevGVCPPendingTimeout

◆ gevGVSPExtendedIDMode

◆ gevHeartbeatTimeout

◆ gevIEEE1588

◆ gevIEEE1588ClockAccuracy

◆ gevIEEE1588Status

◆ gevInterfaceSelector

◆ gevIPConfigurationStatus

◆ gevLinkSpeed

◆ gevMACAddress

◆ gevMCDA

◆ gevMCPHostPort