Reference

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 understanding about which interfaces are most important and which interfaces are of secondary importance.

Level 1 interfaces

As mentioned in our introduction, there are only two main interfaces which are being used for navigating and referencing tree items in TwinCAT configuration.

Main class

Description

Available since

ITcSysManager

Base class to create and parameterize a TwinCAT configuration

TwinCAT 2.11

ITcSmTreeItem

Represents a tree item within a TwinCAT configuration

TwinCAT 2.11

Level 2 interfaces

These interfaces are considered as "helper classes" which are always used together with level 1 classes, for example to cast an ITcSmTreeItem object into a more specific type of tree item, for example a POU (ITcPlcPou) or a linked task (ITcTaskReference).

Helper class

Description

Available since

ITcPlcLibraryManager

Defines methods and properties for PLC library management

TwinCAT 3.1

ITcPlcPou

Defines methods and properties to handle PLC POUs

TwinCAT 3.1

ITcPlcDeclaration

Defines methods to read/write the declaration area of a PLC POU

TwinCAT 3.1

ITcPlcImplementation

Defines methods to read/write the implementation area of a PLC POU

TwinCAT 3.1

ITcPlcProject

Defines methods and properties regarding a PLC project, e.g. setting the project as a boot project

TwinCAT 3.1

ITcPlcIECProject

Defines methods needed to import/export PLC projects in PLCopen XML and also install them as a PLC library

TwinCAT 3.1

ITcPlcTaskReference

Defines methods and properties to link the PLC project to a task

TwinCAT 3.1

ITcPlcLibrary

Helper class which represents a single PLC library

TwinCAT 3.1

ITcPlcLibraries

Helper class which represents a collection of PLC libraries

TwinCAT 3.1

ITCPlcReferences

Helper class which represents a collection of ITcPlcLibRef objects (and therefore references in a PLC project)

TwinCAT 3.1

ITcPlcLibRef

Helper class which represents a base class for ITcPlcLibrary and ITcPlcPlaceholderRef objects

TwinCAT 3.1

ITcPlcPlaceholderRef

Helper class which represents a single PLC placeholder

TwinCAT 3.1

ITcPlcLibRepository

Helper class which represents a single PLC library repository

TwinCAT 3.1

ITcPlcLibRepositories

Helper class which represents a collection of PLC library repositories

TwinCAT 3.1