Beckhoff Automation GmbH & Co. KG — 6.1 ITcSysManager

API 6 API This chapter contains a documentation of all classes and methods of the TwinCAT Automation Interface. The provided interfaces can be divided into different "levels" in which the higher level interfaces represent the primary interfaces and therefore the basic interaction with the Automation Interface. Please note that this differentiation comes only from a logical point-of-view, to get a better under- standing about which interfaces are most important and which interfaces are of secondary impor- tance.

Level 1 interfaces As mentioned in our introduction [ } 8] , there are only two main interfaces which are being used for navigating and referencing tree items in TwinCAT configuration. 6.1 ITcSysManager ITcSysManager is the main interface of the TwinCAT Automation Interface. This interface allows basic operations to configure TwinCAT 3 XAE and consists of several methods for doing so. Over the years, the ITcSysManager interface has been extended with more functionalities to give customers a better way to access all Automation Interface features. However, due to restrictions in the COM object model, these features needed to be added as separate interfaces to the Automation Interface.

Therefore, each time a new set of features was added, these features were assembled in a new interface which was named ITcSysManagerX, where X is a number which is incremented each time a new interface was added. The following tables explain which methods are part of the ITcSysManager interface and which have been added to each new "feature-set" interface. Methods Automation Interface 30 Version:

1.2 Main class Description Available since ITcSysManager [} 30] Base class to create and parameterize a TwinCAT configuration TwinCAT 2.11 ITcSmTreeItem [} 37] Represents a tree item within a TwinCAT configuration TwinCAT 2.11 ITcSysManager methods Description Available since NewConfiguration [} 31] Generates a new configuration TwinCAT 2.11 OpenConfiguration [} 32] Loads a prior created configuration file (WSM file) TwinCAT 2.11 SaveConfiguration [} 32] Saves the configuration in a file with the given name or with the current name TwinCAT 2.11 ActivateConfiguration [} 33] Activates the configuration (same as "Save To Registry") TwinCAT 2.11 LookupTreeItem [} 35] Looks up to a configuration item (item in the tree) by name and returns a ITcSmTreeItem [} 37] interface TwinCAT 2.11 StartRestartTwinCAT [} 33] Starts or Restarts the TwinCAT System TwinCAT 2.11 IsTwinCATStarted [} 33] Evaluates if the TwinCAT System is running TwinCAT 2.11 LinkVariables [} 33] Links two variables given by names TwinCAT 2.11 UnlinkVariables [} 34] Clears the link between two variables given by names or all links from one variable.

TwinCAT 2.11 ITcSysManager2 methods Description Available since SetTargetNetId Set the target NetId of the currently opened TwinCAT configuration. TwinCAT 2.11