ISIAPINetworkCCG Interface¶

Namespace: SIDRASolutions.SI.API
Assembly: SIDRASolutions.SI.API.dll COM CLSID: 19F00866-DA77-4C33-8A2C-B433B45AA65F

Wrapper interface for a Common Control Group (CCG) in a particular Network

Declaration¶

[Guid("19F00866-DA77-4C33-8A2C-B433B45AA65F")]
public interface ISIAPINetworkCCG

Get an instance¶

C#VB.NETPythonPowerShell

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

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

# Navigate to the ISIAPINetworkCCG you need via the ISIAPI tree.
# See ISIAPI for the activation root.
networkCCG = ...

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

Properties¶

Name¶

string Name { get; set; }

Type string

Code samples

C#VB.NETPythonPowerShell

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

Dim name As String = networkCCG.Name
networkCCG.Name = "Example"

name = networkCCG.Name
networkCCG.Name = r"Example"

$name = $networkCCG.Name
$networkCCG.Name = "Example"

NetworkCCGID¶

Network Common Control Group (CCG) ID for displaying in reports.

string NetworkCCGID { get; set; }

Type string

Code samples

C#VB.NETPythonPowerShell

string networkCCGID = networkCCG.NetworkCCGID;
networkCCG.NetworkCCGID = @"id-1";

Dim networkCCGID As String = networkCCG.NetworkCCGID
networkCCG.NetworkCCGID = "id-1"

network_ccgid = networkCCG.NetworkCCGID
networkCCG.NetworkCCGID = r"id-1"

$networkCCGID = $networkCCG.NetworkCCGID
$networkCCG.NetworkCCGID = "id-1"

Position¶

The Common Control Group (CCG) Position in the Network's CCGs collection. It is a zero-base integer.

int Position { get; }

Type int

Code samples

C#VB.NETPythonPowerShell

int position = networkCCG.Position;

Dim position As Integer = networkCCG.Position

position = networkCCG.Position

$position = $networkCCG.Position

IsReference¶

bool IsReference { get; set; }

Type bool

Code samples

C#VB.NETPythonPowerShell

bool isReference = networkCCG.IsReference;
networkCCG.IsReference = true;

Dim isReference As Boolean = networkCCG.IsReference
networkCCG.IsReference = true

is_reference = networkCCG.IsReference
networkCCG.IsReference = True

$isReference = $networkCCG.IsReference
$networkCCG.IsReference = $true

Offset¶

int Offset { get; set; }

Type int

Code samples

C#VB.NETPythonPowerShell

int offset = networkCCG.Offset;
networkCCG.Offset = 0;

Dim offset As Integer = networkCCG.Offset
networkCCG.Offset = 0

offset = networkCCG.Offset
networkCCG.Offset = 0

$offset = $networkCCG.Offset
$networkCCG.Offset = 0

CoordinatedOption¶

Coordinated Option

int CoordinatedOption { get; set; }

Type int

Value

One of:

0 - NA
1 - Yes
2 - No

Code samples

C#VB.NETPythonPowerShell

int coordinatedOption = networkCCG.CoordinatedOption;
networkCCG.CoordinatedOption = 0;

Dim coordinatedOption As Integer = networkCCG.CoordinatedOption
networkCCG.CoordinatedOption = 0

coordinated_option = networkCCG.CoordinatedOption
networkCCG.CoordinatedOption = 0

$coordinatedOption = $networkCCG.CoordinatedOption
$networkCCG.CoordinatedOption = 0

Signal_analysis_method¶

Signalised analysis method, applied to the Sites in this Common Control Group (CCG).

int Signal_analysis_method { get; set; }

Type int

Value

One of:

0 - Fixed-Time/Pretimed
1 - Actuated

Code samples

C#VB.NETPythonPowerShell

int signal_analysis_method = networkCCG.Signal_analysis_method;
networkCCG.Signal_analysis_method = 0;

Dim signal_analysis_method As Integer = networkCCG.Signal_analysis_method
networkCCG.Signal_analysis_method = 0

signal_analysis_method = networkCCG.Signal_analysis_method
networkCCG.Signal_analysis_method = 0

$signal_analysis_method = $networkCCG.Signal_analysis_method
$networkCCG.Signal_analysis_method = 0

Network¶

ISIAPINetwork Network { get; }

Type ISIAPINetwork

Code samples

C#VB.NETPythonPowerShell

var network = networkCCG.Network;

Dim network As ISIAPINetwork = networkCCG.Network

network = networkCCG.Network

$network = $networkCCG.Network

NetworkSites¶

ISIAPINetworkSites NetworkSites { get; }

Type ISIAPINetworkSites

Code samples

C#VB.NETPythonPowerShell

var networkSites = networkCCG.NetworkSites;

Dim networkSites As ISIAPINetworkSites = networkCCG.NetworkSites

network_sites = networkCCG.NetworkSites

$networkSites = $networkCCG.NetworkSites

CCGSequences¶

ISIAPINetworkCCGSequences CCGSequences { get; }

Type ISIAPINetworkCCGSequences

Code samples

C#VB.NETPythonPowerShell

var cCGSequences = networkCCG.CCGSequences;

Dim cCGSequences As ISIAPINetworkCCGSequences = networkCCG.CCGSequences

ccg_sequences = networkCCG.CCGSequences

$cCGSequences = $networkCCG.CCGSequences

LastErrorMessage¶

string LastErrorMessage { get; }

Type string

Code samples

C#VB.NETPythonPowerShell

string lastErrorMessage = networkCCG.LastErrorMessage;

Dim lastErrorMessage As String = networkCCG.LastErrorMessage

last_error_message = networkCCG.LastErrorMessage

$lastErrorMessage = $networkCCG.LastErrorMessage

Is_multi_sequence_enabled¶

bool Is_multi_sequence_enabled { get; set; }

Type bool

Code samples

C#VB.NETPythonPowerShell

bool is_multi_sequence_enabled = networkCCG.Is_multi_sequence_enabled;
networkCCG.Is_multi_sequence_enabled = true;

Dim is_multi_sequence_enabled As Boolean = networkCCG.Is_multi_sequence_enabled
networkCCG.Is_multi_sequence_enabled = true

is_multi_sequence_enabled = networkCCG.Is_multi_sequence_enabled
networkCCG.Is_multi_sequence_enabled = True

$is_multi_sequence_enabled = $networkCCG.Is_multi_sequence_enabled
$networkCCG.Is_multi_sequence_enabled = $true

Methods¶

AddNetworkSite(ISIAPINetworkSite)¶

Add a Network Site into this Network CCG.

bool AddNetworkSite(ISIAPINetworkSite networkSite)

Parameters

Name	Type	Description
`networkSite`	`ISIAPINetworkSite`	The Network Site to add.

Returns bool - true if the Network Site is successfully added; otherwise, false.

Code samples

C#VB.NETPythonPowerShell

bool result = networkCCG.AddNetworkSite(null);

Dim result As Boolean = networkCCG.AddNetworkSite(Nothing)

result = networkCCG.AddNetworkSite(None)

$result = $networkCCG.AddNetworkSite($null)

RemoveNetworkSite(ISIAPINetworkSite)¶

Remove a Network Site from this Network CCG.

bool RemoveNetworkSite(ISIAPINetworkSite networkSite)

Parameters

Name	Type	Description
`networkSite`	`ISIAPINetworkSite`	The Network Site to remove.

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

Code samples

C#VB.NETPythonPowerShell

bool result = networkCCG.RemoveNetworkSite(null);

Dim result As Boolean = networkCCG.RemoveNetworkSite(Nothing)

result = networkCCG.RemoveNetworkSite(None)

$result = $networkCCG.RemoveNetworkSite($null)

AddCCGSequence(string)¶

Add a Sequence. A new Sequence is created and added to this Network CCG.

ISIAPINetworkCCGSequence AddCCGSequence(string name)

Parameters

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

Returns ISIAPINetworkCCGSequence - The new Sequence

Code samples

C#VB.NETPythonPowerShell

var result = networkCCG.AddCCGSequence(@"Example");

Dim result As ISIAPINetworkCCGSequence = networkCCG.AddCCGSequence("Example")

result = networkCCG.AddCCGSequence(r"Example")

$result = $networkCCG.AddCCGSequence("Example")

RemoveCCGSequence(ISIAPINetworkCCGSequence)¶

Remove a Sequence from this Network CCG.

bool RemoveCCGSequence(ISIAPINetworkCCGSequence ccgSequence)

Parameters

Name	Type	Description
`ccgSequence`	`ISIAPINetworkCCGSequence`	The Sequence to remove.

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

Code samples

C#VB.NETPythonPowerShell

bool result = networkCCG.RemoveCCGSequence(null);

Dim result As Boolean = networkCCG.RemoveCCGSequence(Nothing)

result = networkCCG.RemoveCCGSequence(None)

$result = $networkCCG.RemoveCCGSequence($null)

CloneCCGSequence(ISIAPINetworkCCGSequence)¶

Clone a Sequence.

ISIAPINetworkCCGSequence CloneCCGSequence(ISIAPINetworkCCGSequence ccgSequence)

Parameters

Name	Type	Description
`ccgSequence`	`ISIAPINetworkCCGSequence`	The Sequence to be cloned.

Returns ISIAPINetworkCCGSequence - The new cloned Sequence.

Code samples

C#VB.NETPythonPowerShell

var result = networkCCG.CloneCCGSequence(null);

Dim result As ISIAPINetworkCCGSequence = networkCCG.CloneCCGSequence(Nothing)

result = networkCCG.CloneCCGSequence(None)

$result = $networkCCG.CloneCCGSequence($null)

MoveCCGSequenceTo(ISIAPINetworkCCGSequence, int)¶

Move a Sequence to a new position.

bool MoveCCGSequenceTo(ISIAPINetworkCCGSequence ccgSequence, int newPosition)

Parameters

Name	Type	Description
`ccgSequence`	`ISIAPINetworkCCGSequence`	The Sequence to move.
`newPosition`	`int`	The zero-based position that the Sequence should be moved to.

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

Code samples

C#VB.NETPythonPowerShell

bool result = networkCCG.MoveCCGSequenceTo(null, 0);

Dim result As Boolean = networkCCG.MoveCCGSequenceTo(Nothing, 0)

result = networkCCG.MoveCCGSequenceTo(None, 0)

$result = $networkCCG.MoveCCGSequenceTo($null, 0)