NCMLBaseArray.h

Go to the documentation of this file.

// This file is part of the "NcML Module" project, a BES module designed
// to allow NcML files to be used to be used as a wrapper to add
// AIS to existing datasets of any format.
//
// Copyright (c) 2009 OPeNDAP, Inc.
// Author: Michael Johnson  <m.johnson@opendap.org>
//
// For more information, please also see the main website: http://opendap.org/
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//
// Please see the files COPYING and COPYRIGHT for more information on the GLPL.
//
// You can contact OPeNDAP, Inc. at PO Box 112, Saunderstown, RI. 02874-0112.
#ifndef __NCML_MODULE__NCMLBASEARRAY_H__
#define __NCML_MODULE__NCMLBASEARRAY_H__

#include <Array.h>
#include <memory>
#include "Shape.h"

namespace ncml_module
{

  class NCMLBaseArray : public libdap::Array
  {
  public: // class methods
    static auto_ptr< NCMLBaseArray > createFromArray(const libdap::Array& proto);

  public:  // Instance methods
    NCMLBaseArray();
    explicit NCMLBaseArray(const std::string& name);
    explicit NCMLBaseArray(const NCMLBaseArray& proto);

    virtual ~NCMLBaseArray();

    NCMLBaseArray& operator=(const NCMLBaseArray& rhs);

    virtual bool read_p();

    virtual void set_read_p(bool state);

    virtual bool read();

    virtual Shape getSuperShape() const;

    virtual bool isConstrained() const;

    virtual bool haveConstraintsChangedSinceLastRead() const;

    virtual void cacheCurrentConstraints();

    virtual void cacheUnconstrainedDimensions();

    virtual void cacheSuperclassStateIfNeeded();

    virtual void cacheValuesIfNeeded() = 0;

    virtual void copyDataFrom(libdap::Array& from)=0;

    virtual bool isDataCached() const = 0;

    virtual void createAndSetConstrainedValueBuffer() = 0;

  private:

    void copyLocalRepFrom(const NCMLBaseArray& proto);

    void destroy() throw();

  protected: // Data rep
    // The Shape for the case of NO constraints on the data, or null if not set yet.
     Shape* _noConstraints;

     // The Shape for the CURRENT dimensions in super Array, used to calculate the transmission buffer
     // for read() and also to check if haveConstraintsChangedSinceLastRead().  Null if not set yet.
     Shape* _currentConstraints;
  };

}

#endif /* __NCML_MODULE__NCMLBASEARRAY_H__ */