node.H

Go to the documentation of this file.

/*
 * This file is part of the "Archon" framework.
 * (http://files3d.sourceforge.net)
 *
 * Copyright © 2002 by Kristian Spangsege and Brian Kristiansen.
 *
 * Permission to use, copy, modify, and distribute this software and
 * its documentation under the terms of the GNU General Public License is
 * hereby granted. No representations are made about the suitability of
 * this software for any purpose. It is provided "as is" without express
 * or implied warranty. See the GNU General Public License
 * (http://www.gnu.org/copyleft/gpl.html) for more details.
 *
 * The characters in this file are ISO8859-1 encoded.
 *
 * The documentation in this file is in "Doxygen" style
 * (http://www.doxygen.org).
 */

#ifndef ARCHON_X3D_NODE_H
#define ARCHON_X3D_NODE_H

#include <string>

#include <archon/util/logger.H>
#include <archon/util/ref.H>

#include <archon/x3d/server/exception.H>
#include <archon/x3d/server/type.H>
#include <archon/x3d/server/event_source.H>

namespace Archon
{
  namespace X3D
  {
    struct ExecutionContext; // "scene.H"
    struct Parser;           // "parse.H"
    struct RouteHead;        // "event.H"
    struct MetadataObject;   // "core.H"

    struct NodeNameInUseException: Exception
    {
      NodeNameInUseException(string l): Exception(l) {}
    };

    struct NodeBase: virtual BackRefObjectBase
    {
      virtual const NodeType *getType() const = 0;

      struct RealizedException: Exception
      {
        RealizedException(string l): Exception(l) {}
      };
      struct AccessException: Exception
      {
        AccessException(string l): Exception(l) {}
      };
      struct RangeException: Exception
      {
        RangeException(string l): Exception(l) {}
      };

      void realize();

      bool isRealized() const;

      virtual void onRealized() {}

      string getName() const;

      void setName(string name)
        throw(NodeNameInUseException);

      virtual const FieldBase *lookupField(string name) const;

      Ref<ValueBase> get(const FieldBase *)
        const throw(AccessException, UnexpectedException);

      unsigned getSize(const SequenceFieldBase *) const
        throw(AccessException, UnexpectedException);

      Ref<ValueBase> getAt(const SequenceFieldBase *, unsigned index) const
        throw(AccessException, RangeException, UnexpectedException);

      void set(const FieldBase *, const Event *)
        throw(AccessException, UnexpectedException);

      void setAt(const SequenceFieldBase *, Ref<const ValueBase>,
                 unsigned index, Time)
        throw(AccessException, RangeException, UnexpectedException);

      void add(const SequenceFieldBase *, Ref<const ValueBase>, Time)
        throw(AccessException, UnexpectedException);

      void remove(const SequenceFieldBase *, Ref<const ValueBase>, Time)
        throw(AccessException, UnexpectedException);

      void add(const NodeSequenceFieldBase *, Ref<NodeBase>, Time)
        throw(AccessException, UnexpectedException);

      void remove(const NodeSequenceFieldBase *, Ref<NodeBase>, Time)
        throw(AccessException, UnexpectedException);

      bool inject(const NodeFieldBase *, Ref<NodeBase> childNode, Time stamp)
        throw(AccessException, UnexpectedException);

      virtual bool changedSince(const Time &t) const;

      //virtual string dumpFields(set<const NodeBase *> processedNodes, int level) const;

      //string dump(set<const NodeBase *> processedNodes, int level, bool indentFirstLine) const;

      const BackRef<ExecutionContext> context;

    protected:
      NodeBase(BackRef<ExecutionContext> context);

      NodeBase();

      virtual ~NodeBase();

      virtual void refForwardDestroy();

      bool isRealizedNoLock() const { return realized; }

      const Mutex mutex;

    private:
      friend struct Route;
      Mutex routeTargetsMutex;
      list<Ref<const RouteHead> > routeTargets;
      void addRouteTarget(Ref<const RouteHead>);
      void removeRouteTarget(Ref<const RouteHead>);

      string name;

      bool realized;
    };
  }
}

#endif // ARCHON_X3D_NODE_H

---