CVB.Net 14.0
CompositeStream Class Reference

Stream that returns composites. More...

Inherits CompositeStreamBase.

Public Member Functions

Composite WaitFor (UsTimeSpan timeout, out WaitStatus waitStatus)
 Waits for and returns the next composite of the stream. More...
 
Composite WaitFor (UsTimeSpan timeout)
 Waits for and returns the next composite of the stream. More...
 
Composite WaitFor (UsTimeSpan timeout, out WaitStatus waitStatus, out NodeMapDictionary nodeMaps)
 Waits for and returns the next composite of the stream. More...
 
Composite WaitFor (UsTimeSpan timeout, out NodeMapDictionary nodeMaps)
 Waits for and returns the next composite of the stream. More...
 
Composite WaitFor (UsTimeSpan timeout, CancellationToken token, out WaitStatus waitStatus)
 Waits for and returns the next composite of the stream. More...
 
Composite WaitFor (UsTimeSpan timeout, CancellationToken token)
 Waits for and returns the next composite of the stream. More...
 
Composite WaitFor (UsTimeSpan timeout, CancellationToken token, out WaitStatus waitStatus, out NodeMapDictionary nodeMaps)
 Waits for and returns the next composite of the stream. More...
 
Composite WaitFor (UsTimeSpan timeout, CancellationToken token, out NodeMapDictionary nodeMaps)
 Waits for and returns the next composite of the stream. More...
 
Composite Wait (out WaitStatus waitStatus)
 Infinite wait, abortable by the cancellation token More...
 
Composite Wait ()
 Waits inifinitely More...
 
Composite Wait (CancellationToken token, out WaitStatus waitStatus)
 Infinite wait, abortable by the cancellation token More...
 
Composite Wait (CancellationToken token)
 Infinite wait, abortable by the cancellation token. More...
 
- 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. More...
 
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. More...
 
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. More...
 
virtual void EngineStop ()
 Stops the acquisition engine.
 
virtual void EngineStop (UsTimeSpan timeout)
 Stops the acquisition engine. More...
 
virtual bool TryEngineStop ()
 Tries to stop the acquisition engine. Does not throw an exception when engine could not be stopped. More...
 
virtual bool TryEngineStop (UsTimeSpan timeout)
 Tries to stop the acquisition engine. Does not throw an exception when engine could not be stopped. More...
 
virtual void EngineAbort ()
 Aborts the acquisition engine. Does not throw an exception when engine could not be aborted. More...
 
virtual bool TryEngineAbort ()
 Aborts the acquisition engine. More...
 
virtual void DeviceStart ()
 Starts the device acquisition.
 
virtual void DeviceStart (long frameCountToAcquire)
 Starts the device acquisition. More...
 
virtual void DeviceStop ()
 Stops the device acquisition. More...
 
virtual bool TryDeviceStop ()
 Tries to stop the device acquisition. Des not throw an exception when the device could not be stopped. More...
 
virtual void DeviceAbort ()
 Aborts the device acquisition. More...
 
virtual bool TryDeviceAbort ()
 Tries to abort the device acquisition. Does not throw an error if the device could not be aborted. More...
 
void RegisterManagedFlowSetPool (int numFlowSets)
 Registers an internal flow-set pool. More...
 
void DeregisterFlowSetPool ()
 Removes an existing flow set pool from the acquisition engine. More...
 
void Start ()
 Start the acquisition.
 
void Stop ()
 Stops the acquisition.
 
void Abort ()
 Stops the acquisition of images immediately.
 

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 More...
 
virtual void Dispose (bool disposing)
 IDisposable helper function. More...
 
IntPtr WaitForNextComposite (UsTimeSpan timeout, out WaitStatus waitStatus)
 Waits for and returns the next composite of the stream. More...
 
IntPtr WaitForNextComposite (UsTimeSpan timeout, CancellationToken token, out WaitStatus waitStatus)
 Waits for and returns the next composite of the stream. More...
 
RegisterComposite< T > (T composite)
 Registers a composite for deregistration on disposal. More...
 
- 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. More...
 
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. More...
 
- Properties inherited from IStream
AcquisitionInterface AcquisitionInterface [get]
 Gets or sets the acquisition interface to use on this stream.
 
bool IsIndexed [get]
 Gets if this stream is indexed (has a fixed amount of data).
 
- Properties inherited from INativeHandle
IntPtr Handle [get]
 The native handle of the object.
 
bool IsDisposed [get]
 Possibility to check whether the object has already been disposed of.
 
- Events inherited from CompositeStreamBase
NativeHandleEventDelegate ObjectDisposing
 Raised when this object is about to be disposed via the IDisposable.Dispose method. More...
 
- Events inherited from INativeHandle
NativeHandleEventDelegate ObjectDisposing
 Raised when this object is about to be disposed via the IDisposable.Dispose method.
More...
 

Detailed Description

Stream that returns composites.

Member Function Documentation

◆ Wait() [1/4]

Composite Wait ( )

Waits inifinitely

Returns
Acquired Composite

◆ Wait() [2/4]

Composite Wait ( CancellationToken  token)

Infinite wait, abortable by the cancellation token.

Parameters
tokenToken to cancel the operation.
Returns
Received composite

◆ Wait() [3/4]

Composite Wait ( CancellationToken  token,
out WaitStatus  waitStatus 
)

Infinite wait, abortable by the cancellation token

Parameters
tokenToken to cancel the operation
waitStatusReturns status of wait
Returns
Received composite

◆ Wait() [4/4]

Composite Wait ( out WaitStatus  waitStatus)

Infinite wait, abortable by the cancellation token

Parameters
waitStatusReturns status of wait
Returns
Received composite

◆ WaitFor() [1/8]

Composite WaitFor ( UsTimeSpan  timeout)

Waits for and returns the next composite of the stream.

Parameters
timeoutTime to wait before timeout.
Returns
Acquired composite.

◆ WaitFor() [2/8]

Composite WaitFor ( UsTimeSpan  timeout,
CancellationToken  token 
)

Waits for and returns the next composite of the stream.

Parameters
timeoutTime to wait before timeout.
tokenToken to cancel the operation.
Returns
Acquired composite.

◆ WaitFor() [3/8]

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

Waits for and returns the next composite of the stream.

Parameters
timeoutTime to wait before timeout.
tokenToken to cancel the operation.
nodeMapsNodeMaps of the returned composite.
Returns
Acquired composite.

◆ WaitFor() [4/8]

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

Waits for and returns the next composite of the stream.

Parameters
timeoutTime to wait before timeout.
tokenToken to cancel the operation.
waitStatusReturn status of the operation.
Returns
Acquired composite.

◆ WaitFor() [5/8]

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

Waits for and returns the next composite of the stream.

Parameters
timeoutTime to wait before timeout.
tokenToken to cancel the operation.
waitStatusReturn status of the operation.
nodeMapsNodeMaps of the returned composite.
Returns
Acquired composite.

◆ WaitFor() [6/8]

Composite WaitFor ( UsTimeSpan  timeout,
out NodeMapDictionary  nodeMaps 
)

Waits for and returns the next composite of the stream.

Parameters
timeoutTime to wait before timeout.
nodeMapsNodeMaps of the returned composite.
Returns
Acquired composite.

◆ WaitFor() [7/8]

Composite WaitFor ( UsTimeSpan  timeout,
out WaitStatus  waitStatus 
)

Waits for and returns the next composite of the stream.

Parameters
timeoutTime to wait before timeout.
waitStatusReturn status of the operation.
Returns
Acquired composite.

◆ WaitFor() [8/8]

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

Waits for and returns the next composite of the stream.

Parameters
timeoutTime to wait before timeout.
waitStatusReturn status of the operation.
nodeMapsNodeMaps of the returned composite.
Returns
Acquired composite.