IBM Rational Performance Tester SDK

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 Summary
static String PACING_RATE
           
 
Fields inherited from interface com.ibm.rational.test.common.models.behavior.edit.CBEdit
MOVE_OLD_PARENT_FLAG
 
Method Summary
 com.ibm.rational.test.common.models.behavior.loop.CBLoopCondition getLoopCondition()
          Returns the value of the 'Loop Condition' containment reference
 long getPacingRate()
          Returns the value of the 'Pacing Rate' attribute.
 long getPacingRatePeriod()
          Returns the value of the 'Pacing Rate Period' attribute.
 boolean isEnablePacing()
          Returns the value of the 'Enable Pacing' attribute.
 boolean isFinishLoopIterationBeforeStop()
          Returns the value of the 'Finish Loop Iteration Before Stop' attribute.
 boolean isInitialDelay()
          Returns the value of the 'Initial Delay' attribute.
 boolean isRandomDistribution()
          Returns the value of the 'Random Distribution' attribute.
 void setEnablePacing(boolean value)
          Sets the value of the 'Enable Pacing' attribute
 void setFinishLoopIterationBeforeStop(boolean value)
          Sets the value of the 'Finish Loop Iteration Before Stop' attribute
 void setInitialDelay(boolean value)
          Sets the value of the 'Initial Delay' attribute
 void setLoopCondition(com.ibm.rational.test.common.models.behavior.loop.CBLoopCondition value)
          Sets the value of the 'Loop Condition' containment reference
 void setPacingRate(long value)
          Sets the value of the 'Pacing Rate' attribute
 void setPacingRatePeriod(long value)
          Sets the value of the 'Pacing Rate Period' attribute
 void setRandomDistribution(boolean value)
          Sets the value of the 'Random Distribution' attribute
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.CBBlock
getActions, getCBErrors, getCBRequirementTarget, processRemoval, setCBRequirementTarget
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.CBBlockElement
isControlBlock
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.CBActionElement
canDisable, canEnable, enable, getAction, getBooleanProperty, getByteProperty, getCharProperty, getDisabledCount, getDoubleProperty, getFloatProperty, getInheritedCBActionElements, getIntProperty, getLongProperty, getMovingFrom, getParent, getShortProperty, getStringProperty, getTransformID, getType, isAlwaysLog, isEnabled, isMoving, move, resetDisabledCount, setAction, setAlwaysLog, setDisabledCount, setEnabled, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setTransformID, setType, validate
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.CBNamedElement
getDescription, getId, getName, getStopId, setDescription, setId, setName
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.internal.CBTempData
getTempAttribute, getTempAttribute, getTempAttributes, setTempAttribute, setTempAttribute, unsetTempAttribute
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.edit.CBCloneable
doClone, isCloneable
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.edit.CBEdit
canCopy, canMove, doCopy, doMove, findProblemsWithCopy, findProblemsWithMove
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.errors.CBErrorHost
canHostCBErrors, isErrorGenerator
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.CBElementHost
getElements
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.cbdata.SubstituterHost
getSubstituters, substitutersToDisplay
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.cbdata.CBAttribute
getAttributeValue, getCharset
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.cbdata.CBElementModifier
modifyText
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.CBSyncPointHost
canHostSyncPoints, getSyncPoints
 

Field Detail

PACING_RATE

static final String PACING_RATE
See Also:
Constant Field Values
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()

setPacingRatePeriod

void setPacingRatePeriod(long value)
Sets the value of the 'Pacing Rate Period' attribute.

Parameters:
value - the new value of the 'Pacing Rate Period' attribute.
See Also:
CBLoop.getPacingRatePeriod()

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()

setRandomDistribution

void setRandomDistribution(boolean value)
Sets the value of the 'Random Distribution' attribute.

Parameters:
value - the new value of the 'Random Distribution' attribute.
See Also:
CBLoop.isRandomDistribution()

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()

setFinishLoopIterationBeforeStop

void setFinishLoopIterationBeforeStop(boolean value)
Sets the value of the 'Finish Loop Iteration Before Stop' attribute.

Parameters:
value - the new value of the 'Finish Loop Iteration Before Stop' attribute.
See Also:
CBLoop.isFinishLoopIterationBeforeStop()

IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.