NetCDF4 C++ API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
NcDim.h
Go to the documentation of this file.
1 
17 #ifndef INC_netcdf_NcDim_h
18 #define INC_netcdf_NcDim_h
19 
20 #include "NcItem.h"
21 
22 namespace netcdf {
23 
24 class NcGroup;
25 
26 class NcDim : public NcItem
27 {
28 
29  public:
30 
31  NcDim ();
32 
38  NcDim (
39  int const useFileID,
40  NcGroup const & grp,
41  int const dimId );
42 
43  NcDim (
44  int const useFileID,
45  int const useGroupID,
46  int const useDimID );
47 
48  NcDim ( const NcDim& ncDim );
49 
50  NcGroup GetParentGroup() const;
51  bool IsUnlimited() const;
52 
56  size_t Size() const;
57 
58  void Rename ( std::string const & newName);
59 
60  bool operator< ( NcDim const & rhs ) const; // compare sizes
61  bool operator== ( NcDim const & rhs ) const; // compare names and sizes
62  bool operator!= ( NcDim const & rhs ) const
63  { return !operator==(rhs); }
64 
65  private:
66 
67  std::string RetrieveDimName() const;
68 
69 };
70 
71 } // namespace netcdf
72 
73 
74 #endif
bool operator!=(NcDim const &rhs) const
Definition: NcDim.h:62
bool operator==(NcDim const &rhs) const
Definition: NcDim.cpp:109
void Rename(std::string const &newName)
Definition: NcDim.cpp:97
Represents a netCDF dimension.
Definition: NcDim.h:26
NcGroup GetParentGroup() const
Definition: NcDim.cpp:57
bool operator<(NcDim const &rhs) const
Definition: NcDim.cpp:103
bool IsUnlimited() const
Definition: NcDim.cpp:73
size_t Size() const
Definition: NcDim.cpp:65
Base class for NcAtt, NcVar, NcDim, NcGroup.
Definition: NcItem.h:22
NcDim()
Definition: NcDim.cpp:26
Represents a netCDF group.
Definition: NcGroup.h:36