org.kepler.provenance

Class FireState<FireIdType>

java.lang.Object

org.kepler.provenance.FireState<FireIdType>

public class FireState<FireIdType>
extends java.lang.Object

A utility class to keep track of an actor's firing.

Author:

Daniel Crawl

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FireState.PortAccessType The types of port accesses.

Constructor Summary

Constructors

Constructor and Description
FireState(Actor actor, int id) Construct a FireState with an actor and its id.

Method Summary

Modifier and Type	Method and Description
void	fireStart(FiringEvent.FiringEventType type, FireIdType fireId) Record the start of a firing for this actor.
FireIdType	fireStop(FiringEvent.FiringEventType type) Record the stop of a firing, and get the fire index for a type of fire.
Actor	getActor() Get the actor.
int	getActorId() Get the actor's id.
FireIdType	getCurFireId() Get the current (non-rw) firing index.
FireIdType	getCurFireId(boolean wantRWFireId) Get the current firing index.
FiringEvent.FiringEventType	getLastStartFireType() Get the last starting firing type seen.
FiringEvent.FiringEventType	getNextStopFiringType() Get the expected firing type for stopping the firing iteration.
int	getNumberOfFirings() Return the number of firings seen.
FireState.PortAccessType	getPortLastAccess() Get the last port access for the actor.
void	setPortLastAccess(FireState.PortAccessType type) Set the last port access for the actor.

Methods inherited from class java.lang.Object

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

Constructor Detail

FireState

public FireState(Actor actor,
                 int id)

Construct a FireState with an actor and its id.

Method Detail

getActor

public Actor getActor()

Get the actor.

getActorId

public int getActorId()

Get the actor's id.

fireStart

public void fireStart(FiringEvent.FiringEventType type,
                      FireIdType fireId)

Record the start of a firing for this actor.

Parameters:

type - type of firing.

fireId - fire id.

fireStop

public FireIdType fireStop(FiringEvent.FiringEventType type)

Record the stop of a firing, and get the fire index for a type of fire.

Parameters:

type - the current type of fire that running

Returns:

the firing id

getCurFireId

public FireIdType getCurFireId()

Get the current (non-rw) firing index.

getCurFireId

public FireIdType getCurFireId(boolean wantRWFireId)

Get the current firing index.

Parameters:

wantRWFireId - If true, return current rw fire id, else return current non-rw fire id. In the latter case, it returns the id of the most recent prefire, fire, or postfire to start. If none of those three types of fire are currently running, it returns the id of the currently "iterate" firing. If no "iterate" is currently running, returns UNKNOWN_FIRE_ID.

getLastStartFireType

public FiringEvent.FiringEventType getLastStartFireType()

Get the last starting firing type seen.

getNextStopFiringType

public FiringEvent.FiringEventType getNextStopFiringType()
                                                  throws RecordingException

Get the expected firing type for stopping the firing iteration.

Throws:

RecordingException

getNumberOfFirings

public int getNumberOfFirings()

Return the number of firings seen. The number is incremented each time fireStop() is called.

getPortLastAccess

public FireState.PortAccessType getPortLastAccess()

Get the last port access for the actor.

setPortLastAccess

public void setPortLastAccess(FireState.PortAccessType type)

Set the last port access for the actor.