NetworkScenario¶

Type ISIAPINetworkScenario · Interface
Namespace SIDRASolutions.SI.API
Assembly SIDRASolutions.SI.API.dll
COM CLSID ACE73758-FDD9-4C77-8349-BB5846E313A9

Declaration¶

[Guid("ACE73758-FDD9-4C77-8349-BB5846E313A9")]
public interface ISIAPINetworkScenario

Members¶

Properties

Property	Type	Summary
Name	`string`	Network Scenario name
ID	`string`	Network Scenario ID in the Network Scenarios dialog and reports.
Position	`int`
VolumeType	`int`	Network Scenario Volume Type
Analyse	`bool`	Flag indicating this Network Scenario is applied to the Network.
Network	`ISIAPINetwork`
NetworkSiteScenarios	`ISIAPINetworkSiteScenarios`	NetworkSiteScenarios collection for this Scenario.

Properties¶

Name¶

Network Scenario name

string Name { get; set; }

Type string

Value

The Network Scenario name, max length = 100.

Code samples

C#C++PythonPowerShell

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

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

name = networkScenario.Name
networkScenario.Name = r"Example"

$name = $networkScenario.Name
$networkScenario.Name = "Example"

ID¶

Network Scenario ID in the Network Scenarios dialog and reports.

string ID { get; set; }

Type string

Value

Network Scenario ID, max length = 10.

Code samples

C#C++PythonPowerShell

string iD = networkScenario.ID;
networkScenario.ID = @"id-1";

CComBSTR iD;
networkScenario->get_ID(&iD);
networkScenario->put_ID(CComBSTR(L"id-1"));

id = networkScenario.ID
networkScenario.ID = r"id-1"

$iD = $networkScenario.ID
$networkScenario.ID = "id-1"

Position¶

int Position { get; }

Type int

Code samples

C#C++PythonPowerShell

int position = networkScenario.Position;

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

position = networkScenario.Position

$position = $networkScenario.Position

VolumeType¶

Network Scenario Volume Type

int VolumeType { get; }

Type int

Value

One of:

0 - Local, the local volumes of the Sites in the Network are applied
2 - Custom, the Site Scenarios defined in the property NetworkSiteScenarios collection are applied

Code samples

C#C++PythonPowerShell

int volumeType = networkScenario.VolumeType;

long volumeType;
networkScenario->get_VolumeType(&volumeType);

volume_type = networkScenario.VolumeType

$volumeType = $networkScenario.VolumeType

Analyse¶

Flag indicating this Network Scenario is applied to the Network.

bool Analyse { get; set; }

Type bool

Code samples

C#C++PythonPowerShell

bool analyse = networkScenario.Analyse;
networkScenario.Analyse = true;

VARIANT_BOOL analyse;
networkScenario->get_Analyse(&analyse);
networkScenario->put_Analyse(VARIANT_TRUE);

analyse = networkScenario.Analyse
networkScenario.Analyse = True

$analyse = $networkScenario.Analyse
$networkScenario.Analyse = $true

Network¶

ISIAPINetwork Network { get; }

Type ISIAPINetwork

Code samples

C#C++PythonPowerShell

var network = networkScenario.Network;

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

network = networkScenario.Network

$network = $networkScenario.Network

NetworkSiteScenarios¶

NetworkSiteScenarios collection for this Scenario.

ISIAPINetworkSiteScenarios NetworkSiteScenarios { get; }

Type ISIAPINetworkSiteScenarios

Remarks

This NetworkSiteScenarios property only applies to the Network Scenario which VolumeType == 2 (Custom).

Code samples

C#C++PythonPowerShell

var networkSiteScenarios = networkScenario.NetworkSiteScenarios;

CComPtr<ISIAPINetworkSiteScenarios> networkSiteScenarios;
networkScenario->get_NetworkSiteScenarios(&networkSiteScenarios);

network_site_scenarios = networkScenario.NetworkSiteScenarios

$networkSiteScenarios = $networkScenario.NetworkSiteScenarios