BifrostGraph::Executor::Watchpoint::Records Class Reference

An interface for the watchpoints to manage recorded values. More...

#include <Watchpoint.h>

Public Types
using	String = Watchpoint::String
using	StringArray = Watchpoint::StringArray

Public Member Functions
	Records (const Amino::WatchPoint &watchpoint) noexcept
virtual	~Records () noexcept
bool	getSetting (const String &parameter, String &value) const noexcept
	Query the value currently assigned to a given parameter. see Watchpoint::getParameterDetails. More...
virtual void	clear () noexcept=0
	Remove all stored values. More...
virtual void	erase (const String &parameter) noexcept=0
	Remove stored values for the given parameter. More...
virtual void	set (const String &parameter, const String &value) noexcept=0
	Set (replace) recorded value for given parameter. More...
virtual void	set (const String &parameter, const StringArray &values) noexcept=0
	Set (replace) recorded values for given parameter. More...
virtual void	add (const String &parameter, const String &value) noexcept=0
	Add (append) recorded value for given parameter. More...
virtual void	add (const String &parameter, const StringArray &values) noexcept=0
	Add (append) recorded values for given parameter. More...

Detailed Description

An interface for the watchpoints to manage recorded values.

Deprecated:

Use Watcher instead.

Note

This class belongs to a feature that is still under development and may change in subsequent versions.

Definition at line 290 of file Watchpoint.h.

Member Typedef Documentation

String

using BifrostGraph::Executor::Watchpoint::Records::String = Watchpoint::String

Definition at line 292 of file Watchpoint.h.

StringArray

using BifrostGraph::Executor::Watchpoint::Records::StringArray = Watchpoint::StringArray

Definition at line 293 of file Watchpoint.h.

Constructor & Destructor Documentation

Records()

BifrostGraph::Executor::Watchpoint::Records::Records ( const Amino::WatchPoint &  watchpoint )

explicitnoexcept

~Records()

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

virtualnoexcept

Member Function Documentation

add() [1/2]

virtual void BifrostGraph::Executor::Watchpoint::Records::add ( const String &  parameter, const String &  value  )

pure virtualnoexcept

Add (append) recorded value for given parameter.

Parameters

[in]	parameter	The parameter.
[in]	value	The value.

add() [2/2]

virtual void BifrostGraph::Executor::Watchpoint::Records::add ( const String &  parameter, const StringArray &  values  )

pure virtualnoexcept

Add (append) recorded values for given parameter.

Parameters

[in]	parameter	The parameter.
[in]	values	The values.

clear()

virtual void BifrostGraph::Executor::Watchpoint::Records::clear ( )

pure virtualnoexcept

Remove all stored values.

erase()

virtual void BifrostGraph::Executor::Watchpoint::Records::erase ( const String &  parameter )

pure virtualnoexcept

Remove stored values for the given parameter.

Parameters

[in]

parameter

The parameter.

getSetting()

bool BifrostGraph::Executor::Watchpoint::Records::getSetting ( const String &  parameter, String &  value  ) const

noexcept

Query the value currently assigned to a given parameter. see Watchpoint::getParameterDetails.

Parameters

[in]	parameter	The parameter.
[out]	value	The parameter's value.

Returns

true if parameter is valid, false otherwise.

set() [1/2]

virtual void BifrostGraph::Executor::Watchpoint::Records::set ( const String &  parameter, const String &  value  )

pure virtualnoexcept

Set (replace) recorded value for given parameter.

Parameters

[in]	parameter	The parameter.
[in]	value	The value.

set() [2/2]

virtual void BifrostGraph::Executor::Watchpoint::Records::set ( const String &  parameter, const StringArray &  values  )

pure virtualnoexcept

Set (replace) recorded values for given parameter.

Parameters

[in]	parameter	The parameter.
[in]	values	The values.