precice::action::RecorderAction Class Reference

Action that records invocations for testing purposes. More...

#include <RecorderAction.hpp>

Inheritance diagram for precice::action::RecorderAction:

Collaboration diagram for precice::action::RecorderAction:

Classes
struct	Record

Public Member Functions
	RecorderAction (Timing timing, const mesh::PtrMesh &mesh)
	Constructor.
void	performAction () final override
	Records the invocation and appends it to the records.
Public Member Functions inherited from precice::action::Action
	Action (Timing timing, const mesh::PtrMesh &mesh, mapping::Mapping::MeshRequirement requirement)
	Action (Timing timing, const mesh::PtrMesh &mesh)
Action &	operator= (Action &&)=delete
virtual	~Action ()=default
	Destructor, empty.
Timing	getTiming () const
	Returns the timing of the action.
const mesh::PtrMesh &	getMesh () const
	Returns the mesh carrying the data used in the action.
mapping::Mapping::MeshRequirement	getMeshRequirement () const
	Returns the mesh requirement of this action.

Static Public Member Functions
static void	reset ()
	resets the saved records.

Static Public Attributes
static std::vector< Record >	records {}

Additional Inherited Members
Public Types inherited from precice::action::Action
enum	Timing { WRITE_MAPPING_POST , READ_MAPPING_POST }
	Defines the time and place of application of the action. More...

Detailed Description

Action that records invocations for testing purposes.

Definition at line 10 of file RecorderAction.hpp.

Constructor & Destructor Documentation

RecorderAction()

precice::action::RecorderAction::RecorderAction	(	Timing	timing,
		const mesh::PtrMesh &	mesh )

Constructor.

Parameters

[in]	timing	When to apply the action.
[in]	mesh	the target mesh.

Definition at line 8 of file RecorderAction.cpp.

Here is the call graph for this function:

Member Function Documentation

performAction()

void precice::action::RecorderAction::performAction ( )

finaloverridevirtual

Records the invocation and appends it to the records.

Implements precice::action::Action.

Definition at line 13 of file RecorderAction.cpp.

Here is the call graph for this function:

reset()

void precice::action::RecorderAction::reset ( )

static

resets the saved records.

Definition at line 20 of file RecorderAction.cpp.

Member Data Documentation

records

std::vector< RecorderAction::Record > precice::action::RecorderAction::records {}

static

Definition at line 33 of file RecorderAction.hpp.

---

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

• src/action/RecorderAction.hpp
• src/action/RecorderAction.cpp