HDF.h

Go to the documentation of this file.

/* -*- c++ -*-
 * $Id: HDF.h,v 1.46 2006/05/16 20:06:34 brook Exp $
 */

/*
 * ClearSilver++ Software License.
 *
 * Copyright (c) 2005,2006 Brook Milligan <brook@nmsu.edu>
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above
 *    copyright notice, this list of conditions and the following
 *    disclaimer in the documentation and/or other materials provided
 *    with the distribution.
 * 3. The name of the author may not be used to endorse or promote
 *    products derived from this software without specific prior
 *    written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef HDF_h_
#define HDF_h_ 1

#include <iterator>
#include <string>
#include <boost/operators.hpp>
#include <boost/shared_ptr.hpp>
#include "ConstHDFNode.h"
#include "HDFAttributes.h"
#include "HDFNode.h"
#include "Nodes.h"
#include "RootNode.h"
#include "SymlinkTarget.h"
#include "TraceObject.h"

namespace ClearSilver
{
  class ConstHDF;               // forward declarations

  class HDF : TraceObject, public ConstHDFNode, public HDFNode,
   boost::equality_comparable<HDF>
  {
    friend class ConstHDF;

    public:
      //\{
      typedef size_t size_type;
      struct input_iterator_tag {};
      struct forward_iterator_tag : public input_iterator_tag {};
      typedef forward_iterator_tag iterator_category;
      typedef HDF value_type;
      typedef ptrdiff_t difference_type;
      typedef HDF* pointer;
      typedef HDF reference;
      typedef HDF iterator;
      typedef HDF const_reference;
      typedef HDF const_iterator;
      //\}

  protected:
    virtual Nodes nodes () const;
    virtual Nodes& nodes ();
    virtual void push (const ConstHDFNode::Name&, const ClearSilverNode&);
    virtual void pop ();
    virtual ClearSilverNode top () const;

  public:
    //\{
    HDF ();
    explicit HDF (const char * path);
    explicit HDF (const std::string& path);
    explicit HDF (const RootNode&);
    HDF (const HDF&);
    ~HDF () throw();
    //\}

    //\{
    HDF& operator = (const HDF&);
    HDF& operator = (const char* value);
    HDF& operator = (const std::string& value);
    HDF& operator = (int value);
    HDF& operator = (bool value);
    HDF& operator = (const SymlinkTarget&);
    //\}

    //\{
    size_type depth () const;
    std::string path () const;
    //\}

    //\{
    const_reference operator [] (const char* key) const;
    const_reference operator [] (const std::string& key) const;
    reference operator [] (const char* key);
    reference operator [] (const std::string& key);
    //\}

    //\{
    const_iterator begin () const;
    const_iterator end () const;
    iterator begin ();
    iterator end ();

    const_iterator find (const char* key) const;
    const_iterator find (const std::string& key) const;
    iterator find (const char* key);
    iterator find (const std::string& key);
    //\}

    //\{
    iterator& operator ++ ();
    iterator  operator ++ (int);
    value_type operator * ();
    pointer operator -> ();
    //\}

    //\{
    HDF& copy (const HDF& dataset);
    HDF& copy (const char* key, const HDF& dataset);
    HDF& copy (const std::string& key, const HDF& dataset);
    //\}

    virtual ClearSilverNode node () const;

    ClearSilverNode HDF::root () const;

    HDFAttributes attributes ();

    void swap (HDF&) throw();

    friend bool operator == (const reference&, const reference&);

    static bool& debug ();

  private:
    RootNode root_;
    Nodes nodes_;
  };

};                              // namespace ClearSilver

#endif

---