Info Class Reference

A class to query various general information about the device, its driver and other information. More...

Inheritance diagram for Info:

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.
	Info (Device device)
	Constructs a new mv.impact.acquire.Info object.
void	restoreDefault ()
	Restores the default for every component of this collection.

Public Attributes
readonly PropertyI	captureBufferAlignment = new PropertyI()
	An integer property (read-only) containing the capture buffer alignment in bytes needed by this device driver.
readonly PropertyS	deviceDriverVersion = new PropertyS()
	An integer property (read-only) containing the device driver version used by this device.
readonly PropertyS	driverDate = new PropertyS()
	A string property (read-only) containing the date the device driver has been compiled.
readonly PropertyS	driverVersion = new PropertyS()
	A string property (read-only) containing the version number of the device driver.
readonly PropertyS	loadedSettings = new PropertyS()
	A string property (read-only) containing the name of the setting currently loaded.
readonly PropertyS	logFile = new PropertyS()
	A string property (read-only) containing the name and the full path of the current log-file for this device.
readonly PropertyS	recommendedListsForUIs = new PropertyS()
	A string property (read-only) containing an array of full search paths to lists which are recommended to be displayed in a user interface that is created dynamically.
readonly EnumPropertyI< TDeviceState >	state = new EnumPropertyI<TDeviceState>()
	An enumerated integer property (read-only) containing the current state of this device.
readonly PropertyI	systemLogicalProcessorCount = new PropertyI()
	An integer property (read-only) containing the number of logical processors detected in the current system.
readonly PropertyI	systemPhysicalProcessorCount = new PropertyI()
	An integer property (read-only) containing the number of physical processors detected in the current system.

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

A class to query various general information about the device, its driver and other information.

This class contains a collection of properties providing various information about the device and its driver.

Constructor & Destructor Documentation

Info()

Info ( Device device )

inline

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

Parameters

[in]

device

A pointer to a mv.impact.acquire.Device object obtained from a mv.impact.acquire.DeviceManager object.

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

captureBufferAlignment

readonly PropertyI captureBufferAlignment = new PropertyI()

An integer property (read-only) containing the capture buffer alignment in bytes needed by this device driver.

deviceDriverVersion

readonly PropertyS deviceDriverVersion = new PropertyS()

An integer property (read-only) containing the device driver version used by this device.

This is the version of the underlying hardware driver. For device drivers that don't have another user mode driver below the interface driver this property will contain the same version information as the property mv.impact.acquire.Info.driverVersion.

driverDate

readonly PropertyS driverDate = new PropertyS()

A string property (read-only) containing the date the device driver has been compiled.

driverVersion

readonly PropertyS driverVersion = new PropertyS()

A string property (read-only) containing the version number of the device driver.

loadedSettings

readonly PropertyS loadedSettings = new PropertyS()

A string property (read-only) containing the name of the setting currently loaded.

logFile

readonly PropertyS logFile = new PropertyS()

A string property (read-only) containing the name and the full path of the current log-file for this device.

recommendedListsForUIs

readonly PropertyS recommendedListsForUIs = new PropertyS()

A string property (read-only) containing an array of full search paths to lists which are recommended to be displayed in a user interface that is created dynamically.

state

readonly EnumPropertyI<TDeviceState> state = new EnumPropertyI<TDeviceState>()

An enumerated integer property (read-only) containing the current state of this device.

This property e.g. provides information about the current state of the device. For USB devices this can e.g. indicate whether a device is currently plugged into the system or not.

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

GenICam/GenTL device specific: In order to reduce the amount of network traffic to a minimum, this property will only be updated automatically for network devices if the property mv.impact.acquire.Device.registerErrorEvent is set to mv.impact.acquire.TBoolean.bTrue (which is the default behaviour). If the IP addresses stay the same the connection is automatically re-established then once the device is detected by the driver again. However if the IP address of the device and/or the network adapter of the system it is used from changes mv.impact.acquire.DeviceManager.updateDeviceList() must be called regardless of the value of mv.impact.acquire.Device.registerErrorEvent before a device that was lost can re-establish a connection to the capture driver.

systemLogicalProcessorCount

readonly PropertyI systemLogicalProcessorCount = new PropertyI()

An integer property (read-only) containing the number of logical processors detected in the current system.

Since

2.44.0

systemPhysicalProcessorCount

readonly PropertyI systemPhysicalProcessorCount = new PropertyI()

An integer property (read-only) containing the number of physical processors detected in the current system.

Since

2.44.0

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);
}

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);
}

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.