IOccShield Interface

In This Topic

Shield occurrence (non-conductive). The shield can be connected to a grouped (super) pin only. Both or one end only can be connected. If the shield is set as not conductive in the Library then it cannot be connected to a grouped pin's virtual pin. If it was set as conductive, its occurrence will be transformed to an IOccConductiveShield occurrence after connecting.

Object Model

Syntax

public interface IOccShield : EPLAN.Harness.API.Interfaces.IApiObject, I3DOccurrence, ICableSublayer, IControlPath, IControlPathWithEnds, IGraphicalOccurrence, IOccurrence, IReconnectable, IUserDefinedProperties

Public Properties

	Name	Description
	BendingRadiiCheck	Gets or sets the value of the 'Bending radii check' property of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.ICableSublayer)
	BendingRadius	Gets the bending radius of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.ICableSublayer)
	CableLength	Gets the cable length of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.ICableSublayer)
	Children	Gets children occurrences of closest level in hierarchy of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.IOccurrence)
	Color	Gets the color of this occurrence.
	ConnectedPins	Gets the names of pins to which this conductive shield is connected.
	CrossSection	Get or set the cross section of this occurrence.
	ID	Identifier of the API object. (Inherited from EPLAN.Harness.API.Interfaces.IApiObject)
	Imprint	Gets or sets the imprint of this occurrence.
	Interpolation	Gets or sets the interpolation algorithm of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.ICableSublayer)
	IsRapid	Is the part a rapid prototype? (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.IOccurrence)
	IsTopLayer	Specifies if this cable's sublayer is the top layer of the cable. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.ICableSublayer)
	IsValid	Is occurrence valid? (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.IOccurrence)
	Length	Gets the length of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.IControlPath)
	MaterialCode	Gets the material code of this occurrence.
	Name	Gets or sets the name of the occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.I3DOccurrence)
	OutsideDiameter	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. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.IControlPathWithEnds)
	Parents	Gets parent occurrences of closest level in hierarchy of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.IOccurrence)
	RawLength	Gets the raw length of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.ICableSublayer)
	Selectable	Gets or sets the value of 'Selectable' property of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.ICableSublayer)
	UserDefinedProperties	Gets or sets a list of user-defined properties of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.IUserDefinedProperties)

Top

Public Methods

	Name	Description
	Equals	(Inherited from System.IEquatable<IOccurrence>)
	GetConnectedPins	Gets pins to which this wire is connected. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.IReconnectable)
	GetControlPoints	Gets all control point on this control path. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.IControlPath)
	Reconnect	Reconnect this shield from one grouped pin to another. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.IReconnectable)

Top

Reference

IOccShield Members
EPLAN.Harness.API.Occurrences.Interfaces Namespace
IOccConductiveShield Interface
IOccShieldWire Interface
OccWdShield Class
OccWsShield Class

Send Feedback