Package com.semedy.reasoner.builtin.sensor

Class Alarm

java.lang.Object

com.semedy.reasoner.api.builtin.SensorBuiltin

com.semedy.reasoner.builtin.sensor.Alarm

All Implemented Interfaces:

Builtin

public class Alarm
extends SensorBuiltin

Creates one time tick at the given time.
Used for stream-based reasoning to trigger an event.

Author:

angele

Constructor Summary

Constructors

Constructor	Description
Alarm()

Method Summary

Modifier and Type	Method	Description
void	clear()	frees up allocated resources
Builtin	cloneBuiltin()	create a clone of the built-in
void	evaluationFinished()	evaluation is finished
String[]	getArgumentDescriptions()	get a description of the arguments
int	getArity()	get the arity of the built-in
String	getDescription()	get a description of the built-in itself
String	getName()	get the name of the built-in
BuiltinType	getType()	get the type of the built-in
long	getWeight(BitSet grounds, BitSet variableInstantiations, Object[] args)	get the weight of the built-in
void	init(Object[] args)	initialize the built-in
boolean	isEvaluable(BitSet grounds, BitSet variableInstantiations, Object[] args)	is builtin evaluable with the given ground instantiation of variables
boolean	isInternal()	is it an internal built-in
BitSet	objectGeneratingArguments(BitSet grounds, BitSet variableInstantiations, Object[] args)	at which argument positions new objects are generated
boolean	readsSymbolTable()	does the built-in read the symbol table
void	setProperties(Properties prp)	set the sytem properties
void	setSymbolTable(SymbolTable symbolTable)	set the symbol table
boolean	writesSymbolTable()	does the built-in write the symbol table

Methods inherited from class com.semedy.reasoner.api.builtin.SensorBuiltin

addReceiver, receiveEncodedEvent, receiveEvent, retractEncodedEvent, retractEvent, retractEvents, setSemaphore

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Alarm

public Alarm()

Method Details

clear

public void clear()

Description copied from interface: Builtin

frees up allocated resources

setProperties

public void setProperties(Properties prp)

Description copied from interface: Builtin

set the sytem properties

Parameters:

prp - , properties

isEvaluable

public boolean isEvaluable(BitSet grounds,
 BitSet variableInstantiations,
 Object[] args)
                    throws BuiltinException

Description copied from class: SensorBuiltin

is builtin evaluable with the given ground instantiation of variables

Specified by:

isEvaluable in interface Builtin

Specified by:

isEvaluable in class SensorBuiltin

Parameters:

grounds - , which arguments are ground

variableInstantiations - , which variables are instantiated

args - , the arguments

Returns:

was it evaluable

Throws:

BuiltinException

init

public void init(Object[] args)
          throws InterruptedException,
SemReasonerException

Description copied from class: SensorBuiltin

initialize the built-in

Specified by:

init in interface Builtin

Specified by:

init in class SensorBuiltin

Parameters:

args - , the builtin arguments

Throws:

InterruptedException

SemReasonerException

cloneBuiltin

public Builtin cloneBuiltin()

Description copied from class: SensorBuiltin

create a clone of the built-in

Specified by:

cloneBuiltin in interface Builtin

Specified by:

cloneBuiltin in class SensorBuiltin

Returns:

the cloned built-in

setSymbolTable

public void setSymbolTable(SymbolTable symbolTable)

Description copied from class: SensorBuiltin

set the symbol table

Specified by:

setSymbolTable in interface Builtin

Overrides:

setSymbolTable in class SensorBuiltin

Parameters:

symbolTable - , the symbol table

evaluationFinished

public void evaluationFinished()
                        throws BuiltinException,
InterruptedException

Description copied from class: SensorBuiltin

evaluation is finished

Specified by:

evaluationFinished in interface Builtin

Overrides:

evaluationFinished in class SensorBuiltin

Throws:

BuiltinException

InterruptedException

getWeight

public long getWeight(BitSet grounds,
 BitSet variableInstantiations,
 Object[] args)

Description copied from class: SensorBuiltin

get the weight of the built-in

Specified by:

getWeight in interface Builtin

Specified by:

getWeight in class SensorBuiltin

Parameters:

grounds - , ground arguments

variableInstantiations - , instantiated variables

args - , arguments of the builtin

Returns:

the weight of the builtin (influences the position in the rule)

objectGeneratingArguments

public BitSet objectGeneratingArguments(BitSet grounds,
 BitSet variableInstantiations,
 Object[] args)
                                 throws BuiltinException

Description copied from class: SensorBuiltin

at which argument positions new objects are generated

Specified by:

objectGeneratingArguments in interface Builtin

Specified by:

objectGeneratingArguments in class SensorBuiltin

Parameters:

grounds - , ground argument positions

variableInstantiations - , instantiated variables

args - , arguments of the literal

Returns:

each bit indicates the argument position where new objects are created

Throws:

BuiltinException

getName

public String getName()

Description copied from class: SensorBuiltin

get the name of the built-in

Specified by:

getName in interface Builtin

Specified by:

getName in class SensorBuiltin

Returns:

the name of the built-in

getArity

public int getArity()

Description copied from class: SensorBuiltin

get the arity of the built-in

Specified by:

getArity in interface Builtin

Specified by:

getArity in class SensorBuiltin

Returns:

the arity of the built-in

getType

public BuiltinType getType()

Description copied from class: SensorBuiltin

get the type of the built-in

Specified by:

getType in interface Builtin

Specified by:

getType in class SensorBuiltin

Returns:

the type of the built-in

isInternal

public boolean isInternal()

Description copied from class: SensorBuiltin

is it an internal built-in

Specified by:

isInternal in interface Builtin

Specified by:

isInternal in class SensorBuiltin

Returns:

getArgumentDescriptions

public String[] getArgumentDescriptions()

Description copied from class: SensorBuiltin

get a description of the arguments

Specified by:

getArgumentDescriptions in interface Builtin

Specified by:

getArgumentDescriptions in class SensorBuiltin

Returns:

a description of the arguments of the built-in

getDescription

public String getDescription()

Description copied from class: SensorBuiltin

get a description of the built-in itself

Specified by:

getDescription in interface Builtin

Specified by:

getDescription in class SensorBuiltin

Returns:

a description of the built-in

readsSymbolTable

public boolean readsSymbolTable()

Description copied from class: SensorBuiltin

does the built-in read the symbol table

Specified by:

readsSymbolTable in interface Builtin

Specified by:

readsSymbolTable in class SensorBuiltin

Returns:

true if it reads the symbol table

writesSymbolTable

public boolean writesSymbolTable()

Description copied from class: SensorBuiltin

does the built-in write the symbol table

Specified by:

writesSymbolTable in interface Builtin

Specified by:

writesSymbolTable in class SensorBuiltin

Returns:

true if it writes to the symbol table