#include <AssignLink.h>

Inheritance diagram for opencog::AssignLink:

Collaboration diagram for opencog::AssignLink:

Public Member Functions
	AssignLink (const HandleSeq &, TruthValuePtr tv=TruthValue::DEFAULT_TV(), AttentionValuePtr av=AttentionValue::DEFAULT_AV())

	AssignLink (Type t, const HandleSeq &, TruthValuePtr tv=TruthValue::DEFAULT_TV(), AttentionValuePtr av=AttentionValue::DEFAULT_AV())

	AssignLink (Link &l)

virtual Handle	execute (AtomSpace *=NULL) const

Public Member Functions inherited from opencog::FunctionLink
	FunctionLink (Type, const HandleSeq &oset, TruthValuePtr tv=TruthValue::NULL_TV(), AttentionValuePtr av=AttentionValue::DEFAULT_AV())

	FunctionLink (Link &l)

virtual	~FunctionLink ()

Public Member Functions inherited from opencog::FreeLink
	FreeLink (const HandleSeq &oset, TruthValuePtr tv=TruthValue::NULL_TV(), AttentionValuePtr av=AttentionValue::DEFAULT_AV())

	FreeLink (const Handle &a, TruthValuePtr tv=TruthValue::NULL_TV(), AttentionValuePtr av=AttentionValue::DEFAULT_AV())

	FreeLink (Link &l)

virtual	~FreeLink ()

const HandleSeq &	get_vars (void)

virtual Handle	reduce (void)

Public Member Functions inherited from opencog::Link
	Link (Type t, const HandleSeq &oset, TruthValuePtr tv=TruthValue::DEFAULT_TV(), AttentionValuePtr av=AttentionValue::DEFAULT_AV())

	Link (Type t, const Handle &h, TruthValuePtr tv=TruthValue::DEFAULT_TV(), AttentionValuePtr av=AttentionValue::DEFAULT_AV())

	Link (Type t, const Handle &ha, const Handle &hb, TruthValuePtr tv=TruthValue::DEFAULT_TV(), AttentionValuePtr av=AttentionValue::DEFAULT_AV())

	Link (Type t, const Handle &ha, const Handle &hb, const Handle &hc, TruthValuePtr tv=TruthValue::DEFAULT_TV(), AttentionValuePtr av=AttentionValue::DEFAULT_AV())

	Link (Type t, const Handle &ha, const Handle &hb, const Handle &hc, const Handle &hd, TruthValuePtr tv=TruthValue::DEFAULT_TV(), AttentionValuePtr av=AttentionValue::DEFAULT_AV())

	Link (Link &l)

	~Link ()

Arity	getArity () const

const HandleSeq &	getOutgoingSet () const

Handle	getOutgoingAtom (Arity pos) const throw (RuntimeException)

template<class T >
bool	foreach_outgoing (bool(T::cb)(const Handle &), T data)

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

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

bool	isSource (Handle) const throw (InvalidParamException)

bool	isSource (size_t) const throw (IndexErrorException, InvalidParamException)

bool	isTarget (Handle) const throw (InvalidParamException)

bool	isTarget (size_t) const throw (IndexErrorException, InvalidParamException)

virtual bool	operator== (const Atom &) const

virtual bool	operator!= (const Atom &) const

Public Member Functions inherited from opencog::Atom
virtual	~Atom ()

Type	getType () const

bool	isType (Type t, bool subclass) const

Handle	getHandle ()

AttentionValuePtr	getAttentionValue ()

void	setAttentionValue (AttentionValuePtr)
	Sets the AttentionValue object of the atom. More...

AttentionValue::sti_t	getSTI ()
	Handy-dandy convenience getters for attention values. More...

AttentionValue::lti_t	getLTI ()

AttentionValue::vlti_t	getVLTI ()

void	setSTI (AttentionValue::sti_t stiValue)

void	setLTI (AttentionValue::lti_t ltiValue)

void	incVLTI ()

void	decVLTI ()

TruthValuePtr	getTruthValue ()

void	setTruthValue (TruthValuePtr)
	Sets the TruthValue object of the atom. More...

void	merge (TruthValuePtr)

Handle	tvmerge (TruthValuePtr tv)

size_t	getIncomingSetSize ()
	Get the size of the incoming set. More...

IncomingSet	getIncomingSet ()

template<typename OutputIterator >
OutputIterator	getIncomingSet (OutputIterator result)

template<class T >
bool	foreach_incoming (bool(T::cb)(const Handle &), T data)

template<typename OutputIterator >
OutputIterator	getIncomingSetByType (OutputIterator result, Type type, bool subclass=false)

IncomingSet	getIncomingSetByType (Type type, bool subclass=false)

Protected Member Functions
void	init (const HandleSeq &)

Protected Member Functions inherited from opencog::FunctionLink
	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())

Protected Member Functions inherited from opencog::FreeLink
void	init (void)

void	find_vars (std::set< Handle > &, const HandleSeq &)

void	build_index (void)

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

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

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

Protected Member Functions inherited from opencog::Atom
	Atom (Type t, TruthValuePtr tv=TruthValue::DEFAULT_TV(), AttentionValuePtr av=AttentionValue::DEFAULT_AV())

void	keep_incoming_set ()

void	drop_incoming_set ()

void	insert_atom (LinkPtr)
	Add an atom to the incoming set. More...

void	remove_atom (LinkPtr)
	Remove an atom from the incoming set. More...

Protected Attributes
Type	_link_type

HandleSeq	_outset

size_t	_osetz

Protected Attributes inherited from opencog::FreeLink
HandleSeq	_varseq

std::map< Handle, unsigned int >	_index

Protected Attributes inherited from opencog::Link
HandleSeq	_outgoing

Protected Attributes inherited from opencog::Atom
UUID	_uuid

AtomTable *	_atomTable

Type	_type

char	_flags

TruthValuePtr	_truthValue

AttentionValuePtr	_attentionValue

std::mutex	_mtx

InSetPtr	_incoming_set

Additional Inherited Members
Static Public Member Functions inherited from opencog::FunctionLink
static Handle	do_execute (AtomSpace *, const Handle &)

static LinkPtr	factory (LinkPtr)

static Handle	factory (Type, const HandleSeq &)

Protected Types inherited from opencog::Atom
typedef std::shared_ptr< InSet >	InSetPtr

Detailed Description

The InsertLink is used to create atoms at some defered time in the future, while still being able to describe and talk about them at the present time. The issue that it is solving is this: when an atom is explicitly named, it also becomes a member of the AtomSpace; that is, it is brought into existance by naming it. The usual mechanism for deferring the creation of an atom is to place a VariableNode in it; theatom is then created later, when the Variable is given a value. The InsertLink provides an alternative mechanism, without requiring the use of VariableNodes.

The InsertLink is a kind of executable link; that it, upon execution, it transforms into another link. It should have the following form:

InsertLink TypeNode "SomeLink" SomeAtom OtherAtom

Upon execution, this will result in the following being created:

SomeLink SomeAtom OtherAtom

The RemoveLink is like the InsertLink, except that it causes the indicated form to be deleted (removed from the atomspace). If the RemoveLink contains variables, and those variables are free, then all matching paterns will be deleted from the AtomSpace.

The InsertLink vaguely resembles the ProLog predicate "assert()" with respect to what it does to the atomspace database. The RemoveLink behaves like the ProLog "retract()" predicate.

The AssignLink combines the Insert and Remove into one. Since the format does not allow a close specification of the exact link to be removed, it will remove all atoms fitting the general pattern, i.e. those links having the indicated link type, the same first atom (SomeAtom, above), and the same arity. It will not remove those links containing variables, as these are not concrete (closed), but open. It will do this before performing the Insert.

To be precise:

AssignLink
    TypeNode "SomeLink"
    SomeAtom
    OtherAtom

is identical to saying:

RemoveLink
    TypeNode "SomeLink"
    SomeAtom
    VariableNode "$free"

InsertLink
    TypeNode "SomeLink"
    SomeAtom
    OtherAtom

Definition at line 97 of file AssignLink.h.

Constructor & Destructor Documentation

AssignLink::AssignLink	(	const HandleSeq &	oset,
		TruthValuePtr	tv = `TruthValue::DEFAULT_TV()`,
		AttentionValuePtr	av = `AttentionValue::DEFAULT_AV()`
	)

Definition at line 35 of file AssignLink.cc.

References opencog::FreeLink::init().

AssignLink::AssignLink	(	Type	t,
		const HandleSeq &	oset,
		TruthValuePtr	tv = `TruthValue::DEFAULT_TV()`,
		AttentionValuePtr	av = `AttentionValue::DEFAULT_AV()`
	)