mvIMPACT Acquire SDK C++

Custom area. More...

Inheritance diagram for mvCustomData:
ComponentCollection

Public Member Functions

HOBJ hObj (void) const
 Returns a unique identifier for the component collection referenced by this object. More...
 
 mvCustomData (mvIMPACT::acquire::Device *pDev, const std::string &settingName="Base")
 Constructs a new mvIMPACT::acquire::GenICam::mvCustomData object. More...
 
const ComponentCollectionrestoreDefault (void) const
 Restores the default for every component of this collection. More...
 

Public Attributes

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

Protected Attributes

HOBJ m_hRoot
 

Detailed Description

Custom area.

Custom area.

Constructor & Destructor Documentation

◆ mvCustomData()

mvCustomData ( mvIMPACT::acquire::Device pDev,
const std::string &  settingName = "Base" 
)
inlineexplicit

Constructs a new mvIMPACT::acquire::GenICam::mvCustomData object.

Parameters
[in]pDevA pointer to a mvIMPACT::acquire::Device object obtained from a mvIMPACT::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 mvIMPACT::acquire::FunctionInterface::getAvailableSettings, new settings can be created with the function mvIMPACT::acquire::FunctionInterface::createSetting

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

◆ m_hRoot

HOBJ m_hRoot
protectedinherited

◆ mvCustomCommandBuffer

PropertyS mvCustomCommandBuffer

A string property. Command buffer for custom commands.

Command buffer for custom commands.

◆ mvCustomCommandInterpreterVersionMajor

PropertyI64 mvCustomCommandInterpreterVersionMajor

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

PropertyI64 mvCustomCommandInterpreterVersionMinor

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

PropertyS mvCustomText

A string property. Custom text.

Custom text.

◆ mvDeviceFPGAErrorCode

PropertyI64 mvDeviceFPGAErrorCode

An integer property. Error Code of the FPGA Faultbus.

Error Code of the FPGA Faultbus.

◆ mvExposureStartDelay

PropertyF 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.

◆ mvExposureTimeIncrement

PropertyF mvExposureTimeIncrement

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

Increment of the expsure time in us.

◆ mvImxSensorIdOne

PropertyI64 mvImxSensorIdOne

An integer property. IMX SensorID1.

IMX SensorID1

◆ mvImxSensorIdTwo

PropertyI64 mvImxSensorIdTwo

An integer property. IMX SensorID2.

IMX SensorID2

◆ mvInternalRegister

PropertyI64 mvInternalRegister

An integer property. Register address to access.

Register address to access.

◆ mvInternalRegisterValue

PropertyI64 mvInternalRegisterValue

An integer property. Value of internal register.

Value of internal register.

◆ mvLVDSAlignment

PropertyI64 mvLVDSAlignment

An integer property. Alignment of LVDS lanes.

Alignment of LVDS lanes.

◆ mvLVDSSelection

PropertyI64 mvLVDSSelection

An integer property. Selector for LVDS lanes.

Selector for LVDS lanes.

◆ mvMSeqRegister

PropertyI64 mvMSeqRegister

An integer property. Register address to access.

Register address to access.

◆ mvMSeqRegisterValue

PropertyI64 mvMSeqRegisterValue

An integer property. Value of mseq register.

Value of mseq register.

◆ mvReadCustomData

Method mvReadCustomData

A method object. Function to read custom data.

Function to read custom data.

◆ mvRunTest

Method mvRunTest

A method object. Runs internal test.

Runs internal test.

◆ mvSensorRegister

PropertyI64 mvSensorRegister

An integer property. Sensor register address to access.

Sensor register address to access.

◆ mvSensorRegisterValue

PropertyI64 mvSensorRegisterValue

An integer property. Value of sensor register.

Value of sensor register.

◆ mvStat2SumRegister

PropertyI64 mvStat2SumRegister

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

Indicates several states besides some other info.

◆ mvStat3SumRegister

PropertyI64 mvStat3SumRegister

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

Indicates several states besides some other info.

◆ mvStat4SumRegister

PropertyI64 mvStat4SumRegister

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

Indicates several states besides some other info.

◆ mvStat5SumRegister

PropertyI64 mvStat5SumRegister

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

Indicates several states besides some other info.

◆ mvStat6SumRegister

PropertyI64 mvStat6SumRegister

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

Indicates several states besides some other info.

◆ mvStateSumRegister

PropertyI64 mvStateSumRegister

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

Indicates several states besides some other info.

◆ mvStateSumRegister3Reset

Method mvStateSumRegister3Reset

A method object. Resets the state register.

Resets the state register.

◆ mvStateSumRegisterReset

Method mvStateSumRegisterReset

A method object. Resets the state register.

Resets the state register.

◆ mvTestMax

PropertyI64 mvTestMax

An integer property. Max number for test.

Max number for test.

◆ mvTestMin

PropertyI64 mvTestMin

An integer property. Min number for test.

Min number for test.

◆ mvTestNumber

PropertyI64 mvTestNumber

An integer property. Number of test to run.

Number of test to run.

◆ mvWriteCustomData

Method mvWriteCustomData

A method object. Function to write custom data.

Function to write custom data.


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