netcdfpp
Header-only NetCDF C++ wrapper
Loading...
Searching...
No Matches
Public Member Functions | Friends | List of all members
netCDF::Dimension Class Referencefinal

NetCDF dimension. More...

#include <netcdfpp.h>

Public Member Functions

std::size_t size () const
 Returns the current dimension length.
 
bool is_unlimited () const
 Returns true when the dimension is unlimited.
 
Group parent () const
 Returns the parent group.
 
void rename (std::string name)
 Renames the dimension in place.
 
- Public Member Functions inherited from netCDF::detail::Object
const std::string & name () const
 
int id () const
 

Friends

class Group
 
class Maybe< Dimension >
 
class Variable
 

Additional Inherited Members

- Protected Member Functions inherited from netCDF::detail::Object
 Object (std::shared_ptr< Path > path_p)
 
void raise_error (int ret) const
 
void check (int ret) const
 
- Static Protected Member Functions inherited from netCDF::detail::Object
static std::string get_error_message (int ret)
 
- Protected Attributes inherited from netCDF::detail::Object
std::shared_ptr< Pathpath
 

Detailed Description

NetCDF dimension.

Member Function Documentation

◆ is_unlimited()

bool netCDF::Dimension::is_unlimited ( ) const
inline

Returns true when the dimension is unlimited.

◆ parent()

Group netCDF::Dimension::parent ( ) const
inline

Returns the parent group.

◆ rename()

void netCDF::Dimension::rename ( std::string  name)
inline

Renames the dimension in place.

◆ size()

std::size_t netCDF::Dimension::size ( ) const
inline

Returns the current dimension length.

Friends And Related Symbol Documentation

◆ Group

friend class Group
friend

◆ Maybe< Dimension >

friend class Maybe< Dimension >
friend

◆ Variable

friend class Variable
friend

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