Skip to content

Sequence

Type ISIAPISequence · Interface
Namespace SIDRASolutions.SI.API
Assembly SIDRASolutions.SI.API.dll
COM CLSID 3BE91ECF-5A7F-4DA5-8F7F-72C9E2320809

Declaration

[Guid("3BE91ECF-5A7F-4DA5-8F7F-72C9E2320809")]
public interface ISIAPISequence

Members

Properties

Property Type Summary
Name string
Position int The Sequence Position in the Site's Sequences collection. It is a zero-base integer.
Is_selected bool Get or Set this Sequence is selected for analysis. More than one Sequence can be selected for analysis.
Cycle_time_option int Cycle Time Option
Practical_max_cycle_time float
Practical_cycle_rounding_applied bool
Practical_cycle_rounding int
Optimum_cycle_time_lower_user bool
Optimum_cycle_time_lower int
Optimum_cycle_time_upper int
Optimum_cycle_time_increment int
Optimum_cycle_time_perf_measure int
Optimum_cycle_time_optim_method int
Optimum_max_green_percent_lower int
Optimum_max_green_percent_upper int
Optimum_max_green_percent_increment int
Optimum_max_green_perf_measure int
Optimum_max_green_optim_method int
Variable_phasing_perf_measure int
Usergiven_cycle_time float
Green_split_priority_option int Green Split Priority
Actuated_max_green_major_mov float
Actuated_max_green_minor_mov float
Actuated_gap_major_mov float
Actuated_gap_minor_mov float
Eff_det_zone_len_major_mov float
Eff_det_zone_len_minor_mov float
Site ISIAPISite
Phases ISIAPIPhases
LastErrorMessage string
Lane_blockage_effect_option int Lane Blockage Effect Option: In Network analysis, include Lane Blockage effects in determining Phase Times.
Is_timing_optimised_for_selected_result bool

Methods

Method Returns Summary
AddPhase(string) ISIAPIPhase Add a new Phase to the end of this Sequence.
RemovePhase(ISIAPIPhase) bool Remove a Phase from this Sequence.
InsertPhase(int, string) ISIAPIPhase Insert a new Phase into this Sequence at the specified position.
ClonePhase(ISIAPIPhase) ISIAPIPhase Clone a Phase.
MovePhaseTo(ISIAPIPhase, int) bool Move a Phase to a new position.

Properties

Name

string Name { get; set; }

Type string

Code samples
string name = sequence.Name;
sequence.Name = @"Example";
CComBSTR name;
sequence->get_Name(&name);
sequence->put_Name(CComBSTR(L"Example"));
name = sequence.Name
sequence.Name = r"Example"
$name = $sequence.Name
$sequence.Name = "Example"

Position

The Sequence Position in the Site's Sequences collection. It is a zero-base integer.

int Position { get; }

Type int

Code samples
int position = sequence.Position;
long position;
sequence->get_Position(&position);
position = sequence.Position
$position = $sequence.Position

Is_selected

Get or Set this Sequence is selected for analysis.
More than one Sequence can be selected for analysis.

bool Is_selected { get; set; }

Type bool

Code samples
bool is_selected = sequence.Is_selected;
sequence.Is_selected = true;
VARIANT_BOOL is_selected;
sequence->get_Is_selected(&is_selected);
sequence->put_Is_selected(VARIANT_TRUE);
is_selected = sequence.Is_selected
sequence.Is_selected = True
$is_selected = $sequence.Is_selected
$sequence.Is_selected = $true

Cycle_time_option

Cycle Time Option

int Cycle_time_option { get; set; }

Type int

Value

One of:

  • 0 - Practical Cycle Time
  • 1 - Optimum Cycle Time
  • 2 - User-Given Cycle Time
  • 3 - User-Given Phase Time
  • 4 - Optimum Maximum Green Settings
Code samples
int cycle_time_option = sequence.Cycle_time_option;
sequence.Cycle_time_option = 0;
long cycle_time_option;
sequence->get_Cycle_time_option(&cycle_time_option);
sequence->put_Cycle_time_option(0);
cycle_time_option = sequence.Cycle_time_option
sequence.Cycle_time_option = 0
$cycle_time_option = $sequence.Cycle_time_option
$sequence.Cycle_time_option = 0

Practical_max_cycle_time

float Practical_max_cycle_time { get; set; }

Type float

Code samples
float practical_max_cycle_time = sequence.Practical_max_cycle_time;
sequence.Practical_max_cycle_time = 0.0;
double practical_max_cycle_time;
sequence->get_Practical_max_cycle_time(&practical_max_cycle_time);
sequence->put_Practical_max_cycle_time(0.0);
practical_max_cycle_time = sequence.Practical_max_cycle_time
sequence.Practical_max_cycle_time = 0.0
$practical_max_cycle_time = $sequence.Practical_max_cycle_time
$sequence.Practical_max_cycle_time = 0.0

Practical_cycle_rounding_applied

bool Practical_cycle_rounding_applied { get; set; }

Type bool

Code samples
bool practical_cycle_rounding_applied = sequence.Practical_cycle_rounding_applied;
sequence.Practical_cycle_rounding_applied = true;
VARIANT_BOOL practical_cycle_rounding_applied;
sequence->get_Practical_cycle_rounding_applied(&practical_cycle_rounding_applied);
sequence->put_Practical_cycle_rounding_applied(VARIANT_TRUE);
practical_cycle_rounding_applied = sequence.Practical_cycle_rounding_applied
sequence.Practical_cycle_rounding_applied = True
$practical_cycle_rounding_applied = $sequence.Practical_cycle_rounding_applied
$sequence.Practical_cycle_rounding_applied = $true

Practical_cycle_rounding

int Practical_cycle_rounding { get; set; }

Type int

Code samples
int practical_cycle_rounding = sequence.Practical_cycle_rounding;
sequence.Practical_cycle_rounding = 0;
long practical_cycle_rounding;
sequence->get_Practical_cycle_rounding(&practical_cycle_rounding);
sequence->put_Practical_cycle_rounding(0);
practical_cycle_rounding = sequence.Practical_cycle_rounding
sequence.Practical_cycle_rounding = 0
$practical_cycle_rounding = $sequence.Practical_cycle_rounding
$sequence.Practical_cycle_rounding = 0

Optimum_cycle_time_lower_user

bool Optimum_cycle_time_lower_user { get; set; }

Type bool

Code samples
bool optimum_cycle_time_lower_user = sequence.Optimum_cycle_time_lower_user;
sequence.Optimum_cycle_time_lower_user = true;
VARIANT_BOOL optimum_cycle_time_lower_user;
sequence->get_Optimum_cycle_time_lower_user(&optimum_cycle_time_lower_user);
sequence->put_Optimum_cycle_time_lower_user(VARIANT_TRUE);
optimum_cycle_time_lower_user = sequence.Optimum_cycle_time_lower_user
sequence.Optimum_cycle_time_lower_user = True
$optimum_cycle_time_lower_user = $sequence.Optimum_cycle_time_lower_user
$sequence.Optimum_cycle_time_lower_user = $true

Optimum_cycle_time_lower

int Optimum_cycle_time_lower { get; set; }

Type int

Code samples
int optimum_cycle_time_lower = sequence.Optimum_cycle_time_lower;
sequence.Optimum_cycle_time_lower = 0;
long optimum_cycle_time_lower;
sequence->get_Optimum_cycle_time_lower(&optimum_cycle_time_lower);
sequence->put_Optimum_cycle_time_lower(0);
optimum_cycle_time_lower = sequence.Optimum_cycle_time_lower
sequence.Optimum_cycle_time_lower = 0
$optimum_cycle_time_lower = $sequence.Optimum_cycle_time_lower
$sequence.Optimum_cycle_time_lower = 0

Optimum_cycle_time_upper

int Optimum_cycle_time_upper { get; set; }

Type int

Code samples
int optimum_cycle_time_upper = sequence.Optimum_cycle_time_upper;
sequence.Optimum_cycle_time_upper = 0;
long optimum_cycle_time_upper;
sequence->get_Optimum_cycle_time_upper(&optimum_cycle_time_upper);
sequence->put_Optimum_cycle_time_upper(0);
optimum_cycle_time_upper = sequence.Optimum_cycle_time_upper
sequence.Optimum_cycle_time_upper = 0
$optimum_cycle_time_upper = $sequence.Optimum_cycle_time_upper
$sequence.Optimum_cycle_time_upper = 0

Optimum_cycle_time_increment

int Optimum_cycle_time_increment { get; set; }

Type int

Code samples
int optimum_cycle_time_increment = sequence.Optimum_cycle_time_increment;
sequence.Optimum_cycle_time_increment = 0;
long optimum_cycle_time_increment;
sequence->get_Optimum_cycle_time_increment(&optimum_cycle_time_increment);
sequence->put_Optimum_cycle_time_increment(0);
optimum_cycle_time_increment = sequence.Optimum_cycle_time_increment
sequence.Optimum_cycle_time_increment = 0
$optimum_cycle_time_increment = $sequence.Optimum_cycle_time_increment
$sequence.Optimum_cycle_time_increment = 0

Optimum_cycle_time_perf_measure

int Optimum_cycle_time_perf_measure { get; set; }

Type int

Code samples
int optimum_cycle_time_perf_measure = sequence.Optimum_cycle_time_perf_measure;
sequence.Optimum_cycle_time_perf_measure = 0;
long optimum_cycle_time_perf_measure;
sequence->get_Optimum_cycle_time_perf_measure(&optimum_cycle_time_perf_measure);
sequence->put_Optimum_cycle_time_perf_measure(0);
optimum_cycle_time_perf_measure = sequence.Optimum_cycle_time_perf_measure
sequence.Optimum_cycle_time_perf_measure = 0
$optimum_cycle_time_perf_measure = $sequence.Optimum_cycle_time_perf_measure
$sequence.Optimum_cycle_time_perf_measure = 0

Optimum_cycle_time_optim_method

int Optimum_cycle_time_optim_method { get; set; }

Type int

Code samples
int optimum_cycle_time_optim_method = sequence.Optimum_cycle_time_optim_method;
sequence.Optimum_cycle_time_optim_method = 0;
long optimum_cycle_time_optim_method;
sequence->get_Optimum_cycle_time_optim_method(&optimum_cycle_time_optim_method);
sequence->put_Optimum_cycle_time_optim_method(0);
optimum_cycle_time_optim_method = sequence.Optimum_cycle_time_optim_method
sequence.Optimum_cycle_time_optim_method = 0
$optimum_cycle_time_optim_method = $sequence.Optimum_cycle_time_optim_method
$sequence.Optimum_cycle_time_optim_method = 0

Optimum_max_green_percent_lower

int Optimum_max_green_percent_lower { get; set; }

Type int

Code samples
int optimum_max_green_percent_lower = sequence.Optimum_max_green_percent_lower;
sequence.Optimum_max_green_percent_lower = 0;
long optimum_max_green_percent_lower;
sequence->get_Optimum_max_green_percent_lower(&optimum_max_green_percent_lower);
sequence->put_Optimum_max_green_percent_lower(0);
optimum_max_green_percent_lower = sequence.Optimum_max_green_percent_lower
sequence.Optimum_max_green_percent_lower = 0
$optimum_max_green_percent_lower = $sequence.Optimum_max_green_percent_lower
$sequence.Optimum_max_green_percent_lower = 0

Optimum_max_green_percent_upper

int Optimum_max_green_percent_upper { get; set; }

Type int

Code samples
int optimum_max_green_percent_upper = sequence.Optimum_max_green_percent_upper;
sequence.Optimum_max_green_percent_upper = 0;
long optimum_max_green_percent_upper;
sequence->get_Optimum_max_green_percent_upper(&optimum_max_green_percent_upper);
sequence->put_Optimum_max_green_percent_upper(0);
optimum_max_green_percent_upper = sequence.Optimum_max_green_percent_upper
sequence.Optimum_max_green_percent_upper = 0
$optimum_max_green_percent_upper = $sequence.Optimum_max_green_percent_upper
$sequence.Optimum_max_green_percent_upper = 0

Optimum_max_green_percent_increment

int Optimum_max_green_percent_increment { get; set; }

Type int

Code samples
int optimum_max_green_percent_increment = sequence.Optimum_max_green_percent_increment;
sequence.Optimum_max_green_percent_increment = 0;
long optimum_max_green_percent_increment;
sequence->get_Optimum_max_green_percent_increment(&optimum_max_green_percent_increment);
sequence->put_Optimum_max_green_percent_increment(0);
optimum_max_green_percent_increment = sequence.Optimum_max_green_percent_increment
sequence.Optimum_max_green_percent_increment = 0
$optimum_max_green_percent_increment = $sequence.Optimum_max_green_percent_increment
$sequence.Optimum_max_green_percent_increment = 0

Optimum_max_green_perf_measure

int Optimum_max_green_perf_measure { get; set; }

Type int

Code samples
int optimum_max_green_perf_measure = sequence.Optimum_max_green_perf_measure;
sequence.Optimum_max_green_perf_measure = 0;
long optimum_max_green_perf_measure;
sequence->get_Optimum_max_green_perf_measure(&optimum_max_green_perf_measure);
sequence->put_Optimum_max_green_perf_measure(0);
optimum_max_green_perf_measure = sequence.Optimum_max_green_perf_measure
sequence.Optimum_max_green_perf_measure = 0
$optimum_max_green_perf_measure = $sequence.Optimum_max_green_perf_measure
$sequence.Optimum_max_green_perf_measure = 0

Optimum_max_green_optim_method

int Optimum_max_green_optim_method { get; set; }

Type int

Code samples
int optimum_max_green_optim_method = sequence.Optimum_max_green_optim_method;
sequence.Optimum_max_green_optim_method = 0;
long optimum_max_green_optim_method;
sequence->get_Optimum_max_green_optim_method(&optimum_max_green_optim_method);
sequence->put_Optimum_max_green_optim_method(0);
optimum_max_green_optim_method = sequence.Optimum_max_green_optim_method
sequence.Optimum_max_green_optim_method = 0
$optimum_max_green_optim_method = $sequence.Optimum_max_green_optim_method
$sequence.Optimum_max_green_optim_method = 0

Variable_phasing_perf_measure

int Variable_phasing_perf_measure { get; set; }

Type int

Code samples
int variable_phasing_perf_measure = sequence.Variable_phasing_perf_measure;
sequence.Variable_phasing_perf_measure = 0;
long variable_phasing_perf_measure;
sequence->get_Variable_phasing_perf_measure(&variable_phasing_perf_measure);
sequence->put_Variable_phasing_perf_measure(0);
variable_phasing_perf_measure = sequence.Variable_phasing_perf_measure
sequence.Variable_phasing_perf_measure = 0
$variable_phasing_perf_measure = $sequence.Variable_phasing_perf_measure
$sequence.Variable_phasing_perf_measure = 0

Usergiven_cycle_time

float Usergiven_cycle_time { get; set; }

Type float

Code samples
float usergiven_cycle_time = sequence.Usergiven_cycle_time;
sequence.Usergiven_cycle_time = 0.0;
double usergiven_cycle_time;
sequence->get_Usergiven_cycle_time(&usergiven_cycle_time);
sequence->put_Usergiven_cycle_time(0.0);
usergiven_cycle_time = sequence.Usergiven_cycle_time
sequence.Usergiven_cycle_time = 0.0
$usergiven_cycle_time = $sequence.Usergiven_cycle_time
$sequence.Usergiven_cycle_time = 0.0

Green_split_priority_option

Green Split Priority

int Green_split_priority_option { get; set; }

Type int

Value

One of:

  • 0 - None
  • 1 - Coordinated Movements
  • 2 - User-Specified Movements
Code samples
int green_split_priority_option = sequence.Green_split_priority_option;
sequence.Green_split_priority_option = 0;
long green_split_priority_option;
sequence->get_Green_split_priority_option(&green_split_priority_option);
sequence->put_Green_split_priority_option(0);
green_split_priority_option = sequence.Green_split_priority_option
sequence.Green_split_priority_option = 0
$green_split_priority_option = $sequence.Green_split_priority_option
$sequence.Green_split_priority_option = 0

Actuated_max_green_major_mov

float Actuated_max_green_major_mov { get; set; }

Type float

Code samples
float actuated_max_green_major_mov = sequence.Actuated_max_green_major_mov;
sequence.Actuated_max_green_major_mov = 0.0;
double actuated_max_green_major_mov;
sequence->get_Actuated_max_green_major_mov(&actuated_max_green_major_mov);
sequence->put_Actuated_max_green_major_mov(0.0);
actuated_max_green_major_mov = sequence.Actuated_max_green_major_mov
sequence.Actuated_max_green_major_mov = 0.0
$actuated_max_green_major_mov = $sequence.Actuated_max_green_major_mov
$sequence.Actuated_max_green_major_mov = 0.0

Actuated_max_green_minor_mov

float Actuated_max_green_minor_mov { get; set; }

Type float

Code samples
float actuated_max_green_minor_mov = sequence.Actuated_max_green_minor_mov;
sequence.Actuated_max_green_minor_mov = 0.0;
double actuated_max_green_minor_mov;
sequence->get_Actuated_max_green_minor_mov(&actuated_max_green_minor_mov);
sequence->put_Actuated_max_green_minor_mov(0.0);
actuated_max_green_minor_mov = sequence.Actuated_max_green_minor_mov
sequence.Actuated_max_green_minor_mov = 0.0
$actuated_max_green_minor_mov = $sequence.Actuated_max_green_minor_mov
$sequence.Actuated_max_green_minor_mov = 0.0

Actuated_gap_major_mov

float Actuated_gap_major_mov { get; set; }

Type float

Code samples
float actuated_gap_major_mov = sequence.Actuated_gap_major_mov;
sequence.Actuated_gap_major_mov = 0.0;
double actuated_gap_major_mov;
sequence->get_Actuated_gap_major_mov(&actuated_gap_major_mov);
sequence->put_Actuated_gap_major_mov(0.0);
actuated_gap_major_mov = sequence.Actuated_gap_major_mov
sequence.Actuated_gap_major_mov = 0.0
$actuated_gap_major_mov = $sequence.Actuated_gap_major_mov
$sequence.Actuated_gap_major_mov = 0.0

Actuated_gap_minor_mov

float Actuated_gap_minor_mov { get; set; }

Type float

Code samples
float actuated_gap_minor_mov = sequence.Actuated_gap_minor_mov;
sequence.Actuated_gap_minor_mov = 0.0;
double actuated_gap_minor_mov;
sequence->get_Actuated_gap_minor_mov(&actuated_gap_minor_mov);
sequence->put_Actuated_gap_minor_mov(0.0);
actuated_gap_minor_mov = sequence.Actuated_gap_minor_mov
sequence.Actuated_gap_minor_mov = 0.0
$actuated_gap_minor_mov = $sequence.Actuated_gap_minor_mov
$sequence.Actuated_gap_minor_mov = 0.0

Eff_det_zone_len_major_mov

float Eff_det_zone_len_major_mov { get; set; }

Type float

Code samples
float eff_det_zone_len_major_mov = sequence.Eff_det_zone_len_major_mov;
sequence.Eff_det_zone_len_major_mov = 0.0;
double eff_det_zone_len_major_mov;
sequence->get_Eff_det_zone_len_major_mov(&eff_det_zone_len_major_mov);
sequence->put_Eff_det_zone_len_major_mov(0.0);
eff_det_zone_len_major_mov = sequence.Eff_det_zone_len_major_mov
sequence.Eff_det_zone_len_major_mov = 0.0
$eff_det_zone_len_major_mov = $sequence.Eff_det_zone_len_major_mov
$sequence.Eff_det_zone_len_major_mov = 0.0

Eff_det_zone_len_minor_mov

float Eff_det_zone_len_minor_mov { get; set; }

Type float

Code samples
float eff_det_zone_len_minor_mov = sequence.Eff_det_zone_len_minor_mov;
sequence.Eff_det_zone_len_minor_mov = 0.0;
double eff_det_zone_len_minor_mov;
sequence->get_Eff_det_zone_len_minor_mov(&eff_det_zone_len_minor_mov);
sequence->put_Eff_det_zone_len_minor_mov(0.0);
eff_det_zone_len_minor_mov = sequence.Eff_det_zone_len_minor_mov
sequence.Eff_det_zone_len_minor_mov = 0.0
$eff_det_zone_len_minor_mov = $sequence.Eff_det_zone_len_minor_mov
$sequence.Eff_det_zone_len_minor_mov = 0.0

Site

ISIAPISite Site { get; }

Type ISIAPISite

Code samples
var site = sequence.Site;
CComPtr<ISIAPISite> site;
sequence->get_Site(&site);
site = sequence.Site
$site = $sequence.Site

Phases

ISIAPIPhases Phases { get; }

Type ISIAPIPhases

Code samples
var phases = sequence.Phases;
CComPtr<ISIAPIPhases> phases;
sequence->get_Phases(&phases);
phases = sequence.Phases
$phases = $sequence.Phases

LastErrorMessage

string LastErrorMessage { get; }

Type string

Code samples
string lastErrorMessage = sequence.LastErrorMessage;
CComBSTR lastErrorMessage;
sequence->get_LastErrorMessage(&lastErrorMessage);
last_error_message = sequence.LastErrorMessage
$lastErrorMessage = $sequence.LastErrorMessage

Lane_blockage_effect_option

Lane Blockage Effect Option:
In Network analysis, include Lane Blockage effects in determining Phase Times.

int Lane_blockage_effect_option { get; set; }

Type int

Value

One of:

  • 0 - Without Lane Blockage Effects
  • 1 - With Lane Blockage Effects
Code samples
int lane_blockage_effect_option = sequence.Lane_blockage_effect_option;
sequence.Lane_blockage_effect_option = 0;
long lane_blockage_effect_option;
sequence->get_Lane_blockage_effect_option(&lane_blockage_effect_option);
sequence->put_Lane_blockage_effect_option(0);
lane_blockage_effect_option = sequence.Lane_blockage_effect_option
sequence.Lane_blockage_effect_option = 0
$lane_blockage_effect_option = $sequence.Lane_blockage_effect_option
$sequence.Lane_blockage_effect_option = 0

Is_timing_optimised_for_selected_result

bool Is_timing_optimised_for_selected_result { get; set; }

Type bool

Code samples
bool is_timing_optimised_for_selected_result = sequence.Is_timing_optimised_for_selected_result;
sequence.Is_timing_optimised_for_selected_result = true;
VARIANT_BOOL is_timing_optimised_for_selected_result;
sequence->get_Is_timing_optimised_for_selected_result(&is_timing_optimised_for_selected_result);
sequence->put_Is_timing_optimised_for_selected_result(VARIANT_TRUE);
is_timing_optimised_for_selected_result = sequence.Is_timing_optimised_for_selected_result
sequence.Is_timing_optimised_for_selected_result = True
$is_timing_optimised_for_selected_result = $sequence.Is_timing_optimised_for_selected_result
$sequence.Is_timing_optimised_for_selected_result = $true

Methods

AddPhase(string)

Add a new Phase to the end of this Sequence.

ISIAPIPhase AddPhase(string name)

Parameters

Name Type Description
name string The name of the new Phase.

Returns ISIAPIPhase - The new added Phase.

Code samples
var result = sequence.AddPhase(@"Example");
CComPtr<ISIAPIPhase> result;
sequence->AddPhase(CComBSTR(L"Example"), &result);
result = sequence.AddPhase(r"Example")
$result = $sequence.AddPhase("Example")

RemovePhase(ISIAPIPhase)

Remove a Phase from this Sequence.

bool RemovePhase(ISIAPIPhase phase)

Parameters

Name Type Description
phase ISIAPIPhase The Phase to remove.

Returns bool - true if the Phase is successfully removed; otherwise, false. This method also returns false if the Phase does not exist in this Sequence.

Code samples
bool result = sequence.RemovePhase(null);
VARIANT_BOOL result;
sequence->RemovePhase(NULL, &result);
result = sequence.RemovePhase(None)
$result = $sequence.RemovePhase($null)

InsertPhase(int, string)

Insert a new Phase into this Sequence at the specified position.

ISIAPIPhase InsertPhase(int position, string name)

Parameters

Name Type Description
position int The zero-based position at which the new Phase should be inserted.
name string The name of the new Phase.

Returns ISIAPIPhase - The new added Phase.

Code samples
var result = sequence.InsertPhase(0, @"Example");
CComPtr<ISIAPIPhase> result;
sequence->InsertPhase(0, CComBSTR(L"Example"), &result);
result = sequence.InsertPhase(0, r"Example")
$result = $sequence.InsertPhase(0, "Example")

ClonePhase(ISIAPIPhase)

Clone a Phase.

ISIAPIPhase ClonePhase(ISIAPIPhase phase)

Parameters

Name Type Description
phase ISIAPIPhase The Phase to clone.

Returns ISIAPIPhase - The new cloned Phase.

Code samples
var result = sequence.ClonePhase(null);
CComPtr<ISIAPIPhase> result;
sequence->ClonePhase(NULL, &result);
result = sequence.ClonePhase(None)
$result = $sequence.ClonePhase($null)

MovePhaseTo(ISIAPIPhase, int)

Move a Phase to a new position.

bool MovePhaseTo(ISIAPIPhase phase, int newPosition)

Parameters

Name Type Description
phase ISIAPIPhase The Phase to move.
newPosition int The zero-based position that the Phase should be moved to.

Returns bool - true if the Phase is successfully moved; otherwise, false. This method also returns false if the Phase does not exist in this Sequence.

Code samples
bool result = sequence.MovePhaseTo(null, 0);
VARIANT_BOOL result;
sequence->MovePhaseTo(NULL, 0, &result);
result = sequence.MovePhaseTo(None, 0)
$result = $sequence.MovePhaseTo($null, 0)