Package org.opennars.operator

Class Operator

java.lang.Object

org.opennars.language.Term

org.opennars.operator.Operator

All Implemented Interfaces:

Serializable, Cloneable, Comparable<AbstractTerm>, AbstractTerm, Plugin

Direct Known Subclasses:

Abbreviation.Abbreviate, Anticipate, Believe, Consider, Doubt, Evaluate, Feel, FunctionOperator, Hesitate, Name, NullOperator, Register, Remind, Want, Wonder

public abstract class Operator
extends Term
implements Plugin

An individual operator that can be execute by the system, which can be either inside NARS or outside it, in another system or device.

This is the only file to modify when registering a new operator into NARS.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Operator.ExecutionResult

Nested classes/interfaces inherited from class org.opennars.language.Term

Term.TermVisitor

Field Summary

Fields inherited from class org.opennars.language.Term

EmptyTermArray, imagination, index_variable, SELF, SEQ_SPATIAL, SEQ_TEMPORAL, term_indices

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Operator()
protected	Operator(String name)

Method Summary

Modifier and Type	Method	Description
static String	addPrefixIfMissing(String opName)
boolean	call(Operation operation, Term[] args, Memory memory, Timable time)	The standard way to carry out an operation, which invokes the execute method defined for the operator, and handles feedback tasks as input
boolean	call(Operation op, Memory memory, Timable time)
Operator	clone()	Make a new Term with the same name.
protected abstract List<Task>	execute(Operation operation, Term[] args, Memory memory, Timable time)	Required method for every operator, specifying the corresponding operation
static String	operationExecutionString(Statement operation)
static void	reportExecution(Operation operation, Term[] args, Object feedback, Memory memory)
boolean	setEnabled(Nar n, boolean enabled)	called when plugin is activated (enabled = true) / deactivated (enabled=false)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opennars.plugin.Plugin

name

Methods inherited from class org.opennars.language.Term

cloneDeep, compareTo, containedTemporalRelations, containsTerm, containsTermRecursively, countTermRecursively, equals, get, get, getComplexity, getIsSpatial, getTemporalOrder, hashCode, hasInterval, hasVar, hasVar, hasVarDep, hasVarIndep, hasVarQuery, isConstant, isExecutable, isHigherOrderStatement, isSelf, name, nameInternal, operator, recurseSubtermsContainingVariables, recurseSubtermsContainingVariables, recurseTerms, setName, subjectOrPredicateIsIndependentVar, text, toSortedSet, toSortedSetArray, toString, valid

Constructor Detail

Operator

protected Operator()

Operator

protected Operator(String name)

Method Detail

setEnabled

public boolean setEnabled(Nar n,
                          boolean enabled)

Description copied from interface: Plugin

called when plugin is activated (enabled = true) / deactivated (enabled=false)

Specified by:

setEnabled in interface Plugin

execute

protected abstract List<Task> execute(Operation operation,
                                      Term[] args,
                                      Memory memory,
                                      Timable time)

Required method for every operator, specifying the corresponding operation

Parameters:

args - Arguments of the operation, both input (constant) and output (variable)

memory - The memory to work on

Returns:

The direct collectable results and feedback of the reportExecution

call

public final boolean call(Operation operation,
                          Term[] args,
                          Memory memory,
                          Timable time)

The standard way to carry out an operation, which invokes the execute method defined for the operator, and handles feedback tasks as input

Parameters:

operation - The operator to be executed

args - The arguments to be taken by the operator

memory - The memory on which the operation is executed

time - used to retrieve the time

Returns:

true if successful, false if an error occurred

operationExecutionString

public static String operationExecutionString(Statement operation)

clone

public Operator clone()

Description copied from class: Term

Make a new Term with the same name.

Overrides:

clone in class Term

Returns:

The new Term

reportExecution

public static void reportExecution(Operation operation,
                                   Term[] args,
                                   Object feedback,
                                   Memory memory)

call

public final boolean call(Operation op,
                          Memory memory,
                          Timable time)

addPrefixIfMissing

public static String addPrefixIfMissing(String opName)