Properties to configure which information shall be attached to the resulting images. More...

Inheritance diagram for RequestInfoConfiguration:

Public Member Functions
synchronized void	delete ()

PropertyI	getExposeStart_us ()
	An enumerated integer property which can be used to configure whether the exposure start(us) information shall be attached to the resulting mvIMPACT.acquire.Request objects.

PropertyI	getExposeTime_us ()
	An enumerated integer property which can be used to configure whether the exposure time(us) information shall be attached to the resulting mvIMPACT.acquire.Request objects.

PropertyI	getFrameID ()
	An enumerated integer property which can be used to configure whether the frame ID information shall be attached to the resulting mvIMPACT.acquire.Request objects.

PropertyI	getFrameNr ()
	An enumerated integer property which can be used to configure whether the frame number information shall be attached to the resulting mvIMPACT.acquire.Request objects.

PropertyI	getGain_dB ()
	An enumerated integer property which can be used to configure whether the gain(dB) information shall be attached to the resulting mvIMPACT.acquire.Request objects.

PropertyI	getImageAverage ()
	An enumerated integer property which can be used to configure whether the image average information shall be attached to the resulting mvIMPACT.acquire.Request objects.

PropertyI	getIOStatesAtExposureStart ()
	An enumerated integer property which can be used to configure whether the I/O states at exposure start information shall be attached to the resulting mvIMPACT.acquire.Request objects.

PropertyI	getLineCounter ()
	An enumerated integer property which can be used to configure whether the line counter information shall be attached to the resulting mvIMPACT.acquire.Request objects.

PropertyI	getLineStatusAll ()
	An enumerated integer property which can be used to configure whether the line status all information shall be attached to the resulting mvIMPACT.acquire.Request objects.

PropertyI	getMissingData_pc ()
	An enumerated integer property which can be used to configure whether the missing data information shall be attached to the resulting mvIMPACT.acquire.Request objects.

PropertyI	getSettingUsed ()
	An enumerated integer property which can be used to configure whether the 'setting used' information shall be attached to the resulting mvIMPACT.acquire.Request objects.

PropertyI	getTimeStamp_us ()
	An enumerated integer property which can be used to configure whether the time stamp(us) information shall be attached to the resulting mvIMPACT.acquire.Request objects.

PropertyI	getTransferDelay_us ()
	An enumerated integer property which can be used to configure whether the transfer delay(us) information shall be attached to the resulting mvIMPACT.acquire.Request objects.

PropertyI	getTriggerCounterAcquisitionStart ()
	An enumerated integer property which can be used to configure whether the trigger counter at acquisition start information shall be attached to the resulting mvIMPACT.acquire.Request objects.

PropertyI	getTriggerCounterFrameStart ()
	An enumerated integer property which can be used to configure whether the trigger counter at frame start information shall be attached to the resulting mvIMPACT.acquire.Request objects.

PropertyI	getUserData ()
	An enumerated integer property which can be used to configure whether the user data information shall be attached to the resulting mvIMPACT.acquire.Request objects.

PropertyI	getVideoChannel ()
	An enumerated integer property which can be used to configure whether the video channel information shall be attached to the resulting mvIMPACT.acquire.Request objects.

int	hObj ()
	Returns a unique identifier for the component collection referenced by this object.

	RequestInfoConfiguration (Device pDev)
	brief Constructs a new mvIMPACT.acquire.RequestInfoConfiguration object.

	RequestInfoConfiguration (Device pDev, String settingName)
	brief Constructs a new mvIMPACT.acquire.RequestInfoConfiguration object.

ComponentCollection	restoreDefault ()
	Restores the default for every component of this collection.

Protected Member Functions
void	finalize ()

	RequestInfoConfiguration (long cPtr, boolean cMemoryOwn)

Static Protected Member Functions
static long	swigRelease (ComponentCollection obj)

static long	swigRelease (RequestInfoConfiguration obj)

Protected Attributes
transient boolean	swigCMemOwn

Detailed Description

Properties to configure which information shall be attached to the resulting images.

This class provides properties allowing the user to define which additional information shall be attached to the resulting images. For example some devices can transmit the state of the digital I/Os at the time the exposure of an image has been started. Some information will always be attached to the resulting images other information will only be available if it has been explicitly enabled before.

//-----------------------------------------------------------------------------
public void fn( Device pDev )
//-----------------------------------------------------------------------------
{
   RequestInfoConfiguration ric = new RequestInfoConfiguration( pDev );
   if( !ric.lineStatusAll.isValid() )
   {
      // feature not supported
      return;
   }
   ric.getLineStatusAll().write( TBoolean.bTrue );
   Request pRequest = captureAnImage( pDev );
   System.out.println( String.format( "%s: 0x%08x\n", pRequest.getChunkLineStatusAll().name(), ( int )( pRequest.getChunkLineStatusAll().read() ) ) );
}

E.g. for the mvBlueCOUGAR-X/XD series possible LineStatusAll values are

0x11, Out0 and In0 on (Out0 needs to be connected with In0 for this to work)
0x33, Out0, Out1, In0 and In1 on (Out0 and Out1 need to be connected with In0 and In1 for this to work)
0x37, Out0, Out1, Out2, In0 and In1 on (Out0 and Out1 need to be connected with In0 and In1 for this to work)
0x3f, Out0, Out1, Out2, Out3, In0 and In1 on (Out0 and Out1 need to be connected with in0 and in1 for this to work)

Since: 2.10.0

Constructor & Destructor Documentation

◆ RequestInfoConfiguration() [1/3]

RequestInfoConfiguration	(	long	cPtr,
		boolean	cMemoryOwn )

protected

◆ RequestInfoConfiguration() [2/3]

RequestInfoConfiguration	(	Device	pDev,
		String	settingName )

brief Constructs a new mvIMPACT.acquire.RequestInfoConfiguration 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

◆ RequestInfoConfiguration() [3/3]

RequestInfoConfiguration ( Device pDev )

brief Constructs a new mvIMPACT.acquire.RequestInfoConfiguration 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 ( )

Reimplemented from ComponentCollection.

◆ finalize()

void finalize ( )

protected

Reimplemented from ComponentCollection.

◆ getExposeStart_us()

PropertyI getExposeStart_us ( )

An enumerated integer property which can be used to configure whether the exposure start(us) information shall be attached to the resulting mvIMPACT.acquire.Request objects.