CVBpy 15.0
StreamBase Class Reference

The base class for all stream classes. More...

Inherits object.

Inherited by CompositeStreamBase, and Stream.

Public Member Functions

None abort (self)
 Stops the acquisition of images immediately. More...
 
None start (self)
 Starts the acquisition. More...
 
None stop (self)
 Stops the acquisition. More...
 
bool try_abort (self)
 Stops the acquisition of images immediately. More...
 
bool try_stop (self)
 Stops the acquisition. More...
 

Properties

 is_indexed = property
 bool: Returns whether this stream is an indexed stream.
 

Detailed Description

The base class for all stream classes.

Member Function Documentation

◆ abort()

None abort (   self)

Stops the acquisition of images immediately.

This stops the acquisition as fast as possible interrupting the ongoing operation. This might result in partially acquired images.

If the underlying driver does not support this, this call behaves as if stop() has been called.

◆ start()

None start (   self)

Starts the acquisition.

The acquisition engine is started in on the host first, then the stream on the device is started.

◆ stop()

None stop (   self)

Stops the acquisition.

This stops the acquisition gracefully letting the ongoing operation finish.The acquisition is stopped in the device first, then the engine on the host is stopped. The disadvantage may be that this call lasts until the timeout time of the last Wait() call.

◆ try_abort()

bool try_abort (   self)

Stops the acquisition of images immediately.

Same as abort(), but does not throw.

Returns

bool True if successfully stopped, false on error.

◆ try_stop()

bool try_stop (   self)

Stops the acquisition.

Same as stop(), but does not throw.

Returns

bool True if successfully stopped, false on error.