CVB++ 14.1
ImageStream Class Reference

Streams images. More...

#include <cvb/driver/image_stream.hpp>

Inherits CompositeStreamBase.

Public Member Functions

template<class Rep , class Period >
WaitResultTuple< MultiPartImageWaitFor (const std::chrono::duration< Rep, Period > &timeSpan, CancellationToken &token)
 Waits for the given time span for the next acquired image. More...
 
template<class Rep , class Period >
WaitResultTuple< MultiPartImageWaitFor (const std::chrono::duration< Rep, Period > &timeSpan)
 Waits for the given time span for the next acquired image. More...
 
WaitResultTuple< MultiPartImageWait (const CancellationToken &token)
 Waits for ever for the next acquired image. More...
 
WaitResultTuple< MultiPartImageWait ()
 Waits for ever for the next acquired image. More...
 
- Public Member Functions inherited from CompositeStreamBase
void * Handle () const noexcept
 Classic API stream handle. More...
 
virtual void EngineStart ()
 Starts the acquisition engine on the host. More...
 
virtual void EngineStart (std::int64_t bufferCountToAcquire)
 Starts the acquisition engine on the host. More...
 
template<class Rep , class Period >
void EngineStop (const std::chrono::duration< Rep, Period > &timeout)
 Stops the acquisition engine. More...
 
virtual void EngineStop ()
 Stops the acquisition engine. More...
 
template<class Rep , class Period >
bool TryEngineStop (const std::chrono::duration< Rep, Period > &timeout) noexcept
 Stops the acquisition engine. More...
 
virtual bool TryEngineStop () noexcept
 Stops the acquisition engine. More...
 
virtual bool TryEngineStop (const std::chrono::milliseconds &timeout) noexcept
 Stops the acquisition engine. More...
 
virtual void EngineAbort ()
 Stops the acquisition engine immediately. More...
 
virtual bool TryEngineAbort () noexcept
 Stops the acquisition engine immediately. More...
 
virtual void DeviceStart ()
 Starts the stream on the device. More...
 
virtual void DeviceStart (std::int64_t bufferCountToAcquire)
 Starts the stream on the device. More...
 
virtual void DeviceStop ()
 Stops the stream in the device. More...
 
virtual bool TryDeviceStop () noexcept
 Stops the stream in the device. More...
 
virtual void DeviceAbort ()
 Stops the stream in the device immediately. More...
 
virtual bool TryDeviceAbort () noexcept
 Stops the stream in the device immediately. More...
 
void DeregisterFlowSetPool ()
 Removes an existing flow set pool from the acquisition engine. More...
 
void RegisterManagedFlowSetPool (int flowSetCount)
 Registers an internal flows set pool. More...
 
void RegisterExternalFlowSetPool (FlowSetPoolPtr flowSetPoolPtr)
 Registers external memory. More...
 
void RegisterExternalFlowSetPool (FlowSetPoolPtr flowSetPoolPtr, std::function< void()> releaseCallback)
 Registers external memory. More...
 
int FlowSetCount () const noexcept
 Gets the number of registered flow sets. More...
 
int MinRequiredFlowSetCount () const
 Gets minimum number of flow sets required for the acquisition. More...
 
Cvb::Driver::AcquisitionInterface AcquisitionInterface () const noexcept override
 Gets the interface of this implementation. More...
 
void Start () override
 Starts the acquisition. More...
 
void Stop () override
 Stops the acquisition. More...
 
bool TryStop () noexcept override
 Stops the acquisition. More...
 
void Abort () override
 Stops the acquisition of images immediately. More...
 
bool TryAbort () noexcept override
 Stops the acquisition of images immediately. More...
 
bool IsIndexed () const noexcept override
 Gets whether this stream is an indexed stream. More...
 
Cvb::AcquisitionState AcquisitionState () const noexcept
 Gets the current acquisition state. More...
 
std::vector< FlowInfoFlowSetInfo () const
 Gets the flow set info of this stream. More...
 
NodeMapPtr NodeMap (const String &name) const
 Gets the NodeMap with the given name. More...
 
std::map< String, NodeMapPtr > NodeMaps () const
 Gets the dictionary holding all available stream NodeMaps. More...
 
- Public Member Functions inherited from StreamBase
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...
 

Detailed Description

Streams images.

Examples
Cvb/CppStreamConsoleWithMock.

Member Function Documentation

◆ Wait() [1/2]

WaitResultTuple< MultiPartImage > Wait ( )
inline

Waits for ever for the next acquired image.

Returns
A tuple containing an image, the wait status, and an node map enumerator.
Exceptions
Anyexception derived from std::exception including CvbException.

◆ Wait() [2/2]

WaitResultTuple< MultiPartImage > Wait ( const CancellationToken token)
inline

Waits for ever for the next acquired image.

Parameters
[in]tokenA token to cancel this individual wait.
Returns
A tuple containing an image, the wait status, and an node map enumerator.
Exceptions
Anyexception derived from std::exception including CvbException.

◆ WaitFor() [1/2]

WaitResultTuple< MultiPartImage > WaitFor ( const std::chrono::duration< Rep, Period > &  timeSpan)
inline

Waits for the given time span for the next acquired image.

Parameters
[in]timeSpanTime to wait for data.
Returns
A tuple containing an image, the wait status, and an node map enumerator.
Exceptions
Anyexception derived from std::exception including CvbException.

◆ WaitFor() [2/2]

WaitResultTuple< MultiPartImage > WaitFor ( const std::chrono::duration< Rep, Period > &  timeSpan,
CancellationToken token 
)
inline

Waits for the given time span for the next acquired image.

Parameters
[in]timeSpanTime to wait for data.
[in]tokenA token to cancel this individual wait.
Returns
A tuple containing an image, the wait status, and an node map enumerator.
Exceptions
Anyexception derived from std::exception including CvbException.