impeller::CapturePlaybackList< Type > Class Template Reference

#include <capture.h>

Public Member Functions
	CapturePlaybackList ()=default
	~CapturePlaybackList ()
void	Rewind ()
size_t	Count ()
std::shared_ptr< Type >	GetNext (std::shared_ptr< Type > captured, bool force_overwrite)
std::shared_ptr< Type >	FindFirstByLabel (const std::string &label)
void	Iterate (std::function< void(Type &)> iterator) const

Detailed Description

template<typename Type>
class impeller::CapturePlaybackList< Type >

Definition at line 133 of file capture.h.

Constructor & Destructor Documentation

CapturePlaybackList()

template<typename Type >

impeller::CapturePlaybackList< Type >::CapturePlaybackList ( )

default

~CapturePlaybackList()

template<typename Type >

impeller::CapturePlaybackList< Type >::~CapturePlaybackList ( )

inline

Definition at line 137 of file capture.h.

                         {
    // Force the list element type to inherit the CRTP type. We can't enforce
    // this as a template requirement directly because `CaptureElement` has a
    // recursive `CaptureCursorList<CaptureElement>` property, and so the
    // compiler fails the check due to the type being incomplete.
    static_assert(std::is_base_of_v<CaptureCursorListElement<Type>, Type>);
  }

Member Function Documentation

Count()

template<typename Type >

size_t impeller::CapturePlaybackList< Type >::Count ( )

inline

Definition at line 147 of file capture.h.

{ return values_.size(); }

FindFirstByLabel()

template<typename Type >

std::shared_ptr<Type> impeller::CapturePlaybackList< Type >::FindFirstByLabel ( const std::string &  label )

inline

Definition at line 172 of file capture.h.

                                                               {
    for (std::shared_ptr<Type>& value : values_) {
      if (value->label == label) {
        return value;
      }
    }
    return nullptr;
  }

GetNext()

template<typename Type >

std::shared_ptr<Type> impeller::CapturePlaybackList< Type >::GetNext ( std::shared_ptr< Type >  captured, bool  force_overwrite  )

inline

Definition at line 149 of file capture.h.

                                                      {
    if (cursor_ < values_.size()) {
      std::shared_ptr<Type>& result = values_[cursor_];
 
      if (result->MatchesCloselyEnough(*captured)) {
        if (force_overwrite) {
          values_[cursor_] = captured;
        }
        // Safe playback is possible.
        ++cursor_;
        return result;
      }
      // The data has changed too much from the last capture to safely continue
      // playback. Discard this and all subsequent elements to re-record.
      values_.resize(cursor_);
    }
 
    ++cursor_;
    values_.push_back(captured);
    return captured;
  }

Iterate()

template<typename Type >

void impeller::CapturePlaybackList< Type >::Iterate ( std::function< void(Type &)>  iterator ) const

inline

Definition at line 181 of file capture.h.

                                                        {
    for (auto& value : values_) {
      iterator(*value);
    }
  }

Rewind()

template<typename Type >

void impeller::CapturePlaybackList< Type >::Rewind ( )

inline

Definition at line 145 of file capture.h.

{ cursor_ = 0; }

---

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

• impeller/core/capture.h