Terminals(Project,TerminalsSequence,TerminalsPotential,TerminalsPotential,TerminalsPotential,MultipleTerminals,TerminalsWithAlphabeticalCharacters,String,Int32,Int32,String,String,Boolean,Boolean,Boolean,Boolean) Method

In This Topic

Method for renumbering terminals specified by the collection pFunctions.

Syntax

C#
C++/CLI

public void Terminals( 
   Project pProject,
   Renumber.Enums.TerminalsSequence eSequence,
   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,
   bool bPermitSortChange,
   bool bFillGaps
)

public:
void Terminals( 
   Project^ pProject,
   Renumber.Enums.TerminalsSequence eSequence,
   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,
   bool bPermitSortChange,
   bool bFillGaps
)

Parameters

Parameter Name	Description
pProject	Project in which all terminals will be renumbered.
eSequence	Mode to use for numbering, given by a member of enum TerminalsSequence.
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 scheme is set to "According to online numbering format".
strSufix	The suffix value that comes after the numbering value. Is only used if scheme is set to "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.
bPermitSortChange	Permit sort change.
bFillGaps	Fill gaps.

Exceptions

Exception	Description
System.ArgumentNullException	Thrown if an argument is set to `NULL`.
System.ArgumentException	Thrown in case of invalid parameters, e.g. the specified functions do not exist or are invalid.
System.ApplicationException	Thrown if the internal interface for numbering could not be created.
Eplan.EplApi.Base.BaseException	Thrown if an error occurred during numbering.
Eplan.EplApi.HEServices.Exceptions.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