Interface IElectrodes

Gives access to electrodes.

Namespace: TopSolid.Cad.Electrode.Automating

Assembly: TopSolid.Cad.Electrode.Automating.dll

Syntax

public interface IElectrodes

Remarks

This interface is available since v7.12.

Methods

GetElectrodeCAngle(ElementId, Int32)

Get the C angle of an electrode at a given position index.

Declaration

double GetElectrodeCAngle(ElementId inElementId, int inPositionIndex)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the electrode to analyze.
System.Int32	inPositionIndex	Position index.

Returns

Type	Description
System.Double	C angle.

Remarks

This method is available since v7.12.

GetElectrodeDivingDistance(ElementId, Int32)

Get the diving distance of an electrode at a given position index.

Declaration

double GetElectrodeDivingDistance(ElementId inElementId, int inPositionIndex)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the electrode to analyze.
System.Int32	inPositionIndex	Position index.

Returns

Type	Description
System.Double	Diving distance.

Remarks

This method is available since v7.14.

GetElectrodeGaps(ElementId)

Gets gap parameter entities of an electrode.

Declaration

List<ElementId> GetElectrodeGaps(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the electrode to analyze.

Returns

Type	Description
System.Collections.Generic.List<ElementId>	Gap parameter entities found.

Remarks

This method is available since v7.12.

GetElectrodeInitialXPosition(ElementId, Int32)

Get the initial X position of an electrode at a given position index.

Declaration

double GetElectrodeInitialXPosition(ElementId inElementId, int inPositionIndex)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the electrode to analyze.
System.Int32	inPositionIndex	Position index.

Returns

Type	Description
System.Double	Initial X position.

Remarks

This method is available since v7.14.

GetElectrodeInitialYPosition(ElementId, Int32)

Get the Y initial position of an electrode at a given position index.

Declaration

double GetElectrodeInitialYPosition(ElementId inElementId, int inPositionIndex)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the electrode to analyze.
System.Int32	inPositionIndex	Position index.

Returns

Type	Description
System.Double	Initial Y position.

Remarks

This method is available since v7.14.

GetElectrodeInitialZPosition(ElementId, Int32)

Get the Z initial position of an electrode at a given position index.

Declaration

double GetElectrodeInitialZPosition(ElementId inElementId, int inPositionIndex)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the electrode to analyze.
System.Int32	inPositionIndex	Position index.

Returns

Type	Description
System.Double	Initial Z position.

Remarks

This method is available since v7.14.

GetElectrodeMandrels(ElementId)

Gets mandrels of an electrode.

Declaration

List<ElementId> GetElectrodeMandrels(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the electrode to analyze.

Returns

Type	Description
System.Collections.Generic.List<ElementId>	Mandrel entities found.

Remarks

This method is available since v7.12.

GetElectrodePositionCount(ElementId)

Get the position count of an electrode.

Declaration

int GetElectrodePositionCount(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the electrode to analyze.

Returns

Type	Description
System.Int32	Theoretical position count.

Remarks

This method is available since v7.12.

GetElectrodePositionIndex(ElementId)

Get the position index of an electrode.

Declaration

int GetElectrodePositionIndex(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the electrode to analyze.

Returns

Type	Description
System.Int32	Position index.

Remarks

This method is available since v7.12.

GetElectrodes(DocumentId, Boolean)

Gets all electrode entities that are in the electrode set an electrodes document.

Declaration

List<ElementId> GetElectrodes(DocumentId inDocumentId, bool inIncludeTheoreticalElectrodes)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the electrodes document to analyze.
System.Boolean	inIncludeTheoreticalElectrodes	Whether to include theoretical electrodes.

Returns

Type	Description
System.Collections.Generic.List<ElementId>	Electrode entities found.

Remarks

This method is available since v7.12.

GetElectrodeXPosition(ElementId, Int32)

Get the X position of an electrode at a given position index.

Declaration

double GetElectrodeXPosition(ElementId inElementId, int inPositionIndex)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the electrode to analyze.
System.Int32	inPositionIndex	Position index.

Returns

Type	Description
System.Double	X position.

Remarks

This method is available since v7.12.

GetElectrodeYPosition(ElementId, Int32)

Get the Y position of an electrode at a given position index.

Declaration

double GetElectrodeYPosition(ElementId inElementId, int inPositionIndex)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the electrode to analyze.
System.Int32	inPositionIndex	Position index.

Returns

Type	Description
System.Double	Y position.

Remarks

This method is available since v7.12.

GetElectrodeZPosition(ElementId, Int32)

Get the Z position of an electrode at a given position index.

Declaration

double GetElectrodeZPosition(ElementId inElementId, int inPositionIndex)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the electrode to analyze.
System.Int32	inPositionIndex	Position index.

Returns

Type	Description
System.Double	Z position.

Remarks

This method is available since v7.12.

IsElectrodes(DocumentId)

Tells whether a document is an electrodes document.

Declaration

bool IsElectrodes(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
System.Boolean	The document is an electrodes document.

Remarks

This method is available since v7.12.

IsElectrodeTheoreticalPosition(ElementId)

Tells whether a element is a theoretical position of an electrode.

Declaration

bool IsElectrodeTheoreticalPosition(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the electrode to analyze.

Returns

Type	Description
System.Boolean	The element is a theoretical position of an electrode.

Remarks

This method is available since v7.12.