nrt::SeekableImageSourceType Class Reference

#include <SeekableImageSourceType.H>

---

A pure virtual base class for seekable ImageSourceTypes.

The SeekableImageSourceType base class is used to provide a common interface for all ImageSourceType which provide random access to frames.

Examples:

tests/test-stream.C.

Definition at line 52 of file SeekableImageSourceType.H.

Inheritance diagram for nrt::SeekableImageSourceType:

List of all members.

Public Member Functions
	SeekableImageSourceType (std::string const &instanceID="SeekableImageSourceType")
virtual void	preStart ()
	Reset the current frame upon start.
virtual bool const	seek (size_t const framenumber)=0
	Request the Image source to seek to the given framenumber.
virtual FrameRange const	frameRange () const =0
	Get the range of frame numbers that are valid to use in a call to seek()
virtual size_t const	nextFrameNumber () const =0
	Get the frame number that will be returned by the next call to in()
Protected Attributes
Parameter< FrameRange >	itsFrameRange
	The FrameRange for this source.

---

Member Function Documentation

virtual bool const nrt::SeekableImageSourceType::seek

(

size_t const

framenumber

)

[pure virtual]

Request the Image source to seek to the given framenumber.

Classes which implement this method should take no action and return false if the requested framenumber is out of bounds of the given FrameRange and the limits of the file(s)

Implemented in nrt::ImageFilesSource, and nrt::VideoSource.

Referenced by preStart().

---

The documentation for this class was generated from the following file:

• include/nrt/ImageProc/IO/ImageSource/details/SeekableImageSourceType.H