PCTLoop Class

In This Topic

Inheritance Hierarchy
Syntax
Example
Public Constructors
Public Properties
Public Methods
See Also

TODO

Inheritance Hierarchy

System.Object
   Eplan.EplApi.DataModel.StorableObject
      Eplan.EplApi.DataModel.Planning.PlanningSegment
         Eplan.EplApi.DataModel.Planning.PCTLoop

Syntax

C#
C++/CLI

public class PCTLoop : PlanningSegment, Eplan.EplApi.DataModel.IArticleUser, Eplan.EplApi.DataModel.IWriteProtection

public ref class PCTLoop : public PlanningSegment, Eplan.EplApi.DataModel.IArticleUser, Eplan.EplApi.DataModel.IWriteProtection

Example

The names of PCT-Loops are composed of 4 properties. To change the name- change the 4 properties.

SegmentDefinition oSegmentDefinition = m_oTestProject.GetSegmentDefinition("Eplan.PCT.Loop");
PCTLoop oPCTLoop  = PCTLoop.Create(oSegmentDefinition) as PCTLoop;

oPCTLoop.Properties.DMPLAOBJECT_PCT_IDENTIFIER = "C";   //Technical facility
oPCTLoop.Properties.DMPLAOBJECT_PCT_MEASURAND = "T";   //Measurand           
oPCTLoop.Properties.DMPLAOBJECT_PCT_FUNCTION = "IR";  //Processing function
oPCTLoop.Properties.DMPLAOBJECT_PCT_NUMBER = "100";  //Number
//oPCLoop.Name == "CTIR 100"                        //Full designation (name)

Public Constructors

	Name	Description
	PCTLoop Constructor	Default constructor.

Top

Public Properties

	Name	Description
	ArticleReferences	Returns Eplan.EplApi.DataModel.ArticleReferences that are referenced by PlanningSegment. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
	CanHaveArticleData	Check if the PlanningSegment can have Eplan.EplApi.DataModel.Articles. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
	Children	Returns all children of this object. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
	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)
	Functions	Returns array of functions and 3d functions assigned to this object. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
	IsArticleDataReadOnly	Determines whether the article reference data can be changed for this object. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
	IsFixedDevice	Set or checks if device of this function is fixed. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
	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 Eplan.EplApi.DataModel.Page and it was not assigned a Eplan.EplApi.DataModel.Project, it is a Eplan.EplApi.DataModel.Placement or any class derived from it and was not assigned a Eplan.EplApi.DataModel.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)
	LocalTemplates	Returns set of local templates assigned to this object or to its segment template. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
	Macro	Macro file with window or page macros, used when placing the macro. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
	Name	Returns the name of planning segment. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
	ObjectIdentifier	Returns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	Pages	Returns collection of all pages assigned to the planning segment. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
	Parent	Gets or Sets parent object. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
	PLCAddresses	Returns array of PLC inputs and outputs for this planning object. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
	Project	Returns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	Properties	EPLAN properties of the PCTLoop object.
	SegmentDefinition	Returns the SegmentDefinition of the PlanningObject. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
	SegmentPlacement	Returns placed representation of this planning segment. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
	SegmentTemplate	Segment template assigned to this object. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
	SortId	Number used to sort elements in current branch of planning tree. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
	TemplatesFromArticles	Returns set of templates from articles assigned to this object or to its segment template. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
	TypeIdentifier	Returns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	WriteProtected	Check if object is currently write protected or sets Manual write protection (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)

Top

Public Methods

	Name	Description
	AddArticleReference	Overloaded. Adds a new Eplan.EplApi.DataModel.ArticleReference to the PlanningSegment. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
	AddLocalTemplate	Add new local template based on function definition. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
	AddPLCAddress	Overloaded. Creates copy of existing PLC inputs or outputs for this planning object. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
	CollectStructureProperties	Returns Eplan.EplApi.DataModel.FunctionBasePropertyList. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
	Dispose()	Destructor for deterministic finalization of PCTLoop 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)
	GetHashCode	Serves as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	GetTypeName	Returns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	GetWriteProtectionFlagSet	Checks if a specific write protection kind was set. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
	LockObject	Tries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	PauseWriteProtection	Temporarily disables write protection. Note that current write protection flags are not cleared. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
	PlaceAt	Places the segment onto the given page, in the given location. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
	PlaceMacroAt	Places a macro on a given page. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
	Remove	Removes object from PlanningSegment with all its children. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
	RemoveArticleReference	Removes the ArticleReference from the PlanningSegment (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
	RemoveLocalTemplate	Removes a local template from this object. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
	RemovePLCAddress	Removes existing PLC input or output from this planning object. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
	RevertToTemplate	Restores information stored in template to planning object. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
	SmartLock	Tries to lock current object. If object is Eplan.EplApi.DataModel.Placement - it's page will be locked as well; Eplan.EplApi.DataModel.E3D.Placement3D locks it's installation space; Eplan.EplApi.DataModel.Function locks all it's connections and connection definition points; Eplan.EplApi.DataModel.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

PCTLoop Members
Eplan.EplApi.DataModel.Planning Namespace

Send Feedback