NetworkCCGSequence¶

Type ISIAPINetworkCCGSequence · Interface
Namespace SIDRASolutions.SI.API
Assembly SIDRASolutions.SI.API.dll
COM CLSID BF82040F-AE5D-4968-8776-7EF476FF4940

Declaration¶

[Guid("BF82040F-AE5D-4968-8776-7EF476FF4940")]
public interface ISIAPINetworkCCGSequence

Members¶

Properties

Property	Type	Summary
Name	`string`
Position	`int`	The Sequence Position in the Netowrk CCG's Sequences collection. It is a zero-base integer.
Is_selected	`bool`
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`
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`
NetworkCCG	`ISIAPINetworkCCG`
CCGPhases	`ISIAPINetworkCCGPhases`
LastErrorMessage	`string`

Methods

Method	Returns	Summary
AddCCGPhase(string)	`ISIAPINetworkCCGPhase`	Add a new Phase to the end of this Sequence.
InsertCCGPhase(int, string)	`ISIAPINetworkCCGPhase`	Insert a new Phase into this Sequence at the specified position.
RemoveCCGPhase(ISIAPINetworkCCGPhase)	`bool`	Remove a Phase from this Sequence.
CloneCCGPhase(ISIAPINetworkCCGPhase)	`ISIAPINetworkCCGPhase`	Clone a Phase.
MoveCCGPhaseTo(ISIAPINetworkCCGPhase, int)	`bool`	Move a Phase to a new position.

Properties¶

Name¶

string Name { get; set; }

Type string

Code samples

C#C++PythonPowerShell

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

CComBSTR name;
networkCCGSequence->get_Name(&name);
networkCCGSequence->put_Name(CComBSTR(L"Example"));

name = networkCCGSequence.Name
networkCCGSequence.Name = r"Example"

$name = $networkCCGSequence.Name
$networkCCGSequence.Name = "Example"

Position¶

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

int Position { get; }

Type int

Code samples

C#C++PythonPowerShell

int position = networkCCGSequence.Position;

long position;
networkCCGSequence->get_Position(&position);

position = networkCCGSequence.Position

$position = $networkCCGSequence.Position

Is_selected¶

bool Is_selected { get; set; }

Type bool

Code samples

C#C++PythonPowerShell

bool is_selected = networkCCGSequence.Is_selected;
networkCCGSequence.Is_selected = true;

VARIANT_BOOL is_selected;
networkCCGSequence->get_Is_selected(&is_selected);
networkCCGSequence->put_Is_selected(VARIANT_TRUE);

is_selected = networkCCGSequence.Is_selected
networkCCGSequence.Is_selected = True

$is_selected = $networkCCGSequence.Is_selected
$networkCCGSequence.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#C++PythonPowerShell

int cycle_time_option = networkCCGSequence.Cycle_time_option;
networkCCGSequence.Cycle_time_option = 0;

long cycle_time_option;
networkCCGSequence->get_Cycle_time_option(&cycle_time_option);
networkCCGSequence->put_Cycle_time_option(0);

cycle_time_option = networkCCGSequence.Cycle_time_option
networkCCGSequence.Cycle_time_option = 0

$cycle_time_option = $networkCCGSequence.Cycle_time_option
$networkCCGSequence.Cycle_time_option = 0

Practical_max_cycle_time¶

float Practical_max_cycle_time { get; set; }

Type float

Code samples

C#C++PythonPowerShell

float practical_max_cycle_time = networkCCGSequence.Practical_max_cycle_time;
networkCCGSequence.Practical_max_cycle_time = 0.0;

double practical_max_cycle_time;
networkCCGSequence->get_Practical_max_cycle_time(&practical_max_cycle_time);
networkCCGSequence->put_Practical_max_cycle_time(0.0);

practical_max_cycle_time = networkCCGSequence.Practical_max_cycle_time
networkCCGSequence.Practical_max_cycle_time = 0.0

$practical_max_cycle_time = $networkCCGSequence.Practical_max_cycle_time
$networkCCGSequence.Practical_max_cycle_time = 0.0

Practical_cycle_rounding_applied¶

bool Practical_cycle_rounding_applied { get; set; }

Type bool

Code samples

C#C++PythonPowerShell

bool practical_cycle_rounding_applied = networkCCGSequence.Practical_cycle_rounding_applied;
networkCCGSequence.Practical_cycle_rounding_applied = true;

VARIANT_BOOL practical_cycle_rounding_applied;
networkCCGSequence->get_Practical_cycle_rounding_applied(&practical_cycle_rounding_applied);
networkCCGSequence->put_Practical_cycle_rounding_applied(VARIANT_TRUE);

practical_cycle_rounding_applied = networkCCGSequence.Practical_cycle_rounding_applied
networkCCGSequence.Practical_cycle_rounding_applied = True

$practical_cycle_rounding_applied = $networkCCGSequence.Practical_cycle_rounding_applied
$networkCCGSequence.Practical_cycle_rounding_applied = $true

Practical_cycle_rounding¶

int Practical_cycle_rounding { get; set; }

Type int

Code samples

C#C++PythonPowerShell

int practical_cycle_rounding = networkCCGSequence.Practical_cycle_rounding;
networkCCGSequence.Practical_cycle_rounding = 0;

long practical_cycle_rounding;
networkCCGSequence->get_Practical_cycle_rounding(&practical_cycle_rounding);
networkCCGSequence->put_Practical_cycle_rounding(0);

practical_cycle_rounding = networkCCGSequence.Practical_cycle_rounding
networkCCGSequence.Practical_cycle_rounding = 0

$practical_cycle_rounding = $networkCCGSequence.Practical_cycle_rounding
$networkCCGSequence.Practical_cycle_rounding = 0

Optimum_cycle_time_lower_user¶

bool Optimum_cycle_time_lower_user { get; set; }

Type bool

Code samples

C#C++PythonPowerShell

bool optimum_cycle_time_lower_user = networkCCGSequence.Optimum_cycle_time_lower_user;
networkCCGSequence.Optimum_cycle_time_lower_user = true;

VARIANT_BOOL optimum_cycle_time_lower_user;
networkCCGSequence->get_Optimum_cycle_time_lower_user(&optimum_cycle_time_lower_user);
networkCCGSequence->put_Optimum_cycle_time_lower_user(VARIANT_TRUE);

optimum_cycle_time_lower_user = networkCCGSequence.Optimum_cycle_time_lower_user
networkCCGSequence.Optimum_cycle_time_lower_user = True

$optimum_cycle_time_lower_user = $networkCCGSequence.Optimum_cycle_time_lower_user
$networkCCGSequence.Optimum_cycle_time_lower_user = $true

Optimum_cycle_time_lower¶

int Optimum_cycle_time_lower { get; set; }

Type int

Code samples

C#C++PythonPowerShell

int optimum_cycle_time_lower = networkCCGSequence.Optimum_cycle_time_lower;
networkCCGSequence.Optimum_cycle_time_lower = 0;

long optimum_cycle_time_lower;
networkCCGSequence->get_Optimum_cycle_time_lower(&optimum_cycle_time_lower);
networkCCGSequence->put_Optimum_cycle_time_lower(0);

optimum_cycle_time_lower = networkCCGSequence.Optimum_cycle_time_lower
networkCCGSequence.Optimum_cycle_time_lower = 0

$optimum_cycle_time_lower = $networkCCGSequence.Optimum_cycle_time_lower
$networkCCGSequence.Optimum_cycle_time_lower = 0

Optimum_cycle_time_upper¶

int Optimum_cycle_time_upper { get; set; }

Type int

Code samples

C#C++PythonPowerShell

int optimum_cycle_time_upper = networkCCGSequence.Optimum_cycle_time_upper;
networkCCGSequence.Optimum_cycle_time_upper = 0;

long optimum_cycle_time_upper;
networkCCGSequence->get_Optimum_cycle_time_upper(&optimum_cycle_time_upper);
networkCCGSequence->put_Optimum_cycle_time_upper(0);

optimum_cycle_time_upper = networkCCGSequence.Optimum_cycle_time_upper
networkCCGSequence.Optimum_cycle_time_upper = 0

$optimum_cycle_time_upper = $networkCCGSequence.Optimum_cycle_time_upper
$networkCCGSequence.Optimum_cycle_time_upper = 0

Optimum_cycle_time_increment¶

int Optimum_cycle_time_increment { get; set; }

Type int

Code samples

C#C++PythonPowerShell

int optimum_cycle_time_increment = networkCCGSequence.Optimum_cycle_time_increment;
networkCCGSequence.Optimum_cycle_time_increment = 0;

long optimum_cycle_time_increment;
networkCCGSequence->get_Optimum_cycle_time_increment(&optimum_cycle_time_increment);
networkCCGSequence->put_Optimum_cycle_time_increment(0);

optimum_cycle_time_increment = networkCCGSequence.Optimum_cycle_time_increment
networkCCGSequence.Optimum_cycle_time_increment = 0

$optimum_cycle_time_increment = $networkCCGSequence.Optimum_cycle_time_increment
$networkCCGSequence.Optimum_cycle_time_increment = 0

Optimum_cycle_time_perf_measure¶

int Optimum_cycle_time_perf_measure { get; set; }

Type int

Code samples

C#C++PythonPowerShell

int optimum_cycle_time_perf_measure = networkCCGSequence.Optimum_cycle_time_perf_measure;
networkCCGSequence.Optimum_cycle_time_perf_measure = 0;

long optimum_cycle_time_perf_measure;
networkCCGSequence->get_Optimum_cycle_time_perf_measure(&optimum_cycle_time_perf_measure);
networkCCGSequence->put_Optimum_cycle_time_perf_measure(0);

optimum_cycle_time_perf_measure = networkCCGSequence.Optimum_cycle_time_perf_measure
networkCCGSequence.Optimum_cycle_time_perf_measure = 0

$optimum_cycle_time_perf_measure = $networkCCGSequence.Optimum_cycle_time_perf_measure
$networkCCGSequence.Optimum_cycle_time_perf_measure = 0

Optimum_cycle_time_optim_method¶

int Optimum_cycle_time_optim_method { get; set; }

Type int

Code samples

C#C++PythonPowerShell

int optimum_cycle_time_optim_method = networkCCGSequence.Optimum_cycle_time_optim_method;
networkCCGSequence.Optimum_cycle_time_optim_method = 0;

long optimum_cycle_time_optim_method;
networkCCGSequence->get_Optimum_cycle_time_optim_method(&optimum_cycle_time_optim_method);
networkCCGSequence->put_Optimum_cycle_time_optim_method(0);

optimum_cycle_time_optim_method = networkCCGSequence.Optimum_cycle_time_optim_method
networkCCGSequence.Optimum_cycle_time_optim_method = 0

$optimum_cycle_time_optim_method = $networkCCGSequence.Optimum_cycle_time_optim_method
$networkCCGSequence.Optimum_cycle_time_optim_method = 0

Optimum_max_green_percent_lower¶

int Optimum_max_green_percent_lower { get; set; }

Type int

Code samples

C#C++PythonPowerShell

int optimum_max_green_percent_lower = networkCCGSequence.Optimum_max_green_percent_lower;
networkCCGSequence.Optimum_max_green_percent_lower = 0;

long optimum_max_green_percent_lower;
networkCCGSequence->get_Optimum_max_green_percent_lower(&optimum_max_green_percent_lower);
networkCCGSequence->put_Optimum_max_green_percent_lower(0);

optimum_max_green_percent_lower = networkCCGSequence.Optimum_max_green_percent_lower
networkCCGSequence.Optimum_max_green_percent_lower = 0

$optimum_max_green_percent_lower = $networkCCGSequence.Optimum_max_green_percent_lower
$networkCCGSequence.Optimum_max_green_percent_lower = 0

Optimum_max_green_percent_upper¶

int Optimum_max_green_percent_upper { get; set; }

Type int

Code samples

C#C++PythonPowerShell

int optimum_max_green_percent_upper = networkCCGSequence.Optimum_max_green_percent_upper;
networkCCGSequence.Optimum_max_green_percent_upper = 0;

long optimum_max_green_percent_upper;
networkCCGSequence->get_Optimum_max_green_percent_upper(&optimum_max_green_percent_upper);
networkCCGSequence->put_Optimum_max_green_percent_upper(0);

optimum_max_green_percent_upper = networkCCGSequence.Optimum_max_green_percent_upper
networkCCGSequence.Optimum_max_green_percent_upper = 0

$optimum_max_green_percent_upper = $networkCCGSequence.Optimum_max_green_percent_upper
$networkCCGSequence.Optimum_max_green_percent_upper = 0

Optimum_max_green_percent_increment¶

int Optimum_max_green_percent_increment { get; set; }

Type int

Code samples

C#C++PythonPowerShell

int optimum_max_green_percent_increment = networkCCGSequence.Optimum_max_green_percent_increment;
networkCCGSequence.Optimum_max_green_percent_increment = 0;

long optimum_max_green_percent_increment;
networkCCGSequence->get_Optimum_max_green_percent_increment(&optimum_max_green_percent_increment);
networkCCGSequence->put_Optimum_max_green_percent_increment(0);

optimum_max_green_percent_increment = networkCCGSequence.Optimum_max_green_percent_increment
networkCCGSequence.Optimum_max_green_percent_increment = 0

$optimum_max_green_percent_increment = $networkCCGSequence.Optimum_max_green_percent_increment
$networkCCGSequence.Optimum_max_green_percent_increment = 0

Optimum_max_green_perf_measure¶

int Optimum_max_green_perf_measure { get; set; }

Type int

Code samples

C#C++PythonPowerShell

int optimum_max_green_perf_measure = networkCCGSequence.Optimum_max_green_perf_measure;
networkCCGSequence.Optimum_max_green_perf_measure = 0;

long optimum_max_green_perf_measure;
networkCCGSequence->get_Optimum_max_green_perf_measure(&optimum_max_green_perf_measure);
networkCCGSequence->put_Optimum_max_green_perf_measure(0);

optimum_max_green_perf_measure = networkCCGSequence.Optimum_max_green_perf_measure
networkCCGSequence.Optimum_max_green_perf_measure = 0

$optimum_max_green_perf_measure = $networkCCGSequence.Optimum_max_green_perf_measure
$networkCCGSequence.Optimum_max_green_perf_measure = 0

Optimum_max_green_optim_method¶

int Optimum_max_green_optim_method { get; set; }

Type int

Code samples

C#C++PythonPowerShell

int optimum_max_green_optim_method = networkCCGSequence.Optimum_max_green_optim_method;
networkCCGSequence.Optimum_max_green_optim_method = 0;

long optimum_max_green_optim_method;
networkCCGSequence->get_Optimum_max_green_optim_method(&optimum_max_green_optim_method);
networkCCGSequence->put_Optimum_max_green_optim_method(0);

optimum_max_green_optim_method = networkCCGSequence.Optimum_max_green_optim_method
networkCCGSequence.Optimum_max_green_optim_method = 0

$optimum_max_green_optim_method = $networkCCGSequence.Optimum_max_green_optim_method
$networkCCGSequence.Optimum_max_green_optim_method = 0

Variable_phasing_perf_measure¶

int Variable_phasing_perf_measure { get; set; }

Type int

Code samples

C#C++PythonPowerShell

int variable_phasing_perf_measure = networkCCGSequence.Variable_phasing_perf_measure;
networkCCGSequence.Variable_phasing_perf_measure = 0;

long variable_phasing_perf_measure;
networkCCGSequence->get_Variable_phasing_perf_measure(&variable_phasing_perf_measure);
networkCCGSequence->put_Variable_phasing_perf_measure(0);

variable_phasing_perf_measure = networkCCGSequence.Variable_phasing_perf_measure
networkCCGSequence.Variable_phasing_perf_measure = 0

$variable_phasing_perf_measure = $networkCCGSequence.Variable_phasing_perf_measure
$networkCCGSequence.Variable_phasing_perf_measure = 0

Usergiven_cycle_time¶

float Usergiven_cycle_time { get; set; }

Type float

Code samples

C#C++PythonPowerShell

float usergiven_cycle_time = networkCCGSequence.Usergiven_cycle_time;
networkCCGSequence.Usergiven_cycle_time = 0.0;

double usergiven_cycle_time;
networkCCGSequence->get_Usergiven_cycle_time(&usergiven_cycle_time);
networkCCGSequence->put_Usergiven_cycle_time(0.0);

usergiven_cycle_time = networkCCGSequence.Usergiven_cycle_time
networkCCGSequence.Usergiven_cycle_time = 0.0

$usergiven_cycle_time = $networkCCGSequence.Usergiven_cycle_time
$networkCCGSequence.Usergiven_cycle_time = 0.0

Green_split_priority_option¶

int Green_split_priority_option { get; set; }

Type int

Code samples

C#C++PythonPowerShell

int green_split_priority_option = networkCCGSequence.Green_split_priority_option;
networkCCGSequence.Green_split_priority_option = 0;

long green_split_priority_option;
networkCCGSequence->get_Green_split_priority_option(&green_split_priority_option);
networkCCGSequence->put_Green_split_priority_option(0);

green_split_priority_option = networkCCGSequence.Green_split_priority_option
networkCCGSequence.Green_split_priority_option = 0

$green_split_priority_option = $networkCCGSequence.Green_split_priority_option
$networkCCGSequence.Green_split_priority_option = 0

Actuated_max_green_major_mov¶

float Actuated_max_green_major_mov { get; set; }

Type float

Code samples

C#C++PythonPowerShell

float actuated_max_green_major_mov = networkCCGSequence.Actuated_max_green_major_mov;
networkCCGSequence.Actuated_max_green_major_mov = 0.0;

double actuated_max_green_major_mov;
networkCCGSequence->get_Actuated_max_green_major_mov(&actuated_max_green_major_mov);
networkCCGSequence->put_Actuated_max_green_major_mov(0.0);

actuated_max_green_major_mov = networkCCGSequence.Actuated_max_green_major_mov
networkCCGSequence.Actuated_max_green_major_mov = 0.0

$actuated_max_green_major_mov = $networkCCGSequence.Actuated_max_green_major_mov
$networkCCGSequence.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#C++PythonPowerShell

float actuated_max_green_minor_mov = networkCCGSequence.Actuated_max_green_minor_mov;
networkCCGSequence.Actuated_max_green_minor_mov = 0.0;

double actuated_max_green_minor_mov;
networkCCGSequence->get_Actuated_max_green_minor_mov(&actuated_max_green_minor_mov);
networkCCGSequence->put_Actuated_max_green_minor_mov(0.0);

actuated_max_green_minor_mov = networkCCGSequence.Actuated_max_green_minor_mov
networkCCGSequence.Actuated_max_green_minor_mov = 0.0

$actuated_max_green_minor_mov = $networkCCGSequence.Actuated_max_green_minor_mov
$networkCCGSequence.Actuated_max_green_minor_mov = 0.0

Actuated_gap_major_mov¶

float Actuated_gap_major_mov { get; set; }

Type float

Code samples

C#C++PythonPowerShell

float actuated_gap_major_mov = networkCCGSequence.Actuated_gap_major_mov;
networkCCGSequence.Actuated_gap_major_mov = 0.0;

double actuated_gap_major_mov;
networkCCGSequence->get_Actuated_gap_major_mov(&actuated_gap_major_mov);
networkCCGSequence->put_Actuated_gap_major_mov(0.0);

actuated_gap_major_mov = networkCCGSequence.Actuated_gap_major_mov
networkCCGSequence.Actuated_gap_major_mov = 0.0

$actuated_gap_major_mov = $networkCCGSequence.Actuated_gap_major_mov
$networkCCGSequence.Actuated_gap_major_mov = 0.0

Actuated_gap_minor_mov¶

float Actuated_gap_minor_mov { get; set; }

Type float

Code samples

C#C++PythonPowerShell

float actuated_gap_minor_mov = networkCCGSequence.Actuated_gap_minor_mov;
networkCCGSequence.Actuated_gap_minor_mov = 0.0;

double actuated_gap_minor_mov;
networkCCGSequence->get_Actuated_gap_minor_mov(&actuated_gap_minor_mov);
networkCCGSequence->put_Actuated_gap_minor_mov(0.0);

actuated_gap_minor_mov = networkCCGSequence.Actuated_gap_minor_mov
networkCCGSequence.Actuated_gap_minor_mov = 0.0

$actuated_gap_minor_mov = $networkCCGSequence.Actuated_gap_minor_mov
$networkCCGSequence.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#C++PythonPowerShell

float eff_det_zone_len_major_mov = networkCCGSequence.Eff_det_zone_len_major_mov;
networkCCGSequence.Eff_det_zone_len_major_mov = 0.0;

double eff_det_zone_len_major_mov;
networkCCGSequence->get_Eff_det_zone_len_major_mov(&eff_det_zone_len_major_mov);
networkCCGSequence->put_Eff_det_zone_len_major_mov(0.0);

eff_det_zone_len_major_mov = networkCCGSequence.Eff_det_zone_len_major_mov
networkCCGSequence.Eff_det_zone_len_major_mov = 0.0

$eff_det_zone_len_major_mov = $networkCCGSequence.Eff_det_zone_len_major_mov
$networkCCGSequence.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#C++PythonPowerShell

float eff_det_zone_len_minor_mov = networkCCGSequence.Eff_det_zone_len_minor_mov;
networkCCGSequence.Eff_det_zone_len_minor_mov = 0.0;

double eff_det_zone_len_minor_mov;
networkCCGSequence->get_Eff_det_zone_len_minor_mov(&eff_det_zone_len_minor_mov);
networkCCGSequence->put_Eff_det_zone_len_minor_mov(0.0);

eff_det_zone_len_minor_mov = networkCCGSequence.Eff_det_zone_len_minor_mov
networkCCGSequence.Eff_det_zone_len_minor_mov = 0.0

$eff_det_zone_len_minor_mov = $networkCCGSequence.Eff_det_zone_len_minor_mov
$networkCCGSequence.Eff_det_zone_len_minor_mov = 0.0

NetworkCCG¶

ISIAPINetworkCCG NetworkCCG { get; }

Type ISIAPINetworkCCG

Code samples

C#C++PythonPowerShell

var networkCCG = networkCCGSequence.NetworkCCG;

CComPtr<ISIAPINetworkCCG> networkCCG;
networkCCGSequence->get_NetworkCCG(&networkCCG);

network_ccg = networkCCGSequence.NetworkCCG

$networkCCG = $networkCCGSequence.NetworkCCG

CCGPhases¶

ISIAPINetworkCCGPhases CCGPhases { get; }

Type ISIAPINetworkCCGPhases

Code samples

C#C++PythonPowerShell

var cCGPhases = networkCCGSequence.CCGPhases;

CComPtr<ISIAPINetworkCCGPhases> cCGPhases;
networkCCGSequence->get_CCGPhases(&cCGPhases);

ccg_phases = networkCCGSequence.CCGPhases

$cCGPhases = $networkCCGSequence.CCGPhases

LastErrorMessage¶

string LastErrorMessage { get; }

Type string

Code samples

C#C++PythonPowerShell

string lastErrorMessage = networkCCGSequence.LastErrorMessage;

CComBSTR lastErrorMessage;
networkCCGSequence->get_LastErrorMessage(&lastErrorMessage);

last_error_message = networkCCGSequence.LastErrorMessage

$lastErrorMessage = $networkCCGSequence.LastErrorMessage

Methods¶

AddCCGPhase(string)¶

Add a new Phase to the end of this Sequence.

ISIAPINetworkCCGPhase AddCCGPhase(string name)

Parameters

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

Returns ISIAPINetworkCCGPhase - The new added Phase.

Code samples

C#C++PythonPowerShell

var result = networkCCGSequence.AddCCGPhase(@"Example");

CComPtr<ISIAPINetworkCCGPhase> result;
networkCCGSequence->AddCCGPhase(CComBSTR(L"Example"), &result);

result = networkCCGSequence.AddCCGPhase(r"Example")

$result = $networkCCGSequence.AddCCGPhase("Example")

InsertCCGPhase(int, string)¶

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

ISIAPINetworkCCGPhase InsertCCGPhase(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 ISIAPINetworkCCGPhase - The new added Phase.

Code samples

C#C++PythonPowerShell

var result = networkCCGSequence.InsertCCGPhase(0, @"Example");

CComPtr<ISIAPINetworkCCGPhase> result;
networkCCGSequence->InsertCCGPhase(0, CComBSTR(L"Example"), &result);

result = networkCCGSequence.InsertCCGPhase(0, r"Example")

$result = $networkCCGSequence.InsertCCGPhase(0, "Example")

RemoveCCGPhase(ISIAPINetworkCCGPhase)¶

Remove a Phase from this Sequence.

bool RemoveCCGPhase(ISIAPINetworkCCGPhase ccgPhase)

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

C#C++PythonPowerShell

bool result = networkCCGSequence.RemoveCCGPhase(null);

VARIANT_BOOL result;
networkCCGSequence->RemoveCCGPhase(NULL, &result);

result = networkCCGSequence.RemoveCCGPhase(None)

$result = $networkCCGSequence.RemoveCCGPhase($null)

CloneCCGPhase(ISIAPINetworkCCGPhase)¶

Clone a Phase.

ISIAPINetworkCCGPhase CloneCCGPhase(ISIAPINetworkCCGPhase ccgPhase)

Parameters

Name	Type	Description
`ccgPhase`	`ISIAPINetworkCCGPhase`	The Phase to clone.

Returns ISIAPINetworkCCGPhase - The new cloned Phase.

Code samples

C#C++PythonPowerShell

var result = networkCCGSequence.CloneCCGPhase(null);

CComPtr<ISIAPINetworkCCGPhase> result;
networkCCGSequence->CloneCCGPhase(NULL, &result);

result = networkCCGSequence.CloneCCGPhase(None)

$result = $networkCCGSequence.CloneCCGPhase($null)

MoveCCGPhaseTo(ISIAPINetworkCCGPhase, int)¶

Move a Phase to a new position.

bool MoveCCGPhaseTo(ISIAPINetworkCCGPhase ccgPhase, int newPosition)

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.

Code samples

C#C++PythonPowerShell

bool result = networkCCGSequence.MoveCCGPhaseTo(null, 0);

VARIANT_BOOL result;
networkCCGSequence->MoveCCGPhaseTo(NULL, 0, &result);

result = networkCCGSequence.MoveCCGPhaseTo(None, 0)

$result = $networkCCGSequence.MoveCCGPhaseTo($null, 0)