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

Gocator_GrabSection

Header:	ThirdPartySdk.h
Namespace:	fil

Captures Section from Gocator device.

Syntax

bool fil::Gocator_GrabSection
(
	Gocator_State& ioState,
	const ftl::Optional<fil::GocatorAddress>& inAddress,
	int inInputQueueSize,
	int inSectionID,
	ftl::Array<fil::Point2D>& outSectionData,
	ftl::Conditional<fil::Profile>& outSectionIntensity,
	ftl::real& outXScale,
	ftl::real& outXOffset,
	ftl::real& outZScale,
	ftl::real& outZOffset,
	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
inSectionID	int	0 -
outSectionData	Array<Point2D>&
outSectionIntensity	Conditional<Profile>&
outXScale	real&			X scale in mm
outXOffset	real&			X offset in mm
outZScale	real&			Z scale in mm
outZOffset	real&			Z offset in mm
outFrameInfo	GocatorFrameInfo&

Multithreaded environment

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