Eplan Platform API
Eplan.EplApi.DataModel Namespace / Project Class

In This Topic
    Project Class Methods
    In This Topic

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

    Public Methods
     NameDescription
    Public MethodOverloaded. Adds a new ArticleReference to the Project. Returns the added ArticleReference.  
    Public MethodOverloaded. Adds Option to the Project.  
    Public MethodOverloaded. Adds OptionGroup to the Project. The description is set to an empty multilang value.  
    Public MethodChanges name of the given location. After that change a location object becomes invalid, to get this object once again, use the GetLocationObjects function.  
    Public MethodCloses the project. Must not be called before Remove()  
    Public MethodOverloaded. Creates location in the given hierarchy, and places it in position eRelPos relatively to the existing location strExistingLocation.  
    Public MethodDestructor for deterministic finalization of Project 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 MethodOverloaded. Returns array of all project's location objects.  
    Public MethodCreates location prototype using property list pProps. Property identifiers that describe location are written to the list.  
    Public MethodReturns array of names of project's location for given hierarchy type (PLANT, LOCATION etc.)  
    Public MethodOverloaded. Gets the name prototype for a given function group. For given function group two separate lists with properties used in project structure are created.  
    Public MethodMethod for finding Option assigned to the Project with a given name.  
    Public MethodMethod for finding OptionGroup assigned to the Project with a given name.  
    Public MethodReturns Eplan.EplApi.DataModel.Planning.SegmentDefinition from this Project with given name.  
    Public MethodReturns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodLocks all data model objects in the project.  
    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 MethodParsing of function name with additional properties.  
    Public MethodRemoves the project. Must not be called after Close()  
    Public MethodRemoves all pages from project.  
    Public MethodRemoves the ArticleReference from the Project  
    Public MethodSets the location order, as in the arrLocations parameter, for given hierarchy type. Locations existing in project and not passed in arrLocations are placed after the passed ones. If arrLocations parameter contains not existing location name, this method returns false and no changes are made to the project  
    Public MethodTries 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)
    Public MethodReturns a string that represents the current object.  
    Public MethodReturns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Top
    See Also