Base class of all streams. More...
#include <cvb/driver/stream_base.hpp>
Inherits enable_shared_from_this< StreamBase >.
Inherited by CompositeStreamBase, and Stream.
Public Member Functions | |
DevicePtr | Parent () const noexcept |
Gets the parent device of this stream. More... | |
virtual Cvb::Driver::AcquisitionInterface | AcquisitionInterface () const noexcept=0 |
Gets the interface of this implementation. More... | |
virtual void | Start ()=0 |
Starts the acquisition. More... | |
virtual void | Stop ()=0 |
Stops the acquisition. More... | |
virtual bool | TryStop () noexcept=0 |
Stops the acquisition. More... | |
virtual void | Abort ()=0 |
Stops the acquisition of images immediately. More... | |
virtual bool | TryAbort () noexcept=0 |
Stops the acquisition of images immediately. More... | |
virtual bool | IsIndexed () const noexcept=0 |
Gets whether this stream is an indexed stream. More... | |
Base class of all streams.
|
pure virtual |
Stops the acquisition of images immediately.
Any | exception derived from std::exception including CvbException. |
This stops the acquisition as fast as possible interrupting the ongoing operation. This might result in partially acquired images. The acquisition is stopped in the device first, then the engine on the host is stopped.
If the underlying driver does not support this, this call behaves as if Stop() had been called.
Implemented in CompositeStreamBase, and Stream.
|
pure virtualnoexcept |
Gets the interface of this implementation.
Does | not throw any exception. |
Implemented in CompositeStreamBase, and Stream.
|
pure virtualnoexcept |
Gets whether this stream is an indexed stream.
Does | not throw any exception. |
Implemented in CompositeStreamBase, IndexedStream, and Stream.
|
inlinenoexcept |
Gets the parent device of this stream.
Does | not throw any exception. |
|
pure virtual |
Starts the acquisition.
Any | exception derived from std::exception including CvbException. |
The acquisition engine is started in on the host first, then the stream on the device is started.
Implemented in CompositeStreamBase, and Stream.
|
pure virtual |
Stops the acquisition.
Any | exception derived from std::exception including CvbException. |
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.
Implemented in CompositeStreamBase, and Stream.
|
pure virtualnoexcept |
Stops the acquisition of images immediately.
Does | not throw any exception. |
Same as Abort(), but does not throw.
Implemented in CompositeStreamBase, and Stream.
|
pure virtualnoexcept |
Stops the acquisition.
Does | not throw any exception. |
Same as Stop(), but does not throw.
Implemented in CompositeStreamBase, and Stream.