PointCloudStream Class Reference

Stream that delivers PointClouds. More...

Inherits CompositeStreamBase.

Public Member Functions
PointCloud	WaitFor (UsTimeSpan timeout, out WaitStatus waitStatus)
	Waits for and returns the next pointcloud of the stream.
PointCloud	WaitFor (UsTimeSpan timeout)
	Waits for and returns the next pointcloud of the stream.
PointCloud	WaitFor (UsTimeSpan timeout, out WaitStatus waitStatus, out NodeMapDictionary nodeMaps)
	Waits for and returns the next pointcloud of the stream.
PointCloud	WaitFor (UsTimeSpan timeout, out NodeMapDictionary nodeMaps)
	Waits for and returns the next pointcloud of the stream.
PointCloud	WaitFor (UsTimeSpan timeout, CancellationToken token, out WaitStatus waitStatus)
	Waits for and returns the next pointcloud of the stream.
PointCloud	WaitFor (UsTimeSpan timeout, CancellationToken token)
	Waits for and returns the next pointcloud of the stream.
PointCloud	WaitFor (UsTimeSpan timeout, CancellationToken token, out WaitStatus waitStatus, out NodeMapDictionary nodeMaps)
	Waits for and returns the next image of the stream.
PointCloud	WaitFor (UsTimeSpan timeout, CancellationToken token, out NodeMapDictionary nodeMaps)
	Waits for and returns the next image of the stream.
PointCloud	Wait (out WaitStatus waitStatus)
	Infinite wait, abortable by the cancellation token.
PointCloud	Wait ()
	Waits inifinitely.
PointCloud	Wait (CancellationToken token, out WaitStatus waitStatus)
	Infinite wait, abortable by the cancellation token.
PointCloud	Wait (CancellationToken token)
	Infinite wait, abortable by the cancellation token.
PointCloud	Wait (CancellationToken token, out NodeMapDictionary nodeMaps)
	Infinite wait, abortable by the cancellation token.
Public Member Functions inherited from CompositeStreamBase
void	Dispose ()
	IDisposable implementation.
void	Start ()
	Starts both the engine using EngineStart() and then the device using DeviceStart().
void	Stop ()
	Stops both the engine using EngineStart() and then the device using DeviceStart().
bool	TryStop ()
	Tries to stop the Device using TryDeviceStop and then the engine using TryEngineStop(). Does not throw an exception if stopping wasn't successful.
void	Abort ()
	Aborts both the engine using EngineStart() and then the device using DeviceStart().
bool	TryAbort ()
	Tries to abort the device using TryDeviceAbort and then the engine using TryEngineAbort. Does not throw an exception if aborting wasn't successful.
virtual void	EngineStart ()
	Starts the acquisition engine. This starts continuous acquisition that needs to be stopped via EngineStop(), EngineStop(UsTimeSpan) or EngineAbort.
virtual void	EngineStart (long bufferCountToAcquire)
	Starts the acquisition engine.
virtual void	EngineStop ()
	Stops the acquisition engine.
virtual void	EngineStop (UsTimeSpan timeout)
	Stops the acquisition engine.
virtual bool	TryEngineStop ()
	Tries to stop the acquisition engine. Does not throw an exception when engine could not be stopped.
virtual bool	TryEngineStop (UsTimeSpan timeout)
	Tries to stop the acquisition engine. Does not throw an exception when engine could not be stopped.
virtual void	EngineAbort ()
	Aborts the acquisition engine. Does not throw an exception when engine could not be aborted.
virtual bool	TryEngineAbort ()
	Aborts the acquisition engine.
virtual void	DeviceStart ()
	Starts the device acquisition.
virtual void	DeviceStart (long frameCountToAcquire)
	Starts the device acquisition.
virtual void	DeviceStop ()
	Stops the device acquisition.
virtual bool	TryDeviceStop ()
	Tries to stop the device acquisition. Des not throw an exception when the device could not be stopped.
virtual void	DeviceAbort ()
	Aborts the device acquisition.
virtual bool	TryDeviceAbort ()
	Tries to abort the device acquisition. Does not throw an error if the device could not be aborted.
void	RegisterManagedFlowSetPool (int numFlowSets)
	Registers an internal flow-set pool.
void	DeregisterFlowSetPool ()
	Removes an existing flow set pool from the acquisition engine.

Additional Inherited Members
Static Public Attributes inherited from CompositeStreamBase
static readonly UsTimeSpan	INFINITY = UsTimeSpan.FromMilliseconds(ENDLESS)
	Constant for infinite time span.
Protected Member Functions inherited from CompositeStreamBase
	CompositeStreamBase (Device device, int index)
	Constructor.
virtual void	Dispose (bool disposing)
	IDisposable helper function.
IntPtr	WaitForNextComposite (UsTimeSpan timeout, out WaitStatus waitStatus)
	Waits for and returns the next composite of the stream.
IntPtr	WaitForNextComposite (UsTimeSpan timeout, CancellationToken token, out WaitStatus waitStatus)
	Waits for and returns the next composite of the stream.
T	RegisterComposite< T > (T composite)
	Registers a composite for deregistration on disposal.
Properties inherited from CompositeStreamBase
Device	Parent [get]
	Gets the parent Device.
IntPtr	Handle [get]
	Native handle of the PointCloud.
bool	IsDisposed [get]
	Gets if the native handle has been disposed.
StreamNodeMapDictionary	NodeMaps [get]
	Gets the dictionary holding all available GenApi.NodeMaps.
AcquisitionInterface	AcquisitionInterface [get]
	Gets the acquisition interface to use on this stream. Composite streams currently only support AcquisitionInterface.Grab3.
bool	IsIndexed [get]
	Gets if this stream is indexed (has a fixed amount of data).
AcquisitionState	AcquisitionState [get, protected set]
	Current acquisition state of the stream.
int	FlowSetCount [get]
	Gets the number of registered flow sets.
int	MinRequireedFlowSetCount [get]
	Gets minimum number of flow-sets required for the acquisition.
Events inherited from CompositeStreamBase
NativeHandleEventDelegate	ObjectDisposing
	Raised when this object is about to be disposed via the IDisposable.Dispose method.
Events inherited from INativeHandle
NativeHandleEventDelegate	ObjectDisposing
	Raised when this object is about to be disposed via the IDisposable.Dispose method.

Detailed Description

Stream that delivers PointClouds.

Member Function Documentation

Wait() [1/5]

PointCloud Wait

(

)

Waits inifinitely.

Returns

Acquired pointcloud

Wait() [2/5]

PointCloud Wait

(

CancellationToken

token

)

Infinite wait, abortable by the cancellation token.

Parameters

token

Token to cancel the operation.

Returns

Received pointcloud

Wait() [3/5]

PointCloud Wait	(	CancellationToken	token,
		out NodeMapDictionary	nodeMaps )

Infinite wait, abortable by the cancellation token.

Dispose of the returned nodeMaps when not needed anymore! Notably, it must also be explicitly disposed of when the method is called in a using statement block; the returned PointCloud object will be disposed of once the execution goes out from the scope but it does not take care of nodeMaps ; the responsibility has been left on the client's side.

Parameters

token	Token to cancel the operation
nodeMaps	NodeMaps of the returned pointcloud.

Returns

Received pointcloud

Wait() [4/5]

PointCloud Wait	(	CancellationToken	token,
		out WaitStatus	waitStatus )

Infinite wait, abortable by the cancellation token.

Parameters

token	Token to cancel the operation
waitStatus	Returns status of wait

Returns

Received pointcloud

Wait() [5/5]

PointCloud Wait

(

out WaitStatus

waitStatus

)

Infinite wait, abortable by the cancellation token.

Parameters

waitStatus

Returns status of wait

Returns

Received pointcloud

WaitFor() [1/8]

PointCloud WaitFor

(

UsTimeSpan

timeout

)

Waits for and returns the next pointcloud of the stream.

Parameters

timeout

Time to wait before timeout.

Returns

Acquired pointcloud.

WaitFor() [2/8]

PointCloud WaitFor	(	UsTimeSpan	timeout,
		CancellationToken	token )

Waits for and returns the next pointcloud of the stream.

Parameters

timeout	Time to wait before timeout.
token	Token to cancel the operation.

Returns

Acquired pointcloud.

WaitFor() [3/8]

PointCloud WaitFor	(	UsTimeSpan	timeout,
		CancellationToken	token,
		out NodeMapDictionary	nodeMaps )

Waits for and returns the next image of the stream.

Parameters

timeout	Time to wait before timeout.
token	Token to cancel the operation.
nodeMaps	NodeMaps of the returned pointcloud.

Returns

Acquired pointcloud.

WaitFor() [4/8]

PointCloud WaitFor	(	UsTimeSpan	timeout,
		CancellationToken	token,
		out WaitStatus	waitStatus )

Waits for and returns the next pointcloud of the stream.

Parameters

timeout	Time to wait before timeout.
token	Token to cancel the operation.
waitStatus	Return status of the operation.

Returns

Acquired pointcloud.

WaitFor() [5/8]

PointCloud WaitFor	(	UsTimeSpan	timeout,
		CancellationToken	token,
		out WaitStatus	waitStatus,
		out NodeMapDictionary	nodeMaps )

Waits for and returns the next image of the stream.

Parameters

timeout	Time to wait before timeout.
token	Token to cancel the operation.
waitStatus	Return status of the operation.
nodeMaps	NodeMaps of the returned pointcloud.

Returns

Acquired pointcloud.

WaitFor() [6/8]

PointCloud WaitFor	(	UsTimeSpan	timeout,
		out NodeMapDictionary	nodeMaps )

Waits for and returns the next pointcloud of the stream.

Parameters

timeout	Time to wait before timeout.
nodeMaps	NodeMaps of the returned pointcloud.

Returns

Acquired pointcloud.

WaitFor() [7/8]

PointCloud WaitFor	(	UsTimeSpan	timeout,
		out WaitStatus	waitStatus )

Waits for and returns the next pointcloud of the stream.

Parameters

timeout	Time to wait before timeout.
waitStatus	Return status of the operation.

Returns

Acquired pointcloud.

WaitFor() [8/8]

PointCloud WaitFor	(	UsTimeSpan	timeout,
		out WaitStatus	waitStatus,
		out NodeMapDictionary	nodeMaps )

Waits for and returns the next pointcloud of the stream.

Parameters

timeout	Time to wait before timeout.
waitStatus	Return status of the operation.
nodeMaps	NodeMaps of the returned pointcloud.

Returns

Acquired pointcloud.