ISIAPINetworkCCGSequence Interface¶
Namespace: SIDRASolutions.SI.API
Assembly: SIDRASolutions.SI.API.dll
COM CLSID: BF82040F-AE5D-4968-8776-7EF476FF4940
Declaration¶
Get an instance¶
Properties¶
Name¶
Type string
Code samples
Position¶
The Sequence Position in the Netowrk CCG's Sequences collection. It is a zero-base integer.
Type int
Code samples
Is_selected¶
Type bool
Code samples
Cycle_time_option¶
Cycle Time Option
Type int
Value
One of:
0- Practical Cycle Time1- Optimum Cycle Time2- User-Given Cycle Time3- User-Given Phase Time4- Optimum Maximum Green Settings
Code samples
Practical_max_cycle_time¶
Type float
Code samples
Practical_cycle_rounding_applied¶
Type bool
Code samples
Practical_cycle_rounding¶
Type int
Code samples
Optimum_cycle_time_lower_user¶
Type bool
Code samples
Optimum_cycle_time_lower¶
Type int
Code samples
Optimum_cycle_time_upper¶
Type int
Code samples
Optimum_cycle_time_increment¶
Type int
Code samples
Optimum_cycle_time_perf_measure¶
Type int
Code samples
Optimum_cycle_time_optim_method¶
Type int
Code samples
Optimum_max_green_percent_lower¶
Type int
Code samples
Optimum_max_green_percent_upper¶
Type int
Code samples
Optimum_max_green_percent_increment¶
Type int
Code samples
Optimum_max_green_perf_measure¶
Type int
Code samples
Optimum_max_green_optim_method¶
Type int
Code samples
Variable_phasing_perf_measure¶
Type int
Code samples
Usergiven_cycle_time¶
Type float
Code samples
Green_split_priority_option¶
Type int
Code samples
Actuated_max_green_major_mov¶
Type float
Code samples
Actuated_max_green_minor_mov¶
Type float
Code samples
Actuated_gap_major_mov¶
Type float
Code samples
Actuated_gap_minor_mov¶
Type float
Code samples
Eff_det_zone_len_major_mov¶
Type float
Code samples
Eff_det_zone_len_minor_mov¶
Type float
Code samples
NetworkCCG¶
Type ISIAPINetworkCCG
Code samples
CCGPhases¶
Code samples
LastErrorMessage¶
Type string
Code samples
Methods¶
AddCCGPhase(string)¶
Add a new Phase to the end of this Sequence.
Parameters
| Name | Type | Description |
|---|---|---|
name |
string |
The name of the new Phase. |
Returns ISIAPINetworkCCGPhase - The new added Phase.
Code samples
InsertCCGPhase(int, string)¶
Insert a new Phase into this Sequence at the specified position.
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 ISIAPINetworkCCGPhase - The new added Phase.
Code samples
RemoveCCGPhase(ISIAPINetworkCCGPhase)¶
Remove a Phase from this Sequence.
Parameters
| Name | Type | Description |
|---|---|---|
ccgPhase |
ISIAPINetworkCCGPhase |
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
CloneCCGPhase(ISIAPINetworkCCGPhase)¶
Clone a Phase.
Parameters
| Name | Type | Description |
|---|---|---|
ccgPhase |
ISIAPINetworkCCGPhase |
The Phase to clone. |
Returns ISIAPINetworkCCGPhase - The new cloned Phase.
Code samples
MoveCCGPhaseTo(ISIAPINetworkCCGPhase, int)¶
Move a Phase to a new position.
Parameters
| Name | Type | Description |
|---|---|---|
ccgPhase |
ISIAPINetworkCCGPhase |
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.