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

Gocator_GrabSection_WithTimeout

Header:	ThirdPartySdk.h
Namespace:	fil

Captures Section from Gocator device.

Syntax

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

Parameters

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

Multithreaded environment

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