CProfile Class: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) (Created page with '{{DISPLAYTITLE:cProfile Class}}{{Template:API}}{{Template:APIBreadcrumb}}{{InProgress}} <onlyinclude>Represents a profile resource.</onlyinclude> ==Constructors== {| {{APITabl…') |
Kate Racaza (talk | contribs) No edit summary |
||
| Line 27: | Line 27: | ||
| style="width: 220px;"|ID||Gets the numeric ID of the profile. '''Long'''. | | style="width: 220px;"|ID||Gets the numeric ID of the profile. '''Long'''. | ||
|- | |- | ||
|IsCyclical||. '''Boolean'''. | |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||. '''Boolean'''. | |IsValidated||Indicates whether the profile is ready for use in ALTA or BlockSim analyses. '''Boolean'''. Default value = False. | ||
|- | |- | ||
|{{Template:API_TxtIdentifiers}} | |{{Template:API_TxtIdentifiers}} | ||
| Line 35: | Line 35: | ||
|Name||Gets or sets the name of the profile. '''String''' | |Name||Gets or sets the name of the profile. '''String''' | ||
|- | |- | ||
|ProfileType|| | |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''' | ||
Revision as of 18:17, 27 September 2016
 |
Member of: SynthesisAPI Template:InProgress
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 in ALTA or BlockSim analyses. Boolean. Default value = False. |
| ItemApplication | Gets or sets the item's application. (Synthesis identifier) String |
| ItemCategoryID | Gets or sets the category ID. (Synthesis identifier) Integer |
| ItemComments | Gets or sets the comments. (Synthesis identifier) String |
| ItemDescription | Gets or sets the description. (Synthesis identifier) String |
| ItemKeywords | Gets or sets the keywords. (Synthesis identifier) String |
| ItemPartNumber | Gets or sets the part number. (Synthesis identifier) String |
| ItemSupplier | Gets or sets the supplier name. (Synthesis identifier) String |
| ItemVersion | Gets or sets the version number. (Synthesis identifier) 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). |
| ProjectID | Gets the numeric ID of the project the profile belongs to. Integer |