mvIMPACT Acquire SDK C++
Info Class Reference

A base class to access various general information about the device and its driver. More...

Inheritance diagram for Info:
ComponentCollection InfoBlueDevice InfoBlueCOUGAR InfoBlueFOX

Public Member Functions

HOBJ hObj (void) const
 Returns a unique identifier for the component collection referenced by this object. More...
 
 Info (Device *pDev)
 Constructs a new mvIMPACT::acquire::Info 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...
 
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...
 
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...
 
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...
 

Protected Attributes

HOBJ m_hRoot
 

Detailed Description

A base class to access various general information about the device and its driver.

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

Instances of this class can't be constructed directly. Use one of the derived types.

Constructor & Destructor Documentation

◆ Info()

Info ( Device pDev)
inlineexplicit

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

Parameters
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

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

◆ deviceDriverVersion

PropertyS deviceDriverVersion

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.

◆ driverDate

PropertyS driverDate

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

◆ driverVersion

PropertyS driverVersion

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

◆ loadedSettings

PropertyS loadedSettings

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

◆ logFile

PropertyS logFile

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

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

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

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

Since
2.44.0

◆ systemPhysicalProcessorCount

PropertyI systemPhysicalProcessorCount

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

Since
2.44.0

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