inria.meije.rc.sugarcubes
Interface InternalIdentifiers

All Known Implementing Classes:

InternalStringIdentifiers

public interface InternalIdentifiers

InternalIdentifiers provides a way to get event identifiers used internally in a reactive machine Machine. By defaults in SugarCubes v3 Identifiers are defined with Java strings (refer to StringID), and the class InternalStringIdentifiers is provided as a consistent implementation of InternalIdentifiers working with StringID.

The user has to implement that interface in order to provide a consistent way to get identifiers of event from simple java strings. For example, when one only knows the name of a Cube, this class should provide a unique identifier corresponding to that name, or the Identifier of the event used to destroy the Cube.

See Also:

Machine.cubeDestructionIdentifier(java.lang.String), Machine.identifierFromString(java.lang.String), ReactiveEngine.cubeDestructionIdentifier(java.lang.String), ReactiveEngine.identifierFromString(java.lang.String)

Method Summary

Identifier	cubeDestructionIdentifier(java.lang.String aCubeName) This method returns an Identifier referencing the destruction event of a Cube whose name is given as argument.
Identifier	identifierFromString(java.lang.String aString) This method returns an Identifier corresponding to the string.
Identifier	threadFinishIdentifier() This method returns a unique identifier, which is used in the definition of a reactive thread, to terminate its execution.
Identifier	threadStepIdentifier() This method returns a unique identifier, which is used in the definition of a reactive thread, to activate its body at each instant when reactive thread is running.

Method Detail

cubeDestructionIdentifier

public Identifier cubeDestructionIdentifier(java.lang.String aCubeName)

This method returns an Identifier referencing the destruction event of a Cube whose name is given as argument.

identifierFromString

public Identifier identifierFromString(java.lang.String aString)

This method returns an Identifier corresponding to the string.

threadFinishIdentifier

public Identifier threadFinishIdentifier()

This method returns a unique identifier, which is used in the definition of a reactive thread, to terminate its execution.

See Also:

SC.reactiveThread(inria.meije.rc.sugarcubes.Program, inria.meije.rc.sugarcubes.Identifier, inria.meije.rc.sugarcubes.Identifier, inria.meije.rc.sugarcubes.Identifier, inria.meije.rc.sugarcubes.Identifier, int, inria.meije.rc.sugarcubes.InternalIdentifiers)

threadStepIdentifier

public Identifier threadStepIdentifier()

This method returns a unique identifier, which is used in the definition of a reactive thread, to activate its body at each instant when reactive thread is running.

See Also:

SC.reactiveThread(inria.meije.rc.sugarcubes.Program, inria.meije.rc.sugarcubes.Identifier, inria.meije.rc.sugarcubes.Identifier, inria.meije.rc.sugarcubes.Identifier, inria.meije.rc.sugarcubes.Identifier, int, inria.meije.rc.sugarcubes.InternalIdentifiers)