netcdf-cxx4/cxx4/ncCompoundType.h

#include <string>
#include <vector>
#include "ncType.h"
#include "netcdf.h"

#ifndef NcCompoundTypeClass
#define NcCompoundTypeClass


namespace netCDF
{
  class NcGroup;  // forward declaration.

  /*! 
    Class represents a netCDF compound type
  */
  class NcCompoundType : public NcType
  {
  public:

    /*! Constructor generates a \ref isNull "null object". */
    NcCompoundType();

    /*! 
      Constructor.
      The compound Type must already exist in the netCDF file. New netCDF compound types can be 
      added using NcGroup::addNcCompoundType();
      \param grp        The parent group where this type is defined.
      \param name       Name of new type.
    */
    NcCompoundType(const NcGroup& grp, const std::string& name);

    /*! 
      Constructor.
      Constructs from the base type NcType object. Will throw an exception if the NcType is not the base of a Compound type.
      \param ncType     A Nctype object.
    */
    NcCompoundType(const NcType& ncType);

    /*! assignment operator */
    NcCompoundType& operator=(const NcCompoundType& rhs);
      
    /*! 
      Assignment operator.
      This assigns from the base type NcType object. Will throw an exception if the NcType is not the base of a Compound type.
    */
    NcCompoundType& operator=(const NcType& rhs);
      
    /*! The copy constructor. */
    NcCompoundType(const NcCompoundType& rhs);
      
    /*! equivalence operator */
    bool operator==(const NcCompoundType & rhs);

    /*! destructor */
    ~NcCompoundType(){;}
      
      
    /*!  
      Adds a named field.
      \param memName       Name of new field.
      \param newMemberType The type of the new member.
      \param offset        Offset of this member in bytes, obtained by a call to offsetof. For example 
the offset of a member "mem4" in structure struct1 is: offsetof(struct1,mem4).
    */
    void addMember(const std::string& memName, const NcType& newMemberType,size_t offset);

    /*!  
      Adds a named array field.
      \param memName       Name of new field.
      \param newMemberType The type of the new member.
      \param offset        Offset of this member in bytes, obtained by a call to offsetof. For example 
                           the offset of a member "mem4" in structure struct1 is: offsetof(struct1,mem4).
      \param shape         The shape of the array field.
    */
    void addMember(const std::string& memName, const NcType& newMemberType, size_t offset, const std::vector<int>& shape);


    /*! Returns number of members in this NcCompoundType object. */
    size_t  getMemberCount() const;
      
    /*! Returns a NcType object for a single member. */
    NcType getMember(int memberIndex) const;              
      
    /*! Returns the offset of the member with given index. */
    size_t getMemberOffset(const int index) const;

    /*! 
      Returns the number of dimensions of a member with the given index. 
      \param Index of member (numbering starts at zero).
      \return The number of dimensions of the field. Non-array fields have 0 dimensions.
    */
    int getMemberDimCount(int memberIndex) const;
      
      
    /*! 
      Returns the shape of a given member. 
      \param Index of member (numbering starts at zero).
      \return The size of the dimensions of the field. Non-array fields have 0 dimensions.
    */
    std::vector<int> getMemberShape(int memberIndex) const;
      
      
  private:
      
    int myOffset;
      
  };
  
}


#endif