IndexedStream Class Reference

A stream with a finite number of images, which can also be accessed via an index. More...

#include <cvb/driver/indexed_stream.hpp>

Inherits Stream.

Public Member Functions
virtual int	ImageCount () const noexcept=0
	Gets the number of images contained in this stream.
virtual int	ImageIndex () const =0
	Gets the index of the current active image.
virtual void	SetImageIndex (int index)=0
	Sets the index of the current active image.
bool	IsIndexed () const noexcept override
	Gets whether this stream is an indexed stream.
Public Member Functions inherited from Stream
Cvb::Driver::AcquisitionInterface	AcquisitionInterface () const noexcept override
	Gets the interface of this implementation.
void	SetAcquisitionInterface (Cvb::Driver::AcquisitionInterface acquisitionInterface)
	Sets the interface of this implementation.
void	Start () override
	Starts the acquisition.
void	Stop () override
	Stops the acquisition.
bool	TryStop () noexcept override
	Stops the acquisition.
void	Abort () override
	Stops the acquisition of images immediately.
bool	TryAbort () noexcept override
	Stops the acquisition of images immediately.
bool	IsRunning () const noexcept
	Gets whether the acquisition is currently active.
bool	IsIndexed () const noexcept override
	Gets whether this stream is an indexed stream.
double	Statistics (StreamInfo query) const
	Gets statistics value if supported.
template<class T>
T	Statistics (StreamInfo query) const
	Gets statistics value if supported.
virtual RingBufferPtr	RingBuffer () const noexcept
	Gets the ring buffer interface object if present.
template<class T, class Rep, class Period>
std::shared_ptr< T >	WaitFor (const std::chrono::duration< Rep, Period > &timeSpan, WaitStatus &waitStatus)
	Waits for the given time span for the next acquired image.
template<class Rep, class Period>
StreamImagePtr	WaitFor (const std::chrono::duration< Rep, Period > &timeSpan, WaitStatus &waitStatus)
	Waits for the given time span for the next acquired image.
template<class T, class Rep, class Period>
WaitResult< T >	WaitFor (const std::chrono::duration< Rep, Period > &timeSpan)
	Waits for the given time span for the next acquired image.
template<class Rep, class Period>
WaitResult< StreamImage >	WaitFor (const std::chrono::duration< Rep, Period > &timeSpan)
	Waits for the given time span for the next acquired image.
template<class T>
std::shared_ptr< T >	Wait (WaitStatus &waitStatus)
	Waits forever for the next acquired image and returns it.
StreamImagePtr	Wait (WaitStatus &waitStatus)
	Waits for ever for the next acquired image and returns it.
template<class T>
WaitResult< T >	Wait ()
	Waits for ever for the next acquired image and returns it.
WaitResult< StreamImage >	Wait ()
	Waits for ever for the next acquired image and returns it.
template<class T, class Rep, class Period>
std::shared_ptr< T >	GetTimedSnapshot (const std::chrono::duration< Rep, Period > &timeSpan, WaitStatus &waitStatus)
	Acquires a single image for a given time span and returns it.
template<class Rep, class Period>
StreamImagePtr	GetTimedSnapshot (const std::chrono::duration< Rep, Period > &timeSpan, WaitStatus &waitStatus)
	Acquires a single image for a given time span and returns it.
template<class T, class Rep, class Period>
WaitResult< T >	GetTimedSnapshot (const std::chrono::duration< Rep, Period > &timeSpan)
	Acquires a single image for a given time span and returns it.
template<class Rep, class Period>
WaitResult< StreamImage >	GetTimedSnapshot (const std::chrono::duration< Rep, Period > &timeSpan)
	Acquires a single image for a given time span and returns it.
StreamImagePtr	GetSnapshot (WaitStatus &waitStatus)
	Acquires a single image and returns it.
WaitResult< StreamImage >	GetSnapshot ()
	Acquires a single image and returns it.
Public Member Functions inherited from StreamBase
DevicePtr	Parent () const noexcept
	Gets the parent device of this stream.

Detailed Description

A stream with a finite number of images, which can also be accessed via an index.

Member Function Documentation

ImageCount()

virtual int ImageCount ( ) const

pure virtualnoexcept

Gets the number of images contained in this stream.

Returns

Number of images.

Exceptions

Does	not throw any exception.

ImageIndex()

virtual int ImageIndex ( ) const

pure virtual

Gets the index of the current active image.

Returns

Current active image index.

Exceptions

Any	exception derived from std::exception including CvbException.

IsIndexed()

bool IsIndexed ( ) const

inlineoverridevirtualnoexcept

Gets whether this stream is an indexed stream.

Returns

True if indexed, false otherwise.

Exceptions

Does	not throw any exception.

See also

IndexedStream

Implements StreamBase.

SetImageIndex()

virtual void SetImageIndex ( int index )

pure virtual

Sets the index of the current active image.

Parameters

[in]

index

New active image index.

Exceptions

Any	exception derived from std::exception including CvbException.