Terminals(Function[],TerminalsSequence,Extent,TerminalsPotential,TerminalsPotential,TerminalsPotential,MultipleTerminals,TerminalsWithAlphabeticalCharacters,String,Int32,Int32,String,String,Boolean,Boolean) Method

In This Topic

Method for renumbering terminals specified by the collection pFunctions.

Syntax

C#
C++/CLI

public void Terminals( 
   Function[] terminals,
   Renumber.Enums.TerminalsSequence eSequence,
   Renumber.Enums.Extent ext,
   Renumber.Enums.TerminalsPotential ePotential_N,
   Renumber.Enums.TerminalsPotential ePotential_PE,
   Renumber.Enums.TerminalsPotential ePotential_SH,
   Renumber.Enums.MultipleTerminals eMultipleTerminals,
   Renumber.Enums.TerminalsWithAlphabeticalCharacters eTerminalsWithAlphabeticalCharacters,
   string strScheme,
   int nStartValue,
   int nIncrement,
   string strPrefix,
   string strSufix,
   bool bOnlyNumberMarkedOnes,
   bool bAlsoNumberedByPLC
)

public:
void Terminals( 
   array<Function^>^ terminals,
   Renumber.Enums.TerminalsSequence eSequence,
   Renumber.Enums.Extent ext,
   Renumber.Enums.TerminalsPotential ePotential_N,
   Renumber.Enums.TerminalsPotential ePotential_PE,
   Renumber.Enums.TerminalsPotential ePotential_SH,
   Renumber.Enums.MultipleTerminals eMultipleTerminals,
   Renumber.Enums.TerminalsWithAlphabeticalCharacters eTerminalsWithAlphabeticalCharacters,
   String^ strScheme,
   int nStartValue,
   int nIncrement,
   String^ strPrefix,
   String^ strSufix,
   bool bOnlyNumberMarkedOnes,
   bool bAlsoNumberedByPLC
)

Parameters

terminals: Terminals to be renumbered.
eSequence: Mode to use for numbering, given by a member of enum TerminalsSequence.
ext: Parameter enum to define the scope of numbering.
ePotential_N: Parameter to determine, N terminals will be treated during numbering. Use value from enum Renumber.Enums.TerminalsPotential.
ePotential_PE: Parameter to determine, how PE terminals will be treated during numbering. Use value from enum Renumber.Enums.TerminalsPotential.
ePotential_SH: Parameter to determine, how SH terminals will be treated during numbering. Use value from enum Renumber.Enums.TerminalsPotential.
eMultipleTerminals: Parameter enum for numbering terminals with "Allow same designations" property .
eTerminalsWithAlphabeticalCharacters: Parameter enum how terminals or pins with alphabetical elements in the designation should be numbered.
strScheme: Numbering scheme.
nStartValue: Start value.
nIncrement: Step width.
strPrefix: The prefix value that comes before the numbering value. Is only used if schema has set "According to online numbering format".
strSufix: The suffix value that comes after the numbering value. Is only used if schema has set "According to online numbering format".
bOnlyNumberMarkedOnes: I true - Terminals / pins whose designations contain a "?" will be numbered .
bAlsoNumberedByPLC: If true - terminals / pins controlled by PLCs will also be numbered.

Exceptions

Exception	Description
ArgumentNullException	Thrown, if an argument is set to null.
ArgumentException	Thrown in case of invalid parameters, e.g. the specified functions do not exist or are invalid.
ApplicationException	Internal interface for numbering could not be created.
Eplan.EplApi.Base.BaseException	An error occurred during numbering.
InvalidScheme	An error occurrs when used scheme name doesn't exist

Reference

Renumber Class
Renumber Members
Overload List

Use the Eplan Global Support Portal for feedback and support