Harness proD API Help
EPLAN.Harness.API.Common Namespace / Extensions Class / Route Method
Routable occurrence.
Bundles for routing.
Example
In This Topic
    Route Method (Extensions)
    In This Topic
    Route this routable object through the given bundles.
    Syntax
    [Extension()]
public static void Route( 
   IRoutable routable,
   List<IBundle> bundles
)

    Parameters

    routable
    Routable occurrence.
    bundles
    Bundles for routing.
    Exceptions
    ExceptionDescription
    EPLAN.Harness.API.Exceptions.HpdApiNotInitializedExceptionApi is not in an initialized state. You can get current state from Status property. If API is uninitialized, you can initialize it by calling Init(String,String[]) method. If API is in failed state, you can not resurrect it.
    EPLAN.Harness.API.Exceptions.ObjectInvalidException The object is in invalid state. Obtain a new one.
    EPLAN.Harness.API.Exceptions.LicensingErrorException This operation was denied because of your license.
    EPLAN.Harness.API.Exceptions.ArgumentNullException
    EPLAN.Harness.API.Exceptions.OccurrenceMissingInDocumentExceptionThrown when any occurrence is not a part of this document.
    EPLAN.Harness.API.Exceptions.CannotRouteCableWireException Thrown when you try to route a cable wire.
    EPLAN.Harness.API.Exceptions.OccurrenceIsAlreadyRoutedException Thrown when you try to route a routable occurrence through a bundle, in which it is already routed.
    Example
    This example shows how to route a wire.
    // Obtain the wire:
IRoutable wire = ...

// Obtain the bundles you want to route the wire through.
IBundle bundle1 = ...
IBundle bundle2 = ...
IBundle bundle3 = ...

// Route the wire through the bundles.
wire.Route(new[] { bundle1, bundle2, bundle3 }.ToList());
    See Also

    Reference

    Extensions Class
    Extensions Members
    OccWsWire Class
    OccWsCable Class
    OccWsBundle Class
    OccWdWire Class
    OccWdCable Class
    OccWdBundle Class

    Send Feedback