preCICE v3.1.1
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
precice::io::ExportConfiguration Class Reference

Configuration class for exports. More...

#include <ExportConfiguration.hpp>

Inheritance diagram for precice::io::ExportConfiguration:
[legend]
Collaboration diagram for precice::io::ExportConfiguration:
[legend]

Public Member Functions

 ExportConfiguration (xml::XMLTag &parent)
 
std::list< ExportContext > & exportContexts ()
 Returns the configured export context.
 
virtual void xmlTagCallback (const xml::ConfigurationContext &context, xml::XMLTag &callingTag)
 Callback at begin of XML tag.
 
virtual void xmlEndTagCallback (const xml::ConfigurationContext &context, xml::XMLTag &callingTag)
 Callback from automatic configuration. Not utilitzed here.
 
void resetExports ()
 
- Public Member Functions inherited from precice::xml::XMLTag::Listener
Listener & operator= (Listener &&)=delete
 
virtual ~Listener ()
 

Private Attributes

logging::Logger _log {"io::ExportConfiguration"}
 
const std::string TAG = "export"
 
const std::string ATTR_LOCATION = "directory"
 
const std::string ATTR_TYPE = "type"
 
const std::string ATTR_AUTO = "auto"
 
const std::string VALUE_VTK = "vtk"
 
const std::string VALUE_VTU = "vtu"
 
const std::string VALUE_VTP = "vtp"
 
const std::string VALUE_CSV = "csv"
 
const std::string ATTR_EVERY_N_TIME_WINDOWS = "every-n-time-windows"
 
const std::string ATTR_NEIGHBORS = "neighbors"
 
const std::string ATTR_EVERY_ITERATION = "every-iteration"
 
std::list< ExportContext > _contexts
 

Detailed Description

Configuration class for exports.

Definition at line 15 of file ExportConfiguration.hpp.

Constructor & Destructor Documentation

◆ ExportConfiguration()

precice::io::ExportConfiguration::ExportConfiguration ( xml::XMLTag & parent)

Definition at line 8 of file ExportConfiguration.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ exportContexts()

std::list< ExportContext > & precice::io::ExportConfiguration::exportContexts ( )
inline

Returns the configured export context.

Definition at line 22 of file ExportConfiguration.hpp.

◆ resetExports()

void precice::io::ExportConfiguration::resetExports ( )
inline

Definition at line 32 of file ExportConfiguration.hpp.

◆ xmlEndTagCallback()

virtual void precice::io::ExportConfiguration::xmlEndTagCallback ( const xml::ConfigurationContext & context,
xml::XMLTag & callingTag )
inlinevirtual

Callback from automatic configuration. Not utilitzed here.

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

Definition at line 30 of file ExportConfiguration.hpp.

◆ xmlTagCallback()

void precice::io::ExportConfiguration::xmlTagCallback ( const xml::ConfigurationContext & context,
xml::XMLTag & callingTag )
virtual

Callback at begin of XML tag.

At this callback, the attributes of the callingTag are already parsed and available, while the subtags are not yet parsed.

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

Definition at line 52 of file ExportConfiguration.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ _contexts

std::list<ExportContext> precice::io::ExportConfiguration::_contexts
private

Definition at line 54 of file ExportConfiguration.hpp.

◆ _log

logging::Logger precice::io::ExportConfiguration::_log {"io::ExportConfiguration"}
private

Definition at line 38 of file ExportConfiguration.hpp.

◆ ATTR_AUTO

const std::string precice::io::ExportConfiguration::ATTR_AUTO = "auto"
private

Definition at line 44 of file ExportConfiguration.hpp.

◆ ATTR_EVERY_ITERATION

const std::string precice::io::ExportConfiguration::ATTR_EVERY_ITERATION = "every-iteration"
private

Definition at line 52 of file ExportConfiguration.hpp.

◆ ATTR_EVERY_N_TIME_WINDOWS

const std::string precice::io::ExportConfiguration::ATTR_EVERY_N_TIME_WINDOWS = "every-n-time-windows"
private

Definition at line 50 of file ExportConfiguration.hpp.

◆ ATTR_LOCATION

const std::string precice::io::ExportConfiguration::ATTR_LOCATION = "directory"
private

Definition at line 42 of file ExportConfiguration.hpp.

◆ ATTR_NEIGHBORS

const std::string precice::io::ExportConfiguration::ATTR_NEIGHBORS = "neighbors"
private

Definition at line 51 of file ExportConfiguration.hpp.

◆ ATTR_TYPE

const std::string precice::io::ExportConfiguration::ATTR_TYPE = "type"
private

Definition at line 43 of file ExportConfiguration.hpp.

◆ TAG

const std::string precice::io::ExportConfiguration::TAG = "export"
private

Definition at line 40 of file ExportConfiguration.hpp.

◆ VALUE_CSV

const std::string precice::io::ExportConfiguration::VALUE_CSV = "csv"
private

Definition at line 48 of file ExportConfiguration.hpp.

◆ VALUE_VTK

const std::string precice::io::ExportConfiguration::VALUE_VTK = "vtk"
private

Definition at line 45 of file ExportConfiguration.hpp.

◆ VALUE_VTP

const std::string precice::io::ExportConfiguration::VALUE_VTP = "vtp"
private

Definition at line 47 of file ExportConfiguration.hpp.

◆ VALUE_VTU

const std::string precice::io::ExportConfiguration::VALUE_VTU = "vtu"
private

Definition at line 46 of file ExportConfiguration.hpp.

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