charger.act

Interface ActorPlugin

All Known Implementing Classes:

ClockPlugin, CounterPlugin, PulsePlugin, QuantityBarPlugin, SimpleActorPlugin, StockQuotePlugin

public interface ActorPlugin

Provides a mechanism for creating external actors that can be incorporated into CharGer. Implementers of this interface are allowed to write actor classes that "plug in" to CharGer and whose names will show up in the actor list just as the primitive actors do. Classes implementing the ActorPlugin interface must be in the package named "actorplugin". Responsibility for extracting referents from the charger.obj.Concept arguments lies with the class implementing the interface; some convenience methods are found in charger.act.GraphUpdater.

Author:

Harry S. Delugach ( delugach@uah.edu ) Copyright 1998-2020 by Harry S. Delugach

See Also:

GraphUpdater

Method Summary

Modifier and Type	Method and Description
ArrayList	getPluginActorAttributes()
ArrayList<Concept>	getPluginActorInputConceptList() Assumption about input and output lists is that inputs are numbered 1..n and outputs are numbered n+1 ..
String	getPluginActorName()
ArrayList<Concept>	getPluginActorOutputConceptList() Assumption about input and output lists is that inputs are numbered 1..n and outputs are numbered n+1 ..
String	getSourceInfo()
void	performActorOperation(GraphUpdater gu, ArrayList<Concept> inputs, ArrayList<Concept> outputs) Perform the actor's operation.
void	stopActor() Perform any clean-up required by the actor when it is deleted or its graph is de-activated.

Method Detail

getPluginActorName

String getPluginActorName()

Returns:

name by which the actor will be known throughout the system; this is the string that will be used as the label on an actor in CharGer.

getPluginActorInputConceptList

ArrayList<Concept> getPluginActorInputConceptList()

Assumption about input and output lists is that inputs are numbered 1..n and outputs are numbered n+1 .. m.

Returns:

List of input concepts (or graphs), each with a constraining type label (or "T" )

getPluginActorOutputConceptList

ArrayList<Concept> getPluginActorOutputConceptList()

Assumption about input and output lists is that inputs are numbered 1..n and outputs are numbered n+1 .. m.

Returns:

List of output concepts (or graphs), each with a constraining type label (or "T" )

getPluginActorAttributes

ArrayList getPluginActorAttributes()

Returns:

ArrayList of objects, usually in string form, indicating other actor constraints.

See Also:

GraphUpdater.GraphObjectAttributes

performActorOperation

void performActorOperation(GraphUpdater gu,
                           ArrayList<Concept> inputs,
                           ArrayList<Concept> outputs)
                    throws CGActorException

Perform the actor's operation. Called by GraphUpdater when input or output concepts change.

Parameters:

gu - the current graph updater, in case the operation requires further updating

inputs - ArrayList of charger.obj.Concept

outputs - ArrayList of charger.obj.Concept, set by the operation and usable by the caller.

Throws:

CGActorException

stopActor

void stopActor()

Perform any clean-up required by the actor when it is deleted or its graph is de-activated.

getSourceInfo

String getSourceInfo()

Returns:

a string identifying the author, version, and/or email address of this plugin