CProfile Class: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) No edit summary |
Kate Racaza (talk | contribs) No edit summary |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:cProfile Class}}{{Template:API}}{{Template:APIBreadcrumb | {{DISPLAYTITLE:cProfile Class}}{{Template:API}}{{Template:APIBreadcrumb}} | ||
<onlyinclude>Represents a profile resource.</onlyinclude> | <onlyinclude>Represents a profile resource.</onlyinclude> | ||
==Constructors== | ==Constructors== | ||
{| {{APITable}} | {| {{APITable}} | ||
|- | |- | ||
| style="width: | | style="width: 150px;"|cProfile||Creates an instance of the cProfile class. | ||
|- | |- | ||
|[[cProfile Constructors|cProfile()]]||{{:CProfile Constructors}} | |[[cProfile Constructors|cProfile()]]||{{:CProfile Constructors}} | ||
| Line 16: | Line 17: | ||
{| {{APITable}} | {| {{APITable}} | ||
|- | |- | ||
| style="width: | | style="width: 150px;"|[[cProfile.GetSegments|GetSegments]]||{{:CProfile.GetSegments}} | ||
|- | |- | ||
|SetSegments||{{:CProfile.SetSegments}} | |[[cProfile.SetSegments|SetSegments]]||{{:CProfile.SetSegments}} | ||
|} | |} | ||
| Line 25: | Line 26: | ||
{| {{APITable}} | {| {{APITable}} | ||
|- | |- | ||
| style="width: | | style="width: 150px;"|ID||Gets the numeric ID of the profile. '''Long'''. | ||
|- | |- | ||
|IsCyclical||Indicates whether the pattern of segments are treated as a repeating cycle; otherwise, all times after the last segment will use the value of the last segment. '''Boolean'''. Default value = False. | |IsCyclical||Indicates whether the pattern of segments are treated as a repeating cycle; otherwise, all times after the last segment will use the value of the last segment. '''Boolean'''. Default value = False. | ||
|- | |- | ||
|IsValidated||Indicates whether the profile is ready for use | |IsValidated||Indicates whether the profile is ready for use. '''Boolean'''. Default value = False. | ||
|- | |- | ||
|Name||Gets or sets the name of the profile. '''String''' | |Name||Gets or sets the name of the profile. '''String''' | ||
|- | |- | ||
|ProfileType||Gets or sets a value from the [[ProfileTypeEnum]] enumeration, which specifies whether it is a stress profile or throughput profile. Default value = 1 (stress profile). | |ProfileType||Gets or sets a value from the '''[[ProfileTypeEnum]]''' enumeration, which specifies whether it is a stress profile or throughput profile. Default value = 1 (stress profile). | ||
|- | |- | ||
|ProjectID||Gets the numeric ID of the project the profile belongs to. '''Integer''' | |ProjectID||Gets the numeric ID of the project the profile belongs to. '''Integer''' | ||
Latest revision as of 22:16, 22 March 2017
 |
Member of: SynthesisAPI
Represents a profile resource.
Constructors
| Name | Description |
|---|---|
| cProfile | Creates an instance of the cProfile class. |
| cProfile() | A parameterized constructor for the cProfile class. (.NET only) |
Methods
| Name | Description |
|---|---|
| GetSegments | Returns an array of ProfileSegment objects that represent the segments in the profile. |
| SetSegments | Adds segments to the profile. |
Properties
| Name | Description |
|---|---|
| ID | Gets the numeric ID of the profile. Long. |
| IsCyclical | Indicates whether the pattern of segments are treated as a repeating cycle; otherwise, all times after the last segment will use the value of the last segment. Boolean. Default value = False. |
| IsValidated | Indicates whether the profile is ready for use. Boolean. Default value = False. |
| Name | Gets or sets the name of the profile. String |
| ProfileType | Gets or sets a value from the ProfileTypeEnum enumeration, which specifies whether it is a stress profile or throughput profile. Default value = 1 (stress profile). |
| ProjectID | Gets the numeric ID of the project the profile belongs to. Integer |