FunctionLink.h

Go to the documentation of this file.

/*
 * opencog/atoms/reduct/FunctionLink.h
 *
 * Copyright (C) 2015 Linas Vepstas
 * All Rights Reserved
 *
 * 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 Function 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:
 * Function Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef _OPENCOG_FUNCTION_LINK_H
#define _OPENCOG_FUNCTION_LINK_H

#include <opencog/atomspace/AtomSpace.h>
#include <opencog/atoms/core/FreeLink.h>

namespace opencog
{
class FunctionLink : public FreeLink
{
protected:
    FunctionLink(Type, const Handle& a,
                 TruthValuePtr tv = TruthValue::NULL_TV(),
                 AttentionValuePtr av = AttentionValue::DEFAULT_AV());

    FunctionLink(Type, const Handle& a, const Handle& b,
                 TruthValuePtr tv = TruthValue::NULL_TV(),
                 AttentionValuePtr av = AttentionValue::DEFAULT_AV());

public:
    FunctionLink(Type, const HandleSeq& oset,
                 TruthValuePtr tv = TruthValue::NULL_TV(),
                 AttentionValuePtr av = AttentionValue::DEFAULT_AV());

    FunctionLink(Link& l);
    virtual ~FunctionLink() {}

    virtual Handle execute(AtomSpace* = NULL) const;
    static Handle do_execute(AtomSpace*, const Handle&);

    static LinkPtr factory(LinkPtr);
    static Handle factory(Type, const HandleSeq&);
};

typedef std::shared_ptr<FunctionLink> FunctionLinkPtr;
static inline FunctionLinkPtr FunctionLinkCast(const Handle& h)
   { AtomPtr a(h); return std::dynamic_pointer_cast<FunctionLink>(a); }
static inline FunctionLinkPtr FunctionLinkCast(AtomPtr a)
   { return std::dynamic_pointer_cast<FunctionLink>(a); }

// XXX temporary hack ...
#define createFunctionLink std::make_shared<FunctionLink>

}

#endif // _OPENCOG_FUNCTION_LINK_H