mvIMPACT Acquire SDK C++
ComponentCollection Class Reference

A base class for sets of properties that can be modified by the user. More...

Inheritance diagram for ComponentCollection:
AutoControlParameters BasicDeviceSettings BufferPart CameraDescriptionBase Connector DigitalIOMeasurementControl GainOffsetKneeChannelParameters DataStreamModule DeviceModule GenTLDriverConfigurator GenTLProducerConfiguration InterfaceModule SystemModule mvAutoFeatureControl mvCurrentControl mvCustomData mvDefectivePixelCorrectionControl mvFFCControl mvFrameAverageControl mvHDRControl mvLensControl mvLogicGateControl mvSerialInterfaceControl HDRControl HDRKneePoint I2CControl ImageDestination ImageMemoryManager ImageProcessing ImageRequestControl Info LUTParameters MirrorParameters MotorFocusControl PulseStartConfiguration RTCtrProgram RTCtrProgramStep RequestInfoConfiguration Statistics SyncOutput SystemSettings TriggerControl WhiteBalanceSettings

Public Member Functions

HOBJ hObj (void) const
 Returns a unique identifier for the component collection referenced by this object. More...
 
const ComponentCollectionrestoreDefault (void) const
 Restores the default for every component of this collection. More...
 
virtual ~ComponentCollection ()
 

Protected Member Functions

 ComponentCollection ()
 
 ComponentCollection (Device *pDev)
 
 ComponentCollection (HOBJ hRoot)
 

Protected Attributes

HOBJ m_hRoot
 

Detailed Description

A base class for sets of properties that can be modified by the user.

Constructor & Destructor Documentation

◆ ComponentCollection() [1/3]

ComponentCollection ( )
inlineexplicitprotected

◆ ComponentCollection() [2/3]

ComponentCollection ( HOBJ  hRoot)
inlineexplicitprotected

◆ ComponentCollection() [3/3]

ComponentCollection ( Device pDev)
inlineexplicitprotected

◆ ~ComponentCollection()

virtual ~ComponentCollection ( )
inlinevirtual

Member Function Documentation

◆ hObj()

HOBJ hObj ( void  ) const
inline

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
inline

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
protected

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