mvIMPACT Acquire SDK C++

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

Inheritance diagram for SystemModule:
ComponentCollection

Public Member Functions

int64_type getInterfaceModuleCount (void)
 Returns the number of interfaces associated with this GenTL producer. 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...
 
 SystemModule (int64_type index=0)
 Constructs a new mvIMPACT::acquire::GenICam::SystemModule object. More...
 
 SystemModule (mvIMPACT::acquire::Device *pDev, int64_type index=0)
 Constructs a new mvIMPACT::acquire::GenICam::SystemModule object. More...
 

Static Public Member Functions

static int64_type getSystemModuleCount (void)
 Returns the number of GenTL producers detected in the current system. More...
 

Public Attributes

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 GenTL Producer implementation complies with. More...
 
PropertyI64 genCPVersionMinor
 An integer property. Indicates the minor version number of the GenCP specification this GenTL Producer implementation complies with. More...
 
PropertyI64 genTLSFNCVersionMajor
 An integer property. Defines the major version number of the GenTL SFNC specification the GenTL Producer implementation complies with. More...
 
PropertyI64 genTLSFNCVersionMinor
 An integer property. Defines the minor version number of the GenTL SFNC specification the GenTL Producer implementation complies with. More...
 
PropertyI64 genTLSFNCVersionSubMinor
 An integer property. Defines the sub minor version number of the GenTL SFNC specification the GenTL Producer implementation complies with. More...
 
PropertyI64 genTLVersionMajor
 An integer property. Defines the major version number of the GenTL specification the GenTL Producer implementation complies with. More...
 
PropertyI64 genTLVersionMinor
 An integer property. Defines the minor version number of the GenTL specification the GenTL Producer implementation complies with. More...
 
PropertyI64 gevInterfaceDefaultGateway
 An integer property. Indicates the default gateway of the first subnet of the selected interface. More...
 
PropertyI64 gevInterfaceDefaultIPAddress
 An integer property. Indicates the IP address of the first subnet of the selected interface. More...
 
PropertyI64 gevInterfaceDefaultSubnetMask
 An integer property. Indicates the subnet mask of the first subnet of the selected interface. More...
 
PropertyI64 gevInterfaceMACAddress
 An integer property. Indicates the 48-bit MAC address of the selected interface. More...
 
PropertyI64 gevVersionMajor
 An integer property. Indicates the major version number of the GigE Vision specification this GenTL Producer implementation complies with. More...
 
PropertyI64 gevVersionMinor
 An integer property. Indicates the minor version number of the GigE Vision specification this GenTL Producer implementation complies with. More...
 
PropertyS interfaceDisplayName
 A string property. A user-friendly name of the Interface. More...
 
PropertyS interfaceID
 A string property. GenTL producer wide unique identifier of the selected interface. More...
 
PropertyI64 interfaceSelector
 An integer property. Selector for the different GenTL Producer interfaces. More...
 
PropertyI64 interfaceType
 An enumerated integer property. Identifies the interfaces technology of the GenTL Producer implementation. More...
 
Method interfaceUpdateList
 A method object. Updates the internal interface list. More...
 
PropertyI64 interfaceUpdateTimeout
 An integer property. Specifies timeout for the InterfaceUpdateList Command. More...
 
PropertyI64 mvDeviceUpdateListBehaviour
 An enumerated integer property. Defines the behavior of the interface when the device list is being updated. More...
 
PropertyIBoolean mvGevChannelDummyPacketSendEnable
 A boolean property. Enables or disables the periodical sending of dummy packets to a stream or message channel source port of a GigE Vision device. More...
 
PropertyI64 mvGevChannelDummyPacketSendInterval
 An integer property. Defines the period(in ms) for sending dummy packets to a stream or message channel source port of a GigE Vision device. More...
 
PropertyI64 mvGevInterfaceLinkSpeed
 An integer property. Indicates the link speed of this interface. More...
 
PropertyI64 mvGevInterfaceMTU
 An integer property. Indicates the MTU of the selected interface. More...
 
PropertyIBoolean mvInterfaceTechnologyToIgnoreEnable
 A boolean property. When enabled, the selected interface technology type is ignored when updating the device list. More...
 
PropertyI64 mvInterfaceTechnologyToIgnoreSelector
 An enumerated integer property. Selects the interface technology type that should be ignored when updating the device list. More...
 
PropertyS TLDisplayName
 A string property. User readable name of the GenTL Producer. More...
 
PropertyS TLFileName
 A string property. Indicates the file name of the GenTL Producer driver including name and extension. More...
 
PropertyS TLID
 A string property. Indicates the ID of the transport layer. More...
 
PropertyS TLModelName
 A string property. Indicates the name of the transport layer Model. More...
 
PropertyS TLPath
 A string property. Indicates the full path to the GenTL Producer driver including name and extension. More...
 
PropertyI64 TLType
 An enumerated integer property. Identifies the transport layer technology of the GenTL Producer implementation. More...
 
PropertyS TLVendorName
 A string property. Indicates the name of the transport layer vendor. More...
 
PropertyS TLVersion
 A string property. Indicates a vendor specific version string for this transport layer. More...
 
PropertyI64 u3vVersionMajor
 An integer property. Indicates the major version number of the USB3 Vision specification this GenTL Producer implementation complies with. More...
 
PropertyI64 u3vVersionMinor
 An integer property. Indicates the minor version number of the USB3 Vision specification this GenTL Producer implementation complies with. More...
 

Protected Attributes

HOBJ m_hRoot
 

Detailed Description

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

The System category contains items that belong to the system module of the transport layer.

Constructor & Destructor Documentation

◆ SystemModule() [1/2]

SystemModule ( mvIMPACT::acquire::Device pDev,
int64_type  index = 0 
)
inlineexplicit

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

Parameters
[in]pDevA pointer to a mvIMPACT::acquire::Device object obtained from a mvIMPACT::acquire::DeviceManager object.
[in]indexThe index of the instance this object shall be created for. Passing an invalid index will raise an exception.

◆ SystemModule() [2/2]

SystemModule ( int64_type  index = 0)
inlineexplicit

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

Since
2.17.0
Parameters
[in]indexThe index of the instance this object shall be created for. Passing an invalid index will raise an exception.

Member Function Documentation

◆ getInterfaceModuleCount()

int64_type getInterfaceModuleCount ( void  )
inline

Returns the number of interfaces associated with this GenTL producer.

This should return the same value as when calling mvIMPACT::acquire::GenICam::SystemModule::interfaceSelector::getMaxValue however there are producers out there that do not implement the interfaceSelector property correctly.

Since
2.34.0

◆ getSystemModuleCount()

static int64_type getSystemModuleCount ( void  )
inlinestatic

Returns the number of GenTL producers detected in the current system.

This is also the number of system modules detected thus this value - 1 defines the maximum value that can be passed as the index parameter into a mvIMPACT::acquire::SystemModule constructor.

Since
2.32.0

◆ 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

◆ 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 GenTL Producer implementation complies with.

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

◆ genCPVersionMinor

PropertyI64 genCPVersionMinor

An integer property. Indicates the minor version number of the GenCP specification this GenTL Producer implementation complies with.

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

◆ genTLSFNCVersionMajor

PropertyI64 genTLSFNCVersionMajor

An integer property. Defines the major version number of the GenTL SFNC specification the GenTL Producer implementation complies with.

This is a read only element. It defines the major version number of the GenTL SFNC specification the GenTL Producer implementation complies with.

◆ genTLSFNCVersionMinor

PropertyI64 genTLSFNCVersionMinor

An integer property. Defines the minor version number of the GenTL SFNC specification the GenTL Producer implementation complies with.

This is a read only element. It defines the minor version number of the GenTL SFNC specification the GenTL Producer implementation complies with.

◆ genTLSFNCVersionSubMinor

PropertyI64 genTLSFNCVersionSubMinor

An integer property. Defines the sub minor version number of the GenTL SFNC specification the GenTL Producer implementation complies with.

This is a read only element. It defines the sub minor version number of the GenTL SFNC specification the GenTL Producer implementation complies with.

◆ genTLVersionMajor

PropertyI64 genTLVersionMajor

An integer property. Defines the major version number of the GenTL specification the GenTL Producer implementation complies with.

This is a read only element. It defines the major version number of the GenTL specification the GenTL Producer implementation complies with.

◆ genTLVersionMinor

PropertyI64 genTLVersionMinor

An integer property. Defines the minor version number of the GenTL specification the GenTL Producer implementation complies with.

This is a read only element. It defines the minor version number of the GenTL specification the GenTL Producer implementation complies with.

◆ gevInterfaceDefaultGateway

PropertyI64 gevInterfaceDefaultGateway

An integer property. Indicates the default gateway of the first subnet of the selected interface.

This is a read only element. It indicates the default gateway of the first subnet of the selected interface.

◆ gevInterfaceDefaultIPAddress

PropertyI64 gevInterfaceDefaultIPAddress

An integer property. Indicates the IP address of the first subnet of the selected interface.

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

◆ gevInterfaceDefaultSubnetMask

PropertyI64 gevInterfaceDefaultSubnetMask

An integer property. Indicates the subnet mask of the first subnet of the selected interface.

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

◆ gevInterfaceMACAddress

PropertyI64 gevInterfaceMACAddress

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

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

◆ gevVersionMajor

PropertyI64 gevVersionMajor

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

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

◆ gevVersionMinor

PropertyI64 gevVersionMinor

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

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

◆ interfaceDisplayName

PropertyS interfaceDisplayName

A string property. A user-friendly name of the Interface.

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

◆ interfaceID

PropertyS interfaceID

A string property. GenTL producer wide unique identifier of the selected interface.

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

◆ interfaceSelector

PropertyI64 interfaceSelector

An integer property. Selector for the different GenTL Producer interfaces.

Selector for the different GenTL Producer interfaces. Selector for the different GenTL Producer interfaces. This interface list only changes on execution of InterfaceUpdateList. The selector is 0-based in order to match the index of the C interface.

◆ interfaceType

PropertyI64 interfaceType

An enumerated integer property. Identifies the interfaces technology of the GenTL Producer implementation.

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

The following string values might be valid for this feature:

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

◆ interfaceUpdateList

Method interfaceUpdateList

A method object. Updates the internal interface list.

This command updates the internal interface list of this transport layer.

◆ interfaceUpdateTimeout

PropertyI64 interfaceUpdateTimeout

An integer property. Specifies timeout for the InterfaceUpdateList Command.

Specifies timeout for the InterfaceUpdateList Command.

◆ m_hRoot

HOBJ m_hRoot
protectedinherited

◆ mvDeviceUpdateListBehaviour

PropertyI64 mvDeviceUpdateListBehaviour

An enumerated integer property. Defines the behavior of the interface when the device list is being updated.

Defines the behavior of the interface when the device list is being updated.

The following string values might be valid for this feature:

  • NotConfigured (Display string: 'Not Configured'): Interface will enumerate devices or not according to the general enumeration behavior of this interface type(according to mvInterfaceTechnologyToIgnoreEnable setting).
  • ForceIgnore (Display string: 'Force Ignore'): Interface will not enumerate devices, regardless of the the general enumeration behavior of this interface type(overrides mvInterfaceTechnologyToIgnoreEnable setting).
  • ForceEnumerate (Display string: 'Force Enumerate'): Interface will forcefully enumerate devices, regardless of the the general enumeration behavior of this interface type(overrides mvInterfaceTechnologyToIgnoreEnable setting).
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.

◆ mvGevChannelDummyPacketSendEnable

PropertyIBoolean mvGevChannelDummyPacketSendEnable

A boolean property. Enables or disables the periodical sending of dummy packets to a stream or message channel source port of a GigE Vision device.

Enables or disables the periodical sending of dummy packets to a stream or message channel source port of a GigE Vision device. This might be useful to overcome firewall related problems when working with network devices.

◆ mvGevChannelDummyPacketSendInterval

PropertyI64 mvGevChannelDummyPacketSendInterval

An integer property. Defines the period(in ms) for sending dummy packets to a stream or message channel source port of a GigE Vision device.

Defines the period(in ms) for sending dummy packets to a stream or message channel source port of a GigE Vision device. This might be useful to overcome firewall related problems when working with network devices.

◆ mvGevInterfaceLinkSpeed

PropertyI64 mvGevInterfaceLinkSpeed

An integer property. Indicates the link speed of this interface.

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

◆ mvGevInterfaceMTU

PropertyI64 mvGevInterfaceMTU

An integer property. Indicates the MTU of the selected interface.

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

◆ mvInterfaceTechnologyToIgnoreEnable

PropertyIBoolean mvInterfaceTechnologyToIgnoreEnable

A boolean property. When enabled, the selected interface technology type is ignored when updating the device list.

When enabled, the selected interface technology type is ignored when updating the device list.

◆ mvInterfaceTechnologyToIgnoreSelector

PropertyI64 mvInterfaceTechnologyToIgnoreSelector

An enumerated integer property. Selects the interface technology type that should be ignored when updating the device list.

Selects the interface technology type that should be ignored when updating the device list.

The following string values might be valid for this feature:

  • Mixed (Display string: 'Mixed')
  • Custom (Display string: 'Custom')
  • GEV (Display string: 'GigE Vision')
  • CameraLink (Display string: 'CameraLink')
  • CoaXPress (Display string: 'CoaXPress')
  • CameraLinkHS (Display string: 'CameraLink HS')
  • U3V (Display string: 'USB3 Vision')
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.

◆ TLDisplayName

PropertyS TLDisplayName

A string property. User readable name of the GenTL Producer.

This is a read only element. It is a string that indicates a user readable name of the GenTL Producer.

◆ TLFileName

PropertyS TLFileName

A string property. Indicates the file name of the GenTL Producer driver including name and extension.

This is a read only element. It is a string that indicates the file name of the GenTL Producer driver including name and extension.

◆ TLID

PropertyS TLID

A string property. Indicates the ID of the transport layer.

This is a read only element. It is a string that indicates the ID of the transport layer.

◆ TLModelName

PropertyS TLModelName

A string property. Indicates the name of the transport layer Model.

This is a read only element. It is a string that indicates the name of the transport layer Model to distinguish different kinds of GenTL Producer implementations from one vendor.

◆ TLPath

PropertyS TLPath

A string property. Indicates the full path to the GenTL Producer driver including name and extension.

This is a read only element. It is a string that indicates the full path to the GenTL Producer driver including name and extension.

◆ TLType

PropertyI64 TLType

An enumerated integer property. Identifies the transport layer technology of the GenTL Producer implementation.

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

The following string values might be valid for this feature:

  • Mixed (Display string: 'Mixed'): This enumeration value indicates that this is a transport layer for a mixed protocol.
  • Custom (Display string: 'Custom'): This enumeration value indicates that this is a transport layer for a custom protocol.
  • GEV (Display string: 'GigE Vision'): This enumeration value indicates that this is a transport layer for the GigE Vision protocol.
  • CameraLink (Display string: 'CameraLink'): This enumeration value indicates that this is a transport layer for the CameraLink protocol.
  • CoaXPress (Display string: 'CoaXPress'): This enumeration value indicates that this is a transport layer for the CoaXPress protocol.
  • CameraLinkHS (Display string: 'CameraLink HS'): This enumeration value indicates that this is a transport layer for the CameraLink HS protocol.
  • U3V (Display string: 'USB3 Vision'): This enumeration value indicates that this is a transport layer 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.

◆ TLVendorName

PropertyS TLVendorName

A string property. Indicates the name of the transport layer vendor.

This is a read only element. It is a string that indicates the name of the transport layer vendor.

◆ TLVersion

PropertyS TLVersion

A string property. Indicates a vendor specific version string for this transport layer.

This is a read only element. It is a string that indicates a vendor specific version string for this transport layer.

◆ u3vVersionMajor

PropertyI64 u3vVersionMajor

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

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

◆ u3vVersionMinor

PropertyI64 u3vVersionMinor

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

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


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