Ensenso_GetGlobalParameter_String

Header:	ThirdPartySdk.h
Namespace:	avl

Gets the value of a string parameter.

Syntax

void avl::Ensenso_GetGlobalParameter_String
(
	Ensenso_State& ioState,
	const atl::Array<avl::EnsensoCameraInformation>& inDevices,
	const atl::String& inPath,
	atl::String& outValue
)

Parameters

Name	Type	Description
ioState	Ensenso_State&	Object used to maintain state of the function.
inDevices	const Array<EnsensoCameraInformation>&	Structures identifying devices
inPath	const String&	Configuration path, relative
outValue	String&

Examples

Configuration tree

Configuration paths are relative to root or camera tree.

for example path

Sensor/Temperature

GetGlobalParamerter

filter will give read only access to currently opened camera sensor temperature (double)

path

Parameters/Capture/PixelClock

GetParamerter

filter will give access to camera pixel clock

Remarks

Camera identification

When there is only one Ensenso camera connected, the field inDevices can be set to Auto. In this situation, the first available camera will be used.

inDevices can be used to pick one or many of multiple cameras connected to the computer.

Camera driver software

This filter is intended to cooperate with cameras using their vendor's SDK. In order to connect with the camera, it is required to install Ensenso SDK software, and uEye driver (same as in IDS camera filters)

Ensenso SDK can be downloaded from the following website: https://www.ensenso.com/support/sdk-download/

uEye driver can be downloaded from the following website: https://en.ids-imaging.com/download-ueye.html

Recommended Ensenso SDK version for Aurora Vision Studio usage is 2.2 and uEye driver 4.90.

Multithreaded environment

This function is not guaranteed to be thread-safe. When used in multithreaded environment, it has to be manually synchronized.

Errors

Will throw atl::DomainError if the type is not convertible to requested type

Will throw atl::DomainError if the type does not exist or is null