mvIMPACT Acquire SDK C++

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

Inheritance diagram for DeviceModule:
ComponentCollection

Public Member Functions

 DeviceModule (mvIMPACT::acquire::Device *pDev, const std::string &settingName="Base")
 Constructs a new mvIMPACT::acquire::GenICam::DeviceModule object. More...
 
HOBJ hObj (void) const
 Returns a unique identifier for the component collection referenced by this object. More...
 
const ComponentCollectionrestoreDefault (void) const
 Restores the default for every component of this collection. More...
 

Public Attributes

PropertyI64 deviceAccessStatus
 An enumerated integer property. Indicates the current access status for the device. More...
 
PropertyI64 deviceChunkDataFormat
 An enumerated integer property. Indicates the chunk data format used by the remote device. More...
 
PropertyS deviceDisplayName
 A string property. Indicates user readable name for the remote device. More...
 
PropertyI64 deviceEndianessMechanism
 An enumerated integer property. Identifies the endianess mode to be used for this device. More...
 
PropertyI64 deviceEventDataFormat
 An enumerated integer property. Indicates the event data format used by the remote device. More...
 
PropertyS deviceFamilyName
 A string property. Identifier of the product family of the device. More...
 
PropertyS deviceID
 A string property. This feature is deprecated (See DeviceSerialNumber). More...
 
PropertyS deviceManufacturerInfo
 A string property. Manufacturer information about the device. More...
 
PropertyS deviceModelName
 A string property. Model of the device. More...
 
PropertyS deviceSerialNumber
 A string property. Device's serial number. More...
 
PropertyI64 deviceTimestampFrequency
 An integer property. Indicates the tick-frequency of the timestamp clock of the remote device. More...
 
PropertyI64 deviceType
 An enumerated integer property. Returns the device type. More...
 
PropertyS deviceUserID
 A string property. User-programmable device identifier. More...
 
PropertyS deviceVendorName
 A string property. Name of the manufacturer of the device. More...
 
PropertyS deviceVersion
 A string property. Version of the device. More...
 
PropertyI64 eventNotification
 An enumerated integer property. Activate or deactivate the notification to the host application of the occurrence of the selected Event. More...
 
PropertyI64 eventSelector
 An enumerated integer property. Selects which Event to signal to the host application. More...
 
PropertyI64 genCPVersionMajor
 An integer property. Indicates the major version number of the GenCP specification this device complies with. More...
 
PropertyI64 genCPVersionMinor
 An integer property. Indicates the minor version number of the GenCP specification this device complies with. More...
 
PropertyI64 gevDeviceGateway
 An integer property. Indicates the current gateway of the GVCP interface of the selected remote device. More...
 
PropertyI64 gevDeviceIPAddress
 An integer property. Indicates the current IP address of the GVCP interface of the selected remote device. More...
 
PropertyI64 gevDeviceMACAddress
 An integer property. Indicates the 48-bit MAC address of the GVCP interface of the selected remote device. More...
 
PropertyI64 gevDeviceSubnetMask
 An integer property. Indicates the current subnet mask of the GVCP interface of the selected remote device. More...
 
PropertyI64 gevVersionMajor
 An integer property. Indicates the major version number of the GigE Vision specification this device complies with. More...
 
PropertyI64 gevVersionMinor
 An integer property. Indicates the minor version number of the GigE Vision specification this device complies with. More...
 
PropertyI64 linkCommandRetryCount
 An integer property. Specifies maximum number of tries before failing the control channel commands. More...
 
PropertyF linkCommandTimeout
 A floating point property. Specifies application timeout for the control channel communication. More...
 
PropertyS mvDeviceLicenseDetails
 A string property. Details about the granted license. More...
 
PropertyIBoolean mvDeviceLicenseValid
 A boolean property. True if the current device has a valid license. More...
 
PropertyI64 mvLinkCommandTimeoutCheckGranularity
 An integer property. Indicates how often the driver shall check the link during one 'DeviceLinkCommandTimeout' interval. More...
 
PropertyS mvU3VDeviceGUID
 A string property. Indicates the USB3 Vision GUID of the device. More...
 
PropertyS streamID
 A string property. Device wide unique ID of the selected stream. More...
 
PropertyI64 streamSelector
 An integer property. Selects the stream channel. More...
 
PropertyI64 u3vVersionMajor
 An integer property. Indicates the major version number of the USB3 Vision specification this device complies with. More...
 
PropertyI64 u3vVersionMinor
 An integer property. Indicates the minor version number of the USB3 Vision specification this device complies with. More...
 

Protected Attributes

HOBJ m_hRoot
 

Detailed Description

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

The Device category contains items that belong to the device module of the transport layer.

Constructor & Destructor Documentation

◆ DeviceModule()

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

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

Parameters
[in]pDevA pointer to a mvIMPACT::acquire::Device object obtained from a mvIMPACT::acquire::DeviceManager object.
[in]settingNameThe 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

◆ hObj()

HOBJ hObj ( void  ) const
inlineinherited

Returns a unique identifier for the component collection referenced by this object.

This handle will always reference an object of type mvIMPACT::acquire::ComponentList.

Returns
A unique identifier for the component referenced by this object.

◆ restoreDefault()

const ComponentCollection& restoreDefault ( void  ) const
inlineinherited

Restores the default for every component of this collection.

Calling this function will restore the default value for every component belonging to this collection.

Note
The caller must have the right to modify the component. Otherwise an exception will be thrown.
Returns
A const reference to the component.

Member Data Documentation

◆ deviceAccessStatus

PropertyI64 deviceAccessStatus

An enumerated integer property. Indicates the current access status for the device.

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

The following string values might be valid for this feature:

  • Unknown (Display string: 'Unknown'): This enumeration value indicates that the device accessibility is not known.
  • ReadWrite (Display string: 'Read/Write'): This enumeration value indicates that full access to the device is available.
  • ReadOnly (Display string: 'Read Only'): This enumeration value indicates that read access to the device is available.
  • NoAccess (Display string: 'No Access'): This enumeration value indicates that no access to the device is available.
  • Busy (Display string: 'Busy'): This enumeration value indicates that the device is already opened by another entity.
  • OpenReadWrite (Display string: 'Open Read Write'): This enumeration value indicates that the device is open in Read/Write mode by this GenTL host.
  • OpenReadOnly (Display string: 'Open Read Only'): This enumeration value indicates that the device is open in Read only mode by this GenTL host.
Note
Depending on the device some of these values might not be supported and especially when working with third party devices there might be custom values which are not listed here. To get a complete and reliable list of supported values at runtime an application should therefore call mvIMPACT::acquire::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ deviceChunkDataFormat

PropertyI64 deviceChunkDataFormat

An enumerated integer property. Indicates the chunk data format used by the remote device.

This is a read only feature. This enumeration provides a value that indicates the chunk data format used by the remote device.

The following string values might be valid for this feature:

  • None (Display string: 'None'): This enumeration value indicates that the device does not use chunk data at all.
  • GigEVision (Display string: 'GigE Vision'): This enumeration value indicates that the device formats the chunk data using chunk data format defined by GigE Vision specification version 1.x. The chunk data decoding algorithm (chunk adapter) common for the GigE Vision devices can be used.
  • Custom (Display string: 'Custom'): This enumeration value indicates that the device formats the chunk data using a custom, non-standard format. Without a-priori additional knowledge about the device and its implementation, the GenTL Consumer should always use the generic chunk adapter to decode the chunk data, not making any assumptions about the internal event data layout..
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.

◆ deviceDisplayName

PropertyS deviceDisplayName

A string property. Indicates user readable name for the remote device.

This is a read only element. It is a string that indicates user readable name for the remote device model.

◆ deviceEndianessMechanism

PropertyI64 deviceEndianessMechanism

An enumerated integer property. Identifies the endianess mode to be used for this device.

This is a read only feature. This enumeration provides a value that indicates the endianess mode to be used for this device.

The following string values might be valid for this feature:

  • Legacy (Display string: 'Legacy'): This enumeration value indicates that this device shall be handled according to GenICam Schema 1.0.
  • Standard (Display string: 'Standard'): This enumeration value indicates that this device shall be handled according to GenICam Schema 1.1 and later.
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.

◆ deviceEventDataFormat

PropertyI64 deviceEventDataFormat

An enumerated integer property. Indicates the event data format used by the remote device.

This is a read only feature. This enumeration provides a value that indicates the event data format used by the remote device.

The following string values might be valid for this feature:

  • None (Display string: 'None'): This enumeration value indicates that the device does not use event data at all.
  • GigEVision (Display string: 'GigE Vision'): This enumeration value indicates that the device formats the event data using the event data format defined by GigE Vision specification version 1.x. The event data decoding algorithm (event adapter) common for the GigE Vision devices can be used.
  • GigEVisionExtendedId (Display string: 'GigE Vision Extended Id'): This enumeration value indicates that the device formats the event data using the event data format defined by GigE Vision specification version 2.x. The event data decoding algorithm (event adapter) common for the GigE Vision devices can be used.
  • Custom (Display string: 'Custom'): This enumeration value indicates that the device formats the event data using a custom, non-standard format. Without a-priori additional knowledge about the device and its implementation, the GenTL Consumer should always use the generic event adapter to decode the event data, not making any assumptions about the internal event data layout..
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.

◆ deviceFamilyName

PropertyS deviceFamilyName

A string property. Identifier of the product family of the device.

Identifier of the product family of the device.

◆ deviceID

PropertyS deviceID

A string property. This feature is deprecated (See DeviceSerialNumber).

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

◆ deviceManufacturerInfo

PropertyS deviceManufacturerInfo

A string property. Manufacturer information about the device.

Manufacturer information about the device.

◆ deviceModelName

PropertyS deviceModelName

A string property. Model of the device.

Model of the device.

◆ deviceSerialNumber

PropertyS deviceSerialNumber

A string property. Device's serial number.

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

◆ deviceTimestampFrequency

PropertyI64 deviceTimestampFrequency

An integer property. Indicates the tick-frequency of the timestamp clock of the remote device.

Indicates the tick-frequency of the timestamp clock of the remote device.

◆ deviceType

PropertyI64 deviceType

An enumerated integer property. Returns the device type.

Returns the device type.

The following string values might be valid for this feature:

  • Transmitter (Display string: 'Transmitter'): Data stream transmitter device.
  • Receiver (Display string: 'Receiver'): Data stream receiver device.
  • Transceiver (Display string: 'Transceiver'): Data stream receiver and transmitter device.
  • Peripheral (Display string: 'Peripheral'): Controllable device (with no data stream handling).
  • Mixed (Display string: 'Mixed'): This enumeration value indicates that this is a device for a mixed protocol.
  • Custom (Display string: 'Custom'): This enumeration value indicates that this is a device for a custom protocol.
  • GEV (Display string: 'GigE Vision'): This enumeration value indicates that this is a device for the GigE Vision protocol.
  • CameraLink (Display string: 'CameraLink'): This enumeration value indicates that this is a device for the CameraLink protocol.
  • CoaXPress (Display string: 'CoaXPress'): This enumeration value indicates that this is a device for the CoaXPress protocol.
  • CameraLinkHS (Display string: 'CameraLink HS'): This enumeration value indicates that this is a device for the CameraLink HS protocol.
  • U3V (Display string: 'USB3 Vision'): This enumeration value indicates that this is a device for the USB3 Vision protocol.
Note
Depending on the device some of these values might not be supported and especially when working with third party devices there might be custom values which are not listed here. To get a complete and reliable list of supported values at runtime an application should therefore call mvIMPACT::acquire::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ deviceUserID

PropertyS deviceUserID

A string property. User-programmable device identifier.

User-programmable device identifier.

◆ deviceVendorName

PropertyS deviceVendorName

A string property. Name of the manufacturer of the device.

Name of the manufacturer of the device.

◆ deviceVersion

PropertyS deviceVersion

A string property. Version of the device.

Version of the device.

◆ eventNotification

PropertyI64 eventNotification

An enumerated integer property. Activate or deactivate the notification to the host application of the occurrence of the selected Event.

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

The following string values might be valid for this feature:

  • Off (Display string: 'Off'): The selected Event notification is disabled.
  • On (Display string: 'On'): The selected Event notification is enabled.
  • Once (Display string: 'Once'): The selected Event notification is enabled for one event then return to Off state.
  • GigEVisionEvent (Display string: 'Gig E Vision Event')
Note
Depending on the device some of these values might not be supported and especially when working with third party devices there might be custom values which are not listed here. To get a complete and reliable list of supported values at runtime an application should therefore call mvIMPACT::acquire::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ eventSelector

PropertyI64 eventSelector

An enumerated integer property. Selects which Event to signal to the host application.

Selects which Event to signal to the host application.

The following string values might be valid for this feature:

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

◆ genCPVersionMajor

PropertyI64 genCPVersionMajor

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

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

◆ genCPVersionMinor

PropertyI64 genCPVersionMinor

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

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

◆ gevDeviceGateway

PropertyI64 gevDeviceGateway

An integer property. Indicates the current gateway of the GVCP interface of the selected remote device.

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

◆ gevDeviceIPAddress

PropertyI64 gevDeviceIPAddress

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

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

◆ gevDeviceMACAddress

PropertyI64 gevDeviceMACAddress

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

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

◆ gevDeviceSubnetMask

PropertyI64 gevDeviceSubnetMask

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

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

◆ gevVersionMajor

PropertyI64 gevVersionMajor

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

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

◆ gevVersionMinor

PropertyI64 gevVersionMinor

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

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

◆ linkCommandRetryCount

PropertyI64 linkCommandRetryCount

An integer property. Specifies maximum number of tries before failing the control channel commands.

This feature specifies maximum number of tries before failing the control channel commands.

◆ linkCommandTimeout

PropertyF linkCommandTimeout

A floating point property. Specifies application timeout for the control channel communication.

The feature specifies application timeout for the control channel communication. It defines the application timeout, and it is related to the device feature DeviceLinkCommandTimeout specifying the maximum time for handling a command in the device. Up to DeviceLinkCommandRetryCount attempts with this timeout are made before a command fails with a timout error.

◆ m_hRoot

HOBJ m_hRoot
protectedinherited

◆ mvDeviceLicenseDetails

PropertyS mvDeviceLicenseDetails

A string property. Details about the granted license.

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

◆ mvDeviceLicenseValid

PropertyIBoolean mvDeviceLicenseValid

A boolean property. True if the current device has a valid license.

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

◆ mvLinkCommandTimeoutCheckGranularity

PropertyI64 mvLinkCommandTimeoutCheckGranularity

An integer property. Indicates how often the driver shall check the link during one 'DeviceLinkCommandTimeout' interval.

Indicates how often the driver shall check the link during one 'DeviceLinkCommandTimeout' interval. The higher this value the more often the link will be checked. However additional traffic on the link is only generated if no other communication like polling certain registers, reading or writing is performed by an application. A higher value will result in a faster notification in case a device has been physically been unplugged.

◆ mvU3VDeviceGUID

PropertyS mvU3VDeviceGUID

A string property. Indicates the USB3 Vision GUID of the device.

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

◆ streamID

PropertyS streamID

A string property. Device wide unique ID of the selected stream.

This is a read only element. It is a string that indicates a device wide unique identifier of the selected stream.

◆ streamSelector

PropertyI64 streamSelector

An integer property. Selects the stream channel.

Selects the stream channel.

◆ u3vVersionMajor

PropertyI64 u3vVersionMajor

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

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

◆ u3vVersionMinor

PropertyI64 u3vVersionMinor

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

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


The documentation for this class was generated from the following file: