preCICE v3.1.2
Loading...
Searching...
No Matches
Classes | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
precice::action::RecorderAction Class Reference

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

#include <RecorderAction.hpp>

Inheritance diagram for precice::action::RecorderAction:
[legend]
Collaboration diagram for precice::action::RecorderAction:
[legend]

Classes

struct  Record
 

Public Member Functions

 RecorderAction (Timing timing, const mesh::PtrMesh &mesh)
 Constructor.
 
virtual 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)
 
Actionoperator= (Action &&)=delete
 
virtual ~Action ()=default
 Destructor, empty.
 
Timing getTiming () const
 Returns the timing of the action.
 
const mesh::PtrMeshgetMesh () 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< Recordrecords {}
 

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]timingWhen to apply the action.
[in]meshthe target mesh.

Definition at line 8 of file RecorderAction.cpp.

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.

Here is the call graph for this function:

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: