impeller::CaptureProperty Struct Reference

A capturable property type. More...

#include <capture.h>

Inheritance diagram for impeller::CaptureProperty:

Classes
struct	Options

Public Types
enum class	Type { _FOR_EACH_CAPTURE_PROPERTY =(_CAPTURE_TYPE) }

Public Member Functions
	CaptureProperty (const std::string &label, Options options)
virtual	~CaptureProperty ()
virtual Type	GetType () const =0
virtual void	Invoke (const CaptureProcTable &proc_table)=0
bool	MatchesCloselyEnough (const CaptureProperty &other) const override
	Determines if previously captured data matches closely enough with newly recorded data to safely emitted in its place. If this returns false, then the remaining elements in the capture list are discarded and re-recorded.
Public Member Functions inherited from impeller::CaptureCursorListElement< CaptureProperty >
	CaptureCursorListElement (const std::string &label)
virtual	~CaptureCursorListElement ()=default

Public Attributes
Options	options
Public Attributes inherited from impeller::CaptureCursorListElement< CaptureProperty >
std::string	label

Detailed Description

A capturable property type.

Definition at line 68 of file capture.h.

Member Enumeration Documentation

Type

enum class impeller::CaptureProperty::Type

strong

Enumerator
_FOR_EACH_CAPTURE_PROPERTY

Definition at line 69 of file capture.h.

{ _FOR_EACH_CAPTURE_PROPERTY(_CAPTURE_TYPE) };

Constructor & Destructor Documentation

CaptureProperty()

impeller::CaptureProperty::CaptureProperty	(	const std::string &	label,
		Options	options
	)

CaptureProperty

Definition at line 16 of file capture.cc.

    : CaptureCursorListElement(label), options(options) {}

~CaptureProperty()

impeller::CaptureProperty::~CaptureProperty ( )

virtualdefault

Member Function Documentation

GetType()

virtual Type impeller::CaptureProperty::GetType ( ) const

pure virtual

Invoke()

virtual void impeller::CaptureProperty::Invoke ( const CaptureProcTable &  proc_table )

pure virtual

MatchesCloselyEnough()

bool impeller::CaptureProperty::MatchesCloselyEnough ( const CaptureProperty &  other ) const

overridevirtual

Determines if previously captured data matches closely enough with newly recorded data to safely emitted in its place. If this returns false, then the remaining elements in the capture list are discarded and re-recorded.

This mechanism ensures that the UI of an interactive inspector can never deviate from reality, even if the schema of the captured data were to significantly deviate.

Implements impeller::CaptureCursorListElement< CaptureProperty >.

Definition at line 21 of file capture.cc.

                                                                             {
  if (label != other.label) {
    return false;
  }
  if (GetType() != other.GetType()) {
    return false;
  }
  return true;
}

Member Data Documentation

options

Options impeller::CaptureProperty::options

Definition at line 87 of file capture.h.

---

The documentation for this struct was generated from the following files:

• impeller/core/capture.h
• impeller/core/capture.cc