Create(TerminalStrip,Page,SymbolVariant) Method

In This Topic

Creates a Terminal object related to a TerminalStrip given as a parameter and having a Eplan.EplApi.DataModel.Function.Category equal to TERMINAL. Its graphical symbol is taken from a Eplan.EplApi.DataModel.MasterData.SymbolVariant given as the third parameter. The page where terminal will be placed is taken from the second page parameter. If NULL, an unplaced terminal will be created.

Syntax

C#
C++/CLI

public void Create( 
   TerminalStrip ts,
   Page page,
   SymbolVariant variant
)

public:
void Create( 
   TerminalStrip^ ts,
   Page^ page,
   SymbolVariant^ variant
)

Parameters

Parameter Name	Description
ts	TerminalStrip where the Terminal will be located on
page	Eplan.EplApi.DataModel.Page where the Terminal will be placed. If page is NULL terminal won't be placed.
variant	Eplan.EplApi.DataModel.MasterData.SymbolVariant representing the graphical symbol of the terminal

Exceptions

Exception	Description
Eplan.EplApi.DataModel.ObjectCreationException	Thrown when the Terminal cannot be created.
System.ArgumentNullException	Thrown when `ts` parameter is `null`.
System.ArgumentNullException	Thrown when `variant` parameter is `null`.
Eplan.EplApi.DataModel.ObjectAlreadyCreatedException	Thrown when the function has already been created.
Eplan.EplApi.DataModel.WrongCategoryException	Thrown when the `variant` does not represent a Terminal.

Reference

Terminal Class
Terminal Members
Overload List
TerminalStrip Class
SymbolVariant Class

Use the Eplan Global Support Portal for feedback and support