Class ConfigOutput¶

Defined in File ConfigOutput.hpp

Inheritance Relationships¶

Base Types¶

public Nextsim::IDiagnosticOutput (Class IDiagnosticOutput)
public Nextsim::Configured< ConfigOutput > (Template Class Configured)

Class Documentation¶

class ConfigOutput : public Nextsim::IDiagnosticOutput, public Nextsim::Configured<ConfigOutput>¶

An implementation of the diagnostic output that allows some configuration of the file output period and frequency, as well as the fields the files contain.

Public Types

enum [anonymous]¶

Values:

enumerator PERIOD_KEY¶

enumerator START_KEY¶

enumerator SNAPSHOT_KEY¶

enumerator FIELDNAMES_KEY¶

enumerator FILENAME_KEY¶

enumerator FILEPERIOD_KEY¶

Public Functions

ConfigOutput()¶

virtual ~ConfigOutput() = default¶

inline virtual void setFilenamePrefix(const std::string &filePrefix) override¶

Sets the output file name.

Parameters:: fileName – The file name to be set.

virtual void setModelStart(const TimePoint &modelStart) override¶

modelStart the TimePoint of the start of the model run.

Sets the model start time, which implementations may use to time output events.

virtual void outputState(const ModelState &state) override¶

Outputs the passed ModelState.

Parameters:: state – The model state to be written out.

inline virtual std::string getName() const override¶: Returns the name of the component.

inline virtual void setData(const ModelState::DataMap&) override¶

Set the initial data of the component from the passed ModelState.

Parameters:: state – The ModelState containing the data to be set.

virtual void configure() override¶: The configuration function.

Public Static Functions

static HelpMap &getHelpRecursive(HelpMap &map, bool getAll)¶

static HelpMap &getHelpText(HelpMap &map, bool getAll)¶