PlcIO Class

In This Topic

Class representing a PlcIOEntry object. A PlcIOEntry object is an entity that holds some data (hardware address, symbolic address, data type, CPU id) that can be assigned (booked) to a PLC IO terminal. Free PlcIOEntries are created in P8 project by importing an assignment list. Such free PlcIOEntries may then be booked onto existing PLC terminals. When PLCIOEntry is booked onto a PLC terminal, the data is transfered to the terminal and the entry is deleted from project.

Inheritance Hierarchy

System.Object
Eplan.EplApi.DataModel.StorableObject
Eplan.EplApi.DataModel.PlcIO

Syntax

C#
C++/CLI

public class PlcIO : StorableObject

public ref class PlcIO : public StorableObject

Public Constructors

	Name	Description
	PlcIO Constructor	Constructor.

Top

Public Properties

	Name	Description
	Address	Returns the PlcIOEntry's hardware address.
	CrossReferencedObjectsAll	Returns an array of objects cross-referenced with this object (i.e. having the same name - in case of functions - or otherwise associated) (Inherited from Eplan.EplApi.DataModel.StorableObject)
	DatabaseIdentifier	Returns the project as number. The number is unique for all open projects in one session. The number changes when the project is closed and opened again. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	DataType	Returns the PlcIOEntry's data type.
	FunctionText	Returns the PlcIOEntry's comment (function text).
	IsLocked	Determines if the the StorableObject is locked. The StorableObject is locked when it was explicitly or implicitly locked. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	IsReadOnly	Determines if StorableObject is read-only (Inherited from Eplan.EplApi.DataModel.StorableObject)
	IsTransient	Determines if the the StorableObject is transient. The StorableObject is transient when it was created by default constructor and: it is a Page and it was not assigned a Project, it is a Placement or any class derived from it and was not assigned a Page. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	IsValid	Determines if StorableObject is correct database object and is not deleted. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	ObjectIdentifier	Returns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	PlcCpu	Returns the PlcIOEntry's CPU ID.
	Project	Returns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	Properties
	SymbolicAddress	Returns the PlcIOEntry's symbolic address.
	TypeIdentifier	Returns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)

Top

Public Methods

	Name	Description
	Dispose()	Destructor for deterministic finalization of PlcIO object. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	Equals	Operator of comparison implementation. Checks if two StorableObjects refer to the same object in the project. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	GetAll	Returns an array of all PLCIOEntries existing in the project.
	GetHashCode	Serves as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	LockObject	Tries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	SmartLock	Tries to lock current object. If object is Placement - it's page will be locked as well; Eplan.EplApi.DataModel.E3D.Placement3D locks it's installation space; Function locks all it's connections and connection definition points; Page locks all placements from this page. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	ToStringIdentifier	Returns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject)

Top

Reference

PlcIO Members
Eplan.EplApi.DataModel Namespace

Send Feedback