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

Configures an Action subclass object. More...

#include <ActionConfiguration.hpp>

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

Classes

struct  ConfiguredAction
 Stores configuration information temporarily to create the Action. More...
 

Public Member Functions

 ActionConfiguration (xml::XMLTag &parent, mesh::PtrMeshConfiguration meshConfig)
 
virtual void xmlTagCallback (const xml::ConfigurationContext &context, xml::XMLTag &callingTag)
 Callback function required for use of automatic configuration.
 
virtual void xmlEndTagCallback (const xml::ConfigurationContext &context, xml::XMLTag &callingTag)
 Callback function required for use of automatic configuration.
 
int getUsedMeshID () const
 Returns the id of the mesh used in the data action.
 
const std::list< PtrAction > & actions () const
 Returns the configured action.
 
std::list< PtrAction > extractActions ()
 Extracts the configured action.
 
- Public Member Functions inherited from precice::xml::XMLTag::Listener
Listener & operator= (Listener &&)=delete
 
virtual ~Listener ()
 

Private Member Functions

void createAction ()
 Creates the Action object.
 
Action::Timing getTiming () const
 

Private Attributes

logging::Logger _log {"config::ActionConfiguration"}
 
const std::string TAG = "action"
 
const std::string NAME_DIVIDE_BY_AREA
 
const std::string NAME_MULTIPLY_BY_AREA
 
const std::string NAME_SUMMATION
 
const std::string NAME_COMPUTE_CURVATURE
 
const std::string NAME_PYTHON
 
const std::string NAME_RECORDER
 
const std::string TAG_SOURCE_DATA
 
const std::string TAG_TARGET_DATA
 
const std::string TAG_CONVERGENCE_TOLERANCE
 
const std::string TAG_MAX_ITERATIONS
 
const std::string TAG_MODULE_PATH
 
const std::string TAG_MODULE_NAME
 
const std::string ATTR_TYPE = "type"
 
const std::string ATTR_TIMING = "timing"
 
const std::string ATTR_NAME = "name"
 
const std::string ATTR_VALUE = "value"
 
const std::string ATTR_MESH = "mesh"
 
const std::string WRITE_MAPPING_POST
 
const std::string READ_MAPPING_POST
 
mesh::PtrMeshConfiguration _meshConfig
 
ConfiguredAction _configuredAction
 
std::list< PtrAction > _actions
 

Detailed Description

Configures an Action subclass object.

Definition at line 18 of file ActionConfiguration.hpp.

Constructor & Destructor Documentation

◆ ActionConfiguration()

precice::action::ActionConfiguration::ActionConfiguration ( xml::XMLTag & parent,
mesh::PtrMeshConfiguration meshConfig )

Definition at line 22 of file ActionConfiguration.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ actions()

const std::list< PtrAction > & precice::action::ActionConfiguration::actions ( ) const
inline

Returns the configured action.

Definition at line 46 of file ActionConfiguration.hpp.

◆ createAction()

void precice::action::ActionConfiguration::createAction ( )
private

Creates the Action object.

Definition at line 167 of file ActionConfiguration.cpp.

Here is the call graph for this function:

◆ extractActions()

std::list< PtrAction > precice::action::ActionConfiguration::extractActions ( )
inline

Extracts the configured action.

Postcondition
The configured actions are empty

Definition at line 56 of file ActionConfiguration.hpp.

Here is the call graph for this function:

◆ getTiming()

action::Action::Timing precice::action::ActionConfiguration::getTiming ( ) const
private

Definition at line 223 of file ActionConfiguration.cpp.

◆ getUsedMeshID()

int precice::action::ActionConfiguration::getUsedMeshID ( ) const

Returns the id of the mesh used in the data action.

Definition at line 161 of file ActionConfiguration.cpp.

◆ xmlEndTagCallback()

void precice::action::ActionConfiguration::xmlEndTagCallback ( const xml::ConfigurationContext & context,
xml::XMLTag & callingTag )
virtual

Callback function required for use of automatic configuration.

Returns
True, if successful.

Implements precice::xml::XMLTag::Listener.

Definition at line 152 of file ActionConfiguration.cpp.

Here is the call graph for this function:

◆ xmlTagCallback()

void precice::action::ActionConfiguration::xmlTagCallback ( const xml::ConfigurationContext & context,
xml::XMLTag & callingTag )
virtual

Callback function required for use of automatic configuration.

Returns
True, if successful.

Implements precice::xml::XMLTag::Listener.

Definition at line 125 of file ActionConfiguration.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ _actions

std::list<PtrAction> precice::action::ActionConfiguration::_actions
private

Definition at line 108 of file ActionConfiguration.hpp.

◆ _configuredAction

ConfiguredAction precice::action::ActionConfiguration::_configuredAction
private

Definition at line 106 of file ActionConfiguration.hpp.

◆ _log

logging::Logger precice::action::ActionConfiguration::_log {"config::ActionConfiguration"}
mutableprivate

Definition at line 77 of file ActionConfiguration.hpp.

◆ _meshConfig

mesh::PtrMeshConfiguration precice::action::ActionConfiguration::_meshConfig
private

Definition at line 104 of file ActionConfiguration.hpp.

◆ ATTR_MESH

const std::string precice::action::ActionConfiguration::ATTR_MESH = "mesh"
private

Definition at line 99 of file ActionConfiguration.hpp.

◆ ATTR_NAME

const std::string precice::action::ActionConfiguration::ATTR_NAME = "name"
private

Definition at line 97 of file ActionConfiguration.hpp.

◆ ATTR_TIMING

const std::string precice::action::ActionConfiguration::ATTR_TIMING = "timing"
private

Definition at line 96 of file ActionConfiguration.hpp.

◆ ATTR_TYPE

const std::string precice::action::ActionConfiguration::ATTR_TYPE = "type"
private

Definition at line 95 of file ActionConfiguration.hpp.

◆ ATTR_VALUE

const std::string precice::action::ActionConfiguration::ATTR_VALUE = "value"
private

Definition at line 98 of file ActionConfiguration.hpp.

◆ NAME_COMPUTE_CURVATURE

const std::string precice::action::ActionConfiguration::NAME_COMPUTE_CURVATURE
private

Definition at line 84 of file ActionConfiguration.hpp.

◆ NAME_DIVIDE_BY_AREA

const std::string precice::action::ActionConfiguration::NAME_DIVIDE_BY_AREA
private

Definition at line 81 of file ActionConfiguration.hpp.

◆ NAME_MULTIPLY_BY_AREA

const std::string precice::action::ActionConfiguration::NAME_MULTIPLY_BY_AREA
private

Definition at line 82 of file ActionConfiguration.hpp.

◆ NAME_PYTHON

const std::string precice::action::ActionConfiguration::NAME_PYTHON
private

Definition at line 85 of file ActionConfiguration.hpp.

◆ NAME_RECORDER

const std::string precice::action::ActionConfiguration::NAME_RECORDER
private

Definition at line 86 of file ActionConfiguration.hpp.

◆ NAME_SUMMATION

const std::string precice::action::ActionConfiguration::NAME_SUMMATION
private

Definition at line 83 of file ActionConfiguration.hpp.

◆ READ_MAPPING_POST

const std::string precice::action::ActionConfiguration::READ_MAPPING_POST
private

Definition at line 102 of file ActionConfiguration.hpp.

◆ TAG

const std::string precice::action::ActionConfiguration::TAG = "action"
private

Definition at line 79 of file ActionConfiguration.hpp.

◆ TAG_CONVERGENCE_TOLERANCE

const std::string precice::action::ActionConfiguration::TAG_CONVERGENCE_TOLERANCE
private

Definition at line 90 of file ActionConfiguration.hpp.

◆ TAG_MAX_ITERATIONS

const std::string precice::action::ActionConfiguration::TAG_MAX_ITERATIONS
private

Definition at line 91 of file ActionConfiguration.hpp.

◆ TAG_MODULE_NAME

const std::string precice::action::ActionConfiguration::TAG_MODULE_NAME
private

Definition at line 93 of file ActionConfiguration.hpp.

◆ TAG_MODULE_PATH

const std::string precice::action::ActionConfiguration::TAG_MODULE_PATH
private

Definition at line 92 of file ActionConfiguration.hpp.

◆ TAG_SOURCE_DATA

const std::string precice::action::ActionConfiguration::TAG_SOURCE_DATA
private

Definition at line 88 of file ActionConfiguration.hpp.

◆ TAG_TARGET_DATA

const std::string precice::action::ActionConfiguration::TAG_TARGET_DATA
private

Definition at line 89 of file ActionConfiguration.hpp.

◆ WRITE_MAPPING_POST

const std::string precice::action::ActionConfiguration::WRITE_MAPPING_POST
private

Definition at line 101 of file ActionConfiguration.hpp.

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