Skip to content

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

Get an instance

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

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

# Navigate to the ISIAPINetworkSite you need via the ISIAPI tree.
# See ISIAPI for the activation root.
networkSite = ...

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

Properties

NetworkSite_id

The unique ID of the NetworkSite object.

string NetworkSite_id { get; }

Type string

Code samples 
string networkSite_id = networkSite.NetworkSite_id;

Dim networkSite_id As String = networkSite.NetworkSite_id

network_site_id = networkSite.NetworkSite_id

$networkSite_id = $networkSite.NetworkSite_id

Network

ISIAPINetwork Network { get; }

Type ISIAPINetwork

Code samples 
var network = networkSite.Network;

Dim network As ISIAPINetwork = networkSite.Network

network = networkSite.Network

$network = $networkSite.Network

SiteName

string SiteName { get; }

Type string

Code samples 
string siteName = networkSite.SiteName;

Dim siteName As String = networkSite.SiteName

site_name = networkSite.SiteName

$siteName = $networkSite.SiteName

SiteOutputset

Site output data of this Site in the particular Network

ISIAPIOutputset SiteOutputset { get; }

Type ISIAPIOutputset

Code samples 
var siteOutputset = networkSite.SiteOutputset;

Dim siteOutputset As ISIAPIOutputset = networkSite.SiteOutputset

site_outputset = networkSite.SiteOutputset

$siteOutputset = $networkSite.SiteOutputset

IsReference

bool IsReference { get; set; }

Type bool

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

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

is_reference = networkSite.IsReference
networkSite.IsReference = True

$isReference = $networkSite.IsReference
$networkSite.IsReference = $true

Offset

int Offset { get; set; }

Type int

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

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

offset = networkSite.Offset
networkSite.Offset = 0

$offset = $networkSite.Offset
$networkSite.Offset = 0

LayoutX

float LayoutX { get; set; }

Type float

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

Dim layoutX As Single = networkSite.LayoutX
networkSite.LayoutX = 0.0

layout_x = networkSite.LayoutX
networkSite.LayoutX = 0.0

$layoutX = $networkSite.LayoutX
$networkSite.LayoutX = 0.0

LayoutY

float LayoutY { get; set; }

Type float

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

Dim layoutY As Single = networkSite.LayoutY
networkSite.LayoutY = 0.0

layout_y = networkSite.LayoutY
networkSite.LayoutY = 0.0

$layoutY = $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 
int coordinatedOption = networkSite.CoordinatedOption;
networkSite.CoordinatedOption = 0;

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

coordinated_option = networkSite.CoordinatedOption
networkSite.CoordinatedOption = 0

$coordinatedOption = $networkSite.CoordinatedOption
$networkSite.CoordinatedOption = 0

NetworkLegConnections

ISIAPINetworkLegConnections NetworkLegConnections { get; }

Type ISIAPINetworkLegConnections

Code samples 
var networkLegConnections = networkSite.NetworkLegConnections;

Dim networkLegConnections As ISIAPINetworkLegConnections = networkSite.NetworkLegConnections

network_leg_connections = networkSite.NetworkLegConnections

$networkLegConnections = $networkSite.NetworkLegConnections

NetworkCCG

ISIAPINetworkCCG NetworkCCG { get; }

Type ISIAPINetworkCCG

Code samples 
var networkCCG = networkSite.NetworkCCG;

Dim networkCCG As ISIAPINetworkCCG = networkSite.NetworkCCG

network_ccg = networkSite.NetworkCCG

$networkCCG = $networkSite.NetworkCCG

Site

ISIAPISite Site { get; }

Type ISIAPISite

Code samples 
var site = networkSite.Site;

Dim site As ISIAPISite = networkSite.Site

site = networkSite.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 
int diagnosticStatus = networkSite.DiagnosticStatus;

Dim diagnosticStatus As Integer = networkSite.DiagnosticStatus

diagnostic_status = networkSite.DiagnosticStatus

$diagnosticStatus = $networkSite.DiagnosticStatus

DiagnosticMsgs

ISIAPIDiagnosticMsgs DiagnosticMsgs { get; }

Type ISIAPIDiagnosticMsgs

Code samples 
var diagnosticMsgs = networkSite.DiagnosticMsgs;

Dim diagnosticMsgs As ISIAPIDiagnosticMsgs = networkSite.DiagnosticMsgs

diagnostic_msgs = networkSite.DiagnosticMsgs

$diagnosticMsgs = $networkSite.DiagnosticMsgs

IsIncludedInProjectSummary

bool IsIncludedInProjectSummary { get; set; }

Type bool

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

Dim isIncludedInProjectSummary As Boolean = networkSite.IsIncludedInProjectSummary
networkSite.IsIncludedInProjectSummary = true

is_included_in_project_summary = networkSite.IsIncludedInProjectSummary
networkSite.IsIncludedInProjectSummary = True

$isIncludedInProjectSummary = $networkSite.IsIncludedInProjectSummary
$networkSite.IsIncludedInProjectSummary = $true