TransferControl Class Reference

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

Public Member Functions
synchronized void	delete ()
Method	getTransferAbort ()
	A method object.
PropertyI64	getTransferBlockCount ()
	An integer property.
PropertyI64	getTransferBurstCount ()
	An integer property.
PropertyI64	getTransferComponentSelector ()
	An enumerated integer property.
PropertyI64	getTransferControlMode ()
	An enumerated integer property.
PropertyI64	getTransferOperationMode ()
	An enumerated integer property.
Method	getTransferPause ()
	A method object.
PropertyI64	getTransferQueueCurrentBlockCount ()
	An integer property.
PropertyI64	getTransferQueueMaxBlockCount ()
	An integer property.
PropertyI64	getTransferQueueMode ()
	An enumerated integer property.
Method	getTransferResume ()
	A method object.
PropertyI64	getTransferSelector ()
	An enumerated integer property.
Method	getTransferStart ()
	A method object.
PropertyI	getTransferStatus ()
	A boolean property.
PropertyI64	getTransferStatusSelector ()
	An enumerated integer property.
Method	getTransferStop ()
	A method object.
PropertyI64	getTransferStreamChannel ()
	An integer property.
PropertyI64	getTransferTriggerActivation ()
	An enumerated integer property.
PropertyI64	getTransferTriggerMode ()
	An enumerated integer property.
PropertyI64	getTransferTriggerSelector ()
	An enumerated integer property.
PropertyI64	getTransferTriggerSource ()
	An enumerated integer property.
	TransferControl (Device pDev)
	Constructs a new mvIMPACT.acquire.TransferControl object.
	TransferControl (Device pDev, String settingName)
	Constructs a new mvIMPACT.acquire.TransferControl object.

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

Static Protected Member Functions
static long	swigRelease (TransferControl obj)

Protected Attributes
transient boolean	swigCMemOwn

Detailed Description

Category for the data Transfer Control features.

A category for the data Transfer Control features.

Constructor & Destructor Documentation

TransferControl() [1/3]

TransferControl ( long cPtr, boolean cMemoryOwn )

protected

TransferControl() [2/3]

TransferControl	(	Device	pDev,
		String	settingName )

Constructs a new mvIMPACT.acquire.TransferControl object.

Parameters

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

TransferControl() [3/3]

TransferControl

(

Device

pDev

)

Constructs a new mvIMPACT.acquire.TransferControl object.

Parameters

pDev

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

Member Function Documentation

delete()

synchronized void delete

(

)

finalize()

void finalize ( )

protected

getTransferAbort()

Method getTransferAbort

(

)

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

getTransferBlockCount()

PropertyI64 getTransferBlockCount

(

)

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.

getTransferBurstCount()

PropertyI64 getTransferBurstCount

(

)

An integer property.

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

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

getTransferComponentSelector()

PropertyI64 getTransferComponentSelector

(

)

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

getTransferControlMode()

PropertyI64 getTransferControlMode

(

)

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

getTransferOperationMode()

PropertyI64 getTransferOperationMode

(

)

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

getTransferPause()

Method getTransferPause

(

)

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.

getTransferQueueCurrentBlockCount()

PropertyI64 getTransferQueueCurrentBlockCount

(

)

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.

getTransferQueueMaxBlockCount()

PropertyI64 getTransferQueueMaxBlockCount

(

)

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.

getTransferQueueMode()

PropertyI64 getTransferQueueMode

(

)

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

getTransferResume()

Method getTransferResume

(

)

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.

getTransferSelector()

PropertyI64 getTransferSelector

(

)

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:

• All (Display string: 'All'): The transfer features control all the data streams simultaneously.
• 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.

Note

Depending on the device some of these values might not be supported and especially when working with third party devices there might be custom values which are not listed here. To get a complete and reliable list of supported values at runtime an application should therefore call mvIMPACT.acquire.PropertyI.getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

getTransferStart()

Method getTransferStart

(

)

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.

getTransferStatus()

PropertyI getTransferStatus

(

)

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.

getTransferStatusSelector()

PropertyI64 getTransferStatusSelector

(

)

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

getTransferStop()

Method getTransferStop

(

)

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

getTransferStreamChannel()

PropertyI64 getTransferStreamChannel

(

)

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.

getTransferTriggerActivation()

PropertyI64 getTransferTriggerActivation

(

)

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

getTransferTriggerMode()

PropertyI64 getTransferTriggerMode

(

)

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

getTransferTriggerSelector()

PropertyI64 getTransferTriggerSelector

(

)

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

getTransferTriggerSource()

PropertyI64 getTransferTriggerSource

(

)

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:

• 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.
• Counter0End (Display string: 'Counter 0 End'): Specifies which of the Counter signal to use as internal 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.
• Counter1End (Display string: 'Counter 1 End'): 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.
• Counter2End (Display string: 'Counter 2 End'): 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.
• 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.
• 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.
• 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.
• Timer0End (Display string: 'Timer 0 End'): Specifies which Timer 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.
• Timer1End (Display string: 'Timer 1 End'): 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.
• Timer2End (Display string: 'Timer 2 End'): 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.

Note

Depending on the device some of these values might not be supported and especially when working with third party devices there might be custom values which are not listed here. To get a complete and reliable list of supported values at runtime an application should therefore call mvIMPACT.acquire.PropertyI.getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

swigRelease()

static long swigRelease ( TransferControl obj )

staticprotected

Member Data Documentation

swigCMemOwn

transient boolean swigCMemOwn

protected