PlaceRapidPrototypeRibbonCable(List<RibbonCableInputBranchInfo>,List<Connection>,RapidRibbonCableDefinition) Method

In This Topic

Place a rapid prototype ribbon cable with branch structure.

Syntax

public IOccRapidRibbonCable PlaceRapidPrototypeRibbonCable( 
   List<RibbonCableInputBranchInfo> branches,
   List<Connection> connections,
   RapidRibbonCableDefinition definition
)

Parameters

branches: List holding information about branching of ribbon cable.
connections: Connections of wires of placed cable. Determines which pins on connectors will be connected by a wire.
definition: Rapid prototype ribbon cable definition. If the definition is null the default values from settings are used.

Return Value

Placed rapid prototype ribbon cable.

Exceptions

Exception	Description
EPLAN.Harness.API.Exceptions.ConnectionException
EPLAN.Harness.API.Exceptions.ArgumentException
EPLAN.Harness.API.Exceptions.ArgumentNullException
EPLAN.Harness.API.Exceptions.FileClosedException	This file is not opened.
EPLAN.Harness.API.Exceptions.HpdApiNotInitializedException	Api is not in an initialized state. You can get current state from EPLAN.Harness.API.HpdApi.Status property. If API is uninitialized, you can initialize it by calling EPLAN.Harness.API.HpdApi.Init 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.OccurrenceMissingInDocumentException	Thrown when the occurrence is not part of this document.

Remarks

For detailed example how to compose branches see method for placing library cable. Placing rapid ribbon cable is analogical, the only difference is that you have to provide a rapid ribbon cable definition instead of library part.

Reference

Designer Class
Designer Members
Overload List
RapidRibbonCableDefinition Class
Connection Class
LengthProperty Class

Send Feedback