Share via


LoadTestStepLoadProfile Class

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

Inheritance Hierarchy

Object
  Microsoft.VisualStudio.TestTools.LoadTesting.LoadTestLoadProfile
    Microsoft.VisualStudio.TestTools.LoadTesting.LoadTestStepLoadProfile

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

Syntax

'Declaration
<SerializableAttribute> _
Public Class LoadTestStepLoadProfile _
    Inherits LoadTestLoadProfile
[SerializableAttribute]
public class LoadTestStepLoadProfile : LoadTestLoadProfile
[SerializableAttribute]
public ref class LoadTestStepLoadProfile : public LoadTestLoadProfile
[<SerializableAttribute>]
type LoadTestStepLoadProfile =  
    class 
        inherit LoadTestLoadProfile 
    end
public class LoadTestStepLoadProfile extends LoadTestLoadProfile

The LoadTestStepLoadProfile type exposes the following members.

Constructors

  Name Description
Public method LoadTestStepLoadProfile Initializes a new instance of the LoadTestStepLoadProfile class.

Top

Properties

  Name Description
Public property InitialUserCount Gets or sets the initial user count, in the case in which you are using the step load pattern.
Public property MaxUserCount Gets or sets the maximum user count, in the case in which you are using the step load pattern. (Overrides LoadTestLoadProfile.MaxUserCount.)
Public property MinUserCount Gets 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 property ScenarioName Gets or sets the name of the scenario in the load test that the load profile implementation is controlling. (Inherited from LoadTestLoadProfile.)
Public property StepDuration Gets or sets the amount of time between steps in seconds.
Public property StepRampTime Gets or sets the amount of time that it takes in each step to gradually add the users specified by the step user count.
Public property StepUserCount Gets or sets the number of users to increase at each step, in the case in which you are using a step load pattern.

Top

Methods

  Name Description
Public method CheckIfProfileCanBeModified Throws an exception if the profile property is not yet ready to be modified. (Inherited from LoadTestLoadProfile.)
Public method Copy Returns a copy of the current object so it can be modified and assigned to the LoadTestScenario.LoadProfile property. (Inherited from LoadTestLoadProfile.)
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetLoad Returns 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 method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method RestoreUserCountAfterRestart Restores the current user count to the value it had before the restart. (Inherited from LoadTestLoadProfile.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method Validate Throws an InvalidLoadProfileException if the LoadProfile object has invalid or inconsistent properties. (Overrides LoadTestLoadProfile.Validate().)

Top

Thread Safety

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

See Also

Reference

Microsoft.VisualStudio.TestTools.LoadTesting Namespace

Other Resources

About Load Pattern

How to: Create a Load Test Plug-In