story.scheherazade.parameters
Class ActionOccursParameter

java.lang.Object
  extended by story.scheherazade.parameters.SCHParameter
      extended by story.scheherazade.parameters.StoryQueryParameter
          extended by story.scheherazade.parameters.BooleanReturnQueryParameter
              extended by story.scheherazade.parameters.ActionOccursParameter

public class ActionOccursParameter
extends BooleanReturnQueryParameter

An SCHParameter which makes sure that a previously matched AssignedAction takes place within some time range.


Constructor Summary
ActionOccursParameter(VariableID action, StateTime targetState)
          Constructor for ensuring that an action occurs during a particular state.
ActionOccursParameter(VariableID action, TransitionTime targetTransition, ActionTemporality temporality)
          Constructor for ensuring that an action occurs during a particular transition.
 
Method Summary
 SCHParameter makeCopy()
          Make a copy of the Parameter at the level of the concretizing class
 SCHReferenceReqSet referenceRequirements()
          Each concretizing class needs to provide a ReferenceReqSet of all the references which must be set prior to the parameter's evaluation.
 java.lang.StringBuffer specificRender()
          Each concretizing class needs to provide a render function.
 
Methods inherited from class story.scheherazade.parameters.SCHParameter
makeClone, render
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ActionOccursParameter

public ActionOccursParameter(VariableID action,
                             TransitionTime targetTransition,
                             ActionTemporality temporality)
                      throws Scheherexception
Constructor for ensuring that an action occurs during a particular transition.

Parameters:
action - The VariableID of the Action previously matched by AssignedActionParameter.
targetTransition - The transition in question.
temporality - Set MatchesExactly to only find actions that happen precisely during the given transition. Set EnclosedWithin to only find actions that begin and end within the given span (or use StateTime.Unbounded to test "rays" of time). Set OccursDuring to match all actions with a time span that overlaps the given span by a non-zero length of time.
Throws:
Scheherexception

ActionOccursParameter

public ActionOccursParameter(VariableID action,
                             StateTime targetState)
                      throws Scheherexception
Constructor for ensuring that an action occurs during a particular state.

Parameters:
action - The VariableID of the Action previously matched by AssignedActionParameter.
state - The time of the state in question.
Throws:
Scheherexception
Method Detail

referenceRequirements

public SCHReferenceReqSet referenceRequirements()
Description copied from class: SCHParameter
Each concretizing class needs to provide a ReferenceReqSet of all the references which must be set prior to the parameter's evaluation.

Specified by:
referenceRequirements in class SCHParameter

specificRender

public java.lang.StringBuffer specificRender()
                                      throws Scheherexception
Description copied from class: SCHParameter
Each concretizing class needs to provide a render function. It is encapsulated inside this abstract class's render() so that we can render the outgoing reference, if any.

Specified by:
specificRender in class SCHParameter
Throws:
Scheherexception

makeCopy

public SCHParameter makeCopy()
Description copied from class: SCHParameter
Make a copy of the Parameter at the level of the concretizing class

Specified by:
makeCopy in class SCHParameter


Copyright © 2011 David K. Elson. All Rights Reserved.