SOMHunter Core
sh::FramePointerRange Class Reference

Represents CONTINOUS range of const frame pointers. More...

#include <dataset-frames.h>

Public Member Functions

 FramePointerRange ()=default
 
 FramePointerRange (std::vector< VideoFramePointer >::const_iterator b, std::vector< VideoFramePointer >::const_iterator e)
 
 FramePointerRange (const std::vector< VideoFramePointer > &v)
 
void print_display ()
 
bool valid () const
 Returns true iff FramePointerRange contains valid range at the time. More...
 
size_t size () const
 
const VideoFramePointeroperator[] (size_t idx) const
 Returns VideoFramePointer reference to the frame with given index in this frame range. More...
 
const VideoFramePointeroperator[] (size_t idx)
 
std::vector< VideoFramePointer >::const_iterator begin () const
 
std::vector< VideoFramePointer >::const_iterator end () const
 

Private Attributes

std::vector< VideoFramePointer >::const_iterator _begin
 
std::vector< VideoFramePointer >::const_iterator _end
 
bool _valid { false }
 

Detailed Description

Represents CONTINOUS range of const frame pointers.

Constructor & Destructor Documentation

◆ FramePointerRange() [1/3]

sh::FramePointerRange::FramePointerRange ( )
default

◆ FramePointerRange() [2/3]

sh::FramePointerRange::FramePointerRange ( std::vector< VideoFramePointer >::const_iterator  b,
std::vector< VideoFramePointer >::const_iterator  e 
)
inline

◆ FramePointerRange() [3/3]

sh::FramePointerRange::FramePointerRange ( const std::vector< VideoFramePointer > &  v)
inline

Member Function Documentation

◆ begin()

std::vector<VideoFramePointer>::const_iterator sh::FramePointerRange::begin ( ) const
inline

◆ end()

std::vector<VideoFramePointer>::const_iterator sh::FramePointerRange::end ( ) const
inline

◆ operator[]() [1/2]

const VideoFramePointer& sh::FramePointerRange::operator[] ( size_t  idx)
inline

◆ operator[]() [2/2]

const VideoFramePointer& sh::FramePointerRange::operator[] ( size_t  idx) const
inline

Returns VideoFramePointer reference to the frame with given index in this frame range.

◆ print_display()

void sh::FramePointerRange::print_display ( )
inline
Here is the call graph for this function:

◆ size()

size_t sh::FramePointerRange::size ( ) const
inline

◆ valid()

bool sh::FramePointerRange::valid ( ) const
inline

Returns true iff FramePointerRange contains valid range at the time.

Otherwise iterators behaviour is undefined.

Member Data Documentation

◆ _begin

std::vector<VideoFramePointer>::const_iterator sh::FramePointerRange::_begin
private

◆ _end

std::vector<VideoFramePointer>::const_iterator sh::FramePointerRange::_end
private

◆ _valid

bool sh::FramePointerRange::_valid { false }
private

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