NetworkScenarios

Type ISIAPINetworkScenarios · Interface
Namespace SIDRASolutions.SI.API
Assembly SIDRASolutions.SI.API.dll
COM CLSID F0E121B8-4E03-407A-9B19-501D014A9950

Declaration

[Guid("F0E121B8-4E03-407A-9B19-501D014A9950")]
public interface ISIAPINetworkScenarios

Members

Properties

Property	Type	Summary
Count	int	Gets the number of NetworkScenarios contained in the collection.
this[]	ISIAPINetworkScenario	Get the NetworkScenario from the collection by its name.
this[]	ISIAPINetworkScenario	Get the NetworkScenario at the specified index.

Methods

Method	Returns	Summary
NetworkScenarioExists(string)	bool	Queries whether a particular NetworkScenario exists in the collection by its name.

Properties

Count

Gets the number of NetworkScenarios contained in the collection.

int Count { get; }

Type int

Code samples

C#C++PythonPowerShell

int count = networkScenarios.Count;

long count;
networkScenarios->get_Count(&count);

count = networkScenarios.Count

$count = $networkScenarios.Count

this[]

Get the NetworkScenario from the collection by its name.

ISIAPINetworkScenario this[] { get; }

Type ISIAPINetworkScenario

Remarks

The NetworkScenario name is not unique in the collection. It is possible that more than one NetworkScenario has the same name. The first NetworkScenario found by name is returned. If no NetworkScenario is found, null / Nothing is returned.

In C#, use ISIAPINetworkScenarios[] to get a NetworkScenario by its name or its position in the collection.
In VBA, use Item() to get a NetworkScenario by its name or use Item_2() to get by its position.
In C++, use get_Item() to get a NetworkScenario by its name or use get_Item_2() by its position.

Code samples

C#C++PythonPowerShell

var this[] = networkScenarios.this[];

CComPtr<ISIAPINetworkScenario> this[];
networkScenarios->get_this[](&this[]);

this[] = networkScenarios.this[]

$this[] = $networkScenarios.this[]

this[]

Get the NetworkScenario at the specified index.

ISIAPINetworkScenario this[] { get; }

Type ISIAPINetworkScenario

Remarks

In C#, use ISIAPINetworkScenarios[] to get a NetworkScenario by its name or its position in the collection.
In VBA, use Item() to get a NetworkScenario by its name or use Item_2() to get by its position.
In C++, use get_Item() to get a NetworkScenario by its name or use get_Item_2() by its position.

Code samples

C#C++PythonPowerShell

var this[] = networkScenarios.this[];

CComPtr<ISIAPINetworkScenario> this[];
networkScenarios->get_this[](&this[]);

this[] = networkScenarios.this[]

$this[] = $networkScenarios.this[]

Methods

NetworkScenarioExists(string)

Queries whether a particular NetworkScenario exists in the collection by its name.

bool NetworkScenarioExists(string networkScenarioName)

Parameters

Name	Type	Description
networkScenarioName	string	NetworkScenario name to query

Returns bool - True, if any NetworkScenario with the given name exists in the collection. False otherwise

Remarks

The NetworkScenario name is not unique in the collection. It is possible that more than one NetworkScenario has the same name.

Code samples

C#C++PythonPowerShell

bool result = networkScenarios.NetworkScenarioExists(@"Example");

VARIANT_BOOL result;
networkScenarios->NetworkScenarioExists(CComBSTR(L"Example"), &result);

result = networkScenarios.NetworkScenarioExists(r"Example")

$result = $networkScenarios.NetworkScenarioExists("Example")