Impact Acquire SDK .NET
RequestInfoConfiguration Class Reference
Common

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

Inheritance diagram for RequestInfoConfiguration:
[legend]

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() );
}
mv.impact.acquire.ComponentAccess.name
String name
Returns the name of the component referenced by this object.
Definition ComponentAccess.cs:167
mv.impact.acquire.Component.isValid
bool isValid
Checks if the internal component referenced by this object is still valid.
Definition Component.cs:727
mv.impact.acquire.Device
This class and its functions represent an actual device detected by this interface in the current sys...
Definition Device.cs:91
mv.impact.acquire.EnumPropertyI-1-g.write
EnumPropertyI< T > write(T value)
Writes one value to the property.
Definition EnumPropertyI.cs:449
mv.impact.acquire.EnumPropertyI64-1-g.read
T read()
Reads a value from a property.
Definition EnumPropertyI64.cs:325
mv.impact.acquire.RequestInfoConfiguration.RequestInfoConfiguration
RequestInfoConfiguration(Device device)
Constructs a new mv.impact.acquire.RequestInfoConfiguration object.
Definition RequestInfoConfiguration.cs:51
mv.impact.acquire.RequestInfoConfiguration.lineStatusAll
readonly PropertyIBoolean lineStatusAll
An enumerated integer property which can be used to configure whether the line status all information...
Definition RequestInfoConfiguration.cs:193
mv.impact.acquire.Request
Contains information about a captured buffer.
Definition Request.cs:77
mv.impact.acquire.Request.chunkLineStatusAll
readonly PropertyI64 chunkLineStatusAll
A 64 bit integer property (read-only) containing the status of all I/O lines at the time of the inter...
Definition Request.cs:1504
mv.impact.acquire.TBoolean.bTrue
@ bTrue
On, true or logical high.
Definition mvDriverBaseEnums.cs:485

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]deviceA 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]deviceA pointer to a mv.impact.acquire.Device object obtained from a mv.impact.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 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);
}
mv.impact.acquire.Info
A class to query various general information about the device, its driver and other information.
Definition Info.cs:10
mv.impact.acquire.Property
A base class for properties.
Definition Property.cs:109

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.

Valid values for this property are defined by the enumeration mv.impact.acquire.TBoolean.

◆ exposeTime_us

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.

Valid values for this property are defined by the enumeration mv.impact.acquire.TBoolean.

◆ frameID

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.

Valid values for this property are defined by the enumeration mv.impact.acquire.TBoolean.

◆ frameNr

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.

Valid values for this property are defined by the enumeration mv.impact.acquire.TBoolean.

◆ gain_dB

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.

Valid values for this property are defined by the enumeration mv.impact.acquire.TBoolean.

◆ imageAverage

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.

Valid values for this property are defined by the enumeration mv.impact.acquire.TBoolean.

Note
  • This feature currently is only available for mvBlueFOX devices

◆ IOStatesAtExposureStart

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.

Valid values for this property are defined by the enumeration mv.impact.acquire.TBoolean.

Note
This feature currently is only available for mvBlueFOX-MLC devices.

◆ lineCounter

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.

Valid values for this property are defined by the enumeration mv.impact.acquire.TBoolean.

Note
  • This feature currently is only available for mvTITAN-CL, mvGAMMA-CL and mvTITAN-DIG devices

◆ lineStatusAll

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.

Valid values for this property are defined by the enumeration mv.impact.acquire.TBoolean.

Note
  • This feature may be available for GenICam compliant devices

◆ missingData_pc

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.

Valid values for this property are defined by the enumeration mv.impact.acquire.TBoolean.

◆ settingUsed

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.

Valid values for this property are defined by the enumeration mv.impact.acquire.TBoolean.

◆ timeStamp_us

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.

Valid values for this property are defined by the enumeration mv.impact.acquire.TBoolean.

◆ transferDelay_us

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.

Valid values for this property are defined by the enumeration mv.impact.acquire.TBoolean.

Note
  • This feature currently is only available for mvBlueFOX devices

◆ triggerCounterAcquisitionStart

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.

Valid values for this property are defined by the enumeration mv.impact.acquire.TBoolean.

Note
  • This feature currently is only available for mvHYPERION devices

◆ triggerCounterFrameStart

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.

Valid values for this property are defined by the enumeration mv.impact.acquire.TBoolean.

Note
  • This feature currently is only available for mvHYPERION devices

◆ userData

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.

Valid values for this property are defined by the enumeration mv.impact.acquire.TBoolean.

Note
This feature currently is only available for mvVirtual devices

◆ videoChannel

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.

Valid values for this property are defined by the enumeration mv.impact.acquire.TBoolean.

Property Documentation

◆ componentEnumerable

IEnumerable<Component> componentEnumerable
getinherited

Returns an enumerator that iterates through the collection.

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

Info info = new Info(pDev);
foreach (Component c in info.componentEnumerable)
{
Console.WriteLine("{0}", c.name);
}
mv.impact.acquire.ComponentCollection.componentEnumerable
IEnumerable< Component > componentEnumerable
Returns an enumerator that iterates through the collection.
Definition ComponentCollection.cs:202
mv.impact.acquire.Component
A base class to implement access to internal driver components.
Definition Component.cs:133

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

Returns
An enumerator that iterates through the collection

◆ componentListEnumerable

IEnumerable<ComponentList> componentListEnumerable
getinherited

Returns an enumerator that iterates through all the mv.impact.acquire.ComponentList elements in the collection.

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

Info info = new Info(pDev);
foreach (ComponentList cl in info.componentListEnumerable)
{
Console.WriteLine("{0}", cl.name);
}
mv.impact.acquire.ComponentCollection.componentListEnumerable
IEnumerable< ComponentList > componentListEnumerable
Returns an enumerator that iterates through all the mv.impact.acquire.ComponentList elements in the c...
Definition ComponentCollection.cs:229
mv.impact.acquire.ComponentList
A class to provide access to component lists.
Definition ComponentList.cs:14

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

Returns
An enumerator that iterates through the collection

◆ hObj

int hObj
getinherited

Returns a unique identifier for the component collection referenced by this object.

This handle will always reference an object of type mv.impact.acquire.ComponentList.

Returns
A unique identifier for the component referenced by this object.