Difference between revisions of "CProfile.SetSegments"

From ReliaWiki
Jump to navigation Jump to search
Line 2: Line 2:
  
  
<onlyinclude>Adds a new segment to the profile.</onlyinclude>
+
<onlyinclude>Adds segments to the profile.</onlyinclude>
  
 
== Syntax ==
 
== Syntax ==
Line 36: Line 36:
 
   {{APIPrefix|Set}} listOfSegments(1) = segment
 
   {{APIPrefix|Set}} listOfSegments(1) = segment
 
      
 
      
  {{APIComment|'Apply the segments to the profile.}}
+
  {{APIComment|'Add the segments to the profile.}}
 
   myResource.SetSegments listOfSegments
 
   myResource.SetSegments listOfSegments
 
    
 
    
Line 59: Line 59:
 
       {{APIPrefix|New}} SynthesisAPI.ProfileSegment {{APIPrefix|With}} {.SegmentEnd = 3, .Value = {{APIString|"T+2"}}}}
 
       {{APIPrefix|New}} SynthesisAPI.ProfileSegment {{APIPrefix|With}} {.SegmentEnd = 3, .Value = {{APIString|"T+2"}}}}
 
   
 
   
  {{APIComment|'Apply the segments to the profile.}}
+
  {{APIComment|'Add the segments to the profile.}}
 
   myResource.SetSegments(listOfSegments)
 
   myResource.SetSegments(listOfSegments)
 
   
 
   

Revision as of 17:51, 3 October 2016

APIWiki.png


Member of: SynthesisAPI.cProfile

DRAFT GRAY.png

WORK IN PROGRESS
CProfile.SetSegments

DRAFT GRAY.png


Adds segments to the profile.

Syntax

.SetSegment(ByRef arr()) 

Parameters

arr

Required. An array of ProfileSegment objects.


Example

VBA

 'Create a new resource profile and define its properties. 
  Dim myResource As New SynthesisAPI.cProfile
  myResource.Name = "SampleProfile"
  myResource.ProfileType = ProfileTypeEnum_Stress
  myResource.IsCyclical = True
 
 'Define two segments for the profile. 
  Dim segment As SynthesisAPI.ProfileSegment
  Dim listOfSegments(1) As SynthesisAPI.ProfileSegment
       
  Set segment = New SynthesisAPI.ProfileSegment
  segment.SegmentEnd = 1
  segment.Value = 1
  Set listOfSegments(0) = segment
       
  Set segment = New SynthesisAPI.ProfileSegment
  segment.SegmentEnd = 3
  segment.Value = "T+2"
  Set listOfSegments(1) = segment
   
 'Add the segments to the profile. 
  myResource.SetSegments listOfSegments
 
 'Connect to a Synthesis repository. 
  Dim myRepository As New Repository
  myRepository.ConnectToAccessRepository ("C:\RSRepository1.rsr11")
 
 'Add the profile to the first project in the repository. 
  myRepository.Project.SetCurrentProject (1)
  Call myRepository.profile.AddProfile(myResource)
VB.NET

 'Create a new resource profile and define its properties. 
  Dim myResource As New SynthesisAPI.cProfile("SampleProfile")
  myResource.ProfileType = SynthesisAPI.ProfileTypeEnum.Stress
  myResource.IsCyclical = True

 'Define two segments for the profile. 
  Dim listOfSegments() As SynthesisAPI.ProfileSegment _
      = {New SynthesisAPI.ProfileSegment With {.SegmentEnd = 1, .Value = 1}, _
      New SynthesisAPI.ProfileSegment With {.SegmentEnd = 3, .Value = "T+2"}}

 'Add the segments to the profile. 
  myResource.SetSegments(listOfSegments)

 'Connect to a Synthesis repository. 
  Dim myRepository As New SynthesisAPI.Repository
  myRepository.ConnectToAccessRepository("C:\RSRepository1.rsr11")

 'Add the profile to the first project in the repository. 
  myRepository.Project.SetCurrentProject(1)
  myRepository.Profile.AddProfile(myResource)