KnowledgeBase

Example 1 Perform a system calculation

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");
    }

Example 2 Perform a bearing life calculation for a single bearing.

methodID = "800_ROLLING_BEARING_LIFETIME";
var compID = 15;
runCalcMethod(methodID, compID);

This function returns all messages for an executed calculation as a JSON object.

Example Output all messages for a calculation to the Scripting Monitor.

let notifications = getNotifications("ALL");

for(i = 0; i < notifications.length; i++) {
    let notification = notifications[i];
    println("Notification #" + i);
    println("---------------");
    println("Type:                " + notification.type);
    println("CalcMethodCompId:    " + notification.calcMethodCompId);
    println("CalcMethodCompName:  " + notification.calcMethodCompName);
    println("CalcMethodId:        " + notification.calcMethodId);
    println("CalcMethodName:      " + notification.calcMethodName);
    println("CalcStepName:        " + notification.calcStepName);
    println("Message:             " + notification.message);
    println(" ");

    let items = notification.items;

    for(j = 0; j < items.length; j++) {
	let notificationItem = items[j];
	println("   Notification Item #" + j);
	println("   ---------------------");
	println("   AttrId:   " + notificationItem.attrId);
	println("   CompId:   " + notificationItem.compId);
	println("   Message:  " + notificationItem.message);
	println("   Value:    " + notificationItem.value);
        println(" ");
    }
println(" ");
}

Comparison of the Messages window in the user interface with the script output in the Scripting Monitor.

Example 1 Output the value of the normal pressure angle attribute to the console.

1let compID = getCompByType('cylindrical_mesh')[0];
2let value = getAttr("normal pressure angle", compID, EDAT);
3println(value);

Example 2 Output the values of the static load rating array attribute to the console.

1let compID = getCompByType('bearing')[0];
2let value = getAttr("static capacity", compID, RDAT);
3println(value[0]);
4println(value[1]);

Example 1 Set the value of the oil temperature attribute to 90.

1var compID = 1;
2setAttr('temperature', compID, 90, EDAT);

Example 2 Set the attribute FVA_54 to true. The attribute FVA_54 corresponds to the "Calculation of micro pitting acc. to FVA 54" switch in the input editor.

1var compID = getCompByType('cylindrical_mesh')[0];
2setAttr('FVA_54', compID, true, EDAT);

Example 1 Delete the lubricant attribute of the gear unit.

1delAttr('lubricant', 1);

Example Query the properties of the "face width" attribute on a cylindrical gear with ID 8.

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'));

In some circumstances, the status of an attribute may be "locked." These attributes cannot be changed via script. For example, this is the case if specification of the attribute value would lead to overdetermination of the model.

Example 

If the option for "Specification of addendum modification acc. to DIN 3992" is selected from the distribution of the addendum modification pull-down menu for the cylindrical gear component in the Editor, the attributes for manually specifying the nominal addendum modification coefficient are locked and hidden.

The script checks whether the "addendum modification coefficient" attribute can be written. If so, the new value is set. If not, a message stating "nominal addendum modification coefficient cannot be written, check the distribution of the addendum modification" is shown.

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.");
}

For more information see Data integrity (EDAT/RDAT)

Example 1 Delete all RDAT values.

delRDAT();

Example 1 Set the input type for all rolling bearings in the model to "rigidity."

1let bearings = getCompByType("bearing");

2for (i=0; i < bearings.length; i++){
3	setAttr("bearing data type", bearings[i], 2, EDAT);
    }

Example 1 Output a component name and type to the scripting console.

1var compID = 3;
2println(getCompProperty(compID,'TYPE'));
3println(getCompProperty(compID,'NAME'));

Example Change the name of a component.

var compID = 3;
setCompProperty(compID, "NAME", "New component name");

Example 1 Query a cylindrical stage

1var stageID = 3;
2var gearIDs = getSubComponents(stageID, "general_gear");
3println(gearIDs[0]);
4println(gearIDs[1]);

Example 1 Add a notch on a shaft and assign the basic attributes

1let shaftID = 3;
2let notchID = addSubComponent(shaftID, "notch");

3setAttr("notch kind", notchID, 6, EDAT);
4setAttr("position", notchID, 6, EDAT);
5setAttr("notch width", notchID, 5, EDAT);
6setAttr("notch radius", notchID, 2, EDAT);
7setAttr("depth", notchID, 2, EDAT);
8setAttr("surface roughness", notchID, 10, EDAT);

1	The shaftID variable includes the ID of the shaft on which the notch should be added.
2	Adds a new component of type "notch" on shaft 3 via addSubComponent(). The return value of the function, the ID of the new notch, is saved in the notchID variable.
3	Sets the "notch form" combo attribute for the new notch to 6 via setAttr(). The value 6 corresponds to a rectangular notch. (See image for additional options)
4	Sets the position of the notch.
5	Sets the width of the notch.
6	Sets the radius of the notch.
7	Sets the depth of the notch.
8	Sets the surface roughness R_z of the notch.

Example 2 Add a contour to an existing shaft

var shaftID = 3;
var nbrOuterContours = 3;
var nbrInnerContours = 2;
var outerContourIDs = [];
var innerContourIDs = [];
var outerContourlenght = [30, 50, 20];
var innerContourlenght = [40, 80];
var outerContourDiameters = [30, 50, 25];
var innerContourDiameters = [10, 20];

for (let i = 0; i < nbrOuterContours; i++){
  let options = {};
  outerContourIDs.push(addSubComponent(shaftID, "contour",{side: "outer", direction: "left"}));
}
for (let i = 0; i < nbrInnerContours; i++){
    innerContourIDs.push(addSubComponent(shaftID, "contour",{side: "inner", direction: "left"}));
}
for(let i = 0; i < nbrOuterContours; i++){
    setAttr("length",             outerContourIDs[i], outerContourlenght[i], EDAT);
    setAttr("beginning diameter", outerContourIDs[i], outerContourDiameters[i], EDAT);
    setAttr("end diameter",       outerContourIDs[i], outerContourDiameters[i], EDAT);
}
for(let i = 0; i < nbrInnerContours; i++){
    setAttr("length",             innerContourIDs[i], innerContourlenght[i], EDAT);
    setAttr("beginning diameter", innerContourIDs[i], innerContourDiameters[i], EDAT);
    setAttr("end diameter",       innerContourIDs[i], innerContourDiameters[i], EDAT);
}

Example Delete a load component from a shaft

var shaftID = 4;
var forceID = 10;

deleteSubComponent(shaftID, forceID);

Example Add the material 16MnCr5 as a component to the model and allocate it to a cylindrical gear

gearID = 8;
var materialID = addDbComponent("material", "16MnCr5");
setAttr("material", gearID, materialID, EDAT);

Example Delete the database component with the ID 120

deleteDbComponent("120");

Example 1 Update the component with the ID 22 with data from the Global Database.

refreshDbComp(22);

Example 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]);
    }

Example 1 Output text as a message.

var text = "This is a message. Click OK to continue."
alert(text);

Example 2 Output multiple messages in a loop.

1for (i = 0; i < 5; i++){
2    alert("This is the " + i + ". run"); 
     }

Example 1 Request torque from the user and set the attribute value of the load component accordingly.

1var forceID = 20;
2var torque = prompt("Please enter input torque");
3setAttr("scaled torque", forceID, torque, EDAT);

Example 1 Write text to a file selected by the user.

1let options = {directory: "c/example", filename: "myfile.txt", type: "save"};
2let path = promptFile(options);
3let text = "This Text will be written to the ASCII File";
4writeToFile(path, text, "c", "UTF-8");

Example 1 Write a text file to a user-selected directory.

1let directory = promptDirectory("c:/example");
2let filename = "text.txt";
3let path = directory +"/"+ filename;
4let text = "This Text will be written to the ASCII File";
5writeToFile(path, text, "c", "UTF-8");

Example 1 Query the user for criteria for the proposed modification and set the corresponding attribute in the FVA-Workbench.

The possible values for the "3D load distribution tooth modification criterium" combo attribute can be seen in the attribute overview.

1let dropDownEntries = [
                           "Linear increase in pressure", 
                           "Uniform pressure distribution", 
                           "Linear increase of line loads", 
                           "Uniform line loads"
                          ];
2let modCriterion = promptSelect("Select modification criterion for 3d loaddistribution", dropDownEntries);

3switch (modCriterion) {
        case "Linear increase in pressure":   modCriterion = "0"; break; 
        case "Uniform pressure distribution": modCriterion = "1"; break;
        case "Linear increase of line loads": modCriterion = "2"; break;
        case "Uniform line loads":            modCriterion = "3"; break;
        default: break; 
    };

4setAttr("modification_criterion_load_distribution_3d", 1, modCriterion, EDAT);

Example 1 Clear the monitor

clearMonitor();

Example 1 Generate an HTML report

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);

Example 1 Load a model from the specified directory.

loadModel("c:\\modell.wbpz");

Example 1 Save the model file

saveModel();

Example 1 Export the file model.wbpz to the C:\temp directory.

exportModel("C:\\temp\\model.wbpz");

Example 2 Export the model in REXS format (version 1.2)

1var options = {IncludeEmptyAttributes: "true" ,DataClass: "RDAT", Version: 1.2};
2exportModel("C:\\temp\\model.rexs", options);

Example 1 Import a text file and output it to the scripting console

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]));
     }

Example Create a text file and add additional text.

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");

Example

let filestatus = fileExists("c:/example/file.txt");
println(filestatus);

Example

let filestatus = isFileReadable("c:/example/file.txt");
println(filestatus);

Example

let filestatus = isFileWriteable("c:/example/file.txt");
println(filestatus);

Example 1 Export calculation messages as .xml.

exportNotifications("C:\\temp\\notifications.xml");

Example 1 Include external scripts

1#include "*";
2#include "folder\\*";
3#include "folder\\script.wbjs";
4#include "c:\\scripting\\folder\\script.wbjs"

The following functions are disabled:

Example 1 Output multiple messages in a loop

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");
}

Some scripting functions can only be executed in the GUI or in batch mode. The isBatchMode() function can be used to check which mode the FVA-Workbench is in while the script is running, and to react accordingly.

Example

If the script is executed in GUI mode, a dialog queries the user for the directory to be used. In batch mode, the directory in which the model file is located is used.

let filename = "textfile.txt";
let text = "This text will be written to the file";
let directory;
let resultpath;

if (isBatchMode() == true) {
    directory = getModelProperty("FOLDER");
} else {
    directory = promptDirectory();
}

resultpath = directory+filename;
println("File written: "+resultpath);
writeToFile(resultpath, text, "c", "UTF-8");

Example 1 Write a text file to a subdirectory of the model folder.

1let modelpath = getModelProperty("FOLDER");
2let modelname = getModelProperty("MODEL_NAME");
3let filepath = modelpath + "new_directory/textfile.txt";
4writeToFile(filepath, modelname, "c", "UTF-8");

Example Query the directory for report templates and the output folder and create a results report.

1let reportTemplateDirectory = getDirectory("report_templates");
2let templateFile = reportTemplateDirectory +"\\myReportTemplate.wbrep";

3let outputDirectory = getDirectory("reports");
4let outputFile = outputDirectory+"\\report.html";

5generateReport(templateFile, outputFile);

6println("Report was saved here: "+outputFile);

Example

World Clock API is a server that returns the current date and time in JSON. The server returns the data as a string. The JSON.parse command can be used to convert this string to a JSON object. Elements in the JSON object can then be accessed using dot notation.

let JSON_string = get('http://worldclockapi.com/api/json/utc/now');
let JSON_object = JSON.parse(JSON_string);

println(JSON_string);
println(JSON_object.currentDateTime);
println(JSON_object.dayOfTheWeek);

Example

In this script, "name" and "password" are transferred as parameters to a demo server. The response from the server is a JSON string, which also includes the parameters that were sent. The JSON.parse command can be used to convert the string to a JSON object.

let JSON_string = post('https://postman-echo.com/post', {'name':'mustermann', 'password':'secret'});
let JSON_object = JSON.parse(JSON_string);

println(JSON_string);
println(JSON_object.data.name);
println(JSON_object.data.password);

Example Output different messages after a calculation, depending on the language.

1let status = runCalcMethod("001_SYSTEM_CALCULATION", 1);
2let language = getLanguage();
3let success_message = language == "de" ? "Die Berechnung war erfolgreich" : "Calculation was successful";
4let fail_message = language == "de" ? "Die Berechnung ist fehlgeschlagen" : "Calculation failed";

5if (status == 1) {
6    println(success_message);
7    } else {
8  println(fail_message );
    }