OB.DAAC Logo
NASA Logo
Ocean Color Science Software

ocssw V2022

#include <Variable.hpp>

Inheritance diagram for BaseVariable:
[legend]
Collaboration diagram for BaseVariable:
[legend]

Public Member Functions

 BaseVariable ()=default
 
 BaseVariable (const Product &provides)
 
virtual ~BaseVariable ()
 
std::unordered_map< std::string, std::string >::const_iterator attributes_begin () const
 
std::unordered_map< std::string, std::string >::const_iterator attributes_end () const
 
auto & attributes ()
 
auto & dimensions ()
 
virtual void * _data ()
 
virtual const void * _data () const
 
bool has_data () const
 
const Productprovides ()
 
void provides (const Product &provides)
 
const Productprovides () const
 
const auto & name ()
 
bool matches (const Product &needs) const
 
bool matches (const BaseVariable &needs) const
 
virtual OcType get_type () const
 
virtual size_t dimension_count () const
 
OcGeospatialType is_geospatial () const
 
void geospatial (OcGeospatialType geo_type)
 
virtual void rotate (const size_t number_of_lines)
 
template<typename T >
OcType get_type (T) const
 
const std::string type_to_string ()
 

Protected Attributes

Product provides_ {}
 
std::unordered_map< std::string, std::stringattributes_ {}
 
std::vector< std::pair< std::string, size_t > > dimensions_ {}
 
OcGeospatialType geo_type_ {OcGeospatialType::Yes}
 

Detailed Description

Definition at line 76 of file Variable.hpp.

Constructor & Destructor Documentation

◆ BaseVariable() [1/2]

BaseVariable ( )
default

◆ BaseVariable() [2/2]

BaseVariable ( const Product provides)
inline

Definition at line 82 of file Variable.hpp.

◆ ~BaseVariable()

virtual ~BaseVariable ( )
inlinevirtual

Definition at line 83 of file Variable.hpp.

Member Function Documentation

◆ _data() [1/2]

virtual void* _data ( )
inlinevirtual

Reimplemented in Variable< T, Dims >.

Definition at line 91 of file Variable.hpp.

◆ _data() [2/2]

virtual const void* _data ( ) const
inlinevirtual

Reimplemented in Variable< T, Dims >.

Definition at line 92 of file Variable.hpp.

◆ attributes()

auto& attributes ( )
inline

Definition at line 88 of file Variable.hpp.

◆ attributes_begin()

std::unordered_map<std::string, std::string>::const_iterator attributes_begin ( ) const
inline

Definition at line 85 of file Variable.hpp.

◆ attributes_end()

std::unordered_map<std::string, std::string>::const_iterator attributes_end ( ) const
inline

Definition at line 86 of file Variable.hpp.

◆ dimension_count()

virtual size_t dimension_count ( ) const
inlinevirtual

Reimplemented in Variable< T, Dims >.

Definition at line 107 of file Variable.hpp.

◆ dimensions()

auto& dimensions ( )
inline

Definition at line 89 of file Variable.hpp.

◆ geospatial()

void geospatial ( OcGeospatialType  geo_type)
inline

Definition at line 110 of file Variable.hpp.

◆ get_type() [1/2]

virtual OcType get_type ( ) const
inlinevirtual

Reimplemented in Variable< T, Dims >.

Definition at line 106 of file Variable.hpp.

◆ get_type() [2/2]

OcType get_type ( ) const
inline

Definition at line 115 of file Variable.hpp.

◆ has_data()

bool has_data ( ) const
inline

Definition at line 93 of file Variable.hpp.

◆ is_geospatial()

OcGeospatialType is_geospatial ( ) const
inline

Definition at line 109 of file Variable.hpp.

◆ matches() [1/2]

bool matches ( const BaseVariable needs) const
inline

Definition at line 104 of file Variable.hpp.

◆ matches() [2/2]

bool matches ( const Product needs) const
inline

Definition at line 103 of file Variable.hpp.

◆ name()

const auto& name ( )
inline

Definition at line 99 of file Variable.hpp.

◆ provides() [1/3]

const Product& provides ( )
inline

Definition at line 95 of file Variable.hpp.

◆ provides() [2/3]

const Product& provides ( ) const
inline

Definition at line 97 of file Variable.hpp.

◆ provides() [3/3]

void provides ( const Product provides)
inline

Definition at line 96 of file Variable.hpp.

◆ rotate()

virtual void rotate ( const size_t  number_of_lines)
inlinevirtual

Reimplemented in Variable< T, Dims >.

Definition at line 112 of file Variable.hpp.

◆ type_to_string()

const std::string type_to_string ( )
inline

Definition at line 146 of file Variable.hpp.

Member Data Documentation

◆ attributes_

std::unordered_map<std::string, std::string> attributes_ {}
protected

Definition at line 182 of file Variable.hpp.

◆ dimensions_

std::vector<std::pair<std::string, size_t> > dimensions_ {}
protected

Definition at line 183 of file Variable.hpp.

◆ geo_type_

OcGeospatialType geo_type_ {OcGeospatialType::Yes}
protected

Definition at line 184 of file Variable.hpp.

◆ provides_

Product provides_ {}
protected

Definition at line 181 of file Variable.hpp.


The documentation for this class was generated from the following file:
  • /gfs-oceanweb/web/ocssw/ocssw_src/include/focs/Variable.hpp