opencog-sensory / opencog / atoms / sensory-v0 / OpenLink.h

/*
 * opencog/atoms/sensory-v0/OpenLink.h
 *
 * Copyright (C) 2018 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 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_OPEN_LINK_H
#define _OPENCOG_OPEN_LINK_H

#include <opencog/atoms/base/Link.h>
#include <opencog/sensory-v0/types/atom_types.h>

namespace opencog
{
/** \addtogroup grp_atomspace
 *  @{
 */

/// The OpenLink creates a new stream iterator or cursor.
///
class OpenLink : public Link
{
private:
	Type _kind;
	void init(void);

public:
	OpenLink(const HandleSeq&&, Type = OPEN_LINK);
	OpenLink(const Handle&);

	OpenLink(const OpenLink&) = delete;
	OpenLink& operator=(const OpenLink&) = delete;

	Type get_kind(void) { return _kind; }

	// Return a pointer to what was written.
	virtual ValuePtr execute(AtomSpace*, bool);
	virtual bool is_executable(void) const { return true; }

	static Handle factory(const Handle&);
};

LINK_PTR_DECL(OpenLink)
#define createOpenLink CREATE_DECL(OpenLink)

/** @}*/
}

#endif // _OPENCOG_OPEN_LINK_H