mvIMPACT Acquire SDK C++

Category for the data Transfer Control features. More...

#include <mvIMPACT_acquire_GenICam.h>

Public Member Functions

 TransferControl (mvIMPACT::acquire::Device *pDev, const std::string &settingName="Base")
 Constructs a new mvIMPACT::acquire::GenICam::TransferControl object.
 

Public Attributes

Method transferAbort
 A method object. Aborts immediately the streaming of data block(s).
 
PropertyI64 transferBlockCount
 An integer property. Specifies the number of data Blocks that the device should stream before stopping.
 
PropertyI64 transferBurstCount
 An integer property. Number of Block(s) to transfer for each TransferBurstStart trigger.
 
PropertyI64 transferComponentSelector
 An enumerated integer property. Selects the color component for the control of the TransferStreamChannel feature.
 
PropertyI64 transferControlMode
 An enumerated integer property. Selects the control method for the transfers.
 
PropertyI64 transferOperationMode
 An enumerated integer property. Selects the operation mode of the transfer.
 
Method transferPause
 A method object. Pauses the streaming of data Block(s).
 
PropertyI64 transferQueueCurrentBlockCount
 An integer property. Returns the number of Block(s) currently in the transfer queue.
 
PropertyI64 transferQueueMaxBlockCount
 An integer property. Controls the maximum number of data blocks that can be stored in the block queue of the selected stream.
 
PropertyI64 transferQueueMode
 An enumerated integer property. Specifies the operation mode of the transfer queue.
 
Method transferResume
 A method object. Resumes a data Blocks streaming that was previously paused by a TransferPause command.
 
PropertyI64 transferSelector
 An enumerated integer property. Selects which stream transfers are currently controlled by the selected Transfer features.
 
Method transferStart
 A method object. Starts the streaming of data blocks out of the device.
 
PropertyIBoolean transferStatus
 A boolean property. Reads the status of the Transfer module signal selected by TransferStatusSelector.
 
PropertyI64 transferStatusSelector
 An enumerated integer property. Selects which status of the transfer module to read.
 
Method transferStop
 A method object. Stops the streaming of data Block(s).
 
PropertyI64 transferStreamChannel
 An integer property. Selects the streaming channel that will be used to transfer the selected stream of data.
 
PropertyI64 transferTriggerActivation
 An enumerated integer property. Specifies the activation mode of the transfer control trigger.
 
PropertyI64 transferTriggerMode
 An enumerated integer property. Controls if the selected trigger is active.
 
PropertyI64 transferTriggerSelector
 An enumerated integer property. Selects the type of transfer trigger to configure.
 
PropertyI64 transferTriggerSource
 An enumerated integer property. Specifies the signal to use as the trigger source for transfers.
 

Detailed Description

Category for the data Transfer Control features.

A category for the data Transfer Control features.

Constructor & Destructor Documentation

◆ TransferControl()

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

Constructs a new mvIMPACT::acquire::GenICam::TransferControl 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 Data Documentation

◆ transferAbort

Method transferAbort

A method object. Aborts immediately the streaming of data block(s).

Aborts immediately the streaming of data block(s). Aborting the transfer will result in the lost of the data that is present or currently entering in the block queue. However, the next new block received will be stored in the queue and transferred to the host when the streaming is restarted. If implemented, this feature should be available when the TransferControlMode is set to 'UserControlled'.

◆ transferBlockCount

PropertyI64 transferBlockCount

An integer property. Specifies the number of data Blocks that the device should stream before stopping.

Specifies the number of data Blocks that the device should stream before stopping. This feature is only active if the TransferOperationMode is set to MultiBlock.

◆ transferBurstCount

PropertyI64 transferBurstCount

An integer property. Number of Block(s) to transfer for each TransferBurstStart trigger.

Number of Block(s) to transfer for each TransferBurstStart trigger.

◆ transferComponentSelector

PropertyI64 transferComponentSelector

An enumerated integer property. Selects the color component for the control of the TransferStreamChannel feature.

Selects the color component for the control of the TransferStreamChannel feature.

The following string values might be valid for this feature:

  • Red (Display string: 'Red'): The TransferStreamChannel feature controls the index of the stream channel for the streaming of the red plane of the planar pixel formats.
  • Green (Display string: 'Green'): The TransferStreamChannel feature controls the index of the stream channel for the streaming of the green plane of the planar pixel formats.
  • Blue (Display string: 'Blue'): The TransferStreamChannel feature controls the index of the stream channel for the streaming of blue plane of the planar pixel formats.
  • All (Display string: 'All'): The TransferStreamChannel feature controls the index of the stream channel for the streaming of all the planes of the planar pixel formats simultaneously or non planar pixel formats.
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.

◆ transferControlMode

PropertyI64 transferControlMode

An enumerated integer property. Selects the control method for the transfers.

Selects the control method for the transfers.

The following string values might be valid for this feature:

  • Basic (Display string: 'Basic'): Basic
  • Automatic (Display string: 'Automatic'): Automatic
  • UserControlled (Display string: 'User Controlled'): User Controlled
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.

◆ transferOperationMode

PropertyI64 transferOperationMode

An enumerated integer property. Selects the operation mode of the transfer.

Selects the operation mode of the transfer.

The following string values might be valid for this feature:

  • Continuous (Display string: 'Continuous'): Continuous
  • MultiBlock (Display string: 'Multi Block'): Multi Block
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.

◆ transferPause

Method transferPause

A method object. Pauses the streaming of data Block(s).

Pauses the streaming of data Block(s). Pausing the streaming will immediately suspend the ongoing data transfer even if a block is partially transfered. The device will resume its transmission at the reception of a TransferResume command.

◆ transferQueueCurrentBlockCount

PropertyI64 transferQueueCurrentBlockCount

An integer property. Returns the number of Block(s) currently in the transfer queue.

Returns the number of Block(s) currently in the transfer queue.

◆ transferQueueMaxBlockCount

PropertyI64 transferQueueMaxBlockCount

An integer property. Controls the maximum number of data blocks that can be stored in the block queue of the selected stream.

Controls the maximum number of data blocks that can be stored in the block queue of the selected stream.

◆ transferQueueMode

PropertyI64 transferQueueMode

An enumerated integer property. Specifies the operation mode of the transfer queue.

Specifies the operation mode of the transfer queue.

The following string values might be valid for this feature:

  • FirstInFirstOut (Display string: 'First In First Out'): Blocks first In are transferred Out first.
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.

◆ transferResume

Method transferResume

A method object. Resumes a data Blocks streaming that was previously paused by a TransferPause command.

Resumes a data Blocks streaming that was previously paused by a TransferPause command.

◆ transferSelector

PropertyI64 transferSelector

An enumerated integer property. Selects which stream transfers are currently controlled by the selected Transfer features.

Selects which stream transfers are currently controlled by the selected Transfer features.

The following string values might be valid for this feature:

  • Stream0 (Display string: 'Stream 0'): The transfer features control the data stream 0.
  • Stream1 (Display string: 'Stream 1'): The transfer features control the data stream 1.
  • Stream2 (Display string: 'Stream 2'): The transfer features control the data stream 2.
  • Stream#3# (Display string: 'Stream #3#'): The transfer features control the data stream #3#.
  • All (Display string: 'All'): The transfer features control all the data streams simultaneously.
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.

◆ transferStart

Method transferStart

A method object. Starts the streaming of data blocks out of the device.

Starts the streaming of data blocks out of the device. This feature must be available when the TransferControlMode is set to 'UserControlled'. If the TransferStart feature is not writable (locked), the application should not start the transfer and should avoid using the feature until it becomes writable again.

◆ transferStatus

PropertyIBoolean transferStatus

A boolean property. Reads the status of the Transfer module signal selected by TransferStatusSelector.

Reads the status of the Transfer module signal selected by TransferStatusSelector.

◆ transferStatusSelector

PropertyI64 transferStatusSelector

An enumerated integer property. Selects which status of the transfer module to read.

Selects which status of the transfer module to read.

The following string values might be valid for this feature:

  • Streaming (Display string: 'Streaming'): Data blocks are transmitted when enough data is available.
  • Paused (Display string: 'Paused'): Data blocks transmission is suspended immediately.
  • Stopping (Display string: 'Stopping'): Data blocks transmission is stopping. The current block transmission will be completed and the transfer state will stop.
  • Stopped (Display string: 'Stopped'): Data blocks transmission is stopped.
  • QueueOverflow (Display string: 'Queue Overflow'): Data blocks queue is in overflow state.
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.

◆ transferStop

Method transferStop

A method object. Stops the streaming of data Block(s).

Stops the streaming of data Block(s). The current block transmission will be completed. This feature must be available when the TransferControlMode is set to 'UserControlled'.

◆ transferStreamChannel

PropertyI64 transferStreamChannel

An integer property. Selects the streaming channel that will be used to transfer the selected stream of data.

Selects the streaming channel that will be used to transfer the selected stream of data. In general, this feature can be omitted and the default streaming channel will be used.

◆ transferTriggerActivation

PropertyI64 transferTriggerActivation

An enumerated integer property. Specifies the activation mode of the transfer control trigger.

Specifies the activation mode of the transfer control trigger.

The following string values might be valid for this feature:

  • RisingEdge (Display string: 'Rising Edge'): Specifies that the trigger is considered valid on the rising edge of the source signal.
  • FallingEdge (Display string: 'Falling Edge'): Specifies that the trigger is considered valid on the falling edge of the source signal.
  • AnyEdge (Display string: 'Any Edge'): Specifies that the trigger is considered valid on the falling or rising edge of the source signal.
  • LevelHigh (Display string: 'Level High'): Specifies that the trigger is considered valid as long as the level of the source signal is high. This can apply to TransferActive and TransferPause trigger.
  • LevelLow (Display string: 'Level Low'): Specifies that the trigger is considered valid as long as the level of the source signal is low. This can apply to TransferActive and TransferPause trigger.
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.

◆ transferTriggerMode

PropertyI64 transferTriggerMode

An enumerated integer property. Controls if the selected trigger is active.

Controls if the selected trigger is active.

The following string values might be valid for this feature:

  • Off (Display string: 'Off'): Disables the selected trigger.
  • On (Display string: 'On'): Enable the selected trigger.
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.

◆ transferTriggerSelector

PropertyI64 transferTriggerSelector

An enumerated integer property. Selects the type of transfer trigger to configure.

Selects the type of transfer trigger to configure.

The following string values might be valid for this feature:

  • TransferStart (Display string: 'Transfer Start'): Selects a trigger to start the transfers.
  • TransferStop (Display string: 'Transfer Stop'): Selects a trigger to stop the transfers.
  • TransferAbort (Display string: 'Transfer Abort'): Selects a trigger to abort the transfers.
  • TransferPause (Display string: 'Transfer Pause'): Selects a trigger to pause the transfers.
  • TransferResume (Display string: 'Transfer Resume'): Selects a trigger to Resume the transfers.
  • TransferActive (Display string: 'Transfer Active'): Selects a trigger to Activate the transfers. This trigger type is used when TriggerActivation is set LevelHigh or levelLow.
  • TransferBurstStart (Display string: 'Transfer Burst Start'): Selects a trigger to start the transfer of a burst of frames specified by TransferBurstCount.
  • TransferBurstStop (Display string: 'Transfer Burst Stop'): Selects a trigger to end the transfer of a burst of frames.
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.

◆ transferTriggerSource

PropertyI64 transferTriggerSource

An enumerated integer property. Specifies the signal to use as the trigger source for transfers.

Specifies the signal to use as the trigger source for transfers.

The following string values might be valid for this feature:

  • Line0 (Display string: 'Line 0'): Specifies which physical line (or pin) and associated I/O control block to use as external source for the transfer control trigger signal.
  • Line1 (Display string: 'Line 1'): Specifies which physical line (or pin) and associated I/O control block to use as external source for the transfer control trigger signal.
  • Line2 (Display string: 'Line 2'): Specifies which physical line (or pin) and associated I/O control block to use as external source for the transfer control trigger signal.
  • Line#3# (Display string: 'Line #3#'): Specifies which physical line (or pin) and associated I/O control block to use as external source for the transfer control trigger signal.
  • Counter0Start (Display string: 'Counter 0 Start'): Specifies which of the Counter signal to use as internal source for the transfer control trigger signal.
  • Counter1Start (Display string: 'Counter 1 Start'): Specifies which of the Counter signal to use as internal source for the transfer control trigger signal.
  • Counter2Start (Display string: 'Counter 2 Start'): Specifies which of the Counter signal to use as internal source for the transfer control trigger signal.
  • Counter#3#Start (Display string: 'Counter #3# Start'): Specifies which of the Counter signal to use as internal source for the transfer control trigger signal.
  • Counter0End (Display string: 'Counter 0 End'): Specifies which of the Counter signal to use as internal source for the transfer control trigger signal.
  • Counter1End (Display string: 'Counter 1 End'): Specifies which of the Counter signal to use as internal source for the transfer control trigger signal.
  • Counter2End (Display string: 'Counter 2 End'): Specifies which of the Counter signal to use as internal source for the transfer control trigger signal.
  • Counter#3#End (Display string: 'Counter #3# End'): Specifies which of the Counter signal to use as internal source for the transfer control trigger signal.
  • Timer0Start (Display string: 'Timer 0 Start'): Specifies which Timer signal to use as internal source for the transfer control trigger signal.
  • Timer1Start (Display string: 'Timer 1 Start'): Specifies which Timer signal to use as internal source for the transfer control trigger signal.
  • Timer2Start (Display string: 'Timer 2 Start'): Specifies which Timer signal to use as internal source for the transfer control trigger signal.
  • Timer#3#Start (Display string: 'Timer #3# Start'): Specifies which Timer signal to use as internal source for the transfer control trigger signal.
  • Timer0End (Display string: 'Timer 0 End'): Specifies which Timer signal to use as internal source for the transfer control trigger signal.
  • Timer1End (Display string: 'Timer 1 End'): Specifies which Timer signal to use as internal source for the transfer control trigger signal.
  • Timer2End (Display string: 'Timer 2 End'): Specifies which Timer signal to use as internal source for the transfer control trigger signal.
  • Timer#3#End (Display string: 'Timer #3# End'): Specifies which Timer signal to use as internal source for the transfer control trigger signal.
  • LogicBlock0 (Display string: 'Logic Block 0'): Specifies which Logic Block to use as internal source for the transfer control trigger signal.
  • LogicBlock1 (Display string: 'Logic Block 1'): Specifies which Logic Block to use as internal source for the transfer control trigger signal.
  • LogicBlock2 (Display string: 'Logic Block 2'): Specifies which Logic Block to use as internal source for the transfer control trigger signal.
  • LogicBlock#3# (Display string: 'Logic Block #3#'): Specifies which Logic Block to use as internal source for the transfer control trigger signal.
  • SoftwareSignal0 (Display string: 'Software Signal 0'): Specifies which Software Signal to use as internal source for the transfer control trigger signal.
  • SoftwareSignal1 (Display string: 'Software Signal 1'): Specifies which Software Signal to use as internal source for the transfer control trigger signal.
  • SoftwareSignal2 (Display string: 'Software Signal 2'): Specifies which Software Signal to use as internal source for the transfer control trigger signal.
  • SoftwareSignal#3# (Display string: 'Software Signal #3#'): Specifies which Software Signal to use as internal source for the transfer control trigger signal.
  • Action0 (Display string: 'Action 0'): Specifies which Action command to use as internal source for the transfer control trigger signal.
  • Action1 (Display string: 'Action 1'): Specifies which Action command to use as internal source for the transfer control trigger signal.
  • Action2 (Display string: 'Action 2'): Specifies which Action command to use as internal source for the transfer control trigger signal.
  • Action#3# (Display string: 'Action #3#'): Specifies which Action command to use as internal source for the transfer control trigger signal.
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.