BifrostGraph::Executor::Watchpoint::Watcher Class Reference

The interface to get the watchpoint layout and value. More...

#include <Watchpoint.h>

Public Types
enum class	Flags : unsigned { kNone = 0 , kWithinALoop = 1 }

Public Member Functions
	Watcher () noexcept
virtual	~Watcher () noexcept
virtual void	deleteThis () noexcept=0
	Instruct the watcher to delete itself. More...
virtual WatchpointLayoutPtr	getLayout (WatchpointLayoutFactory &factory) const noexcept=0
	Get the layout for watched value. More...
virtual bool	getValue (WatchpointLayoutFactory const &factory, WatchpointLayoutPath &path, Amino::String &out_value) const noexcept=0
	Get the string representation of given element. More...

Detailed Description

The interface to get the watchpoint layout and value.

Definition at line 186 of file Watchpoint.h.

Member Enumeration Documentation

Flags

enum class BifrostGraph::Executor::Watchpoint::Watcher::Flags : unsigned

strong

Enumerator
kNone
kWithinALoop

Definition at line 188 of file Watchpoint.h.

Constructor & Destructor Documentation

Watcher()

BifrostGraph::Executor::Watchpoint::Watcher::Watcher ( )

noexcept

~Watcher()

virtual BifrostGraph::Executor::Watchpoint::Watcher::~Watcher ( )

virtualnoexcept

Member Function Documentation

deleteThis()

virtual void BifrostGraph::Executor::Watchpoint::Watcher::deleteThis ( )

pure virtualnoexcept

Instruct the watcher to delete itself.

getLayout()

virtual WatchpointLayoutPtr BifrostGraph::Executor::Watchpoint::Watcher::getLayout ( WatchpointLayoutFactory &  factory ) const

pure virtualnoexcept

Get the layout for watched value.

Parameters

factory

The layout factory, used to get/create nested layouts.

Returns

A layout if current watched value in valid.

getValue()

virtual bool BifrostGraph::Executor::Watchpoint::Watcher::getValue ( WatchpointLayoutFactory const &  factory, WatchpointLayoutPath &  path, Amino::String &  out_value  ) const

pure virtualnoexcept

Get the string representation of given element.

Parameters

	factory	The layout factory, used to get value from nested layouts
	path	The path to the element. Can be empty if watched value is a POD.
[out]	out_value	The string representation

Note

The path is consumed (pop_front) until the final layout element is reached.

Returns

The true if the path was valid, false otherwise.