NcUtil.h

Go to the documentation of this file.

#ifndef INC_netcdf_NcUtil_h
#define INC_netcdf_NcUtil_h

#include "NcType.h"
#include <vector>
#include <algorithm>

namespace netcdf {


class NcDim;
class NcVar;
class NcGroup;
class NcFile;


inline bool IsAtomicType ( NcType::ncType const typeClass )
{
    return (typeClass < NcType::nc_VLEN);
}

inline bool IsUserDefinedType ( NcType::ncType const typeClass )
{
    return ( typeClass == NcType::nc_VLEN ||
             typeClass == NcType::nc_OPAQUE ||
             typeClass == NcType::nc_ENUM ||
             typeClass == NcType::nc_COMPOUND );
}

template
<
  class TNCT    // type of the NcVar object - atomic types only!
>
typename TNCT::value_type* MakeCArray(
    TNCT const & ncType,
    int const size,
    typename TNCT::value_type const initValue = 0)
{
    if ( !IsAtomicType( ncType.getTypeClass() ) )
        NcEXCEPTION( "Not an atomic NetCDF4 type." );

    typedef typename TNCT::value_type   T;
    T* ca = new T [ size ];
    for ( T* pCA = ca; pCA != ca + size; ++pCA )
        *pCA = initValue;
    return ca;
}

template< class TSrc, class TDest >     
void ToVector(                          
    TSrc const srcBegin,                
    TSrc const srcEnd,                  
    std::vector<TDest> & dest)          
{
    dest.clear();
    for ( TSrc const * i = srcBegin; i != srcEnd; ++i )
        dest.push_back( TDest(*i) );
}

template< class TSrc, class TDest >     
void ToVector(                          
    TSrc const srcBegin,                
    std::vector<TDest> & dest,          
    std::size_t const count)            
{
    dest.clear();
    dest.resize(count);
    TSrc /* C ptr */ iSrc = srcBegin;
    typename std::vector<TDest>::iterator iDest = dest.begin();
    for ( ; iDest != dest.end(); ++iSrc, ++iDest )
        *iDest = *iSrc;
}

template< class T >     
T* FromVector(                                  
    std::vector<T> const & src)                 
{
    T* dest = new T [ src.size() ];
    std::copy( src.begin(), src.end(), dest );
    return dest;
}

char** MakeCStringArray ( int const numStrings, short const size );
char** ToCStringArray ( std::vector< std::string > const & strVec );
void FreeCStringArray ( char** & cStrArray, std::size_t const numStrings );

void GetNcDims (
    int const groupID, int const varID,
    std::vector<NcDim> & ncDims);

bool IsRecordVariable ( int const groupID, int const varID );


std::size_t GetTotalSize( NcVar const & var );
std::size_t GetTotalSize( int const groupID, int const varID );
std::size_t GetTotalSize( int const groupID, int const varID,
                          std::vector< std::size_t > const & count );   // edge lengths


void GetTypeName (
  NcGroup const & group,                
  NcType::ncType const typeID,          
  std::string & name );                 

NcGroup GetGroup ( NcFile const & ncFile, int const groupID );
NcVar GetVar ( NcFile const & ncFile, int const groupID, int const varID );
std::string GetVarName(  int const groupID, int const varID );

std::size_t GetDimSize (
    int const groupID,                  
    int const varID,                    
    int const dimIndex);                





} // namespace netcdf

#endif // INC_netcdf_NcUtil_h