Funktionen
Folgende FVA-Workbench spezifische Funktionen können Sie im Scripting verwenden:
Berechnung
runCalcMethod()
runCalcMethod(methodID, compID, {options}); | ||
Parameter | Typ | Beschreibung |
methodID | string | Eindeutige ID der auszuführenden Berechnungsmethode. Eine Liste mit allen Berechnungsmethoden finden Sie im Abschnitt Berechnungen im Scripting. |
compID | int | Eindeutige ID der Komponente im Modell. Die Gesamtsystemberechnung erfolgt immer auf der Getriebeeinheit (Hat immer die ID 1). |
{options} | object | Wenn angegeben, wird ein Ausgabeverzeichnis mit den Rechenkern-Ausgabedateien erzeugt. var options = {resultpath: path/to/results, createResultpath: true/false}; |
Rückgabewert | int | 1 = Berechnung erfolgreich 0 = Berechnung abgebrochen -1 = Fehler in der Berechnung |
Mögliche Fehler | Rechenmethode existiert nicht. Komponente existiert nicht. Komponente ist mit der angegebenen Berechnungsmethode nicht berechenbar. |
Beispiel 1 Gesamtsystemberechnung durchführen
1methodID = "001_SYSTEM_CALCULATION"; 2var compID = 1; 3setAttr("gta_switch_iso_6336_2006", compID, true, EDAT); 4var status = runCalcMethod(methodID, compID); 5if (status == 1) { 6 println("Calculation was successful"); } else { 7 println("Something went wrong"); }
Variable methodID mit der ID für eine Gesamtsystemberechnung belegen. | |
Variable compID mit der ID der Getriebeeinheit belegen. Die ID der Getriebeeinheit ist immer 1. | |
Das Attribut mit der ID "gta_switch_iso_6336_2006" via setAttr() auf true setzten. Damit wird im Rahmen der Gesamtsystemberechnung eine Tragfähigkeitsberechnung nach ISO 6336 (2006) durchgeführt. | |
Gesamtsystemberechnung starten und Rückgabewert in der Variablen status speichern. | |
Wenn Rückgabewert in Variable status = 1, dann: | |
Ausgabe auf der Scripting-Konsole: "Calculation was successful". | |
Für jeden anderen Rückgabewert: "Something went wrong". |
Beispiel 2 Lagerlebensdauerberechnung für ein einzelnes Lager durchführen.
methodID = "800_ROLLING_BEARING_LIFETIME"; var compID = 15; runCalcMethod(methodID, compID);
Zugriff auf Attribute
getAttr()
getAttr(attrID, compID, EDAT/RDAT); | ||
Parameter | Typ | Beschreibung |
attrID | string | Eindeutige ID des Attributs. |
compID | int | Eindeutige ID der Komponente im Modell. |
EDAT/RDAT | Gibt an, ob der Eingabe- (EDAT) oder der berechnete Wert (RDAT) zurückgegeben werden soll. Alternativ kann auch 1 (EDAT) oder 0 (RDAT) als Parameter angegeben werden. Für weitere Informationen siehe Datenhaltung (EDAT/RDAT) | |
Rückgabewert | Wert des Attributs. | |
Mögliche Fehler | Fehlerhafte Attribut-ID Fehlerhafte Komponenten-ID. Nur für Attribute vom Typ String, Integer, Double, Boolean, Array, Matrix. |
Beispiel 1 Wert des Attributs Normaleingriffswinkel auf der Konsole ausgeben.
1let compID = getCompByType('cylindrical_mesh')[0]; 2let value = getAttr("normal pressure angle", compID, EDAT); 3println(value);
Variable compID mit der Komponenten-ID der ersten Stirnradstufe im Modell belegen. | |
Variable value mit dem Eingabewert (EDAT) des Attributs normal pressure angle belegen. | |
Wert der Variable value auf dem Scripting Monitor ausgeben. |
Beispiel 2 Werte des Arrayattributs statische Tragzahl auf der Konsole ausgeben.
1let compID = getCompByType('bearing')[0]; 2let value = getAttr("static capacity", compID, RDAT); 3println(value[0]); 4println(value[1]);
Variable compID mit der Komponenten-ID des ersten Wälzlagers im Modell belegen. | |
Variable value mit dem berechneten Wert (RDAT) des Attributs static capacity belegen. static capacity ist ein Arrayattribut und enthält einen Wert für jede Lagerreihe. | |
Den Attributwert für die erste Lagerreihe auf dem Scripting Monitor ausgeben. | |
Den Attributwert für die zweite Lagerreihe auf dem Scripting Monitor ausgeben. |
setAttr()
setAttr(attrID, compID, value, EDAT/RDAT); | ||
Parameter | Typ | Beschreibung |
attrID | string | Eindeutige ID des Attributs. |
compID | int | Eindeutige ID der Komponente im Modell. |
EDAT/RDAT | Gibt an, ob der Eingabe- (EDAT) oder der berechnete Wert (RDAT) gesetzt werden soll. Alternativ kann auch 1 (EDAT) oder 0 (RDAT) als Parameter angegeben werden. | |
Mögliche Fehler | Fehlerhafte Attribut-ID. Fehlerhafte Komponenten-ID. Datentyp des Werts passt nicht zum Attribut. Wert verstößt gegen die Constraints. |
Beispiel 1 Wert des Attributs Öltemperatur löschen.
1var compID = 1; 2setAttr('temperature', compID, 90, EDAT);
Variable compID mit der Komponenten-ID der Getriebeeinheit belegen. Die Getriebeeinheit als Wurzelkomponente hat immer die ID 1. | |
Attribut temperature auf der Komponente 1 mit dem Eingabewert (EDAT) belegen. |
Beispiel 2 Attribut FVA_54 auf true setzen. Das Attribut FVA_54 entspricht dem Schalter "Graufleckenberechnung nach FVA 54" im Eingabeditor.
1var compID = getCompByType('cylindrical_mesh')[0]; 2setAttr('FVA_54', compID, true, EDAT);
delAttr()
delAttr(attrID, compID); | ||
Parameter | Typ | Beschreibung |
attrID | string | Eindeutige ID des Attributs. |
compID | int | Eindeutige ID der Komponente im Modell. |
Rückgabewert | boolean | true wenn Wert gelöscht, sonst false. |
Mögliche Fehler | Fehlerhafte Komponenten-ID. Fehlerhafte Attribut-ID. |
Beispiel 1 Wert des Attributs Öltemperatur löschen.
1delAttr('lubricant', 1);
Schmierstoff auf der Komponente Getriebeeinheit löschen. |
getAttrProperty()
getAttrProperty(attrID, compID, propertyID); | |||
Parameter | Typ | Beschreibung | |
attrID | string | Eindeutige ID des Attributes im Modell. | |
compID | int | Eindeutige ID der Komponente im Modell. | |
propertyID | string | TYPE | Datentyp des Attributes. |
NUMBER | Numerische Attribut-ID. | ||
NAME | Name des Attributs. | ||
UNIT_NAME | Einheit | ||
SYMBOL | Formelzeichen | ||
EDAT_VALUE | EDAT-Wert konvertiert als String. | ||
RDAT_VALUE | RDAT-Wert konvertiert als String. | ||
Rückgabewert | Eigenschaft des Attributs in der Sprache, in der die FVA-Workbench gestartet wurde. | ||
Mögliche Fehler | Fehlerhafte Komponenten-ID Fehlerhafte Attribut-ID Attribut- und Komponenten-ID passen nicht zusammen. |
Beispiel Attributeigenschaften des Attributs Zahnbreite auf einem Stirnrad mit der ID 8 abfragen.
1var compID = 8; 2var attributeID = 'face width'; 3println('Name: ' + getAttrProperty(attributeID, compID, 'NAME')); 4println('Unit: ' + getAttrProperty(attributeID, compID, 'UNIT_NAME')); 5println('Symbol: ' + getAttrProperty(attributeID, compID, 'SYMBOL')); 6println('Value: ' + getAttrProperty(attributeID, compID, 'RDAT_VALUE'));
Variable compID mit der Komponenten ID 8 belegen. | |
Variable attributeID mit der ID des Attributs Zahnbreite belegen. | |
Namen des Attributs auf der Scripting Konsole ausgeben. | |
Einheit des Attributs auf der Scripting Konsole ausgeben. | |
Formelzeichen des Attributs auf der Scripting Konsole ausgeben. | |
Ausgabewert des Attributs auf der Scripting Konsole ausgeben. |
isAttrLocked()
isAttrLocked(attrID, compID); | ||
Parameter | Typ | Beschreibung |
attrID | string | Eindeutige ID des Attributs. |
compID | int | Eindeutige ID der Komponente im Modell. |
Rückgabewert | boolean | true - Attribut kann nicht geschrieben werden. false - Attribut kann geschrieben werden. |
Attribute können unter Umständen den Status "locked" haben und nicht via Script geändert werden. Dies ist z.B. der Fall, wenn die Vorgabe des Attributwertes zu einer Überbestimmung des Modells führen würde.
Beispiel
Wurde im Editorview auf der Komponente Stirnradstufe der Dropdown-Eintrag zur Aufteilung der Profilverschiebung "Eingabe der Profilverschiebung nach DIN 3992" ausgewählt, werden die Attribute zur manuellen Eingabe des Nennprofilverschiebungsfaktors ausgeblendet und gesperrt.
Das Script prüft, ob das Attribut "addendum modification coefficient" beschreibbar ist. Wenn ja, wird der neue Wert gesetzt. Wenn nein, wird eine Meldung mit dem Hinweis "Nennprofilverschiebungsfaktor kann nicht gesetzt werden, bitte die Aufteilung Profilverschiebung prüfen" ausgegeben.
let gearID = 8; let addendum_modification = 0.3; if(isAttrLocked("addendum modification coefficient", gearID) == false){ setAttr("addendum modification coefficient", gearID, addendum_modification, EDAT); }else{ println("Addendum modification factor cannot be set, please check the addendum modification allocation."); }
delRDAT()
delRDAT(); | ||
Parameter | Typ | Beschreibung |
- | - | - |
Für weitere Informationen siehe Datenhaltung (EDAT/RDAT)
Beispiel 1 Alle RDAT-Werte löschen.
delRDAT();
Zugriff auf Komponenten
getCompByType()
getCompByType(compType); | ||
Parameter | Typ | Beschreibung |
compType | string | Typ der Komponente (z.B. "bearing") |
Rückgabewert | array | Array mit den Komponenten IDs |
Mögliche Fehler | Komponenten-Typ existiert nicht. |
Beispiel 1 Bei allen Wälzlagern im Getriebemodell den Eingabetyp auf "Steifigkeit" setzten.
1let bearings = getCompByType("bearing"); 2for (i=0; i < bearings.length; i++){ 3 setAttr("bearing data type", bearings[i], 2, EDAT); }
Variable bearings mit einem Array aller Wälzlager IDs im Getriebe belegen. | |
for-Schleife, die so oft durchlaufen wird, wie das Array bearings Elemente besitzt. | |
Setzt das Attribut "Eingabetyp" für jedes Lager auf "Steifigkeit" (Wert =2 siehe auch Datentyp Combo-Attribut). |
getCompProperty()
getCompProperty(compID, propertyID); | ||
Parameter | Typ | Beschreibung |
compID | int | Eindeutige ID der Komponente im Modell |
propertyID | String | TYPE - Komponententyp (z.B. cylindrical_mesh) |
NAME - Namen der Komponente | ||
Rückgabewert | String | Eigenschaft der Komponente |
Mögliche Fehler | Fehlerhafte Komponenten-ID |
Beispiel 1 Namen und Typ einer Komponente auf der Scripting Konsole ausgeben.
1var compID = 3; 2println(getCompProperty(compID,'TYPE')); 3println(getCompProperty(compID,'NAME'));
Variable compID mit 3 belegen. | |
Komponententyp der Komponente 3 auf der Scripting Konsole ausgeben. | |
Komponentennamen der Komponente 3 auf der Scripting Konsole ausgeben. |
Hinweis
In früheren Versionen der FVA-Workbench konnten über getCompProperty() die Eigenschaften IDENT_NO und DRAWING_NO abgefragt werden.
Die Zeichnungsnummer (comp_drawing_number) und die Identnummer (comp_ident_number) sind jetzt Attribute auf der jeweiligen Komponente und können über setAttr() und getAttr() gesetzt bzw. ausgelesen werden.
Beispiel Zeichnungsnummer auslesen: getAttr("comp_drawing_number", 3, EDAT);
setCompProperty()
setCompProperty(compID, propertyID); | ||
Parameter | Typ | Beschreibung |
compID | int | Eindeutige ID der Komponente im Modell |
propertyID | String | NAME - Namen der Komponente |
Mögliche Fehler | Fehlerhafte Komponenten-ID |
Beispiel Namen einer Komponente ändern.
var compID = 3; setCompProperty(compID, "NAME", "New component name");
getSubComponents()
getSubComponents(compID, subCompType); | ||
Parameter | Typ | Beschreibung |
compID | int | ID der Hauptkomponente |
subCompType | string | Komponententyp der abzufragenden Unterkomponente z.B. "cylindrical_mesh". |
Rückgabewert | array | Array mit den ID's der Unterkomponenten. Existieren keine Unterkomponenten, wird eine leeres Array zurückgegeben. |
Mögliche Fehler | Der abgefragte Komponententyp existiert nicht auf der Hauptkomponente. Die Hauptkomponente existiert nicht. |
Beispiel 1 Räder einer Stirnradstufe abfragen
1var stageID = 3; 2var gearIDs = getSubComponents(stageID, "general_gear"); 3println(gearIDs[0]); 4println(gearIDs[1]);
Variable stageID enthält die ID der Stirnradstufe. | |
getSubComponents() schreibt ein Array mit den ID's der beiden Stirnräder in die Variable gearIDs. | |
Schreibt die ID des ersten Stirnrads auf die Konsole. | |
Schreibt die ID des zweiten Stirnrads auf die Konsole. |
Abfragbare Subkomponenten
Komponente | Was genau wird abgefragt | getSubComponents(...) |
---|---|---|
Räder | Alle Räder der Stufe | stageID, "general_gear" |
Spezifischer Radtyp, z.B. Kegelrad | stageID, "bevel_or_hypoid_gear" | |
Wellen | Alle Wellen der Stufe | stageID, "shaft" |
Komponente | Was genau wird abgefragt | getSubComponents(...) |
---|---|---|
Korrektur | Korrektur bei bestimmten Radtypen. | gearID, "gear_correction" |
Welle | Welle, auf dem das Rad sitzt. | gearID, "shaft" |
Gegenräder | Alle Gegenräder, die mit dem Rad kämmen. | gearID, "general_gear" |
Stufen | Alle Stufen, in denen das Rad vorkommt. | gearID, "general_stage" |
Stufenbezogene Zahnraddaten | Abstrakte Komponente, die die eingriffsbezogenen Daten eines Zahnrades enthält (z.B. Wälzkreisdurchmesser). | gearID, "stage_gear_data" Gibt, wenn das Rad im Mehrfacheingriff ist, für jeden Eingriff ein Komponente von Typ stage_gear_data zurück. |
gearID, "stage_gear_data", "STAGEID=3" Wird als Option die ID der Stufe mitgegeben, (Hier Stufe mit ID 3) wird nur die Komponente vom Typ stage_gear_data, die zur angegebenen Stufe gehört, zurückgegeben . |
Komponente | Was genau wird abgefragt | getSubComponents(...) |
---|---|---|
Räder | Alle Räder auf der Welle | shaftID, "general_gear" |
Spezifischer Radtyp, z.B. Kegelrad | shaftID, "bevel_or_hypoid_gear" | |
Wälzlager | Alle mit der Welle verbundenen Wälzlager. | shaftID, "bearing", "ANY" |
Wälzlager, die auf der Welle sitzen. | shaftID, "bearing", "OUTER" | |
Wälzlager, die in der Welle sitzen. | shaftID, "bearing", "INNER" | |
Gleitlager | Alle mit der Welle verbundenen Gleitlager | shaftID, "slide_bearing", "ANY" |
Gleitlager, die auf der Welle sitzen. | shaftID, "slide_bearing", "OUTER" | |
Gleitlager, die in der Welle sitzen. | shaftID, "slide_bearing", "INNER" | |
Belastung | Alle Belastungskomponenten (Kräfte) auf der Welle | shaftID, "force" |
Kerbstelle | Alle Kerbstellen auf der Welle | shaftID, "notch" |
Wellenkontur | Alle Konturen | shaftID, "contour", "ANY" |
Alle Außenkonturen | shaftID, "contour", "OUTER" | |
Alle Innenkonturen | shaftID, "contour", "INNER" | |
Passfeder | Alle Passfedern auf der Welle | shaftID, "feather_key", "ANY" |
Alle PF, bei denen die Welle das Innenteil ist. | shaftID, "feather_key", "INNER" | |
Alle PF, bei denen die Welle das Außenteil ist. | shaftID, "feather_key", "OUTER" | |
Kegelpressverband | Alle Kegelpressverbindungen auf der Welle | shaftID, "cone_interference_fit", "ANY" |
Alle KPV, bei denen die Welle das Innenteil ist. | shaftID, "cone_interference_fit", "INNER" | |
Alle KPV, bei denen die Welle das Außenteil ist. | shaftID, "cone_interference_fit", "OUTER" | |
Mehrfachpressverband | Alle Mehrfachpressverbindungen auf der Welle | shaftID, "multiple_interference_fit", "ANY" |
Alle MPV, bei denen die Welle das Innenteil ist. | shaftID, "multiple_interference_fit", "INNER" | |
Alle MPV, bei denen die Welle das Außenteil ist. | shaftID, "multiple_interference_fit", "OUTER" | |
Zylinderpressverband | Alle Zylinderpressverbindungen auf der Welle | shaftID, "interference_fit", "ANY" |
Alle ZPV, bei denen die Welle das Innenteil ist. | shaftID, "interference_fit", "INNER" | |
Alle ZPV, bei denen die Welle das Außenteil ist. | shaftID, "interference_fit", "OUTER" | |
Steckverzahnung | Alle Steckverzahnungen auf der Welle | shaftID, "spline_connection" |
Alle Zahnwellen auf der Welle | shaftID, "spline_shaft" | |
Alle Zahnnaben auf der Welle | shaftID, "spline_hub"Ko | |
Koppelung | Alle Koppelungen auf der Welle | shaftID, "clutch" |
Komponente | Was genau wird abgefragt | getSubComponents(...) |
---|---|---|
Verbundene Komponenten | Alle mit dem Wälzlager verbundenen Komponenten | bearingID, "default", "ANY" |
Mit dem Innenring verbundene Komponenten (Wellen oder Gehäuse) | bearingID, "shaft", "INNER" bearingID, "gear_casing" ,"INNER" | |
Mit dem Außenring verbundene Komponenten (Wellen oder Gehäuse) | bearingID, "shaft", "OUTER" bearingID, "gear_casing" ,"OUTER" | |
Lagerreihen | Lagerreihen sind Ergebniskomponenten, die erst nach erfolgreicher Berechnung abgefragt werden können. | bearingID, "bearing_row" |
Komponente | Was genau wird abgefragt | getSubComponents(...) |
---|---|---|
Verbundene Komponenten | Alle mit dem Gleitlager verbundene Komponenten | slideBearingID, "default", "ANY" |
Mit dem Innenring verbundene Komponenten (Wellen oder Gehäuse) | slideBearingID, "shaft", "INNER" slideBearingID, "gear_casing" ,"INNER" | |
Mit dem Außenring verbundene Komponenten (Wellen oder Gehäuse) | slideBearingID, "shaft", "INNER" slideBearingID, "gear_casing" ,"INNER" | |
Segmente | Segmente, Hydrostatische- und Hydrodynamische Taschen sind Ergebniskomponenten, die nur nach erfolgreicher Berechnung abgefragt werden können. | slideBearingID, "slide_bearing_segment" |
Hydrostatische Taschen | slideBearingID, "hydrostatic_pocket" | |
Hydrodynamische Taschen | slideBearingID, "hydrodynamic_pocket" |
Komponente | Was genau wird abgefragt | getSubComponents(...) |
---|---|---|
Stirnradstufen | Alle Stirnradstufen in der Planetenstufe | planetaryStageID, "general_stage" |
Nur die innere Stufe | planetaryStageID, "general_stage", "INNER" | |
Nur die äußere Stufe | planetaryStageID, "general_stage", "OUTER" | |
Räder | Alle Räder in der Planetenstufe | planetaryStageID, "general_gear" |
Sonnenrad | planetaryStageID, "general_gear", "SUN_GEAR" | |
Planetenrad | planetaryStageID, "general_gear", "PLANET_GEAR" | |
Hohlrad | planetaryStageID, "general_gear", "RING_GEAR" | |
Wellen | Alle Wellen in der Planetenstufe | planetaryStageID, "shaft" |
Sonnenwelle | planetaryStageID, "shaft", "SUN_SHAFT" | |
Planetenwelle | planetaryStageID, "shaft", "PLANET_SHAFT" | |
Hohlradwelle | planetaryStageID, "shaft", "RING_SHAFT" | |
Stegwelle | planetaryStageID, "shaft", "RIM_SHAFT" | |
Planetenträger | Einwangiger Planetenträger | planetaryStageID, "one_sided_planet_carrier" |
Zweiwangiger Planetenträger | planetaryStageID, "two_sided_planet_carrier" | |
Bolzen | planetaryStageID, "planet_pin" | |
Instanzen | Stirnradstufe in der Planetenstufe | stageID, "planet_instance" |
Planetenrad | planetGearID, "planet_instance" | |
Planetenlager | planetBearingID, "planet_instance" | |
Bolzen | planetPinID, "planet_instance" | |
Kopplung | couplingID, "planet_instance" |
Komponente | Was genau wird abgefragt | getSubComponents(...) |
---|---|---|
Kerbstelle | Welle, auf der die Kerbstelle sitzt. | notchID, "shaft" |
Belastung | Welle, auf der die Belastungskomponente sitzt. | forceID, "shaft" |
Steckverzahnung | Wellen, die durch die Steckverzahnung miteinander verbunden sind. | splineConnectionID, "Shaft" |
Räder, die die Steckverzahnung bilden. | splineConnectionID, "general_gear" |
Ausgabe
println()
println(data); | ||
Parameter | Typ | Beschreibung |
data | beliebig | Daten, die auf der Scripting-Konsole ausgegeben werden sollen. |
Mögliche Fehler | Fehlerhafte Komponenten-ID Fehlerhafte Attribut-ID |
Beispiel 1
1var text = "This is text"; 2var array = [1, 2.2, 3, 4]; 3println(text); for (i=0; i<array.length; i++){ 4 println(array[i]); }
format()
Parameter | Beschreibung | |
align | Textausrichtung (links- oder rechtsbündig) | |
width | Feldbreite | |
precision | Anzahl der Nachkommastellen die dargestellt werden sollen | |
type | Datentyp des zu formatierenden Wertes | |
value | Zu formatierender Wert |
1 | format("%-12s", "Power"); | (-) Linksbündig (12) 12 Felder breit (s) Wert von Typ String |
2 | format("%-3s", "P"); | (-) Linksbündig, (3) 3 Felder breit (s) Wert vom Typ String |
3 | format("%10.3f", 148,2456); | () Rechtsbündig, (10) 10 Felder breit (f) Wert vom Typ Fließkommazahl (.3) 3 Nachkommastellen |
4 | format("%3s", "kW"); | () Rechtsbündig (3) Felder breit (s) Wert vom Typ String |
alert()
alert(data); | ||
Parameter | Typ | Beschreibung |
data | beliebig | Text, bzw. Daten, die im Dialog angezeigt werden. |
Beispiel 1 Text als Meldung ausgeben.
var text = "This is a message. Click OK to continue." alert(text);
Beispiel 2 Mehrere Meldungen in einer Schleife ausgeben.
1for (i = 0; i < 5; i++){ 2 alert("This is the " + i + ". run"); }
prompt()
prompt(data); | ||
Parameter | Typ | Beschreibung |
data | beliebig | Text, bzw. Daten, die im Eingabedialog als Text angezeigt werden. |
Beispiel 1 Drehmoment vom Nutzer abfragen und den Attributwert auf der Belastungskomponente entsprechend setzen.
1var forceID = 20; 2var torque = prompt("Please enter input torque"); 3setAttr("scaled torque", forceID, torque, EDAT);
clearMonitor()
clearMonitor(); | ||
Parameter | Typ | Beschreibung |
- | - | - |
Beispiel 1 Monitor leeren
clearMonitor();
generateReport()
generateReport(templateFile, outputFile, {options}); | |||
Parameter | Typ | Beschreibung | |
templateFile | string | Pfad + Name der Reportvorlagendatei | |
outputFile | int | Pfad + Name der HTML-Datei | |
{options} | object | Einspaltiges Layout | compactView:true/false |
Sprache | language: "de"/"en" | ||
Hierarchischer Modellbaum | completeTree: true/false | ||
Navigationsleiste | navigationBar: true/false | ||
Berechnungsmeldungen | notifications: true/false | ||
Mögliche Fehler | Zugriffsbeschränkungen auf Ordner/Dateien Fehlende Reportvorlage |
Beispiel 1 HTML-Report generieren
1var templateFile = "C:\\template.wbrep"; 2var outputFile = "C:\\temp\\output\\report.html"; 3var options = {compactView: false, language: "de", completeTree: false, notifications: true, navigationBar: true}; 4generateReport(templateFile, outputFile, options);
loadModel()
loadModel(path) | ||
Parameter | Typ | Beschreibung |
path | string | Pfad + Name der Datei |
Mögliche Fehler | Modelldatei existiert nicht oder Zugriff wird verweigert. |
Anmerkung
Die Funktion kann nur im Batchbetrieb verwendet werden.
Beispiel 1 Lädt ein Modell aus dem angegebenen Verzeichnis.
loadModel("c:\\modell.wbpz");
saveModel()
saveModel(); | ||
Parameter | Typ | Beschreibung |
Mögliche Fehler | Zugriff auf die Modelldatei wird verweigert. |
Beispiel 1 Modelldatei speichern
saveModel();
exportModel()
exportModel(fileName, {options}); | ||||
Parameter | Typ | Beschreibung | ||
fileName | string | Pfad + Name der Modelldatei. Folgende Dateiendungen werden unterstützt: .wbpz .wbpx .wbps .rexs | ||
{options} | object | IncludeEmptyAttributes Legt fest, ob leere Attribute mit in die Ausgabedatei übernommen werden sollen. (true/false) | DataClass Legt fest, ob EDAT oder RDAT geschrieben werden soll. Sind die RDAT Daten nicht valide, wird automatisch EDAT geschrieben. (EDAT/RDAT) | Version Legt die zu verwendende Version der REXS Spezifikation fest. (1.0/1.1/1.2) |
Mögliche Fehler | Der Benutzer hat keine Schreibberechtigung für den angegeben Pfad. |
Beispiel 1 Datei model.wbpz in das Verzeichnis C:\temp exportieren.
exportModel("C:\\temp\\model.wbpz");
Beispiel 2 Modell im REXS-Format (Version 1.2) exportieren
1var options = {IncludeEmptyAttributes: "true" ,DataClass: "RDAT", Version: 1.2}; 2exportModel("C:\\temp\\model.rexs", options);
readFile()
readFile(path); | ||
Parameter | Typ | Beschreibung |
path | string | Verzeichnis + Name der Datei |
Rückgabewert | array | Inhalt der Datei in einem String Array |
Mögliche Fehler | Datei existiert nicht oder Zugriff verweigert. Datei ist im Binär-Format. |
Beispiel 1 Textdatei einlesen und auf der Scripting-Konsole ausgeben.
1var path = "c:\\textfile.txt"; 2var text = readFile(path); 3for (i = 0; i < text.length; i++){ 4 println(text[i]); 5 println(parseFloat(text[i])+ parseFloat(text[i])); }
Variable path mit dem Pfad zur Textdatei belegen. | |
Variable text wird via readFile() mit einem Array belegt, das so viele Einträge hat wie die Datei textfile.txt Zeilen. | |
For-Schleife, in der die Zählvariable i von 0 bis text.length (Anzahl der Zeilen in der Textdatei) erhöht wird. | |
Ausgabe jeder Zeile in der Textdatei auf der Scripting-Konsole. | |
Über parseFloat() wird jeder Arrayeintrag in der Variablen text in eine Fließkommazahl umgewandelt, mit der im weiteren gerechnet werden kann. Enthält der Arrayeintrag keine Zahl, die umgewandelt werden kann, gibt parseFloat() NaN (Not a Number) als Wert zurück. |
writeToFile()
writeToFile(path, text, mode, encoding); | ||||
Parameter | Typ | Beschreibung | ||
path | string | Pfad + Name der Textdatei Pfade können auch relativ angegeben werden. Ausgangsverzeichnis ist dabei das Installationsverzeichnis der FVA-Workbench. | ||
text | string | Text, der in die Datei geschrieben werden soll. | ||
mode | string | a Fügt den Text einer bestehende Datei hinzu. Falls notwendig, wird diese zuvor erstellt. | c Falls die Datei bereits besteht, wird der Inhalt ersetzt. Sonst erstellt das System eine Datei und fügt den Text ein. | |
encoding | string | Wird kein Parameter angegeben, wird die Standardcodierung des Betriebssystems verwendet. Eine Angabe der Kodierung wird empfohlen, um die Kompatibilität zwischen verschiedenen Systemen zu gewährleisten. UTF-8 UTF-16BE UTF-16LE UTF-16 ISO-8859-1 US-ASCII BINARY | ||
Mögliche Fehler | Der Benutzer hat keine Schreibberechtigung für den angegeben Pfad. |
Beispiel Textdatei erstellen und weitere Texte anhängen.
1var path = "C:\\temp\\test.txt"; 2writeToFile(path, "Part 1\n", "c", "UTF-8"); 3writeToFile(path, "Part 2\n", "a", "UTF-8"); 4writeToFile(path, "Part 3", "c", "UTF-8");
exportNotifications()
exportNotifications(path); | ||||
Parameter | Typ | Beschreibung | ||
path | string | Pfad + Name der Datei | ||
Mögliche Fehler | Der Benutzer hat keine Schreibberechtigung für den angegeben Pfad. |
Beispiel 1 Berechnungsmeldungen als .xml exportieren.
exportNotifications("C:\\temp\\notifications.xml");
Weitere
#include
#include "path\\script.wbjs"; | ||
Parameter | Typ | Beschreibung |
Mögliche Fehler | Angegebene Scriptdatei oder Pfad existiert nicht Die Dateiendung ist nicht .wbjs |
Hinweis
Für weitere Beispiele siehe Externe Scripte einbinden
Beispiel 1 Externe Scripte einbinden
1#include "*"; 2#include "folder\\*"; 3#include "folder\\script.wbjs"; 4#include "c:\\scripting\\folder\\script.wbjs"
refreshDbComp()
refreshDbComp(dbCompID); | ||
Parameter | Typ | Beschreibung |
dbCompID | int | Eindeutige ID der Datenbank Komponente im Modell |
Mögliche Fehler | Datenbank-Komponente existiert nicht im Modell. |
Beispiel 1 Aktualisiert die Datenbank Komponente mit der ID 22 mit den Daten aus der Globalen Datenbank.
refreshDbComp(22);
startTransactionMode()
startTransactionMode(); |
Folgende Funktionen werden abgeschaltet:
Update der 3D-Darstellung
Korrelationen (Synchronisierung zwischen verschiedenen Attributen)
Erzeugung von Modellständen
endTransactionMode()
endTransactionMode(); |
stopScript()
stopScript(message); | ||
Parameter | Typ | Beschreibung |
message | beliebig | Text, bzw. Daten die nach dem Scriptabbruch auf dem Scripting-Monitor angezeigt werden |
Beispiel 1 Mehrere Meldungen in einer Schleife ausgeben
1var safety = 1.8; 2if(safety > 2){ 3 generateReport("c:\\template.wbrep", "c:\\report.html"); 4}else{ 5 stopScript("The safety is: "+safety+"\nScript was stopped"); }