NetworkSite

Type ISIAPINetworkSite · Interface
Namespace SIDRASolutions.SI.API
Assembly SIDRASolutions.SI.API.dll
COM CLSID 0ECC347C-09B4-4EDE-9E11-F710F96F903F

Wrapper interface for the Site in a particular Network

Declaration

[Guid("0ECC347C-09B4-4EDE-9E11-F710F96F903F")]
public interface ISIAPINetworkSite

Members

Properties

Property	Type	Summary
NetworkSite_id	string	The unique ID of the NetworkSite object.
Network	ISIAPINetwork
SiteName	string
SiteOutputset	ISIAPIOutputset	Site output data of this Site in the particular Network
IsReference	bool
Offset	int
LayoutX	float	The X-coordinate of the top-left corner of the Site Image in the Network Configuration Layout.
LayoutY	float	The Y-coordinate of the top-left corner of the Site Image in the Network Configuration Layout.
CoordinatedOption	int	Coordinated Option
NetworkLegConnections	ISIAPINetworkLegConnections
NetworkCCG	ISIAPINetworkCCG
Site	ISIAPISite
DiagnosticStatus	int	Diagnostic Status
DiagnosticMsgs	ISIAPIDiagnosticMsgs
IsIncludedInProjectSummary	bool

Properties

NetworkSite_id

The unique ID of the NetworkSite object.

string NetworkSite_id { get; }

Type string

Code samples

C#C++Python

string networkSite_id = networkSite.NetworkSite_id;

CComBSTR networkSite_id;
networkSite->get_NetworkSite_id(&networkSite_id);

network_site_id = networkSite.NetworkSite_id

Network

ISIAPINetwork Network { get; }

Type ISIAPINetwork

Code samples

C#C++Python

var network = networkSite.Network;

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

network = networkSite.Network

SiteName

string SiteName { get; }

Type string

Code samples

C#C++Python

string siteName = networkSite.SiteName;

CComBSTR siteName;
networkSite->get_SiteName(&siteName);

site_name = networkSite.SiteName

SiteOutputset

Site output data of this Site in the particular Network

ISIAPIOutputset SiteOutputset { get; }

Type ISIAPIOutputset

Code samples

C#C++Python

var siteOutputset = networkSite.SiteOutputset;

CComPtr<ISIAPIOutputset> siteOutputset;
networkSite->get_SiteOutputset(&siteOutputset);

site_outputset = networkSite.SiteOutputset

IsReference

bool IsReference { get; set; }

Type bool

Code samples

C#C++Python

bool isReference = networkSite.IsReference;
networkSite.IsReference = true;

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

is_reference = networkSite.IsReference
networkSite.IsReference = True

Offset

int Offset { get; set; }

Type int

Code samples

C#C++Python

int offset = networkSite.Offset;
networkSite.Offset = 0;

long offset;
networkSite->get_Offset(&offset);
networkSite->put_Offset(0);

offset = networkSite.Offset
networkSite.Offset = 0

LayoutX

The X-coordinate of the top-left corner of the Site Image in the Network Configuration Layout.

float LayoutX { get; set; }

Type float

Remarks

The Network Configuration Layout is used in the Network Configuration Dialog in the SIDRA INTERSECTION program. The dimension of a Site Image in the Network Configuration Layout is 120 x 120 pixels, excluding the Connection Bar on each Leg. In the Network Configuration Dialog, the start point of view is (5000, 5000). So the NetworkSites created through this dialog are usually located around the point (5000, 5000). For example, Site1 (5200, 5100), Site2 (5550, 5100). The Sites' locations in the detailed Network Layout Display are based on the relative ratio of the Sites' locations in the Network Configuration Layout.

We suggest the layoutX and layoutY values to be around 5000, and between 0 and 10000.

Code samples

C#C++Python

float layoutX = networkSite.LayoutX;
networkSite.LayoutX = 0.0;

double layoutX;
networkSite->get_LayoutX(&layoutX);
networkSite->put_LayoutX(0.0);

layout_x = networkSite.LayoutX
networkSite.LayoutX = 0.0

LayoutY

The Y-coordinate of the top-left corner of the Site Image in the Network Configuration Layout.

float LayoutY { get; set; }

Type float

Remarks

The Network Configuration Layout is used in the Network Configuration Dialog in the SIDRA INTERSECTION program. The dimension of a Site Image in the Network Configuration Layout is 120 x 120 pixels, excluding the Connection Bar on each Leg. In the Network Configuration Dialog, the start point of view is (5000, 5000). So the NetworkSites created through this dialog are usually located around the point (5000, 5000). For example, Site1 (5200, 5100), Site2 (5550, 5100). The Sites' locations in the detailed Network Layout Display are based on the relative ratio of the Sites' locations in the Network Configuration Layout.

We suggest the layoutX and layoutY values to be around 5000, and between 0 and 10000.

Code samples

C#C++Python

float layoutY = networkSite.LayoutY;
networkSite.LayoutY = 0.0;

double layoutY;
networkSite->get_LayoutY(&layoutY);
networkSite->put_LayoutY(0.0);

layout_y = networkSite.LayoutY
networkSite.LayoutY = 0.0

CoordinatedOption

Coordinated Option

int CoordinatedOption { get; set; }

Type int

Value

One of:

• 0 - NA
• 1 - Yes
• 2 - No

Code samples

C#C++Python

int coordinatedOption = networkSite.CoordinatedOption;
networkSite.CoordinatedOption = 0;

long coordinatedOption;
networkSite->get_CoordinatedOption(&coordinatedOption);
networkSite->put_CoordinatedOption(0);

coordinated_option = networkSite.CoordinatedOption
networkSite.CoordinatedOption = 0

NetworkLegConnections

ISIAPINetworkLegConnections NetworkLegConnections { get; }

Type ISIAPINetworkLegConnections

Code samples

C#C++Python

var networkLegConnections = networkSite.NetworkLegConnections;

CComPtr<ISIAPINetworkLegConnections> networkLegConnections;
networkSite->get_NetworkLegConnections(&networkLegConnections);

network_leg_connections = networkSite.NetworkLegConnections

NetworkCCG

ISIAPINetworkCCG NetworkCCG { get; }

Type ISIAPINetworkCCG

Code samples

C#C++Python

var networkCCG = networkSite.NetworkCCG;

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

network_ccg = networkSite.NetworkCCG

Site

ISIAPISite Site { get; }

Type ISIAPISite

Code samples

C#C++Python

var site = networkSite.Site;

CComPtr<ISIAPISite> site;
networkSite->get_Site(&site);

site = networkSite.Site

DiagnosticStatus

Diagnostic Status

int DiagnosticStatus { get; }

Type int

Value

One of:

• 1 - Processed
• 2 - Not Processed
• 3 - Input Warning
• 4 - Processing Warning
• 5 - Error

Code samples

C#C++Python

int diagnosticStatus = networkSite.DiagnosticStatus;

long diagnosticStatus;
networkSite->get_DiagnosticStatus(&diagnosticStatus);

diagnostic_status = networkSite.DiagnosticStatus

DiagnosticMsgs

ISIAPIDiagnosticMsgs DiagnosticMsgs { get; }

Type ISIAPIDiagnosticMsgs

Code samples

C#C++Python

var diagnosticMsgs = networkSite.DiagnosticMsgs;

CComPtr<ISIAPIDiagnosticMsgs> diagnosticMsgs;
networkSite->get_DiagnosticMsgs(&diagnosticMsgs);

diagnostic_msgs = networkSite.DiagnosticMsgs

IsIncludedInProjectSummary

bool IsIncludedInProjectSummary { get; set; }

Type bool

Code samples

C#C++Python

bool isIncludedInProjectSummary = networkSite.IsIncludedInProjectSummary;
networkSite.IsIncludedInProjectSummary = true;

VARIANT_BOOL isIncludedInProjectSummary;
networkSite->get_IsIncludedInProjectSummary(&isIncludedInProjectSummary);
networkSite->put_IsIncludedInProjectSummary(VARIANT_TRUE);

is_included_in_project_summary = networkSite.IsIncludedInProjectSummary
networkSite.IsIncludedInProjectSummary = True