API Help
Eplan.EplApi.DataModel.Planning Namespace / PlanningSegment Class
Members

In This Topic
    PlanningSegment Class
    In This Topic
    Base class for planning objects which can be stored in a project.
    Inheritance Hierarchy
    Syntax
    Public Constructors
     NameDescription
    Public ConstructorDefault constructor.  
    Top
    Public Properties
     NameDescription
    Public PropertyReturns Eplan.EplApi.DataModel.ArticleReferences that are referenced by PlanningSegment.  
    Public PropertyCheck if the PlanningSegment can have Eplan.EplApi.DataModel.Articles.  
    Public PropertyReturns all children of this object.  
    Public PropertyReturns 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)
    Public PropertyReturns 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)
    Public PropertyReturns array of functions and 3d functions assigned to this object.  
    Public PropertyDetermines whether the article reference data can be changed for this object.  
    Public PropertySet or checks if device of this function is fixed.  
    Public Property

    Determines if the the StorableObject is locked.

    The StorableObject is locked when it was explicitly or implicitly locked.

    (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyDetermines if StorableObject is read-only (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public Property

    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)
    Public PropertyDetermines if StorableObject is correct database object and is not deleted. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyReturns set of local templates assigned to this object or to its segment template.  
    Public PropertyMacro file with window or page macros, used when placing the macro.  
    Public PropertyReturns the name of planning segment.  
    Public PropertyReturns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyReturns collection of all pages assigned to the planning segment.  
    Public PropertyGets or Sets parent object.  
    Public PropertyReturns array of PLC inputs and outputs for this planning object.  
    Public PropertyReturns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyEPLAN properties of the PlanningSegment object.  
    Public PropertyReturns the SegmentDefinition of the PlanningObject.  
    Public PropertyReturns placed representation of this planning segment.  
    Public PropertySegment template assigned to this object.  
    Public PropertyNumber used to sort elements in current branch of planning tree.  
    Public PropertyReturns set of templates from articles assigned to this object or to its segment template.  
    Public PropertyReturns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyCheck if object is currently write protected or sets Manual write protection  
    Top
    Public Methods
     NameDescription
    Public MethodOverloaded. Adds a new Eplan.EplApi.DataModel.ArticleReference to the PlanningSegment.  
    Public MethodAdd new local template based on function definition.  
    Public MethodOverloaded. Creates copy of existing PLC inputs or outputs for this planning object.  
    Public MethodReturns Eplan.EplApi.DataModel.FunctionBasePropertyList.  
    Public Methodstatic (Shared in Visual Basic)Creates PlanningSegment object.  
    Public Methodstatic (Shared in Visual Basic)Creates transient PlanningSegment object.  
    Public MethodDestructor for deterministic finalization of PlanningSegment object. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodOperator of comparison implementation. Checks if two StorableObjects refer to the same object in the project. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodServes as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodReturns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodChecks if a specific write protection kind was set.  
    Public MethodTries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodTemporarily disables write protection. Note that current write protection  
    Public MethodPlaces the segment onto the given page, in the given location.  
    Public MethodPlaces a macro on a given page.  
    Public MethodRemoves object from PlanningSegment with all its children.  
    Public MethodRemoves the ArticleReference from the PlanningSegment  
    Public MethodRemoves a local template from this object.  
    Public MethodRemoves existing PLC input or output from this planning object.  
    Public MethodRestores information stored in template to planning object.  
    Public MethodTries 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)
    Public MethodReturns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Top
    See Also