This documentation is archived and is not being maintained.

LoadTestStepLoadProfile Class

Represents the load profile of a load test that has a step load pattern.


Namespace:  Microsoft.VisualStudio.TestTools.LoadTesting
Assembly:  Microsoft.VisualStudio.QualityTools.LoadTestFramework (in Microsoft.VisualStudio.QualityTools.LoadTestFramework.dll)

public class LoadTestStepLoadProfile : LoadTestLoadProfile

The LoadTestStepLoadProfile type exposes the following members.

Public methodLoadTestStepLoadProfileInitializes a new instance of the LoadTestStepLoadProfile class.

Public propertyInitialUserCountGets or sets the initial user count, in the case in which you are using the step load pattern.
Public propertyMaxUserCountGets or sets the maximum user count, in the case in which you are using the step load pattern. (Overrides LoadTestLoadProfile.MaxUserCount.)
Public propertyMinUserCountGets or sets the minimum number of users that that can be returned by the GetLoad method of the class extending LoadTestLoadProfile. (Inherited from LoadTestLoadProfile.)
Public propertyScenarioNameGets or sets the name of the scenario in the load test that the load profile implementation is controlling. (Inherited from LoadTestLoadProfile.)
Public propertyStepDurationGets or sets the amount of time between steps in seconds.
Public propertyStepRampTimeGets or sets the amount of time that it takes in each step to gradually add the users specified by the step user count.
Public propertyStepUserCountGets or sets the number of users to increase at each step, in the case in which you are using a step load pattern.

Public methodCheckIfProfileCanBeModifiedThrows an exception if the profile property is not yet ready to be modified. (Inherited from LoadTestLoadProfile.)
Public methodCopyReturns a copy of the current object so it can be modified and assigned to the LoadTestScenario.LoadProfile property. (Inherited from LoadTestLoadProfile.)
Public methodEqualsDetermines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetLoadReturns the user load that should be used at the current time in the load test based on the value of elapsedSeconds since the start of the load test passed as an argument. (Overrides LoadTestLoadProfile.GetLoad(Int32).)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodRestoreUserCountAfterRestartRestores the current user count to the value it had before the restart. (Inherited from LoadTestLoadProfile.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodValidateThrows an InvalidLoadProfileException if the LoadProfile object has invalid or inconsistent properties. (Overrides LoadTestLoadProfile.Validate().)

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.