Skip to content

ISIAPILaneApproachs Interface

Namespace: SIDRASolutions.SI.API
Assembly: SIDRASolutions.SI.API.dll COM CLSID: 7C5E3DE3-C295-478D-9061-88583D18826F

Declaration

[Guid("7C5E3DE3-C295-478D-9061-88583D18826F")]
public interface ISIAPILaneApproachs

Get an instance

// Navigate to the ISIAPILaneApproachs you need via the ISIAPI tree.
// See ISIAPI for the activation root.
var laneApproachs = /* ... */;
' Navigate to the ISIAPILaneApproachs you need via the ISIAPI tree.
' See ISIAPI for the activation root.
Dim laneApproachs As ISIAPILaneApproachs = Nothing
# Navigate to the ISIAPILaneApproachs you need via the ISIAPI tree.
# See ISIAPI for the activation root.
laneApproachs = ...
# Navigate to the ISIAPILaneApproachs you need via the ISIAPI tree.
# See ISIAPI for the activation root.
$laneApproachs = $null

Properties

Count

int Count { get; }

Type int

Code samples
int count = laneApproachs.Count;
Dim count As Integer = laneApproachs.Count
count = laneApproachs.Count
$count = $laneApproachs.Count

this[]

ISIAPILaneApproach this[] { get; }

Type ISIAPILaneApproach

Code samples
var this[] = laneApproachs.this[];
Dim this[] As ISIAPILaneApproach = laneApproachs.this[]
this[] = laneApproachs.this[]
$this[] = $laneApproachs.this[]

Methods

LaneApproachExists(int)

bool LaneApproachExists(int laneno)

Parameters

Name Type Description
laneno int Approach Lane Number, a one-based integer, counts Approach Lanes only from left to right looking in the direction of departure.

Returns bool

Code samples
bool result = laneApproachs.LaneApproachExists(0);
Dim result As Boolean = laneApproachs.LaneApproachExists(0)
result = laneApproachs.LaneApproachExists(0)
$result = $laneApproachs.LaneApproachExists(0)

AddLane()

Add an Approach Lane
If the Leg has Approach Lane(s), if driving-on-left, the rightmost Approach Lane is cloned. The cloned Lane is added to the right. If driving-on-right, the leftmost Approach Lane is cloned. The cloned Lane is added to the left.
If the Leg does not have any Approach Lane, a new default Approach Lane is added.

ISIAPILaneApproach AddLane()

Returns ISIAPILaneApproach - The new added Approach Lane

Remarks

Call SIAPISite.ResetLaneMovements() manually after adding / removing Lanes. If Leg(s) has been added or removed, call SIAPISite.UpdateGeometryData() instead of ResetLaneMovements().

Code samples
var result = laneApproachs.AddLane();
Dim result As ISIAPILaneApproach = laneApproachs.AddLane()
result = laneApproachs.AddLane()
$result = $laneApproachs.AddLane()

RemoveLane()

Remove an Approach Lane

If driving-on-left, the rightmost Approach Lane is removed. If driving-on-right, the leftmost Approach Lane is removed.

void RemoveLane()

Remarks

Call SIAPISite.ResetLaneMovements() manually after adding / removing Lanes. If Leg(s) has been added or removed, call SIAPISite.UpdateGeometryData() instead of ResetLaneMovements().

Code samples
laneApproachs.RemoveLane();
laneApproachs.RemoveLane()
laneApproachs.RemoveLane()
$laneApproachs.RemoveLane()