Difference between revisions of "CProfile Class"

From ReliaWiki
Jump to navigation Jump to search
Line 7: Line 7:
 
{| {{APITable}}
 
{| {{APITable}}
 
|-
 
|-
| style="width: 220px;"|cProfile||Creates an instance of the cProfile class.
+
| style="width: 150px;"|cProfile||Creates an instance of the cProfile class.
 
|-
 
|-
 
|[[cProfile Constructors|cProfile()]]||{{:CProfile Constructors}}
 
|[[cProfile Constructors|cProfile()]]||{{:CProfile Constructors}}
Line 16: Line 16:
 
{| {{APITable}}
 
{| {{APITable}}
 
|-
 
|-
| style="width: 220px;"|[[cProfile.GetSegments|GetSegments]]||{{:CProfile.GetSegments}}
+
| style="width: 150px;"|[[cProfile.GetSegments|GetSegments]]||{{:CProfile.GetSegments}}
 
|-
 
|-
 
|[[cProfile.SetSegments|SetSegments]]||{{:CProfile.SetSegments}}
 
|[[cProfile.SetSegments|SetSegments]]||{{:CProfile.SetSegments}}
Line 25: Line 25:
 
{| {{APITable}}
 
{| {{APITable}}
 
|-
 
|-
| style="width: 220px;"|ID||Gets the numeric ID of the profile. '''Long'''.
+
| 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.  

Revision as of 23:44, 27 September 2016

APIWiki.png


Member of: SynthesisAPI

DRAFT GRAY.png

WORK IN PROGRESS
CProfile Class

DRAFT GRAY.png


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.
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



See Also