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

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

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 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 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 Generate an HTML report

1var templateFile = "C:\\template.wbrep";
2var outputFile = "C:\\output\\report.html";
3var options = {compactView: false, 
                   language: "de", 
                   completeTree: false, 
                   notifications: true, 
                   navigationBar: true};
4generateReport(templateFile, outputFile, options);

Example 2 Create an HTML report with the pre-defined system report template

var templateFile = getPredefinedReportTemplate(SYSTEM_REPORT);
var outputFile = "C:\\output\\report.html";
generateReport(templateFile, outputFile);

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 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.3)

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

Example 1 Export the complete gearbox as a STEP file

let filepath = "c:/output/cadmodel.step";
let options = {"CompIds": [1],
               "CADFormat": "STEP"
              };
exportCAD(filepath, options);

Example 2 Export all shafts and gears of a gearbox model as an IGES file

let filepath = "c:/output/cadmodel.iges";
let gearIds = getCompByType("gear");
let shaftIds = getCompByType("shaft");
let componentsToExport = gearIds.concat(shaftIds);
let options = {"CompIds": componentsToExport,
               "CADFormat": "IGES"
              };
exportCAD(filepath, options);

Example Export a cylindrical gear, including modifications

let filepath = "c:/output/cadmodel.step";
let gearId = [6];
let options = {"CompId": gearId,
               "CADFormat": "STEP",
               "NumberOfSupportingPointsWidth": 20
              };
exportCADGear(filepath, options);

Example 1 Export the complete gearbox as an image file

let filepath = "c:/output/transmission.jpg";
let options = {"CompIds": [1],
               "orientation" : "ISO",
               "size": "SMALL",
               "showDeformation": true
              };
exportImage(filepath, options);

Example 2 Export all shafts and gears of a gear model as an image file

let filepath = "c:/output/shafts_and_gears.jpg";
let gearIds  = getCompByType("gear");
let shaftIds = getCompByType("shaft");
let componentsToExport = gearIds.concat(shaftIds);
let options = {"CompIds": componentsToExport,
               "orientation" : "ISO",
               "size": "LARGE",
               "showDeformation": false
              };
exportImage(filepath, 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 1 Read text file as string

1var path = "c:\\textfile.txt";
2var text = readFileAsString(path);

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 1 Save the model file

saveModel();

Example 1 Include external scripts

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

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