Skip to content

ISIAPISiteVolumeMovVehOD Interface

Namespace: SIDRASolutions.SI.API
Assembly: SIDRASolutions.SI.API.dll COM CLSID: A1188259-4813-4003-B8F8-CA17BDE7CBB9

Declaration

[Guid("A1188259-4813-4003-B8F8-CA17BDE7CBB9")]
public interface ISIAPISiteVolumeMovVehOD

Get an instance

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

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

# Navigate to the ISIAPISiteVolumeMovVehOD you need via the ISIAPI tree.
# See ISIAPI for the activation root.
siteVolumeMovVehOD = ...

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

Properties

Origin

Movement Origin Leg

int Origin { get; }

Type int

Value

One of:

  • 0 - South
  • 1 - South East
  • 2 - East
  • 3 - North East
  • 4 - North
  • 5 - North West
  • 6 - West
  • 7 - South West
Code samples 
int origin = siteVolumeMovVehOD.Origin;

Dim origin As Integer = siteVolumeMovVehOD.Origin

origin = siteVolumeMovVehOD.Origin

$origin = $siteVolumeMovVehOD.Origin

Destination

Movement Destination Leg

int Destination { get; }

Type int

Value

One of:

  • 0 - South
  • 1 - South East
  • 2 - East
  • 3 - North East
  • 4 - North
  • 5 - North West
  • 6 - West
  • 7 - South West
Code samples 
int destination = siteVolumeMovVehOD.Destination;

Dim destination As Integer = siteVolumeMovVehOD.Destination

destination = siteVolumeMovVehOD.Destination

$destination = $siteVolumeMovVehOD.Destination

IsPossible

Flag indicating whether this Approach Movement is Geometry Possible, i.e. the Origin Volume Bin Leg Geometry is Two-way or One-Way Approach, and the Destination Volume Bin Leg Geometry is Two-way or One-Way Exit.

bool IsPossible { get; }

Type bool

Code samples 
bool isPossible = siteVolumeMovVehOD.IsPossible;

Dim isPossible As Boolean = siteVolumeMovVehOD.IsPossible

is_possible = siteVolumeMovVehOD.IsPossible

$isPossible = $siteVolumeMovVehOD.IsPossible

Exists

Flag indicating whether this Approach Movement "exists" (not banned) in the current Site Volume Bin.

The state of this property corresponds to the setting of the "Movement Exists" checkbox in the SIDRA INTERSECTION "Site Bin Setup" dialog - "Approach Movements" tab for the given Approach Movement.

bool Exists { get; set; }

Type bool

Code samples 
bool exists = siteVolumeMovVehOD.Exists;
siteVolumeMovVehOD.Exists = true;

Dim exists As Boolean = siteVolumeMovVehOD.Exists
siteVolumeMovVehOD.Exists = true

exists = siteVolumeMovVehOD.Exists
siteVolumeMovVehOD.Exists = True

$exists = $siteVolumeMovVehOD.Exists
$siteVolumeMovVehOD.Exists = $true

Total_volume

float Total_volume { get; }

Type float

Code samples 
float total_volume = siteVolumeMovVehOD.Total_volume;

Dim total_volume As Single = siteVolumeMovVehOD.Total_volume

total_volume = siteVolumeMovVehOD.Total_volume

$total_volume = $siteVolumeMovVehOD.Total_volume

SiteVolumeBin

ISIAPISiteVolumeBin SiteVolumeBin { get; }

Type ISIAPISiteVolumeBin

Code samples 
var siteVolumeBin = siteVolumeMovVehOD.SiteVolumeBin;

Dim siteVolumeBin As ISIAPISiteVolumeBin = siteVolumeMovVehOD.SiteVolumeBin

site_volume_bin = siteVolumeMovVehOD.SiteVolumeBin

$siteVolumeBin = $siteVolumeMovVehOD.SiteVolumeBin

SiteVolumeMovVehODMCs

ISIAPISiteVolumeMovVehODMCs SiteVolumeMovVehODMCs { get; }

Type ISIAPISiteVolumeMovVehODMCs

Code samples 
var siteVolumeMovVehODMCs = siteVolumeMovVehOD.SiteVolumeMovVehODMCs;

Dim siteVolumeMovVehODMCs As ISIAPISiteVolumeMovVehODMCs = siteVolumeMovVehOD.SiteVolumeMovVehODMCs

site_volume_mov_veh_odm_cs = siteVolumeMovVehOD.SiteVolumeMovVehODMCs

$siteVolumeMovVehODMCs = $siteVolumeMovVehOD.SiteVolumeMovVehODMCs