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

Get an instance¶

C#VB.NETPythonPowerShell

// Navigate to the ISIAPISequence you need via the ISIAPI tree.
// See ISIAPI for the activation root.
var sequence = /* ... */;

' Navigate to the ISIAPISequence you need via the ISIAPI tree.
' See ISIAPI for the activation root.
Dim sequence As ISIAPISequence = Nothing

# Navigate to the ISIAPISequence you need via the ISIAPI tree.
# See ISIAPI for the activation root.
sequence = ...

# Navigate to the ISIAPISequence you need via the ISIAPI tree.
# See ISIAPI for the activation root.
$sequence = $null

Properties¶

Name¶

string Name { get; set; }

Type string

Code samples

C#VB.NETPythonPowerShell

string name = sequence.Name;
sequence.Name = @"Example";

Dim name As String = sequence.Name
sequence.Name = "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

C#VB.NETPythonPowerShell

int position = sequence.Position;

Dim position As Integer = sequence.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

C#VB.NETPythonPowerShell

bool is_selected = sequence.Is_selected;
sequence.Is_selected = true;

Dim is_selected As Boolean = sequence.Is_selected
sequence.Is_selected = 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

C#VB.NETPythonPowerShell

int cycle_time_option = sequence.Cycle_time_option;
sequence.Cycle_time_option = 0;

Dim cycle_time_option As Integer = sequence.Cycle_time_option
sequence.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

C#VB.NETPythonPowerShell

float practical_max_cycle_time = sequence.Practical_max_cycle_time;
sequence.Practical_max_cycle_time = 0.0;

Dim practical_max_cycle_time As Single = 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_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

C#VB.NETPythonPowerShell

bool practical_cycle_rounding_applied = sequence.Practical_cycle_rounding_applied;
sequence.Practical_cycle_rounding_applied = true;

Dim practical_cycle_rounding_applied As Boolean = 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_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

C#VB.NETPythonPowerShell

int practical_cycle_rounding = sequence.Practical_cycle_rounding;
sequence.Practical_cycle_rounding = 0;

Dim practical_cycle_rounding As Integer = sequence.Practical_cycle_rounding
sequence.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

C#VB.NETPythonPowerShell

bool optimum_cycle_time_lower_user = sequence.Optimum_cycle_time_lower_user;
sequence.Optimum_cycle_time_lower_user = true;

Dim optimum_cycle_time_lower_user As Boolean = 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_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

C#VB.NETPythonPowerShell

int optimum_cycle_time_lower = sequence.Optimum_cycle_time_lower;
sequence.Optimum_cycle_time_lower = 0;

Dim optimum_cycle_time_lower As Integer = 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_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

C#VB.NETPythonPowerShell

int optimum_cycle_time_upper = sequence.Optimum_cycle_time_upper;
sequence.Optimum_cycle_time_upper = 0;

Dim optimum_cycle_time_upper As Integer = 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_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

C#VB.NETPythonPowerShell

int optimum_cycle_time_increment = sequence.Optimum_cycle_time_increment;
sequence.Optimum_cycle_time_increment = 0;

Dim optimum_cycle_time_increment As Integer = 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_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

C#VB.NETPythonPowerShell

int optimum_cycle_time_perf_measure = sequence.Optimum_cycle_time_perf_measure;
sequence.Optimum_cycle_time_perf_measure = 0;

Dim optimum_cycle_time_perf_measure As Integer = 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_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

C#VB.NETPythonPowerShell

int optimum_cycle_time_optim_method = sequence.Optimum_cycle_time_optim_method;
sequence.Optimum_cycle_time_optim_method = 0;

Dim optimum_cycle_time_optim_method As Integer = 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_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

C#VB.NETPythonPowerShell

int optimum_max_green_percent_lower = sequence.Optimum_max_green_percent_lower;
sequence.Optimum_max_green_percent_lower = 0;

Dim optimum_max_green_percent_lower As Integer = 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_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

C#VB.NETPythonPowerShell

int optimum_max_green_percent_upper = sequence.Optimum_max_green_percent_upper;
sequence.Optimum_max_green_percent_upper = 0;

Dim optimum_max_green_percent_upper As Integer = 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_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

C#VB.NETPythonPowerShell

int optimum_max_green_percent_increment = sequence.Optimum_max_green_percent_increment;
sequence.Optimum_max_green_percent_increment = 0;

Dim optimum_max_green_percent_increment As Integer = 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_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

C#VB.NETPythonPowerShell

int optimum_max_green_perf_measure = sequence.Optimum_max_green_perf_measure;
sequence.Optimum_max_green_perf_measure = 0;

Dim optimum_max_green_perf_measure As Integer = 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_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

C#VB.NETPythonPowerShell

int optimum_max_green_optim_method = sequence.Optimum_max_green_optim_method;
sequence.Optimum_max_green_optim_method = 0;

Dim optimum_max_green_optim_method As Integer = 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

$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

C#VB.NETPythonPowerShell

int variable_phasing_perf_measure = sequence.Variable_phasing_perf_measure;
sequence.Variable_phasing_perf_measure = 0;

Dim variable_phasing_perf_measure As Integer = 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

$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

C#VB.NETPythonPowerShell

float usergiven_cycle_time = sequence.Usergiven_cycle_time;
sequence.Usergiven_cycle_time = 0.0;

Dim usergiven_cycle_time As Single = sequence.Usergiven_cycle_time
sequence.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

C#VB.NETPythonPowerShell

int green_split_priority_option = sequence.Green_split_priority_option;
sequence.Green_split_priority_option = 0;

Dim green_split_priority_option As Integer = 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

$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

C#VB.NETPythonPowerShell

float actuated_max_green_major_mov = sequence.Actuated_max_green_major_mov;
sequence.Actuated_max_green_major_mov = 0.0;

Dim actuated_max_green_major_mov As Single = 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_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

C#VB.NETPythonPowerShell

float actuated_max_green_minor_mov = sequence.Actuated_max_green_minor_mov;
sequence.Actuated_max_green_minor_mov = 0.0;

Dim actuated_max_green_minor_mov As Single = 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_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

C#VB.NETPythonPowerShell

float actuated_gap_major_mov = sequence.Actuated_gap_major_mov;
sequence.Actuated_gap_major_mov = 0.0;

Dim actuated_gap_major_mov As Single = 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_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

C#VB.NETPythonPowerShell

float actuated_gap_minor_mov = sequence.Actuated_gap_minor_mov;
sequence.Actuated_gap_minor_mov = 0.0;

Dim actuated_gap_minor_mov As Single = 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

$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

C#VB.NETPythonPowerShell

float eff_det_zone_len_major_mov = sequence.Eff_det_zone_len_major_mov;
sequence.Eff_det_zone_len_major_mov = 0.0;

Dim eff_det_zone_len_major_mov As Single = 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_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

C#VB.NETPythonPowerShell

float eff_det_zone_len_minor_mov = sequence.Eff_det_zone_len_minor_mov;
sequence.Eff_det_zone_len_minor_mov = 0.0;

Dim eff_det_zone_len_minor_mov As Single = 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

$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

C#VB.NETPythonPowerShell

var site = sequence.Site;

Dim site As ISIAPISite = sequence.Site

site = sequence.Site

$site = $sequence.Site

Phases¶

ISIAPIPhases Phases { get; }

Type ISIAPIPhases

Code samples

C#VB.NETPythonPowerShell

var phases = sequence.Phases;

Dim phases As ISIAPIPhases = sequence.Phases

phases = sequence.Phases

$phases = $sequence.Phases

LastErrorMessage¶

string LastErrorMessage { get; }

Type string

Code samples

C#VB.NETPythonPowerShell

string lastErrorMessage = sequence.LastErrorMessage;

Dim lastErrorMessage As String = sequence.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

C#VB.NETPythonPowerShell

int lane_blockage_effect_option = sequence.Lane_blockage_effect_option;
sequence.Lane_blockage_effect_option = 0;

Dim lane_blockage_effect_option As Integer = 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

$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

C#VB.NETPythonPowerShell

bool is_timing_optimised_for_selected_result = sequence.Is_timing_optimised_for_selected_result;
sequence.Is_timing_optimised_for_selected_result = true;

Dim is_timing_optimised_for_selected_result As Boolean = 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

$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

C#VB.NETPythonPowerShell

var result = sequence.AddPhase(@"Example");

Dim result As ISIAPIPhase = sequence.AddPhase("Example")

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

C#VB.NETPythonPowerShell

bool result = sequence.RemovePhase(null);

Dim result As Boolean = sequence.RemovePhase(Nothing)

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

C#VB.NETPythonPowerShell

var result = sequence.InsertPhase(0, @"Example");

Dim result As ISIAPIPhase = sequence.InsertPhase(0, "Example")

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

C#VB.NETPythonPowerShell

var result = sequence.ClonePhase(null);

Dim result As ISIAPIPhase = sequence.ClonePhase(Nothing)

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

C#VB.NETPythonPowerShell

bool result = sequence.MovePhaseTo(null, 0);

Dim result As Boolean = sequence.MovePhaseTo(Nothing, 0)

result = sequence.MovePhaseTo(None, 0)

$result = $sequence.MovePhaseTo($null, 0)