com.ibm.rational.test.common.models.behavior

Interface CBLoop

  • All Superinterfaces:
    CBActionElement, com.ibm.rational.test.common.models.behavior.cbdata.CBAttribute, CBBlock, com.ibm.rational.test.common.models.behavior.CBBlockElement, com.ibm.rational.test.common.models.behavior.edit.CBCloneable, com.ibm.rational.test.common.models.behavior.edit.CBEdit, CBElementHost, com.ibm.rational.test.common.models.behavior.cbdata.CBElementModifier, com.ibm.rational.test.common.models.behavior.errors.CBErrorHost, CBNamedElement, com.ibm.rational.test.common.models.behavior.CBSyncPointHost, com.ibm.rational.test.common.models.behavior.internal.CBTempData, com.ibm.rational.test.common.models.behavior.cbdata.DataCorrelation, org.eclipse.emf.ecore.EObject, IAdaptable, org.eclipse.emf.common.notify.Notifier, com.ibm.rational.test.common.models.behavior.cbdata.SubstituterHost
    All Known Subinterfaces:
    LTLoop


    public interface CBLoop
    extends CBBlock, CBElementHost, com.ibm.rational.test.common.models.behavior.cbdata.SubstituterHost, com.ibm.rational.test.common.models.behavior.CBSyncPointHost
    A Loop is an IAction with a Constraint and one list. CBLoop is used to contain a group of actions that want to be looped over. It contains a CBLoopCondition which dictates the behavior of the loop.

    The following features are supported:

    See Also:
    BehaviorPackage.getCBLoop()
    • Field Detail

      • PACING_RATE

        static final String PACING_RATE
    • Method Detail

      • isEnablePacing

        boolean isEnablePacing()
        Returns the value of the 'Enable Pacing' attribute. The default value is "false".

        If the meaning of the 'Enable Pacing' attribute isn't clear, there really should be more of a description here...

        Returns:
        the value of the 'Enable Pacing' attribute.
        See Also:
        CBLoop.setEnablePacing(boolean), BehaviorPackage.getCBLoop_EnablePacing()
      • setEnablePacing

        void setEnablePacing(boolean value)
        Sets the value of the 'Enable Pacing' attribute.
        Parameters:
        value - the new value of the 'Enable Pacing' attribute.
        See Also:
        CBLoop.isEnablePacing()
      • getPacingRate

        long getPacingRate()
        Returns the value of the 'Pacing Rate' attribute. The default value is "1".

        If the meaning of the 'Pacing Rate' attribute isn't clear, there really should be more of a description here...

        Returns:
        the value of the 'Pacing Rate' attribute.
        See Also:
        CBLoop.setPacingRate(long), BehaviorPackage.getCBLoop_PacingRate()
      • setPacingRate

        void setPacingRate(long value)
        Sets the value of the 'Pacing Rate' attribute.
        Parameters:
        value - the new value of the 'Pacing Rate' attribute.
        See Also:
        CBLoop.getPacingRate()
      • getPacingRatePeriod

        long getPacingRatePeriod()
        Returns the value of the 'Pacing Rate Period' attribute. The default value is "60000".

        If the meaning of the 'Pacing Rate Period' attribute isn't clear, there really should be more of a description here...

        Returns:
        the value of the 'Pacing Rate Period' attribute.
        See Also:
        CBLoop.setPacingRatePeriod(long), BehaviorPackage.getCBLoop_PacingRatePeriod()
      • isInitialDelay

        boolean isInitialDelay()
        Returns the value of the 'Initial Delay' attribute. The default value is "false".

        If the meaning of the 'Initial Delay' attribute isn't clear, there really should be more of a description here...

        Returns:
        the value of the 'Initial Delay' attribute.
        See Also:
        CBLoop.setInitialDelay(boolean), BehaviorPackage.getCBLoop_InitialDelay()
      • setInitialDelay

        void setInitialDelay(boolean value)
        Sets the value of the 'Initial Delay' attribute.
        Parameters:
        value - the new value of the 'Initial Delay' attribute.
        See Also:
        CBLoop.isInitialDelay()
      • isRandomDistribution

        boolean isRandomDistribution()
        Returns the value of the 'Random Distribution' attribute. The default value is "true".

        If the meaning of the 'Random Distribution' attribute isn't clear, there really should be more of a description here...

        Returns:
        the value of the 'Random Distribution' attribute.
        See Also:
        CBLoop.setRandomDistribution(boolean), BehaviorPackage.getCBLoop_RandomDistribution()
      • getLoopCondition

        com.ibm.rational.test.common.models.behavior.loop.CBLoopCondition getLoopCondition()
        Returns the value of the 'Loop Condition' containment reference.

        See CBLoopCondition for types of loop conditions that exist

        Returns:
        the value of the 'Loop Condition' containment reference.
        See Also:
        CBLoop.setLoopCondition(CBLoopCondition), BehaviorPackage.getCBLoop_LoopCondition()
      • setLoopCondition

        void setLoopCondition(com.ibm.rational.test.common.models.behavior.loop.CBLoopCondition value)
        Sets the value of the 'Loop Condition' containment reference.
        Parameters:
        value - the new value of the 'Loop Condition' containment reference.
        See Also:
        CBLoop.getLoopCondition()
      • isFinishLoopIterationBeforeStop

        boolean isFinishLoopIterationBeforeStop()
        Returns the value of the 'Finish Loop Iteration Before Stop' attribute. The default value is "false".

        This will delay the user stopping until the current loop iteration is done.

        Returns:
        the value of the 'Finish Loop Iteration Before Stop' attribute.
        See Also:
        CBLoop.setFinishLoopIterationBeforeStop(boolean), BehaviorPackage.getCBLoop_FinishLoopIterationBeforeStop()
IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2013. All rights reserved.