Eplan Platform API
Eplan.EplApi.DataModel.Planning Namespace / PlanningSegment Class

In This Topic
    PlanningSegment Class Methods
    In This Topic

    For a list of all members of this type, see PlanningSegment members.

    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