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

Inheritance diagram for RequestInfoConfiguration:

Public Member Functions
IEnumerable< T >	getEnumerable< T > ()
	Returns an enumerator of a certain type that iterates through the collection.

IEnumerator< int >	GetEnumerator ()
	Returns an enumerator that iterates through the collection.

	RequestInfoConfiguration (Device device)
	Constructs a new mv.impact.acquire.RequestInfoConfiguration object.

	RequestInfoConfiguration (Device device, String settingName)
	Constructs a new mv.impact.acquire.RequestInfoConfiguration object.

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

Public Attributes
readonly PropertyIBoolean	exposeStart_us = new PropertyIBoolean()
	An enumerated integer property which can be used to configure whether the exposure start(us) information shall be attached to the resulting mv.impact.acquire.Request objects.

readonly PropertyIBoolean	exposeTime_us = new PropertyIBoolean()
	An enumerated integer property which can be used to configure whether the exposure time(us) information shall be attached to the resulting mv.impact.acquire.Request objects.

readonly PropertyIBoolean	frameID = new PropertyIBoolean()
	An enumerated integer property which can be used to configure whether the frame ID information shall be attached to the resulting mv.impact.acquire.Request objects.

readonly PropertyIBoolean	frameNr = new PropertyIBoolean()
	An enumerated integer property which can be used to configure whether the frame number information shall be attached to the resulting mv.impact.acquire.Request objects.

readonly PropertyIBoolean	gain_dB = new PropertyIBoolean()
	An enumerated integer property which can be used to configure whether the gain(dB) information shall be attached to the resulting mv.impact.acquire.Request objects.

readonly PropertyIBoolean	imageAverage = new PropertyIBoolean()
	An enumerated integer property which can be used to configure whether the image average information shall be attached to the resulting mv.impact.acquire.Request objects.

readonly PropertyIBoolean	IOStatesAtExposureStart = new PropertyIBoolean()
	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 mv.impact.acquire.Request objects.

readonly PropertyIBoolean	lineCounter = new PropertyIBoolean()
	An enumerated integer property which can be used to configure whether the line counter information shall be attached to the resulting mv.impact.acquire.Request objects.

readonly PropertyIBoolean	lineStatusAll = new PropertyIBoolean()
	An enumerated integer property which can be used to configure whether the line status all information shall be attached to the resulting mv.impact.acquire.Request objects.

readonly PropertyIBoolean	missingData_pc = new PropertyIBoolean()
	An enumerated integer property which can be used to configure whether the missing data information shall be attached to the resulting mv.impact.acquire.Request objects.

readonly PropertyIBoolean	settingUsed = new PropertyIBoolean()
	An enumerated integer property which can be used to configure whether the 'setting used' information shall be attached to the resulting mv.impact.acquire.Request objects.

readonly PropertyIBoolean	timeStamp_us = new PropertyIBoolean()
	An enumerated integer property which can be used to configure whether the time stamp(us) information shall be attached to the resulting mv.impact.acquire.Request objects.

readonly PropertyIBoolean	transferDelay_us = new PropertyIBoolean()
	An enumerated integer property which can be used to configure whether the transfer delay(us) information shall be attached to the resulting mv.impact.acquire.Request objects.

readonly PropertyIBoolean	triggerCounterAcquisitionStart = new PropertyIBoolean()
	An enumerated integer property which can be used to configure whether the trigger counter at acquisition start information shall be attached to the resulting mv.impact.acquire.Request objects.

readonly PropertyIBoolean	triggerCounterFrameStart = new PropertyIBoolean()
	An enumerated integer property which can be used to configure whether the trigger counter at frame start information shall be attached to the resulting mv.impact.acquire.Request objects.

readonly PropertyIBoolean	userData = new PropertyIBoolean()
	An enumerated integer property which can be used to configure whether the user data information shall be attached to the resulting mv.impact.acquire.Request objects.

readonly PropertyIBoolean	videoChannel = new PropertyIBoolean()
	An enumerated integer property which can be used to configure whether the video channel information shall be attached to the resulting mv.impact.acquire.Request objects.

Properties
IEnumerable< Component >	componentEnumerable `[get]`
	Returns an enumerator that iterates through the collection.

IEnumerable< ComponentList >	componentListEnumerable `[get]`
	Returns an enumerator that iterates through all the mv.impact.acquire.ComponentList elements in the collection.

int	hObj `[get]`
	Returns a unique identifier for the component collection referenced by this object.

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.

EXAMPLE:

Enable the transmission of the LineStatusAll information in device interface layout mv.impact.acquire.TDeviceInterfaceLayout.dilDeviceSpecific:

//-----------------------------------------------------------------------------
private void fn( Device pDev )
//-----------------------------------------------------------------------------
{
   RequestInfoConfiguration ric = new RequestInfoConfiguration( pDev );
   if( ric.lineStatusAll.isValid == false )
   {
      // feature not supported
      return;
   }
   ric.lineStatusAll.write( bTrue );
   Request pRequest = captureAnImage( pDev );
   Console.WriteLine( "{0}: {1:X}\n", pRequest.chunkLineStatusAll.name, pRequest.chunkLineStatusAll.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/2]

RequestInfoConfiguration ( Device device )

inline

Constructs a new mv.impact.acquire.RequestInfoConfiguration object.

Parameters

[in] device A pointer to a mv.impact.acquire.Device object obtained from a mv.impact.acquire.DeviceManager object.

◆ RequestInfoConfiguration() [2/2]

RequestInfoConfiguration	(	Device	device,
		String	settingName )

inline

Constructs a new mv.impact.acquire.RequestInfoConfiguration object.

Parameters

[in]	device	A pointer to a mv.impact.acquire.Device object obtained from a mv.impact.acquire.DeviceManager object.
[in]	settingName	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 mv.impact.acquire.FunctionInterface.availableSettings, new settings can be created with the function mv.impact.acquire.FunctionInterface.createSetting

Member Function Documentation

◆ getEnumerable< T >()

IEnumerable< T > getEnumerable< T > ( )

inlineinherited

Returns an enumerator of a certain type that iterates through the collection.

This interface will allow to e.g. write code like this:

Info info = new Info(pDev);
foreach (Property c in info.getEnumerable<Property>())
{
  validateProperty(c);
}

See the framework's documentation about the System.Collections.IEnumerable interface for more information.

Returns: An enumerator that iterates through the collection

◆ GetEnumerator()

IEnumerator< int > GetEnumerator ( )

inlineinherited

Returns an enumerator that iterates through the collection.

See the framework's documentation about the System.Collections.IEnumerable interface for more information.

Returns: An enumerator that iterates through the collection

◆ restoreDefault()

void restoreDefault ( )

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.

Member Data Documentation

◆ exposeStart_us

readonly PropertyIBoolean exposeStart_us = new PropertyIBoolean()

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