story.scheherazade.parameters
Class ConditionInEffectParameter

java.lang.Object
  story.scheherazade.parameters.SCHParameter
      story.scheherazade.parameters.StoryQueryParameter
          story.scheherazade.parameters.BooleanReturnQueryParameter
              story.scheherazade.parameters.ConditionInEffectParameter

public class ConditionInEffectParameter
extends BooleanReturnQueryParameter

An SCHParameter which makes sure that a previously matched AssignedCondition takes effect at a particular state or transition.

Constructor Summary

ConditionInEffectParameter(VariableID condition, StateTime targetTime, int scope, boolean inferProperties)
Constructor for ensuring that a condition is in effect at a state.

ConditionInEffectParameter(VariableID condition, TransitionTime targetTransition)
Constructor for ensuring that a condition is in progress during a 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

ConditionInEffectParameter

public ConditionInEffectParameter(VariableID condition,
                                  StateTime targetTime,
                                  int scope,
                                  boolean inferProperties)
                           throws Scheherexception

Constructor for ensuring that a condition is in effect at a state.

Parameters:

condition - The VariableID of the Condition previously matched by AssignedConditionParameter.

targetTime - The time slice when the condition may or may not apply.

scope - Set -1 to only match Conditions that are explicitly attached to a State node with the given target StateTime. Set 1 to only match Conditions that are "inferred" to apply, e.g., persistent ones that began at a previous time with a conditionBegins action. Set 0 to match either.

inferProperties - Set true to include the "property" conditions that apply to the entire timeline.

Throws:

Scheherexception

ConditionInEffectParameter

public ConditionInEffectParameter(VariableID condition,
                                  TransitionTime targetTransition)
                           throws Scheherexception

Constructor for ensuring that a condition is in progress during a transition. Will only match transitions between the transition with the conditionBegins action and the transition with the conditionEnds action, exclusive.

Parameters:

condition - The VariableID of the Condition previously matched by AssignedConditionParameter.

targetTransition - The time slice when the condition may or may not apply.

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