OccWdShieldWire Class

In This Topic

Represents an occurrence of conductive shield representation from a workdesk. The shield wire's behavior is similar to cable wire's. The conductive shield wire can be connected to a pin and a grouped (super) pin as well. One or both ends can be connected.

Object Model

Inheritance Hierarchy

System.Object
   EPLAN.Harness.API.ApiObject
      EPLAN.Harness.API.Occurrences.BaseOccurrence
         EPLAN.Harness.API.Occurrences.Base3DOccurrence
            EPLAN.Harness.API.Occurrences.BaseWdOccurrence
               EPLAN.Harness.API.Occurrences.Workdesk.BaseWdWire
                  EPLAN.Harness.API.Occurrences.Workdesk.OccWdShieldWire

Syntax

public class OccWdShieldWire : BaseWdWire, EPLAN.Harness.API.Interfaces.IApiObject, EPLAN.Harness.API.Occurrences.Interfaces.I3DOccurrence, EPLAN.Harness.API.Occurrences.Interfaces.IControlPath, EPLAN.Harness.API.Occurrences.Interfaces.IControlPathWithEnds, EPLAN.Harness.API.Occurrences.Interfaces.IExportable3D, EPLAN.Harness.API.Occurrences.Interfaces.IGraphicalOccurrence, EPLAN.Harness.API.Occurrences.Interfaces.IOccShieldWire, EPLAN.Harness.API.Occurrences.Interfaces.IOccurrence, EPLAN.Harness.API.Occurrences.Interfaces.IReconnectable, EPLAN.Harness.API.Occurrences.Interfaces.IUserDefinedProperties, EPLAN.Harness.API.Occurrences.Interfaces.IWire, EPLAN.Harness.API.Occurrences.Interfaces.IWireCommon

Remarks

Please note that values of the shield wire properties are taken from the parent conductive shield. Those values are settable to preserve compatibility with various interfaces, however the setters have no effect! If you want to change conductive shield properties use the conductive shield occurrence itself, not the shield wire. It can be conveniently accessed using the ConductiveShield property.

Public Properties

	Name	Description
	BendingRadiiCheck	Gets or sets the value of the 'Bending radii check' property of this occurrence.
	BendingRadius	Gets the bending radius of this occurrence.
	CableLength	Gets the cable length of this occurrence.
	Children	Gets children occurrences of closest level in hierarchy of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
	Color	Overridden. Gets or sets the color of this occurrence.
	ConductiveShield	Parent conductive shield which is visible in the GUI.
	ConnectedPins	Overridden. Gets the names of pins to which this occurrence is connected.
	ConnectionDescription	Gets or sets the connection description of this occurrence.
	ConnectionDesignation	Overridden. Gets or sets the connection designation of this occurrence.
	CrossSection	Overridden. Get or set the cross section of this occurrence.
	Exportable3D	Determines if this part is to be exported or not when using EPLAN.Harness.API.Projects.Documents.Designer.Export3DFile.
	ID	ID of the HpD object. (Inherited from EPLAN.Harness.API.ApiObject)
	Imprint	Overridden. Gets or sets the imprint of this occurrence.
	Interpolation	Gets or sets the interpolation algorithm of this occurrence.
	IsRapid	Is the part a rapid prototype? (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
	IsValid	Tells you whether this object is valid or not. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
	Length	Overridden. Gets the length of this occurrence.
	LibraryPart	Gets the related library part from which this occurrence was derived. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
	MaterialCode	Overridden. Gets the material code of this occurrence.
	Name	Overridden. Gets or sets the name of the occurrence.
	OutsideDiameter	Overridden. Get or set the outside diameter of this occurrence. Note: In the case of the rapid prototype cables, the outside diameter should be set on the top-level insulator.
	P8DisplayedDT	Gets the P8 displayed device tag. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
	P8FullDT	Gets the P8 full device tag. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
	P8FunctionText	Gets the P8 function text. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
	ParentCable	Parent cable occurrence of this wire.
	Parents	Gets parent occurrences of closest level in hierarchy of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
	RawLength	Gets the raw length of this occurrence.
	Selectable	Gets or sets the value of 'Selectable' property of this occurrence.
	UserDefinedProperties	Overridden. Gets or sets a list of user-defined properties of this occurrence.

Top

Public Methods

	Name	Description
	Equals	Overloaded. Determines whether the specified object is equal to the current object. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
	GetConnectedPins	Overridden. Gets pins to which this wire is connected.
	GetControlPoints	Overridden. Gets all control point on this control path.
	GetHashCode	Serves as the default hash function. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
	Reconnect	Overridden. Reconnect this shield from one grouped pin to another.
	ToString	Returns a string that represents the current object. (Inherited from EPLAN.Harness.API.ApiObject)

Top

Reference

OccWdShieldWire Members
EPLAN.Harness.API.Occurrences.Workdesk Namespace
IOccShieldWire Interface
IOccShield Interface
IOccConductiveShield Interface

Send Feedback