Impact Acquire SDK .NET

Custom area. More...

Inheritance diagram for mvCustomData:
[legend]

Public Member Functions

IEnumerable< TgetEnumerable< T > ()
 Returns an enumerator of a certain type that iterates through the collection.
 
IEnumerator< intGetEnumerator ()
 Returns an enumerator that iterates through the collection.
 
 mvCustomData (mv.impact.acquire.Device device)
 Constructs a new mv.impact.acquire.GenICam.mvCustomData object.
 
 mvCustomData (mv.impact.acquire.Device device, System.String settingName)
 Constructs a new mv.impact.acquire.GenICam.mvCustomData object.
 
void restoreDefault ()
 Restores the default for every component of this collection.
 

Public Attributes

readonly mv.impact.acquire.PropertyS mvCustomCommandBuffer = new mv.impact.acquire.PropertyS()
 A string property. Command buffer for custom commands.
 
readonly mv.impact.acquire.PropertyI64 mvCustomCommandInterpreterVersionMajor = new mv.impact.acquire.PropertyI64()
 An integer property. Returns the major version of the custom command interpreter on the device.
 
readonly mv.impact.acquire.PropertyI64 mvCustomCommandInterpreterVersionMinor = new mv.impact.acquire.PropertyI64()
 An integer property. Returns the minor version of the custom command interpreter on the device.
 
readonly mv.impact.acquire.PropertyS mvCustomText = new mv.impact.acquire.PropertyS()
 A string property. Custom text.
 
readonly mv.impact.acquire.PropertyI64 mvDeviceFPGAErrorCode = new mv.impact.acquire.PropertyI64()
 An integer property. Error Code of the FPGA Faultbus.
 
readonly mv.impact.acquire.PropertyF mvExposureStartDelay = new mv.impact.acquire.PropertyF()
 A floating point property. Delay from sensor-trigger to acutal exposure start in us.
 
readonly mv.impact.acquire.PropertyF mvExposureTimeError = new mv.impact.acquire.PropertyF()
 A floating point property. Additive error of the exposure time in us according to the data sheet.
 
readonly mv.impact.acquire.PropertyF mvExposureTimeIncrement = new mv.impact.acquire.PropertyF()
 A floating point property. Increment of the expsure time in us.
 
readonly mv.impact.acquire.PropertyI64 mvImxSensorIdOne = new mv.impact.acquire.PropertyI64()
 An integer property. IMX SensorID1.
 
readonly mv.impact.acquire.PropertyI64 mvImxSensorIdTwo = new mv.impact.acquire.PropertyI64()
 An integer property. IMX SensorID2.
 
readonly mv.impact.acquire.PropertyI64 mvInternalRegister = new mv.impact.acquire.PropertyI64()
 An integer property. Register address to access.
 
readonly mv.impact.acquire.PropertyI64 mvInternalRegisterValue = new mv.impact.acquire.PropertyI64()
 An integer property. Value of internal register.
 
readonly mv.impact.acquire.PropertyI64 mvLVDSAlignment = new mv.impact.acquire.PropertyI64()
 An integer property. Alignment of LVDS lanes.
 
readonly mv.impact.acquire.PropertyI64 mvLVDSSelection = new mv.impact.acquire.PropertyI64()
 An integer property. Selector for LVDS lanes.
 
readonly mv.impact.acquire.PropertyI64 mvMSeqRegister = new mv.impact.acquire.PropertyI64()
 An integer property. Register address to access.
 
readonly mv.impact.acquire.PropertyI64 mvMSeqRegisterValue = new mv.impact.acquire.PropertyI64()
 An integer property. Value of mseq register.
 
readonly mv.impact.acquire.Method mvReadCustomData = new mv.impact.acquire.Method()
 A method object. Function to read custom data.
 
readonly mv.impact.acquire.Method mvRunTest = new mv.impact.acquire.Method()
 A method object. Runs internal test.
 
readonly mv.impact.acquire.PropertyI64 mvSensorRegister = new mv.impact.acquire.PropertyI64()
 An integer property. Sensor register address to access.
 
readonly mv.impact.acquire.PropertyI64 mvSensorRegisterValue = new mv.impact.acquire.PropertyI64()
 An integer property. Value of sensor register.
 
readonly mv.impact.acquire.PropertyI64 mvStat2SumRegister = new mv.impact.acquire.PropertyI64()
 An integer property. Indicates several states besides some other info.
 
readonly mv.impact.acquire.PropertyI64 mvStat3SumRegister = new mv.impact.acquire.PropertyI64()
 An integer property. Indicates several states besides some other info.
 
readonly mv.impact.acquire.PropertyI64 mvStat4SumRegister = new mv.impact.acquire.PropertyI64()
 An integer property. Indicates several states besides some other info.
 
readonly mv.impact.acquire.PropertyI64 mvStat5SumRegister = new mv.impact.acquire.PropertyI64()
 An integer property. Indicates several states besides some other info.
 
readonly mv.impact.acquire.PropertyI64 mvStat6SumRegister = new mv.impact.acquire.PropertyI64()
 An integer property. Indicates several states besides some other info.
 
readonly mv.impact.acquire.PropertyI64 mvStateSumRegister = new mv.impact.acquire.PropertyI64()
 An integer property. Indicates several states besides some other info.
 
readonly mv.impact.acquire.Method mvStateSumRegister3Reset = new mv.impact.acquire.Method()
 A method object. Resets the state register.
 
readonly mv.impact.acquire.Method mvStateSumRegisterReset = new mv.impact.acquire.Method()
 A method object. Resets the state register.
 
readonly mv.impact.acquire.PropertyI64 mvTestMax = new mv.impact.acquire.PropertyI64()
 An integer property. Max number for test.
 
readonly mv.impact.acquire.PropertyI64 mvTestMin = new mv.impact.acquire.PropertyI64()
 An integer property. Min number for test.
 
readonly mv.impact.acquire.PropertyI64 mvTestNumber = new mv.impact.acquire.PropertyI64()
 An integer property. Number of test to run.
 
readonly mv.impact.acquire.Method mvWriteCustomData = new mv.impact.acquire.Method()
 A method object. Function to write custom data.
 

Properties

IEnumerable< ComponentcomponentEnumerable [get]
 Returns an enumerator that iterates through the collection.
 
IEnumerable< ComponentListcomponentListEnumerable [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

Custom area.

Custom area.

Constructor & Destructor Documentation

◆ mvCustomData() [1/2]

Constructs a new mv.impact.acquire.GenICam.mvCustomData object.

Parameters
[in]deviceA pointer to a mv.impact.acquire.Device object obtained from a mv.impact.acquire.DeviceManager object.

◆ mvCustomData() [2/2]

mvCustomData ( mv::impact::acquire::Device device,
System::String settingName )
inline

Constructs a new mv.impact.acquire.GenICam.mvCustomData 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>())
{
}
A template class to represent 32 bit integer properties and 32 bit enumerated integer properties.
Definition EnumPropertyI.cs:61
A class to query various general information about the device, its driver and other information.
Definition Info.cs:10
A base class for properties.
Definition Property.cs:109

See the frameworks 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 frameworks 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

◆ mvCustomCommandBuffer

A string property. Command buffer for custom commands.

Command buffer for custom commands.

◆ mvCustomCommandInterpreterVersionMajor

readonly mv.impact.acquire.PropertyI64 mvCustomCommandInterpreterVersionMajor = new mv.impact.acquire.PropertyI64()

An integer property. Returns the major version of the custom command interpreter on the device.

Returns the major version of the custom command interpreter on the device.

◆ mvCustomCommandInterpreterVersionMinor

readonly mv.impact.acquire.PropertyI64 mvCustomCommandInterpreterVersionMinor = new mv.impact.acquire.PropertyI64()

An integer property. Returns the minor version of the custom command interpreter on the device.

Returns the minor version of the custom command interpreter on the device.

◆ mvCustomText

A string property. Custom text.

Custom text.

◆ mvDeviceFPGAErrorCode

An integer property. Error Code of the FPGA Faultbus.

Error Code of the FPGA Faultbus.

◆ mvExposureStartDelay

A floating point property. Delay from sensor-trigger to acutal exposure start in us.

Delay from sensor-trigger to acutal exposure start in us.

◆ mvExposureTimeError

A floating point property. Additive error of the exposure time in us according to the data sheet.

Additive error of the exposure time in us according to the data sheet.

◆ mvExposureTimeIncrement

A floating point property. Increment of the expsure time in us.

Increment of the expsure time in us.

◆ mvImxSensorIdOne

An integer property. IMX SensorID1.

IMX SensorID1

◆ mvImxSensorIdTwo

An integer property. IMX SensorID2.

IMX SensorID2

◆ mvInternalRegister

An integer property. Register address to access.

Register address to access.

◆ mvInternalRegisterValue

An integer property. Value of internal register.

Value of internal register.

◆ mvLVDSAlignment

An integer property. Alignment of LVDS lanes.

Alignment of LVDS lanes.

◆ mvLVDSSelection

An integer property. Selector for LVDS lanes.

Selector for LVDS lanes.

◆ mvMSeqRegister

An integer property. Register address to access.

Register address to access.

◆ mvMSeqRegisterValue

An integer property. Value of mseq register.

Value of mseq register.

◆ mvReadCustomData

A method object. Function to read custom data.

Function to read custom data.

◆ mvRunTest

A method object. Runs internal test.

Runs internal test.

◆ mvSensorRegister

An integer property. Sensor register address to access.

Sensor register address to access.

◆ mvSensorRegisterValue

An integer property. Value of sensor register.

Value of sensor register.

◆ mvStat2SumRegister

An integer property. Indicates several states besides some other info.

Indicates several states besides some other info.

◆ mvStat3SumRegister

An integer property. Indicates several states besides some other info.

Indicates several states besides some other info.

◆ mvStat4SumRegister

An integer property. Indicates several states besides some other info.

Indicates several states besides some other info.

◆ mvStat5SumRegister

An integer property. Indicates several states besides some other info.

Indicates several states besides some other info.

◆ mvStat6SumRegister

An integer property. Indicates several states besides some other info.

Indicates several states besides some other info.

◆ mvStateSumRegister

An integer property. Indicates several states besides some other info.

Indicates several states besides some other info.

◆ mvStateSumRegister3Reset

A method object. Resets the state register.

Resets the state register.

◆ mvStateSumRegisterReset

A method object. Resets the state register.

Resets the state register.

◆ mvTestMax

An integer property. Max number for test.

Max number for test.

◆ mvTestMin

An integer property. Min number for test.

Min number for test.

◆ mvTestNumber

An integer property. Number of test to run.

Number of test to run.

◆ mvWriteCustomData

A method object. Function to write custom data.

Function to write custom data.

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);
}
String name
Returns the name of the component referenced by this object.
Definition ComponentAccess.cs:167
A base class to implement access to internal driver components.
Definition Component.cs:133

See the frameworks 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);
}
A class to provide access to component lists.
Definition ComponentList.cs:14

See the frameworks 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.