Class Route

Inheritance

System.Object

Route

Curve

Linear

Implements

IRoute

System.IDisposable

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Experior.Core.Routes

Assembly: Experior.Core.dll

Syntax

[TypeConverter(typeof(ObjectConverter))]
public abstract class Route : IRoute, IDisposable

Constructors

Route()

Declaration

protected Route()

Fields

DragDropLoad

Declaration

public bool DragDropLoad

Field Value

Type	Description
System.Boolean

RemoveLoad

Declaration

public bool RemoveLoad

Field Value

Type	Description
System.Boolean

Properties

Accumulating

Declaration

public bool Accumulating { get; set; }

Property Value

Type	Description
System.Boolean

AccumulationReleaseDelay

When a load is released then the load behind will be released after this delay (seconds) if it is in queue.

Declaration

[Browsable(false)]
public float AccumulationReleaseDelay { get; set; }

Property Value

Type	Description
System.Single

Remarks

Note: Load.WaitingTime is set to this value.

ActionPoints

Get a copy of the action points list.

Declaration

[Browsable(true)]
public IReadOnlyList<ActionPoint> ActionPoints { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyList<ActionPoint>	The action points.

Arrow

Declaration

[Browsable(false)]
public IArrow Arrow { get; }

Property Value

Type	Description
IArrow

ArrowAutoScale

Declaration

[Browsable(false)]
public Route.ArrowAutoScales ArrowAutoScale { get; set; }

Property Value

Type	Description
Route.ArrowAutoScales

Bidirectional

Declaration

[Browsable(false)]
public bool Bidirectional { get; set; }

Property Value

Type	Description
System.Boolean

Center

Declaration

[Browsable(false)]
public virtual Vector3 Center { get; }

Property Value

Type	Description
System.Numerics.Vector3

Disposed

Declaration

[Browsable(false)]
public bool Disposed { get; }

Property Value

Type	Description
System.Boolean

End

Declaration

[Browsable(false)]
[TypeConverter(typeof(Vector3MeterToMillimeter))]
public virtual Vector3 End { get; set; }

Property Value

Type	Description
System.Numerics.Vector3

First

First load on route (in Motor direction).

Declaration

public Load First { get; }

Property Value

Type	Description
Load

Items

Declaration

[Browsable(false)]
public static IReadOnlyCollection<Route> Items { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyCollection<Route>

Last

Last load on route (in Motor direction).

Declaration

public Load Last { get; }

Property Value

Type	Description
Load

Length

Declaration

[Browsable(false)]
public virtual float Length { get; }

Property Value

Type	Description
System.Single

Loads

Get the load list. Do not add or remove loads from the list. Use Route.Add and Route.Remove methods.

Declaration

[Browsable(false)]
public LinkedList<Load> Loads { get; }

Property Value

Type	Description
System.Collections.Generic.LinkedList<Load>	The loads.

LoadsOnPathCount

Get the number of loads on the path that this route is part of.

Declaration

[Browsable(false)]
public int LoadsOnPathCount { get; }

Property Value

Type	Description
System.Int32

Motor

Gets or sets route motor.

Declaration

public virtual IMotor Motor { get; set; }

Property Value

Type	Description
IMotor	The motor.

Name

Gets or sets the route name.

Declaration

[Browsable(false)]
public string Name { get; set; }

Property Value

Type	Description
System.String	The name of the route.

NextRoute

Gets or sets the next route.

Declaration

public Route NextRoute { get; set; }

Property Value

Type	Description
Route	Next route.

Exceptions

Type	Condition
System.Exception

NonAccumulationBlocked

Declaration

[Browsable(false)]
public bool NonAccumulationBlocked { get; }

Property Value

Type	Description
System.Boolean

Orientation

Gets or sets orientation.

Declaration

[Browsable(false)]
public virtual Matrix4x4 Orientation { get; set; }

Property Value

Type	Description
System.Numerics.Matrix4x4	Orientation.

Parent

Get the route parent (ITransportSection).

Declaration

public ITransportSection Parent { get; }

Property Value

Type	Description
ITransportSection	Parent.

Pitch

Pitch.

Declaration

[Browsable(false)]
public virtual float Pitch { get; }

Property Value

Type	Description
System.Single	Pitch.

Position

Gets or sets the Route center position.

Declaration

[Browsable(false)]
public virtual Vector3 Position { get; set; }

Property Value

Type	Description
System.Numerics.Vector3	Route center position.

PreviousRoute

Gets or sets the previous route.

Declaration

public Route PreviousRoute { get; set; }

Property Value

Type	Description
Route	Previous route.

Exceptions

Type	Condition
System.ObjectDisposedException
System.Exception

Roll

Roll.

Declaration

[Browsable(false)]
public virtual float Roll { get; }

Property Value

Type	Description
System.Single	Roll.

Spacing

Spacing between loads. Set SpacingType to select if spacing should be back to front or front to front.

Declaration

[Browsable(false)]
public float Spacing { get; set; }

Property Value

Type	Description
System.Single	The spacing in meters

SpacingAtTransfer

If true then spacing is also kept when the load in front has the leading edge entering the next route. If false the load is allowed to move with 0 space when the load in front has leading edge entering the next route.

Declaration

public bool SpacingAtTransfer { get; set; }

Property Value

Type	Description
System.Boolean

SpacingType

Spacing between loads is either BackToFront or FrontToFront.

Declaration

[Browsable(false)]
public Route.SpacingTypes SpacingType { get; set; }

Property Value

Type	Description
Route.SpacingTypes

Start

Gets or sets the start position of this Route.

Declaration

[Browsable(false)]
[TypeConverter(typeof(Vector3MeterToMillimeter))]
public virtual Vector3 Start { get; set; }

Property Value

Type	Description
System.Numerics.Vector3	Start position.

Steps

Declaration

[Browsable(false)]
public virtual int Steps { get; }

Property Value

Type	Description
System.Int32

TransformedDirectionVector

Declaration

[Browsable(false)]
public Vector3 TransformedDirectionVector { get; }

Property Value

Type	Description
System.Numerics.Vector3

TransformedUpVector

Gets the transformed up vector.

Declaration

[Browsable(false)]
public Vector3 TransformedUpVector { get; }

Property Value

Type	Description
System.Numerics.Vector3	The transformed up vector.

TransitionBlocked

Declaration

public bool TransitionBlocked { get; }

Property Value

Type	Description
System.Boolean

TranslationVector

Gets or sets the translation vector.

Declaration

[Browsable(false)]
public virtual Vector3 TranslationVector { get; set; }

Property Value

Type	Description
System.Numerics.Vector3	The translation vector.

UpdateAutomatically

Declaration

[Browsable(false)]
public static bool UpdateAutomatically { get; set; }

Property Value

Type	Description
System.Boolean

UpdateAutomaticallyButtonToolTip

Declaration

[Browsable(false)]
public static string UpdateAutomaticallyButtonToolTip { get; set; }

Property Value

Type	Description
System.String

Updating

Declaration

public static bool Updating { get; }

Property Value

Type	Description
System.Boolean

UserData

Gets or sets user data.

Declaration

[Browsable(false)]
public object UserData { get; set; }

Property Value

Type	Description
System.Object	User data.

Vertical

Gets or sets a value indicating whether this Route is vertical.

Declaration

[Browsable(false)]
public bool Vertical { get; set; }

Property Value

Type	Description
System.Boolean	true if vertical; otherwise, false.

Visible

Gets or sets a value indicating whether this Route is visible. When a route is initiated inside the Transport class the Visible property works independently from the RenderingOption � It means that the route and the motor arrow is always displayed if visible is set to true even if the RenderingOption of the TransportSection is different from the Environment.Scene.PresentationLevel. In other words: the RenderingOpetion only controls the visibility of the primitive sharp that visualizes the transport section (box or curve area) and not the route line and the motor arrow.

Declaration

[Browsable(false)]
public virtual bool Visible { get; set; }

Property Value

Type	Description
System.Boolean	true if visible; otherwise, false.

Yaw

Yaw.

Declaration

[Browsable(false)]
public virtual float Yaw { get; }

Property Value

Type	Description
System.Single	Yaw.

Methods

Add(Load)

Adds load to route.

Declaration

public void Add(Load load)

Parameters

Type	Name	Description
Load	load	Specified load

Add(Load, Single)

Adds load to route at specified distance (from route start).

Declaration

public void Add(Load load, float distance)

Parameters

Type	Name	Description
Load	load	Specified load
System.Single	distance	Distance of load in meters

AddActionPoint(ActionPoint)

Declaration

protected void AddActionPoint(ActionPoint ap)

Parameters

Type	Name	Description
ActionPoint	ap

ClearLoads()

Clear all Deletable loads on route.

Declaration

public void ClearLoads()

Dispose()

Dispose route.

Declaration

public virtual void Dispose()

FindNextActionPoint(ActionPoint)

Declaration

public static ActionPoint FindNextActionPoint(ActionPoint ap)

Parameters

Type	Name	Description
ActionPoint	ap

Returns

Type	Description
ActionPoint

FindNextActionPoint(ActionPoint, out Single)

Declaration

public static ActionPoint FindNextActionPoint(ActionPoint ap, out float distance)

Parameters

Type	Name	Description
ActionPoint	ap
System.Single	distance

Returns

Type	Description
ActionPoint

FindNextActionPoint(Route)

Declaration

public static ActionPoint FindNextActionPoint(Route route)

Parameters

Type	Name	Description
Route	route

Returns

Type	Description
ActionPoint

FindNextActionPoint(Route, Boolean)

Declaration

public static ActionPoint FindNextActionPoint(Route route, bool include)

Parameters

Type	Name	Description
Route	route
System.Boolean	include

Returns

Type	Description
ActionPoint

FindPreviousActionPoint(ActionPoint)

Declaration

public static ActionPoint FindPreviousActionPoint(ActionPoint ap)

Parameters

Type	Name	Description
ActionPoint	ap

Returns

Type	Description
ActionPoint

FindPreviousActionPoint(ActionPoint, out Single)

Declaration

public static ActionPoint FindPreviousActionPoint(ActionPoint ap, out float distance)

Parameters

Type	Name	Description
ActionPoint	ap
System.Single	distance

Returns

Type	Description
ActionPoint

GetIndexDistance(Single)

Declaration

public abstract int GetIndexDistance(float distance)

Parameters

Type	Name	Description
System.Single	distance

Returns

Type	Description
System.Int32

GetLoadOrientation(ILoad)

Get orientation of specified load.

Declaration

public abstract Matrix4x4 GetLoadOrientation(ILoad load)

Parameters

Type	Name	Description
ILoad	load	Load to get orientation for.

Returns

Type	Description
System.Numerics.Matrix4x4	Orientation of load

GetLoadPosition(ILoad)

Get position of specified load.

Declaration

public abstract Vector3 GetLoadPosition(ILoad load)

Parameters

Type	Name	Description
ILoad	load	Load to get position for.

Returns

Type	Description
System.Numerics.Vector3	Position of load

GetOccupyingDistance(Load)

Get the distance that the specified load occupies on the current route. I.e. takes into account yaw of load etc.

Declaration

public static float GetOccupyingDistance(Load load)

Parameters

Type	Name	Description
Load	load	Specified load

Returns

Type	Description
System.Single	Occupied distance in meters

GetPositionDistance(Single)

Declaration

public abstract Vector3 GetPositionDistance(float distance)

Parameters

Type	Name	Description
System.Single	distance

Returns

Type	Description
System.Numerics.Vector3

GetYawIndex(Int32)

Declaration

public abstract float GetYawIndex(int index)

Parameters

Type	Name	Description
System.Int32	index

Returns

Type	Description
System.Single

InsertActionPoint(ActionPoint)

Insert

ActionPoint

onto route.

Declaration

public void InsertActionPoint(ActionPoint ap)

Parameters

Type	Name	Description
ActionPoint	ap	ActionPoint to insert

InsertActionPoint(ActionPoint, Single)

Insert specified ActionPoint onto the route at specified distance.

Declaration

public abstract void InsertActionPoint(ActionPoint ap, float distance)

Parameters

Type	Name	Description
ActionPoint	ap	ActionPoint
System.Single	distance	Distance in meters where ActionPoint should be created

InsertActionPoint(Single)

Create an ActionPoint and inserts it onto the route at specified distance.

Declaration

public ActionPoint InsertActionPoint(float distance)

Parameters

Type	Name	Description
System.Single	distance	Distance in meters where ActionPoint should be created

Returns

Type	Description
ActionPoint	Newly created ActionPoint

Intersection(Route)

Get intersection position between this route and specified route.

Declaration

public Vector3 Intersection(Route route)

Parameters

Type	Name	Description
Route	route	Route to test for intersection

Returns

Type	Description
System.Numerics.Vector3	Position of intersection

Move(Vector3)

Move route by a delta.

Declaration

public virtual void Move(Vector3 delta)

Parameters

Type	Name	Description
System.Numerics.Vector3	delta	Distance to move route.

PickActionPoint(Vector3, Vector3)

Get any actionpoint hit by ray.

Declaration

public ActionPoint PickActionPoint(Vector3 rayStart, Vector3 rayDirection)

Parameters

Type	Name	Description
System.Numerics.Vector3	rayStart	Ray start.
System.Numerics.Vector3	rayDirection	Ray direction.

Returns

Type	Description
ActionPoint	Non null actionpoint if hit, otherwise null.

PositioningActionPoints()

Declaration

protected void PositioningActionPoints()

Remove(Load)

Remove load from route.

Declaration

public void Remove(Load load)

Parameters

Type	Name	Description
Load	load

RemoveActionPoint(ActionPoint)

Removes specified actionpoint from the route.

Declaration

public void RemoveActionPoint(ActionPoint ap)

Parameters

Type	Name	Description
ActionPoint	ap	The ActionPoint to remove.

SetLength(Single)

Declaration

protected void SetLength(float value)

Parameters

Type	Name	Description
System.Single	value

SetLoadOrientationDirty(ILoad)

Declaration

public abstract void SetLoadOrientationDirty(ILoad load)

Parameters

Type	Name	Description
ILoad	load

SetLoadPositionDirty(ILoad)

Declaration

public abstract void SetLoadPositionDirty(ILoad load)

Parameters

Type	Name	Description
ILoad	load

ShortestDistanceToActionPoint(Load, String)

Declaration

public static float ShortestDistanceToActionPoint(Load load, string destination)

Parameters

Type	Name	Description
Load	load
System.String	destination

Returns

Type	Description
System.Single

ShortestDistanceToActionPoint(String, String)

Declaration

public static float ShortestDistanceToActionPoint(string sourceAP, string destinationAP)

Parameters

Type	Name	Description
System.String	sourceAP
System.String	destinationAP

Returns

Type	Description
System.Single

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Object.ToString()

Update()

Declaration

public static void Update()

Update(Boolean)

Declaration

public static void Update(bool force)

Parameters

Type	Name	Description
System.Boolean	force

Events

OnActionPointAdded

Raised when an ActionPoint is added to this route.

Declaration

public event Route.ActionPointAddedEvent OnActionPointAdded

Event Type

Type	Description
Route.ActionPointAddedEvent

OnArrived

Raised when a load arrives.

Declaration

public event Route.ArrivedEvent OnArrived

Event Type

Type	Description
Route.ArrivedEvent

OnDisposed

Raised when this route is being disposed.

Declaration

public event Route.DisposingEvent OnDisposed

Event Type

Type	Description
Route.DisposingEvent

OnDistanceChanged

Raised when an ActionPoints on this route changes Distance.

Declaration

public event Route.DistanceChangedEvent OnDistanceChanged

Event Type

Type	Description
Route.DistanceChangedEvent

OnGraphCreated

Declaration

public static event Route.GraphCreatedEvent OnGraphCreated

Event Type

Type	Description
Route.GraphCreatedEvent

OnLoadAdded

Raised when a load is added to this route.

Declaration

public event Route.LoadAddedEvent OnLoadAdded

Event Type

Type	Description
Route.LoadAddedEvent

OnLoadReleased

Declaration

public event Load.ReleasedEvent OnLoadReleased

Event Type

Type	Description
Load.ReleasedEvent

OnLoadRemoved

Raised when when a load is removed from this route.

Declaration

public event Route.LoadRemovedEvent OnLoadRemoved

Event Type

Type	Description
Route.LoadRemovedEvent

OnLoadStopped

Declaration

public event Load.ReleasedEvent OnLoadStopped

Event Type

Type	Description
Load.ReleasedEvent

OnOrientationChanged

Raised when Orientation changes.

Declaration

public event Route.OrientationChangedEvent OnOrientationChanged

Event Type

Type	Description
Route.OrientationChangedEvent

OnPositionChanged

Raised when Position changes.

Declaration

public event Route.PositionChangedEvent OnPositionChanged

Event Type

Type	Description
Route.PositionChangedEvent

OnTransitionBlockedChanged

Occurs if TransitionBlocked changed value during the last update.

Declaration

public event EventHandler<Route> OnTransitionBlockedChanged

Event Type

Type	Description
System.EventHandler<Route>

OnUpdateAutomaticallyButtonToolTipChanged

Declaration

public static event Route.UpdateAutomaticallyButtonToolTipChangedEvent OnUpdateAutomaticallyButtonToolTipChanged

Event Type

Type	Description
Route.UpdateAutomaticallyButtonToolTipChangedEvent

OnUpdateAutomaticallyChanged

Declaration

public static event Route.UpdateAutomaticallyChangedEvent OnUpdateAutomaticallyChanged

Event Type

Type	Description
Experior.Core.Routes.Route.UpdateAutomaticallyChangedEvent

OnUpdated

Declaration

public static event Route.UpdatedEvent OnUpdated

Event Type

Type	Description
Route.UpdatedEvent

Implements

IRoute

System.IDisposable