Back to Adaptive Vision Library website

You are here: Start » Function Reference » Camera Support » Gocator » Gocator_GrabSection_WithTimeout

Gocator_GrabSection_WithTimeout


Header: ThirdPartySdk.h
Namespace: avl
Module: ThirdParty

Captures Section from Gocator device.

Syntax

bool avl::Gocator_GrabSection_WithTimeout
(
	Gocator_State& ioState,
	const atl::Optional<avl::GocatorAddress>& inAddress,
	int inInputQueueSize,
	int inTimeout,
	int inSectionID,
	atl::Conditional<atl::Array<avl::Point2D>>& outSectionData,
	atl::Conditional<avl::Profile>& outSectionIntensity,
	atl::Conditional<atl::real>& outXScale,
	atl::Conditional<atl::real>& outXOffset,
	atl::Conditional<atl::real>& outZScale,
	atl::Conditional<atl::real>& outZOffset,
	atl::Conditional<avl::GocatorFrameInfo>& outFrameInfo
)

Parameters

Name Type Range Default Description
Input will be modified
 ioState Gocator_State& Object used to maintain state of the function.
Input value
 inAddress const Optional<GocatorAddress>& NIL Gocator Device identifying IP address (e.g. "127.0.0.1") or serial number (e.g. "SN:17335")
Input value
 inInputQueueSize int 1 - 50000 Number of incoming frames that can be buffered before the application is able to process them
Input value
 inTimeout int 10 - 100
Input value
 inSectionID int 0 -
Output value
 outSectionData Conditional<Array<Point2D>>&
Output value
 outSectionIntensity Conditional<Profile>&
Output value
 outXScale Conditional<real>& X scale in mm
Output value
 outXOffset Conditional<real>& X offset in mm
Output value
 outZScale Conditional<real>& Z scale in mm
Output value
 outZOffset Conditional<real>& Z offset in mm
Output value
 outFrameInfo Conditional<GocatorFrameInfo>&

Remarks

Device identification

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

inAddress can be used to pick one of multiple devices connected to the computer. inAddress can be set to:

  • IP Address - Gocator Device identifying IP address (e.g. "127.0.0.1")
  • Serial Number - Gocator Device serial number with "SN:" prefix (e.g. "SN:17335")
Gocator emulator

This filter was tested with Gocator emulator in version 6.1.20.8.