Skip to content

NetworkCCG

Type 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

Members

Properties

Property Type Summary
Name string
NetworkCCGID string Network Common Control Group (CCG) ID for displaying in reports.
Position int The Common Control Group (CCG) Position in the Network's CCGs collection. It is a zero-base integer.
IsReference bool
Offset int
CoordinatedOption int Coordinated Option
Signal_analysis_method int Signalised analysis method, applied to the Sites in this Common Control Group (CCG).
Network ISIAPINetwork
NetworkSites ISIAPINetworkSites
CCGSequences ISIAPINetworkCCGSequences
LastErrorMessage string
Is_multi_sequence_enabled bool

Methods

Method Returns Summary
AddNetworkSite(ISIAPINetworkSite) bool Add a Network Site into this Network CCG.
RemoveNetworkSite(ISIAPINetworkSite) bool Remove a Network Site from this Network CCG.
AddCCGSequence(string) ISIAPINetworkCCGSequence Add a Sequence. A new Sequence is created and added to this Network CCG.
RemoveCCGSequence(ISIAPINetworkCCGSequence) bool Remove a Sequence from this Network CCG.
CloneCCGSequence(ISIAPINetworkCCGSequence) ISIAPINetworkCCGSequence Clone a Sequence.
MoveCCGSequenceTo(ISIAPINetworkCCGSequence, int) bool Move a Sequence to a new position.

Properties

Name

string Name { get; set; }

Type string

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

CComBSTR name;
networkCCG->get_Name(&name);
networkCCG->put_Name(CComBSTR(L"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 
string networkCCGID = networkCCG.NetworkCCGID;
networkCCG.NetworkCCGID = @"id-1";

CComBSTR networkCCGID;
networkCCG->get_NetworkCCGID(&networkCCGID);
networkCCG->put_NetworkCCGID(CComBSTR(L"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 
int position = networkCCG.Position;

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

position = networkCCG.Position

$position = $networkCCG.Position

IsReference

bool IsReference { get; set; }

Type bool

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

VARIANT_BOOL isReference;
networkCCG->get_IsReference(&isReference);
networkCCG->put_IsReference(VARIANT_TRUE);

is_reference = networkCCG.IsReference
networkCCG.IsReference = True

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

Offset

int Offset { get; set; }

Type int

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

long offset;
networkCCG->get_Offset(&offset);
networkCCG->put_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 
int coordinatedOption = networkCCG.CoordinatedOption;
networkCCG.CoordinatedOption = 0;

long coordinatedOption;
networkCCG->get_CoordinatedOption(&coordinatedOption);
networkCCG->put_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 
int signal_analysis_method = networkCCG.Signal_analysis_method;
networkCCG.Signal_analysis_method = 0;

long signal_analysis_method;
networkCCG->get_Signal_analysis_method(&signal_analysis_method);
networkCCG->put_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 
var network = networkCCG.Network;

CComPtr<ISIAPINetwork> network;
networkCCG->get_Network(&network);

network = networkCCG.Network

$network = $networkCCG.Network

NetworkSites

ISIAPINetworkSites NetworkSites { get; }

Type ISIAPINetworkSites

Code samples 
var networkSites = networkCCG.NetworkSites;

CComPtr<ISIAPINetworkSites> networkSites;
networkCCG->get_NetworkSites(&networkSites);

network_sites = networkCCG.NetworkSites

$networkSites = $networkCCG.NetworkSites

CCGSequences

ISIAPINetworkCCGSequences CCGSequences { get; }

Type ISIAPINetworkCCGSequences

Code samples 
var cCGSequences = networkCCG.CCGSequences;

CComPtr<ISIAPINetworkCCGSequences> cCGSequences;
networkCCG->get_CCGSequences(&cCGSequences);

ccg_sequences = networkCCG.CCGSequences

$cCGSequences = $networkCCG.CCGSequences

LastErrorMessage

string LastErrorMessage { get; }

Type string

Code samples 
string lastErrorMessage = networkCCG.LastErrorMessage;

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

last_error_message = networkCCG.LastErrorMessage

$lastErrorMessage = $networkCCG.LastErrorMessage

Is_multi_sequence_enabled

bool Is_multi_sequence_enabled { get; set; }

Type bool

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

VARIANT_BOOL is_multi_sequence_enabled;
networkCCG->get_Is_multi_sequence_enabled(&is_multi_sequence_enabled);
networkCCG->put_Is_multi_sequence_enabled(VARIANT_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 
bool result = networkCCG.AddNetworkSite(null);

VARIANT_BOOL result;
networkCCG->AddNetworkSite(NULL, &result);

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 
bool result = networkCCG.RemoveNetworkSite(null);

VARIANT_BOOL result;
networkCCG->RemoveNetworkSite(NULL, &result);

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 
var result = networkCCG.AddCCGSequence(@"Example");

CComPtr<ISIAPINetworkCCGSequence> result;
networkCCG->AddCCGSequence(CComBSTR(L"Example"), &result);

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 
bool result = networkCCG.RemoveCCGSequence(null);

VARIANT_BOOL result;
networkCCG->RemoveCCGSequence(NULL, &result);

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 
var result = networkCCG.CloneCCGSequence(null);

CComPtr<ISIAPINetworkCCGSequence> result;
networkCCG->CloneCCGSequence(NULL, &result);

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 
bool result = networkCCG.MoveCCGSequenceTo(null, 0);

VARIANT_BOOL result;
networkCCG->MoveCCGSequenceTo(NULL, 0, &result);

result = networkCCG.MoveCCGSequenceTo(None, 0)

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