EBSILON®Professional Online Dokumentation
EbsScript / EbsScript Funktionen / Profil-Funktionen
In diesem Thema
    Profil-Funktionen
    In diesem Thema

    Profil-Funktionen


    Diese Funktionen sind hilfreich beim Umgang mit Profilen. Jedes Profil bildet einen Modellzustand ab.
     

    Definitionen:

    Berechnungsprofil: das aktuelle Profil, das bei Aufruf einer Berechnung zugrunde gelegt wird. Alle Zuweisungsoperationen werden in diesem Profil ausgeführt.

    Elternprofil (des Berechnungsprofils): Anfangs waren Profile so angelegt, dass Elternprofile ihre Leitungs- und Komponentenergebnisse an ihre Kinder vererbt haben. Das ist ab Version 7.00 nicht mehr so. Ergebnisse werden jetzt nicht vererbt.

    Jedoch konnte das Verhalten wieder umgestellt werden, wenn man zu Beginn des Ebscript die Variable @modeloptions.getresultsbyaddr auf ”false” setzte. Auch dieses Verhalten ist jetzt nicht mehr möglich. Aktuell ist dazu die Funktion changeGetResult() zu benutzen.

    Eingestelltes Elternprofil: das Profil, das bei Erstellen eines neuen Profils (mit newSubProfile) als Elternprofil verwendet wird. Diese Einstellung kann durch setParentProfile verändert werden.

    Name

    Zweck

    Argumente

    Rückgabe­­wert

    Setzt das Berechnungsprofil auf

    Beispiel

    clearCalcProfile

    Löscht alle im aktuellen Berechnungsprofil explizit gesetzten Werte, d.h. es gelten wieder die aus dessen Elternprofil vererbten Werte  (die in den Eigenschaftsfenstern grau angezeigt werden)

    keine

    keiner

    -

    clearCalcProfile;

    copyCalcProfile

    Erstellt eine Kopie des aktuellen Profils auf derselben Hierarchieebene mit denselben Werten. Das kopierte Profil hat dasselbe Elternprofil wie das ursprüngliche, deshalb sind die vererbten Werte gleich. Werte. Die im ursprünglichen Profil eingetragenen Werte werden auch im kopierten gesetzt.

    Das Design-Profil kann nicht kopiert werden.

    1: BOOLEAN: rekursives Kopieren

    2: INTEGER: ID des Elternprofils, an das die Kopie bzw. die Kopien angehängt werden.

    INTEGER:
    Id des erstellten Unterprofils

    das neu erstellte Unterprofil

    i:= copyCalcProfile;

    copyParentProfile

    Erstellt eine Kopie des Profils, das als eingestelltes Elternprofil definiert ist (siehe getParentProfile). Die Kopie wird auf derselben Hierarchiestufe angelegt.  Da das kopierte Profil dadurch dasselbe Elternprofil wie das Quell-Profil hat, sind die vererbten Werte gleich. Werte. Die im Quell-Profil eingetragenen Werte werden auch im kopierten gesetzt.

    Das neu erstellte Profil ist anschließend aktuelles Berechnungsprofil und eingestelltes Elternprofil.

    Das Design-Profil kann nicht kopiert werden.

    1: BOOLEAN: rekursives Kopieren

    2: INTEGER: ID des Elternprofils, an das die Kopie bzw. die Kopien angehängt werden.

    INTEGER:
    Id des erstellten Unterprofils

    das neu erstellte Elternprofil

    i:= copyParentProfile;

    deleteCalcProfile

    Löscht das aktuelle Berechnungsprofil (einschließlich eventuell vorhandener Unterprofile).

    keine

    keiner

    das Elternprofil des Original Berechnungsprofils

    deleteCalcProfile;

    deleteCalcProfileDescendants

    löscht die Unterprofile des aktuellen Berechnungsprofils

    keine

    keiner

     

    deleteCalcProfileDescendants;

    deleteParentProfile

    Löscht das eingestellte Elternprofil (einschließlich eventuell vorhandener Unterprofile).

    keine

    keiner

    das Großelternprofil des Original Berechnungsprofils

    deleteParentProfile;

    deleteParentProfileDescendants

    löscht die Unterprofile des eingestellten Elternprofils

    keine

    keiner

     

     

    getCalcProfile

    Liefert die Id des aktuellen Berechnungsprofils.

    keine

    INTEGER:
    Id des Berechnungsprofils

    -

    i:=getCalcProfile;

    getFirstChildProfileId

     

    Ersetzt die spezifizierte ID durch die ihres ersten Kindes.

    INTEGER:
    Vor Aufruf: Id des bedachten Profils

    Nach Aufruf: Id des ersten Kindes des bedachten Profils,
    -1, wenn das bedachte Profil keine Kinder hat

    keiner

    unverändert

    getFirstChildProfileId (i);

    getFirstProfileId

     

    Liefert die Id des ersten Profils im Modell.

    keine

    INTEGER:
    Id des ersten Profils

    unverändert

    i:=getFirstProfileId;

    GetLastChildProfileId

    Ersetzt die spezifizierte ID durch die ihres letzten Kindes

    INTEGER:
    Vor Aufruf: Id des bedachten Profils

    Nach Aufruf: Id des letzen Kindes des bedachten Profils,
    -1, wenn das bedachte Profil keine Kinder hat

    keiner

    unverändert

    getLastChildProfileId ( i );

    GetLastProfileId

     

    Liefert die Id des letzten Profils im Modell (dies ist der letzte Eintrag im Baum, nicht unbedingt die höchste Id)

    keine

    INTEGER:

    Id des letzten Profils

    unverändert

    i:=getLastProfileId;

    getLocalDesignReferenceProfile

     

    Liefert die Id des eingestellten Referenzprofils, in das bei einer für lokalen Auslegung die Referenzwerte übernommen werden.

    keine

    INTEGER:

    Id des Referenzprofils

    unverändert

    i:=getLocalDesignReferenceProfile;

    getNextProfileId

    Ersetzt die spezifizierte Id durch die des nächsten Profils im Baum, unabhängig von ihrer relativen Position. Diese Funktion kann verwendet werden, um durch alle Profile zu kommen.

    INTEGER:
    Vor Aufruf: Id des bedachten Profils

    Nach Aufruf: Id des nächsten Profils,
    -1, wenn das bedachte Profil das letzte war

    keiner

    unverändert

    getNextProfileId( i );

    getNextSiblProfileId

    Ersetzt die spezifizierte Id durch die des nachfolgenden Geschwister-Profils.

    INTEGER:
    Vor Aufruf: Id des bedachten Profils

    Nach Aufruf: Id des nächsten Profils auf der gleichen Hierarchie Ebene.
    -1, wenn das bedachte Profil keine Geschwister hat

    keiner

    unverändert

    getNextSiblProfileId ( i );

    getParentProfile

    Liefert die Id des eingestellten Elternprofils (das Profil, das Elternprofil sein wird, wenn das nächste ”newSubProfile” aufgerufen wird)

    keine

    INTEGER:
    Id des Elternprofils

    unverändert

    i:=getParentProfile;

    getParentProfileId

    Ersetzt die spezifizierte Id durch die ihrer Eltern.

    INTEGER:
    Vor Aufruf: Id des bedachten Profils

    Nach Aufruf: Id der Eltern des bedachten Profils

    keiner

    unverändert

    getParentProfileId (i);

    getPrevProfileId

    Ersetzt die spezifizierte Id durch die des vorausgehenden Profils im Baum, unabhängig von der relativen Position. Diese Funktion kann verwendet werden, um rückwärts durch alle Profile zu gelangen.

    INTEGER:
    Vor Aufruf: Id des bedachten Profils

    Nach Aufruf: Id des vorher­gehenden Profils.
    -1, wenn das bedachte Profil das erste war

    keiner

    unverändert

    getPrevProfileId( i );

    getPrevSiblProfileId

    Ersetzt die spezifizierte ID durch die des vorausgehenden Geschwister-Profils.

    INTEGER:
    Vor Aufruf: Id des bedachten Profils

    Nach Aufruf: Id des vorher­gehenden Profils auf der gleichen Hierarchie Ebene.
    -1, wenn das bedachte Profil keine Geschwister hat

    keiner

    unverändert

    getPrevSiblProfileId (i);

    getRootProfileId

    Liefert die Id des Hauptprofils

    keine

    INTEGER:
    Id des Hauptprofils

    unverändert

    iProfileId:= getRootProfileId;

    newSubProfile

    Erstellt ein neues Unterprofil und gibt seine Id zurück. Das Profil wird als Kind des eingestellten Elternprofils erstellt.

    1: STRING: Name des zu erstellenden Unterprofils  (optional). Falls nicht spezifiziert, lautet der Name sub_x

    INTEGER:
    Id des erstellten Unterprofils

    das neu erstellte Unterprofil

    i:=newSubProfile (”Prof_1”)

                   

    renameProfile

    Benennt ein bestehendes Profil um.

    1: INTEGER: Id des umzubenennenden Profils,

    2: STRING: neuer Name

    BOOLEAN: true, wenn Umbenennung erfolgreich

    unverändert

    bOk:= renameProfile(iProfileId, "Auslegung" );

    setCalcProfile

    Macht das durch die angegebene Id definierte Profil zum aktuellen Berechnungsprofil.

    1: INTEGER: Id des zum Berechnungsprofil werdenden Profils

    INTEGER: Id des neuen Berechnungs-Unterprofils
    -1, wenn das Unterprofil nicht vorhanden ist

    das spezifizierte Profil

    setCalcProfile(i);

    setCalcProfileByName

    Wie setCalcProfile, das Profil wird jedoch nicht durch die Id, sondern durch seinen Namen spezifiziert.

    1: STRING: Name des zum Berechnungsprofil werdenden Profils

    INTEGER: Id des neuen Berechnungs-Unterprofils
    -1, wenn das Unterprofil nicht vorhanden ist

    das spezifizierte Profil

    i:=setCalcProfileByName ( "Sub_2" );

    setParentProfile

    Macht das durch die angegebene Id definierte Profil zum eingestellten Elternprofil.

    Setzt gleichzeitig die ID des Berechnungs-Profils auf die ID des Eltern-Profils

    1: INTEGER: Id des zum Elternprofil werdenden Profils

    INTEGER: Id des neuen Eltern-Profils
    -1, wenn das Profil nicht vorhanden ist

    das spezifizierte Elternprofil

    setParentProfile (i);

    setParentProfileByName

    Wie setParentProfile, das Profil wird jedoch nicht durch die Id, sondern durch seinen Namen spezifiziert

    Setzt gleichzeitig die ID des Berechnungs-Profils auf die ID des Eltern-Profils

    1: STRING: Name des zum Elternprofil werdenden Profils

    INTEGER: Id des neuen Eltern-Profils
    -1, wenn das Profil nicht vorhanden ist

    das spezifizierte Elternprofil

    i:= setParentProfileByName ("Sub_1”);

    setLocalDesignReferenceProfile

    Macht das durch die angegebene Id definierte Profil zum Referenzprofil in das bei einer lokalen Auslegung die Referenzwerte übernommen werden.                     

    1: INTEGER: Id des zum Referenzprofil werdenden Profils

    keiner

    Das Referenzprofil muss zum diesem Zeitpunkt nicht existieren.

    setDesignReferenceProfile (i);