InfoBlueFOX Class Reference

A more specific class to query information about a mvBlueFOX device and its driver (Device specific interface layout only). More...

Inheritance diagram for InfoBlueFOX:

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.
	InfoBlueFOX (Device device)
	Constructs a new mv.impact.acquire.InfoBlueFOX 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 PropertyI64	deviceSensorRevision = new PropertyI64()
	A 64 bit integer property (read-only) containing the current revision of the sensor head of this device.
readonly PropertyF	deviceTemperature = new PropertyF()
	A float property (read-only) containing the temperature of the selected temperature sensor on the device in degrees Celsius.
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 PropertyI	firmwareVersion = new PropertyI()
	An integer property (read-only) containing the firmware version of this device.
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< TBlueFOXInfoSensorCapabilities >	sensorCaps = new EnumPropertyI<TBlueFOXInfoSensorCapabilities>()
	An integer property (read-only) containing a bit mask containing information about the sensors capabilities(if known).
readonly EnumPropertyI< TInfoSensorColorMode >	sensorColorMode = new EnumPropertyI<TInfoSensorColorMode>()
	An enumerated integer property (read-only) containing the type of the sensor (color/mono/...)(if known).
readonly PropertyI	sensorFPGAVersion = new PropertyI()
	An integer property (read-only) containing the FPGA version of the camera(if known).
readonly EnumPropertyI< TInfoSensorType >	sensorType = new EnumPropertyI<TInfoSensorType>()
	An enumerated integer property (read-only) containing the type of sensor chip of the camera(if known).
readonly PropertyI	sensorXRes = new PropertyI()
	An integer property (read-only) containing the horizontal resolution of the camera sensor.
readonly PropertyI	sensorYRes = new PropertyI()
	An integer property (read-only) containing the vertical resolution of the camera sensor.
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.
readonly PropertyI	userEEPROMSize = new PropertyI()
	An integer property (read-only) containing the size of the user EEPROM that can be accessed using the I2C access features of mv.impact.acquire.I2CControl.

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 more specific class to query information about a mvBlueFOX device and its driver (Device specific interface layout only).

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

Note

This class will only be available if mv.impact.acquire.Device.interfaceLayout is set to mv.impact.acquire.TDeviceInterfaceLayout.dilDeviceSpecific before the device is opened.

Constructor & Destructor Documentation

InfoBlueFOX()

InfoBlueFOX ( Device device )

inline

Constructs a new mv.impact.acquire.InfoBlueFOX 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()

inherited

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

deviceDriverVersion

readonly PropertyS deviceDriverVersion = new PropertyS()

inherited

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.

deviceSensorRevision

readonly PropertyI64 deviceSensorRevision = new PropertyI64()

A 64 bit integer property (read-only) containing the current revision of the sensor head of this device.

Note

This feature is currently not supported by all sensors. If a sensor can't provide this information, the value of this property will remain 0 at all time.

Since

1.12.65

deviceTemperature

readonly PropertyF deviceTemperature = new PropertyF()

A float property (read-only) containing the temperature of the selected temperature sensor on the device in degrees Celsius.

Note

This property will not be available for every mvBlueFOX. Right now this feature is only implemented for 202d version of the mvBlueFOX.

Since

1.12.62

driverDate

readonly PropertyS driverDate = new PropertyS()

inherited

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

driverVersion

readonly PropertyS driverVersion = new PropertyS()

inherited

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

firmwareVersion

readonly PropertyI firmwareVersion = new PropertyI()

An integer property (read-only) containing the firmware version of this device.

loadedSettings

readonly PropertyS loadedSettings = new PropertyS()

inherited

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

logFile

readonly PropertyS logFile = new PropertyS()

inherited

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()

inherited

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.

sensorCaps

readonly EnumPropertyI<TBlueFOXInfoSensorCapabilities> sensorCaps = new EnumPropertyI<TBlueFOXInfoSensorCapabilities>()

An integer property (read-only) containing a bit mask containing information about the sensors capabilities(if known).

Note

If nothing is known about this feature, this property will contain '-1'.

sensorColorMode

readonly EnumPropertyI<TInfoSensorColorMode> sensorColorMode = new EnumPropertyI<TInfoSensorColorMode>()

inherited

An enumerated integer property (read-only) containing the type of the sensor (color/mono/...)(if known).

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

Note

If nothing is known about this feature, this property will contain mv.impact.acquire.TInfoSensorColorMode.iscmUnknown.

If the device has more than one sensor head, and all these sensor heads can be accessed using the current interface, this property will contain as many values as the devices offers sensor heads.

sensorFPGAVersion

readonly PropertyI sensorFPGAVersion = new PropertyI()

An integer property (read-only) containing the FPGA version of the camera(if known).

Note

If nothing is known about this feature, this property will contain '-1'.

sensorType

readonly EnumPropertyI<TInfoSensorType> sensorType = new EnumPropertyI<TInfoSensorType>()

inherited

An enumerated integer property (read-only) containing the type of sensor chip of the camera(if known).

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

This usually will either be mv.impact.acquire.TInfoSensorType.istCCD or mv.impact.acquire.TInfoSensorType.istCMOS.

If the device has more than one sensor head, and all these sensor heads can be accessed using the current interface, this property will contain as many values as the devices offers sensor heads.

sensorXRes

readonly PropertyI sensorXRes = new PropertyI()

inherited

An integer property (read-only) containing the horizontal resolution of the camera sensor.

If the device has more than one sensor head, and all these sensor heads can be accessed using the current interface, this property will contain as many values as the devices offers sensor heads.

sensorYRes

readonly PropertyI sensorYRes = new PropertyI()

inherited

An integer property (read-only) containing the vertical resolution of the camera sensor.

If the device has more than one sensor head, and all these sensor heads can be accessed using the current interface, this property will contain as many values as the devices offers sensor heads.

state

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

inherited

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()

inherited

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()

inherited

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

Since

2.44.0

userEEPROMSize

readonly PropertyI userEEPROMSize = new PropertyI()

An integer property (read-only) containing the size of the user EEPROM that can be accessed using the I2C access features of mv.impact.acquire.I2CControl.

Note

The size may vary depending on the product. Even different products with the same sensor might report different values here.

The user EEPROM uses a virtual I2C address of 0x1A2 for write access and 0x1A3 for read access.

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.