mvIMPACT Acquire SDK C++
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:
InfoBlueDevice Info ComponentCollection

Public Member Functions

HOBJ hObj (void) const
 Returns a unique identifier for the component collection referenced by this object. More...
 
 InfoBlueFOX (Device *pDev)
 Constructs a new mvIMPACT::acquire::InfoBlueFOX object. More...
 
const ComponentCollectionrestoreDefault (void) const
 Restores the default for every component of this collection. More...
 

Public Attributes

PropertyI captureBufferAlignment
 An integer property (read-only) containing the capture buffer alignment in bytes needed by this device driver. More...
 
PropertyS deviceDriverVersion
 An integer property (read-only) containing the device driver version used by this device. More...
 
PropertyI64 deviceSensorRevision
 A 64 bit integer property (read-only) containing the current revision of the sensor head of this device. More...
 
PropertyF deviceTemperature
 A float property (read-only) containing the temperature of the selected temperature sensor on the device in degrees Celsius. More...
 
PropertyS driverDate
 A string property (read-only) containing the date the device driver has been compiled. More...
 
PropertyS driverVersion
 A string property (read-only) containing the version number of the device driver. More...
 
PropertyI firmwareVersion
 An integer property (read-only) containing the firmware version of this device. More...
 
PropertyS loadedSettings
 A string property (read-only) containing the name of the setting currently loaded. More...
 
PropertyS logFile
 A string property (read-only) containing the name and the full path of the current log-file for this device. More...
 
PropertyS recommendedListsForUIs
 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. More...
 
PropertyIBlueFOXInfoSensorCapabilities sensorCaps
 An integer property (read-only) containing a bit mask containing information about the sensors capabilities(if known). More...
 
PropertyIInfoSensorColorMode sensorColorMode
 An enumerated integer property (read-only) containing the type of the sensor (color/mono/...)(if known). More...
 
PropertyI sensorFPGAVersion
 An integer property (read-only) containing the FPGA version of the camera(if known). More...
 
PropertyIInfoSensorType sensorType
 An enumerated integer property (read-only) containing the type of sensor chip of the camera (if known). More...
 
PropertyI sensorXRes
 An integer property (read-only) containing the horizontal resolution of the camera sensor. More...
 
PropertyI sensorYRes
 An integer property (read-only) containing the vertical resolution of the camera sensor. More...
 
PropertyIDeviceState state
 An enumerated integer property (read-only) containing the current state of this device. More...
 
PropertyI systemLogicalProcessorCount
 An integer property (read-only) containing the number of logical processors detected in the current system. More...
 
PropertyI systemPhysicalProcessorCount
 An integer property (read-only) containing the number of physical processors detected in the current system. More...
 
PropertyI userEEPROMSize
 An integer property (read-only) containing the size of the user EEPROM that can be accessed using the I2C access features of mvIMPACT::acquire::I2CControl. More...
 

Protected Attributes

HOBJ m_hRoot
 

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 mvIMPACT::acquire::Device::interfaceLayout is set to mvIMPACT::acquire::dilDeviceSpecific before the device is opened.

Constructor & Destructor Documentation

◆ InfoBlueFOX()

InfoBlueFOX ( Device pDev)
inlineexplicit

Constructs a new mvIMPACT::acquire::InfoBlueFOX object.

Parameters
[in]pDevA pointer to a mvIMPACT::acquire::Device object obtained from a mvIMPACT::acquire::DeviceManager object.

Member Function Documentation

◆ hObj()

HOBJ hObj ( void  ) const
inlineinherited

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

This handle will always reference an object of type mvIMPACT::acquire::ComponentList.

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

◆ restoreDefault()

const ComponentCollection& restoreDefault ( void  ) const
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.
Returns
A const reference to the component.

Member Data Documentation

◆ captureBufferAlignment

PropertyI captureBufferAlignment
inherited

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

◆ deviceDriverVersion

PropertyS deviceDriverVersion
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 mvIMPACT::acquire::Info::driverVersion.

◆ deviceSensorRevision

PropertyI64 deviceSensorRevision

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

PropertyF deviceTemperature

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

PropertyS driverDate
inherited

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

◆ driverVersion

PropertyS driverVersion
inherited

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

◆ firmwareVersion

PropertyI firmwareVersion

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

◆ loadedSettings

PropertyS loadedSettings
inherited

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

◆ logFile

PropertyS logFile
inherited

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

◆ m_hRoot

HOBJ m_hRoot
protectedinherited

◆ recommendedListsForUIs

PropertyS recommendedListsForUIs
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

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

PropertyIInfoSensorColorMode sensorColorMode
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 mvIMPACT::acquire::TInfoSensorColorMode.

Note
If nothing is known about this feature, this property will contain mvIMPACT::acquire::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

PropertyI sensorFPGAVersion

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

PropertyIInfoSensorType sensorType
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 mvIMPACT::acquire::TInfoSensorType.

This usually will either be mvIMPACT::acquire::istCCD or mvIMPACT::acquire::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

PropertyI sensorXRes
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

PropertyI sensorYRes
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

PropertyIDeviceState state
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 mvIMPACT::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 mvIMPACT::acquire::Device::registerErrorEvent is set to mvIMPACT::acquire::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 mvIMPACT::acquire::DeviceManager::updateDeviceList() must be called regardless of the value of mvIMPACT::acquire::Device::registerErrorEvent before a device that was lost can re-establish a connection to the capture driver.

◆ systemLogicalProcessorCount

PropertyI systemLogicalProcessorCount
inherited

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

Since
2.44.0

◆ systemPhysicalProcessorCount

PropertyI systemPhysicalProcessorCount
inherited

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

Since
2.44.0

◆ userEEPROMSize

PropertyI userEEPROMSize

An integer property (read-only) containing the size of the user EEPROM that can be accessed using the I2C access features of mvIMPACT::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.

The documentation for this class was generated from the following file: