Skip to content

ISIAPISiteVolumeLegs Interface

Namespace: SIDRASolutions.SI.API
Assembly: SIDRASolutions.SI.API.dll COM CLSID: 054C4737-ACF6-42B1-AF5B-B5F6358FD3CA

Declaration

[Guid("054C4737-ACF6-42B1-AF5B-B5F6358FD3CA")]
public interface ISIAPISiteVolumeLegs

Get an instance

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

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

# Navigate to the ISIAPISiteVolumeLegs you need via the ISIAPI tree.
# See ISIAPI for the activation root.
siteVolumeLegs = ...

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

Properties

Count

int Count { get; }

Type int

Code samples 
int count = siteVolumeLegs.Count;

Dim count As Integer = siteVolumeLegs.Count

count = siteVolumeLegs.Count

$count = $siteVolumeLegs.Count

this[]

Get a Site Volume Bin Leg.
Return a Site Volume Bin Leg if it exists in the data storage; otherwise, null/Nothing.

ISIAPISiteVolumeLeg this[] { get; }

Type ISIAPISiteVolumeLeg

Code samples 
var this[] = siteVolumeLegs.this[];

Dim this[] As ISIAPISiteVolumeLeg = siteVolumeLegs.this[]

this[] = siteVolumeLegs.this[]

$this[] = $siteVolumeLegs.this[]

Methods

LegExists(int)

Get a value indicating whether a Site Volume Bin Leg exists in the data storage.

bool LegExists(int orientation)

Parameters

Name Type Description
orientation int One of: - 0 - South - 1 - South East - 2 - East - 3 - North East - 4 - North - 5 - North West - 6 - West - 7 - South West

Returns bool - true if it exists in the data storage; otherwise, false

Code samples 
bool result = siteVolumeLegs.LegExists(0);

Dim result As Boolean = siteVolumeLegs.LegExists(0)

result = siteVolumeLegs.LegExists(0)

$result = $siteVolumeLegs.LegExists(0)