Nextsim::ModelMetadata Class Reference

#include <ModelMetadata.hpp>

Collaboration diagram for Nextsim::ModelMetadata:

Public Member Functions
void	setTime (const TimePoint &time)
	Sets the initial or current model time.
void	incrementTime (const Duration &step)
	Increments the model time metadata value.
const TimePoint &	time () const
	Returns the current model time.
const std::string &	structureName () const
	Returns the string description of the model grid structure.
void	setConfig (const ConfigMap &config)
	Sets the configuration metadata.

Public Attributes
friend	CommonRestartMetadata

Detailed Description

A class to hold the metadata pertaining to the model as a whole, both constant and time varying values. Especially values required for data file output.

Definition at line 24 of file ModelMetadata.hpp.

Member Function Documentation

incrementTime()

void Nextsim::ModelMetadata::incrementTime ( const Duration & step )

inline

Increments the model time metadata value.

Parameters

step	Duration of the time increment to add.

Definition at line 37 of file ModelMetadata.hpp.

Here is the caller graph for this function:

setConfig()

void Nextsim::ModelMetadata::setConfig ( const ConfigMap & config )

inline

Sets the configuration metadata.

Parameters

config

The configuration metadata

Definition at line 49 of file ModelMetadata.hpp.

setTime()

void Nextsim::ModelMetadata::setTime ( const TimePoint & time )

inline

Sets the initial or current model time.

Parameters

time	TimePoint instance encoding the current time.

Definition at line 31 of file ModelMetadata.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

structureName()

const std::string & Nextsim::ModelMetadata::structureName

(

)

const

Returns the string description of the model grid structure.

Definition at line 14 of file ModelMetadata.cpp.

Here is the caller graph for this function:

time()

const TimePoint & Nextsim::ModelMetadata::time ( ) const

inline

Returns the current model time.

Definition at line 39 of file ModelMetadata.hpp.

Here is the caller graph for this function:

Member Data Documentation

CommonRestartMetadata

friend Nextsim::ModelMetadata::CommonRestartMetadata

Definition at line 52 of file ModelMetadata.hpp.

---

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

• /github/workspace/core/src/include/ModelMetadata.hpp
• /github/workspace/core/src/ModelMetadata.cpp