Eplan Platform API
Eplan.EplApi.DataModel.EObjects Namespace / Cable Class / GetSourcesAndTargets Method / GetSourcesAndTargets(ICollection<StorableObject>,ICollection<StorableObject>,Boolean) Method
Collection which will be filled with sources of the cable. Can't be null or read-only.
Collection which will be filled with targets of the cable. Can't be null or read-only.
If set to true collections for sourcres and target will be filled for every connection. If set to false works like overloaded method.

In This Topic
GetSourcesAndTargets(ICollection<StorableObject>,ICollection<StorableObject>,Boolean) Method
In This Topic
Gets sources and targets of the cable.
Syntax
public void GetSourcesAndTargets( 
   ICollection<StorableObject> colSources,
   ICollection<StorableObject> colTargets,
   bool bForAllWires
)

Parameters

colSources
Collection which will be filled with sources of the cable. Can't be null or read-only.
colTargets
Collection which will be filled with targets of the cable. Can't be null or read-only.
bForAllWires
If set to true collections for sourcres and target will be filled for every connection. If set to false works like overloaded method.
Exceptions
ExceptionDescription
System.ArgumentNullExceptionIf any parameter is null.
System.NotSupportedExceptionThrown if given collection is read-only.
Eplan.EplApi.DataModel.InvalidHandleExceptionThrown when internally used handle is not valid.
Eplan.EplApi.Base.BaseExceptionThrown when an internal error occured. Please refer to the error message.
Remarks
Method removes all elements from given collections and fills them with sources and targets of a cable. When method is used for all wires it outputs device tags of sources and targets with detailed information about connections.
See Also

Reference

Cable Class
Cable Members
Overload List

 

 

EPLAN API , 18.11.2024, © by EPLAN GmbH & Co. KG. All rights reserved.

Send Feedback