PISM, A Parallel Ice Sheet Model 2.3.3-d9dd21c10 committed by Constantine Khrulev on 2026-10-13
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
pism::VariableMetadata Class Reference

#include <VariableMetadata.hh>

+ Inheritance diagram for pism::VariableMetadata:

Public Member Functions

 VariableMetadata (const std::string &name, std::shared_ptr< units::System > system, unsigned int ndims=0)
 
 VariableMetadata (const std::string &name, const std::vector< std::tuple< std::string, int > > &dimensions, std::shared_ptr< units::System > system)
 
 VariableMetadata (std::shared_ptr< units::System > system, const std::string &name, const Grid &grid, const std::vector< double > &levels={})
 
virtual ~VariableMetadata ()=default
 
Attribute operator[] (const std::string &name)
 
ConstAttribute operator[] (const std::string &name) const
 
VariableMetadata & long_name (const std::string &input)
 
VariableMetadata & standard_name (const std::string &input)
 
VariableMetadata & units (const std::string &input)
 
VariableMetadata & output_units (const std::string &input)
 
double get_number (const std::string &name) const
 Get a single-valued scalar attribute.
 
VariableMetadata & set_number (const std::string &name, double value)
 Set a scalar attribute to a single (scalar) value.
 
std::vector< double > get_numbers (const std::string &name) const
 Get an array-of-doubles attribute.
 
VariableMetadata & set_numbers (const std::string &name, const std::vector< double > &values)
 Set a scalar attribute to a single (scalar) value.
 
std::string get_name () const
 
VariableMetadata & set_name (const std::string &name)
 
std::string get_string (const std::string &name) const
 Get a string attribute.
 
VariableMetadata & set_string (const std::string &name, const std::string &value)
 Set a string attribute.
 
VariableMetadata & set_units_without_validation (const std::string &value)
 
bool get_time_dependent () const
 
VariableMetadata & set_time_dependent (bool flag)
 
io::Type get_output_type () const
 
VariableMetadata & set_output_type (io::Type type)
 
VariableMetadata & clear ()
 Clear all attributes.
 
std::shared_ptr< units::System > unit_system () const
 
unsigned int n_spatial_dimensions () const
 
const grid::DistributedGridInfo * grid_info () const
 
const std::vector< double > & levels () const
 
std::vector< DimensionMetadata > dimensions () const
 
std::vector< std::string > dimension_names () const
 
DimensionMetadata & dimension (const std::string &name)
 
const DimensionMetadata & dimension (const std::string &name) const
 
bool has_attribute (const std::string &name) const
 
bool has_attributes () const
 
const std::map< std::string, std::string > & all_strings () const
 
const std::map< std::string, std::vector< double > > & all_doubles () const
 
const VariableAttributes & attributes () const
 
void report_to_stdout (const Logger &log, int verbosity_threshold) const
 
void check_range (const std::string &filename, double min, double max) const
 Check if the range [min, max] is a subset of [valid_min, valid_max].
 
void report_range (const Logger &log, double min, double max) const
 Report the range of a global Vec v.
 

Protected Member Functions

virtual std::vector< DimensionMetadata > dimensions_impl () const
 

Protected Attributes

unsigned int m_n_spatial_dims
 
std::vector< DimensionMetadata > m_dimensions
 
std::shared_ptr< grid::DistributedGridInfo > m_grid_info
 
std::vector< double > m_levels
 vertical grid levels (or similar)
 

Private Attributes

VariableAttributes m_attributes
 
std::string m_name
 
bool m_time_dependent
 
io::Type m_output_type
 

Detailed Description

Definition at line 133 of file VariableMetadata.hh.


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