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

Gocator_GrabResampledProfile_WithTimeout

Captures resampled profile from Gocator device.

Syntax

bool avl::Gocator_GrabResampledProfile_WithTimeout
(
	Gocator_State& ioState,
	const atl::Optional<avl::GocatorAddress>& inAddress,
	int inInputQueueSize,
	int inTimeout,
	atl::Conditional<atl::Array<avl::Point2D>>& outProfileData,
	atl::Conditional<avl::Profile>& outProfileIntensity,
	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
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
outProfileData	Conditional<Array<Point2D>>&
outProfileIntensity	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>&

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")

Multithreaded environment