mvIMPACT Acquire SDK C++

Category containing the Lighting control features. More...

#include <mvIMPACT_acquire_GenICam.h>

Public Member Functions

 LightControl (mvIMPACT::acquire::Device *pDev, const std::string &settingName="Base")
 Constructs a new mvIMPACT::acquire::GenICam::LightControl object.
 

Public Attributes

PropertyF lightBrightness
 A floating point property. Set the brightness of the lighting output in percent.
 
PropertyI64 lightConnectionStatus
 An enumerated integer property. Status of a light connected to the controller's output Line.
 
PropertyI64 lightControllerSelector
 An enumerated integer property. Selects the Light Controller to configure.
 
PropertyI64 lightControllerSource
 An enumerated integer property. Selects the input source signal of the Light Controller.
 
PropertyF lightCurrentMeasured
 A floating point property. The measured current applied to the lighting.
 
PropertyF lightCurrentRating
 A floating point property. Set the current rating of the lighting output.
 
PropertyF lightVoltageMeasured
 A floating point property. The measured voltage applied to the lighting.
 
PropertyF lightVoltageRating
 A floating point property. Set the voltage rating of the lighting output.
 

Detailed Description

Category containing the Lighting control features.

A category containing the Lighting control features.

Constructor & Destructor Documentation

◆ LightControl()

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

Constructs a new mvIMPACT::acquire::GenICam::LightControl 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 Data Documentation

◆ lightBrightness

PropertyF lightBrightness

A floating point property. Set the brightness of the lighting output in percent.

Set the brightness of the lighting output in percent. Can be greater than 100% for short overdrive period.

◆ lightConnectionStatus

PropertyI64 lightConnectionStatus

An enumerated integer property. Status of a light connected to the controller's output Line.

Status of a light connected to the controller's output Line.

The following string values might be valid for this feature:

  • Sensing (Display string: 'Sensing'): Sensing
  • Ready (Display string: 'Ready'): Ready
  • NoConnect (Display string: 'No Connect'): No Connect
  • Error (Display string: 'Error'): Error
Note
Depending on the device some of these values might not be supported and especially when working with third party devices there might be custom values which are not listed here. To get a complete and reliable list of supported values at runtime an application should therefore call mvIMPACT::acquire::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ lightControllerSelector

PropertyI64 lightControllerSelector

An enumerated integer property. Selects the Light Controller to configure.

Selects the Light Controller to configure.

The following string values might be valid for this feature:

  • LightController0 (Display string: 'Light Controller 0'): Light Controller 0
  • LightController1 (Display string: 'Light Controller 1'): Light Controller 1
  • LightController2 (Display string: 'Light Controller 2'): Light Controller 2
  • LightController#3# (Display string: 'Light Controller #3#'): Light Controller #3#
  • LightController3 (Display string: 'Light Controller 3'): Light Controller 3
  • LightController4 (Display string: 'Light Controller 4'): Light Controller 4
  • LightController5 (Display string: 'Light Controller 5'): Light Controller 5
  • LightController6 (Display string: 'Light Controller 6'): Light Controller 6
  • LightController7 (Display string: 'Light Controller 7'): Light Controller 7
  • LightController8 (Display string: 'Light Controller 8'): Light Controller 8
  • LightController9 (Display string: 'Light Controller 9'): Light Controller 9
  • LightController10 (Display string: 'Light Controller 10'): Light Controller 10
  • LightController11 (Display string: 'Light Controller 11'): Light Controller 11
  • LightController12 (Display string: 'Light Controller 12'): Light Controller 12
  • LightController13 (Display string: 'Light Controller 13'): Light Controller 13
  • LightController14 (Display string: 'Light Controller 14'): Light Controller 14
  • LightController15 (Display string: 'Light Controller 15'): Light Controller 15
Note
Depending on the device some of these values might not be supported and especially when working with third party devices there might be custom values which are not listed here. To get a complete and reliable list of supported values at runtime an application should therefore call mvIMPACT::acquire::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ lightControllerSource

PropertyI64 lightControllerSource

An enumerated integer property. Selects the input source signal of the Light Controller.

Selects the input source signal of the Light Controller.

The following string values might be valid for this feature:

  • Line0 (Display string: 'Line 0'): Line 0
  • Line#1# (Display string: 'Line #1#'): Line #1#
  • Timer0 (Display string: 'Timer 0'): Timer 0
  • Timer#1# (Display string: 'Timer #1#'): Timer #1#
  • Counter0 (Display string: 'Counter 0'): Counter 0
  • Counter#1# (Display string: 'Counter #1#'): Counter #1#
  • UserOutput0 (Display string: 'User Output 0'): User Output 0
  • UserOutput#1# (Display string: 'User Output #1#'): User Output #1#
  • Line1 (Display string: 'Line 1'): Line 1
  • Line2 (Display string: 'Line 2'): Line 2
  • Line3 (Display string: 'Line 3'): Line 3
  • Line4 (Display string: 'Line 4'): Line 4
  • Line5 (Display string: 'Line 5'): Line 5
  • Line6 (Display string: 'Line 6'): Line 6
  • Line7 (Display string: 'Line 7'): Line 7
  • Line8 (Display string: 'Line 8'): Line 8
  • Line9 (Display string: 'Line 9'): Line 9
  • Line10 (Display string: 'Line 10'): Line 10
  • Line11 (Display string: 'Line 11'): Line 11
  • Line12 (Display string: 'Line 12'): Line 12
  • Line13 (Display string: 'Line 13'): Line 13
  • Line14 (Display string: 'Line 14'): Line 14
  • Line15 (Display string: 'Line 15'): Line 15
  • Timer1 (Display string: 'Timer 1'): Timer 1
  • Timer2 (Display string: 'Timer 2'): Timer 2
  • Timer3 (Display string: 'Timer 3'): Timer 3
  • Timer4 (Display string: 'Timer 4'): Timer 4
  • Timer5 (Display string: 'Timer 5'): Timer 5
  • Timer6 (Display string: 'Timer 6'): Timer 6
  • Timer7 (Display string: 'Timer 7'): Timer 7
  • Timer8 (Display string: 'Timer 8'): Timer 8
  • Timer9 (Display string: 'Timer 9'): Timer 9
  • Timer10 (Display string: 'Timer 10'): Timer 10
  • Timer11 (Display string: 'Timer 11'): Timer 11
  • Timer12 (Display string: 'Timer 12'): Timer 12
  • Timer13 (Display string: 'Timer 13'): Timer 13
  • Timer14 (Display string: 'Timer 14'): Timer 14
  • Timer15 (Display string: 'Timer 15'): Timer 15
  • Counter1 (Display string: 'Counter 1'): Counter 1
  • Counter2 (Display string: 'Counter 2'): Counter 2
  • Counter3 (Display string: 'Counter 3'): Counter 3
  • Counter4 (Display string: 'Counter 4'): Counter 4
  • Counter5 (Display string: 'Counter 5'): Counter 5
  • Counter6 (Display string: 'Counter 6'): Counter 6
  • Counter7 (Display string: 'Counter 7'): Counter 7
  • Counter8 (Display string: 'Counter 8'): Counter 8
  • Counter9 (Display string: 'Counter 9'): Counter 9
  • Counter10 (Display string: 'Counter 10'): Counter 10
  • Counter11 (Display string: 'Counter 11'): Counter 11
  • Counter12 (Display string: 'Counter 12'): Counter 12
  • Counter13 (Display string: 'Counter 13'): Counter 13
  • Counter14 (Display string: 'Counter 14'): Counter 14
  • Counter15 (Display string: 'Counter 15'): Counter 15
  • UserOutput1 (Display string: 'User Output 1'): User Output 1
  • UserOutput2 (Display string: 'User Output 2'): User Output 2
  • UserOutput3 (Display string: 'User Output 3'): User Output 3
  • UserOutput4 (Display string: 'User Output 4'): User Output 4
  • UserOutput5 (Display string: 'User Output 5'): User Output 5
  • UserOutput6 (Display string: 'User Output 6'): User Output 6
  • UserOutput7 (Display string: 'User Output 7'): User Output 7
  • UserOutput8 (Display string: 'User Output 8'): User Output 8
  • UserOutput9 (Display string: 'User Output 9'): User Output 9
  • UserOutput10 (Display string: 'User Output 10'): User Output 10
  • UserOutput11 (Display string: 'User Output 11'): User Output 11
  • UserOutput12 (Display string: 'User Output 12'): User Output 12
  • UserOutput13 (Display string: 'User Output 13'): User Output 13
  • UserOutput14 (Display string: 'User Output 14'): User Output 14
  • UserOutput15 (Display string: 'User Output 15'): User Output 15
Note
Depending on the device some of these values might not be supported and especially when working with third party devices there might be custom values which are not listed here. To get a complete and reliable list of supported values at runtime an application should therefore call mvIMPACT::acquire::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ lightCurrentMeasured

PropertyF lightCurrentMeasured

A floating point property. The measured current applied to the lighting.

The measured current applied to the lighting.

◆ lightCurrentRating

PropertyF lightCurrentRating

A floating point property. Set the current rating of the lighting output.

Set the current rating of the lighting output.

◆ lightVoltageMeasured

PropertyF lightVoltageMeasured

A floating point property. The measured voltage applied to the lighting.

The measured voltage applied to the lighting.

◆ lightVoltageRating

PropertyF lightVoltageRating

A floating point property. Set the voltage rating of the lighting output.

Set the voltage rating of the lighting output.