Node.h

Go to the documentation of this file.

/*
 * opencog/atomspace/Node.h
 *
 * Copyright (C) 2002-2007 Novamente LLC
 * All Rights Reserved
 *
 * Written by Thiago Maia <thiago@vettatech.com>
 *            Andre Senna <senna@vettalabs.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License v3 as
 * published by the Free Software Foundation and including the exceptions
 * at http://opencog.org/wiki/Licenses
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program; if not, write to:
 * Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef _OPENCOG_NODE_H
#define _OPENCOG_NODE_H

#include <opencog/util/oc_assert.h>
#include <opencog/atomspace/Atom.h>

namespace opencog
{
class Node : public Atom
{
protected:
    // properties
    std::string _name;
    void init(const std::string&);

    Node(const Node &l) : Atom(0)
    { OC_ASSERT(false, "Node: bad use of copy ctor"); }

public:
    Node(Type t, const std::string& s,
         TruthValuePtr tv = TruthValue::DEFAULT_TV(),
         AttentionValuePtr av = AttentionValue::DEFAULT_AV())
        : Atom(t,tv,av)
    {
        init(s);
    }

    Node(Node &n)
        : Atom(n.getType(),
               n.getTruthValue()->clone(),
               n.getAttentionValue()->clone())
    {
        init(n._name);
    }

    inline const std::string& getName() const { return _name; }

    std::string toString(std::string indent = "");
    std::string toShortString(std::string indent = "");

    virtual bool operator==(const Atom&) const;

    virtual bool operator!=(const Atom&) const;
};

typedef std::shared_ptr<Node> NodePtr;
static inline NodePtr NodeCast(const Handle& h)
    { AtomPtr a(h); return std::dynamic_pointer_cast<Node>(a); }
static inline NodePtr NodeCast(const AtomPtr& a)
    { return std::dynamic_pointer_cast<Node>(a); }

// XXX temporary hack ...
#define createNode std::make_shared<Node>

} // namespace opencog

#endif // _OPENCOG_NODE_H