IES VisualFoundation User's Guide
Commands
| Command | Description | Example Input | Example Result | |
| Clear | Clears all text in the command line and clears any stored variables | |||
| Browse | Launches the Open dialog box to navigate to an external script to run | |||
| Up/Down Arrows | Use the "Up Arrow" and "Down Arrow" keys to navigate the command line history | |||
| Esc | Press the "Esc" key while a script is running to end the script run | |||
| Help() | Launches the Help File and navigates to the command line overview page | |||
| Help(command) | Launches the Help File and navigates to the specified command | Help("AddSlab") | Launches the Help File and navigates to the AddSlab command | |
| SetUnits(style) | Sets the unit style to a default or custom style in the program | SetUnits("Canadian") | Sets the programs unit style to Canadian | |
| SetDisplayPrecision(DecimalPlaces) | Sets the number of decimal places displayed | SetDisplayPrecision(4) | Sets the precision to 4 decimal places | |
| Select(names[]) | Selects a specified item(s) (e.g. slab, vertex, etc.) in the model | Select("F1", "V1") | Selects slab F1 and vertex V1 in the model | |
| Delete() | Deletes the selected model object(s) and/or load(s) | Select element Bm1, node N1, and vertex V1 then enter Delete() | Deletes element Bm1, node N1, and vertex V1 in the model | |
| Delete(names[]) | Deletes a specified item(s) (e.g. slabs, piers, piles, etc.) in the model | Delete("F1", "C1", "P1") | Deletes slab F1, pier C1, and pile P1 in the model | |
| DeleteAll() | Deletes everything in the model | |||
| Zoom(name) | Zooms to a specified item (e.g. slabs, piers, piles, etc.) in the model | Zoom("V1") | Zooms into vertex V1 in the model | |
| Print(List<names>) | Prints the list of items in a comma-delimited format | Print(Slabs()) | Prints the list of nodes in the project in a comma-delimited format | |
| List(List<names>) | Lists the list of items with one item per line | List(Vertices()) | Lists the list of vertices with one item per line | |
| PickConcrete() | Opens the Concrete Material Database dialog box | SetPierMaterial("C1", PickConcrete()) | Opens the Concrete Material Database dialog box to set the concrete for pier C1 | |
| PickMaterial() | Opens the Material Database dialog box | AddPile("P1", 12, 24, 48, "HP8X36", 0, PickMaterial()) | Opens the Material Database dialog box to define a material for pile P1 that is created at {12, 24} | |
| PickDatabaseSection() | Opens the Shape Database dialog box | AddPile("P1", 12, 24, 48, PickDatabaseSection(), 0, "ASTM A992 Grade 50") | Opens the Shape Database dialog box to define a database section for pile P1 that is created at {12, 24} | |
| PickParametricSection() | Opens the Parametric Shape Dimensions dialog box | AddPile("P1", 12, 24, 48, PickParametricSection(), 0, "Concrete (F'c = 4 ksi)") | Opens the Parametric Shape Dimensions dialog box to define a parametric section for pile P1 that is created at {12, 24} | |
| SetTitle() | Sets the Title for the project | SetTitle("Pile Cap Design") | Sets the Title for the project to "Pile Cap Design" | |
| SetBillingReference() | Sets the Billing Reference for the project | SetBillingReference("ABC Architects") | Sets the Billing Reference for the project to "ABC Architects" | |
| SetProjectNotes() | Adds a project note | SetProjectNotes("Analysis & design complete.") | Adds note "Analysis & design complete." to the project. | |
| SetNodalTolerance() | Sets the Nodal Tolerance | SetNodalTolerance(0.075) | Sets the Nodal Tolerance to 0.075 | |
| Vertices() | Returns a list of all the vertices in the project | Print(Vertices()) | Prints the list of all the vertices in the project in a comma-delimited format | |
| MoveTo(name, X, Y) | Moves a specified vertex to a defined location | MoveTo("V1", 0, 0) | Moves vertex V1 to the origin | |
| MoveTo(name, location) | Moves a specified vertex to a predefined location |
var location1 = new Location(10, 20); MoveTo("V1", location1) |
Moves vertex V1 to location1 | |
| MoveBy(name, distanceX, distanceY) | Moves a specified vertex by a specified distance in each global direction | MoveBy("V1", 5, 10) | Moves vertex V1 by 5 in the global X direction and 10 in the global Y direction | |
| X(name) | Returns the global X-coordinate of the specified vertex | X("V1") | Returns the global X-coordinate of vertex V1 | |
| Y(name) | Returns the global Y-coordinate of the specified vertex | Y("V1") | Returns the global Y-coordinate of vertex V1 | |
| Slabs() | Returns a list of all the slabs in the project | Print(Slabs()) | Prints the list of all the slabs in the project in a comma-delimited format | |
| AddSlab(List<X>, List<Y>) | Adds a slab defined by the a list of X coordinates and list of Y coordinates. |
var X = new List<double>(){0, 1, 0}; var Y = new List<double>(){0, 0, 1}; AddSlab(X, Y) |
Adds a slab defined by coordinate lists X and Y | |
| AddSlab(Location[]) | Adds a slab defined by and array of locations |
var location1 = new Location(0, 0); var location2 = new Location(1, 0); var location3 = new Location(0, 1); AddSlab(location1, location2, location3) |
Adds a slab defined by location1, location2, and location3 | |
| AddRectangleSlab(centerX, centerY, width, height) | Adds a rectangular slab of specified width and height at a defined location | AddRectangleSlab(1, 2, 5, 15) | Adds a 5 wide by 10 tall rectangular slab centered at {1, 2} | |
| AddCircleSlab(centerX, centerY, radius) | Adds a circular slab of specified radius at a defined location | AddCircleSlab(1, 2, 5) | Adds a circular slab of radius 5 centered at {1, 2} | |
| AddPolygonSlab(centerX, centerX, radius, numberSides, angle) | Adds a polygon slab of specified radius at a defined location | AddPolygonSlab(1, 2, 5, 6, 45) | Adds a 6 sided polygon of radius 5 centered at {1, 2} with a rotation angle of 45 | |
| ToggleHole(slab) | Toggles the Hole? parameter for the specified slab on or off | ToggleHole("F1") | Toggles the Hole? parameter on or off for slab F1 | |
| SubgradeModulus(slab, modulus) | Sets the subgrade modulus to a specified value for the defined slab | SubgradeModulus("F1", 0.25) | Sets the subgrade modulus for slab F1 to 0.25 | |
| Thickness(slab, thickness) | Sets the thickness to a specified value for the defined slab | Thickness("F1", 12) | Sets the thickness for slab F1 to 12 | |
| ToggleSelfWeight(slab) | Toggles the Add Self Weight parameter for the specified slab on or off | ToggleSelfWeight("F1") | Toggles the Add Self Weight parameter on or off for slab F1 | |
| Height(slab, height) | Modifies the height of a rectangular or circular slab | Height("F1", 120) | Changes the height of slab F1 to 120 | |
| Width(slab, width) | Modifies the width of a rectangular or circular slab | Width("F1", 120) | Changes the width of slab F1 to 120 | |
| Theta(slab, theta) | Modifies the theta of a rectangular or polygon slab | Theta("F1", 45) | Changes theta of slab F1 to 45 | |
| Radius(slab, radius) | Modifies the radius of a circular or polygon slab | Radius("F3", 120) | Changes the radius of slab F1 to 120 | |
| SideCount(slab, sideCount) | Modifies the number of sides for a polygon slab | SideCount("F1", 6) | Changes the number of sides for slab F1 to 6 | |
| SideLength(slab, length) | Modifies the side length for a polygon slab | SideLength("F1", 120) | Changes the side length for slab F1 to 120 | |
| MoveCenterTo(slab, centerX, centerY) | Moves the center of the a circular, rectangular, or polygon slab to a defined location | MoveCenterTo("F1", 120, 240) | Moves the center of slab F1 to {120, 240} | |
| MoveCenterTo(slab, location) | Moves the center of the a circular, rectangular, or polygon slab to a defined location |
var locaiton1 = new Location(120, 240); MoveCenterTo("F1", location1) |
Moves the center of slab F1 to location1 | |
| MoveCenterBy(slab, distanceX, distanceY) | Moves the center of the a circular, rectangular, or polygon slab by a specified amount | MoveCenterBy("F1", 120, 240) | Moves the center of slab F1 by 120 in the X-direction and 240 in the Y-direction | |
| SingleMat_Optimize(slab, xBarsTop, bottomCover, (string, double)[] barPatterns) | Sets the design approach for the slab to optimize, defines the reinforcement details, and sets the reinforcement search patterns for the single mat | SingleMat_Optimize("F1", true, 3, ("#4", 18), ("#4", 12), ("#5", 18), ("#5", 12)) | Sets the design approach for slab F1 to optimize, defines the rebar directions and cover, and sets the search patterns as #4 @ 18, #4 @ 12, #5 @ 18, #4 @ 12, for the single mat | |
| DoubleMat_Optimize(slab, topXTop, topCover, bottomXTop, bottomCover, (string, double)[] barPatterns) | Sets the design approach for the slab to optimize, defines the reinforcement details, and sets the reinforcement search patterns for both mats | DoubleMat_Optimize("F1", true, 2, true, 3, ("#4", 18), ("#4", 12), ("#5", 18), ("#5", 12)) | Sets the design approach for slab F1 to optimize, defines the rebar directions and covers, and sets the search patterns as #4 @ 18, #4 @ 12, #5 @ 18, #4 @ 12, for both mats | |
| SingleMat_Specify(slab, xBarsTop, bottomCover, xSize, xSpacing, ySize, ySpacing) | Sets the design approach for the slab to specify and defines the reinforcement mat and the reinforcement details | SingleMat_Specify("F1", true, 2, "#6", 12, "#8", 16) | Sets the design approach for slab F1 to specify and defines the single mat of reinforcement | |
| DoubleMat_Specify(slab, topXTop, topCover, bottomXTop, bottomCover, topXSize, topXSpacing, topYSize, topYSpacing, bottomXSize, bottomXSpacing, bottomYSize, bottomYSpacing) | Sets the design approach for the slab to specify and defines the reinforcement mats (top and bottom) and the reinforcement details | DoubleMat_Specify("F1", true, 2, true, 3, "#6", 12, "#6", 12, "#8", 16, "#8", 16) | Sets the design approach for slab F1 to specify and defines the two mats of reinforcement | |
| Piles() | Returns a list of all the piles in the project | Print(Piles()) | Prints the list of all the piles in the project in a comma-delimited format | |
| AddPile(X, Y) | Adds a default pile at a specified coordinate | AddPlie(0, 0) | Adds a default pile at the origin | |
| AddPile(location) | Adds a default pile at a specified location |
var location1 = new Location(12, 24); AddPile(location1) |
Adds a default pile at location1 | |
| AddPile(name, X, Y, length, shape, theta, material) | Adds a pile with a defined name at a specified coordinates with the shape and material parameters defined | AddPile("P1", 12, 24, 48, "HP8X36", 15, "ASTM A992 Grade 50") | Adds pile P1 at {12, 24} that has a length of 48 with specified shape and material parameters | |
| AddPile(name, location, length, shape, theta, material) | Adds a pile with a defined name at a specified location with the shape and material parameters defined |
var location1 = new Location(12, 24); AddPile("P1", location1, 48, "HP8X36", 15, "ASTM A992 Grade 50") |
Adds pile P1 at location1 that has a length of 48 with specified shape and material parameters | |
| SetPileStiffness(pile, k) | Sets the stiffness for defined pile to a specific value | SetPileStiffness("P1", 1000) | Sets the stiffness of P1 to 1000 | |
| SetPileRigid(pile) | Sets the specified pile to rigid | SetPileRigid("P1") | Sets pile P1 to rigid | |
| RefinePile(pile, offset, startLength, endLength) | Sets the Refine parameter for the specified pile to true and defines the mesh refinement parameters | RefinePile("P1", 6, 0.5, 4) | Sets the Refine parameter for pile P1 to true and set the offset to 6, the element length at start to 0.5, and the element length at end to 4 | |
| UnRefinePile(pile) | Sets the Refine parameter for the specified pile to false | UnRefinePile("P1") | Sets the Refine parameter for pile P1 to false | |
| SetPileTensionOnly(pile) | Sets specified pile to Tension Only | SetPileTensionOnly("P1") | Sets pile P1 to Tension Only | |
| SetPileCompressionOnly(pile) | Sets specified pile to Compression Only | SetPileCompressionOnly("P1") | Sets pile P1 to Compression Only | |
| SetPileTwoWay(pile) | Sets specified pile to Tension and Compression |
SetPileTwoWay("P1") |
Sets pile P1 to Tension and Compression | |
| MovePileTo(pile, X, Y) | Moves specified pile to defined coordinates | MovePileTo("P1", 12, 24) | Moves pile P1 to {12, 24} | |
| MovePileTo(pile, location) | Moves specified pile to defined location |
var location1 = new Location(12, 24); MovePileTo("P1", location1) |
Moves pile P1 to location1 | |
| MovePileBy(pile, distanceX, distanceY) | Moves specified pile by a specified distance in each global direction | MovePileBy("P1", 12, 24) | Moves pile P1 by 12 in the X-direction and 24 in the Y-direction | |
| PileGeotechnicalCapacity(pile, tension, compression, AtServiceLevel) | Sets the geotechnical tension and compression capacity for the specified pile, defining the capacity at either the service or strength level | PileGeotechnicalCapacity("P1", 50, 100, true) | Sets the geotechnical tension capacity to 50 and the geotechnical compression capacity to 100 for Pile P1, and sets the code check to the service level. | |
| Piers() | Returns a list of all the piers in the project | Print(Piers()) | Prints the list of all the piers in the project in a comma-delimited format | |
| AddPier(X, Y) | Adds a default pier at a specified coordinate | AddPier(0, 0) | Adds a default pier at the origin | |
| AddPier(location) | Adds a default pier at a specified location |
var location1 = new Location(12, 24); AddPier(location1) |
Adds a default pier at location1 | |
| NamePier(currentName, newName) | Renames a pier | NamePier("C1", "C2") | Changes the name of pier C1 to C2 | |
| SquarePierSize(pier, size) | Sets the specified pier shape to square and defines its size |
SquarePierSize("C1", 8) |
Sets pier C1 as a square and defines its size as 8 | |
| RectanglePierSize(pier, sizeX, sizeY) | Sets the specified pier shape to rectangular and defines its size | RectanglePierSize("C1", 6, 12) | Sets pier C1 as a rectangle and defines its size as 6x12 | |
| CirclePierSize(pier, radius) | Sets the specified pier shape to circle and defines its size | CirclePierSize("C1", 6) | Sets pier C1 as a circle and defines its radius as 6 | |
| OctagonPierSize(pier, radius) | Sets the specified pier shape to octagon and defines its size | OctagonPierSize("C1", 9) | Sets pier C1 as an octagon and defines its radius as 9 | |
| SetPierHeight(pier, height) | Sets the height for a specified pier | SetPierHeight("C1", 12) | Sets the height of pier C1 to 12 | |
| SetPierMaterial(pier, material) | Sets the material for a specified pier | SetPierMaterial("C1", "Concrete (F'c = 4 ksi)") | Sets the material of pier C1 to Concrete (F'c = 4 ksi) | |
| SetPierTheta(pier, theta) | Sets the rotation for a specified pier | SetPierTheta("C1", 45) | Sets the rotation of pier C1 to 45 | |
| SetPierSelfWeight(pier, includeWeight) | Includes or excludes the self weight for a specified pier | SetPierSelfWeight("C1", false) | Excludes the self weight for pier C1 | |
| RefinePier(pier, offset, startLength, endLength) | Sets the Refine parameter for the specified pier to true and defines the mesh refinement parameters | RefinePier("C1", 6, 0.5, 4) | Sets the Refine parameter for pier C1 to true and set the offset to 6, the element length at start to 0.5, and the element length at end to 4 | |
| UnRefinePier(pier) | Sets the Refine parameter for the specified pier to false |
UnRefinePier("C1") |
Sets the Refine parameter for pier P1 to false | |
| MovePierTo(pier, X, Y) | Moves specified pier to defined coordinates | MovePierTo("C1", 12, 24) | Moves pier C1 to {12, 24} | |
| MovePierTo(pier, location) | Moves specified pier to defined location |
var location1 = new Location(12, 24); MovePierTo("C1", location1) |
Moves pier C1 to location1 | |
| MovePierBy(pier, distanceX, distanceY) | Moves specified pier by a specified distance in each global direction | MovePierBy("C1", 12, 24) | Moves pier C1 by 12 in the X-direction and 24 in the Y-direction | |
| SetRectangularReinforcement(item, izCount, iyCount, longSize, longFy, confSpacing, confSize, confFy) | Sets the longitudinal and confining reinforcement parameters for a pier or pile with a rectangular reinforcement layout | SetRectangularReinforcement("C1", 2, 1, "#6", 60, 6, "#4", 40) | Sets the rectangular reinforcement for C1 to #6 60 ksi longitudinal bars, with two intermediate bars on the z-face and one intermediate bar on the y-face, and #4 40 ksi confining bars with 6-inch spacing | |
| SetRoundReinforcement(item, longCount, longSize, longFy, confSpacing, confSize, confFy, confSpiral) | Sets the longitudinal and confining reinforcement parameters for a pier or pile with a circular reinforcement layout | SetRoundReinforcement("C1", 6, "#6", 60, 6, "#4", 40, false) | Sets the round reinforcement for C1 to (6) #6 60 ksi longitudinal bars with #4 40 ksi tie confining bars at 6-inch spacing | |
| Beams() | Returns a list of all the grade beams in the project | Print(Beams()) | Prints the list of all the grade beams in the project in a comma-delimited format | |
| AddBeam(startX, startY, endX, endY) | Adds a grade beam between start coordinates and end coordinates | AddBeam(0, 0, 120, 240) | Adds a grade beam between {0, 0} and {120, 240} | |
| AddBeam(startLocation, endLocation) | Adds a grade beam between a start location and an end location |
var location1 = new Location(0, 0); var location2 = new Location(120, 240); AddBeam(location1, location2) |
Adds a grade beam between location1 and location2 | |
| AddBeam(name, startX, startY, endX, endY, depth, width, includeSelfWeight) | Adds a grade beam between start coordinates and end coordinates with a defined name, depth, , and width and with the self weight included or excluded | AddBeam("GB1", 0, 0, 120, 240, 24, 12, true) | Adds a grade beam named GB1 between {0, 0} and {120, 240} that is 24 deep, 12 wide, and includes its self weight | |
| AddBeam(name, startLocation, endLocation, depth, width, includeSelfWeight) | Adds a grade beam between a start location and an end location with a defined name, depth, and width and with the self weight included or excluded |
var location1 = new Location(0, 0); var location2 = new Location(120, 240); AddBeam("GB1", location1, location2, 24, 12, true) |
Adds a grade beam named GB1 between location1 and location2 that is 24 deep, 12 wide, and includes its self weight | |
| BeamSubgradeModulus(beam, subgradeIncrement) | Sets the Subgrade Increment for the specified grade beam | BeamSubgradeModulus("GB1", 0.1) | Sets the Subgrade Increment for grade beam GB1 to 0.1 | |
| SetBeamTopFlush(beam) | Sets the vertical offset for the specified grade beam to Top Flush | SetBeamTopFlush("GB1") | Sets the vertical offset for grade beam GB1 to Top Flush | |
| SetBeamCentered(beam) | Sets the vertical offset for the specified grade beam to Centered | SetBeamCentered("GB1") | Sets the vertical offset for grade beam GB1 to Centered | |
| SetBeamBottomFlush(beam) | Sets the vertical offset for the specified grade beam to Bottom Flush | SetBeamBottomFlush("GB1") | Sets the vertical offset for grade beam GB1 to Bottom Flush | |
| Walls() | Returns a list of all the walls in the project | Print(Walls()) | Prints the list of all the walls in the project in a comma-delimited format | |
| AddWall(startX, startY, endX, endY) | Adds a wall between start coordinates and end coordinates | AddWall(0, 0, 120, 240) | Adds a wall between {0, 0} and {120, 240} | |
| AddWall(startLocation, endLocation) | Adds a wall between a start location and an end location |
var location1 = new Location(0, 0); var location2 = new Location(120, 240); AddWall(location1, location2) |
Adds a wall between location1 and location2 | |
| AddWall(name, startX, startY, endX, endY, height, thickness, includeSelfWeight) | Adds a wall between start coordinates and end coordinates with a defined name, height, and thickness and with the self weight included or excluded | AddWall("W1", 0, 0, 120, 240, 60, 12, true) | Adds a wall named W1 between {0, 0} and {120, 240} that is 60 tall, 12 thick, and includes its self weight | |
| AddWall(name, startLocation, endLocation, height, thickness, includeSelfWeight) | Adds a wall between a start location and an end location with a defined name, height, and thickness and with the self weight included or excluded |
var location1 = new Location(0, 0); var location2 = new Location(120, 240); AddWall("W1", location1, location2, 60, 12, true) |
Adds a wall named W1 between location1 and location2 that is 60 tall, 12 thick, and includes its self weight | |
| WallSubgradeModulus(wall, increment) | Sets the Subgrade Increment for the specified wall | WallSubgradeModulus("W1", 0.1) | Sets the Subgrade Increment for wall W1 to 0.1 | |
| MoveLineTo(beamOrWall, startX, startY, endX, endY) | Moves specified beam or wall to a defined start coordinate and end coordinate | MoveLineTo("L1", 0, 0, 120, 240) | Moves beam or wall L1 to span between coordinates {0, 0} and {120, 240} | |
| MoveLineTo(beamOrWall, startLocation, endLocation) | Moves specified beam or wall to a defined start location and end location |
var location1 = new Location(0, 0); var location2 = new Location(120, 240); MoveLineTo("L1", location1, location2) |
Moves beam or wall L1 to span between location1 and locaiton2 | |
| MoveLineBy(beamOrWallm, distanceX, distanceY) | Moves specified beam or wall by specified amounts in the X-direction and the Y-direction | MoveLineBy("L1", 12, 24) | Moves beam or wall L1 by 12 in the X-direction and 24 in the Y-direction | |
| MoveStart(beamOrWall, X, Y) | Moves the start point of a specified beam or wall to a defined coordinate | MoveStart("L1", 6, 12) | Moves the start coordinate of beam or wall L1 to {6, 12} | |
| MoveStart(beamOrWall, startLocation) | Moves the start point of a specified beam or wall to a defined location |
var location1 = new Location(0, 0); MoveStart("L1", location1) |
Moves the start coordinate of beam or wall L1 to locatoin1 | |
| MoveEnd(beamOrWall, X, Y) | Moves the end point of a specified beam or wall to a defined coordinate | MoveEnd("L1", 6, 12) | Moves the end coordinate of beam or wall L1 to {6, 12} | |
| MoveEnd(beamOrWall, endLocation) | Moves the end point of a specified beam or wall to a defined location |
var location1 = new Location(120, 120); MoveEnd("L1", location1) |
Moves the end coordinate of beam or wall L1 to locatoin1 | |
| ServiceCases() | Returns a list of all the service cases in the project | Print(ServiceCases()) | Prints the list of all the service cases in the project in a comma-delimited format | |
| AddServiceCase(name, source) | Adds a service case with a specified name and source | AddServiceCase("S-Unbalanced", "Snow") | Add service case S-Unbalanced with a Snow load source | |
| AddServiceCase(name, source, includeInCombos, pattern) | Adds a service case with a specified name and source and defines the pattern ID and if the case is included in the building code combinations | AddServiceCase("S-Unbalanced", "Snow", true, 1) | Add service case S-Unbalanced with a Snow load source and includes the service case in the building code combination and sets the pattern ID to 1 | |
| VerticalSelfWeight(name) | Turns on the self weight for a specified service case | VerticalSelfWeight("D") | Turns on the self weight for service case D | |
| NoSelfWeight(name) | Turns off the self weight for a specified service case | NoSelfWeight("D") | Turns off the self weight for service case D | |
| RectangularLoad(X, Y, widthX, widthY, UniformPressure, MX, MY) | Applies a widthX by widthY rectangular load centered at {X, Y} with a specified uniform pressure with MX and MY overturning loads in the current service case | RectangularLoad(0, 0, 2, 4, -50, 10, 20) | Applies a 2 by 4 rectangular load centered at {0, 0} with a specified uniform pressure of -50 with 10 and 20 overturning loads in the current service case | |
| RectangularLoad(ServiceCase, X, Y, widthX, widthY, UniformPressure, MX, MY) | Applies a widthX by widthY rectangular load centered at {X, Y} with a specified uniform pressure with MX and MY overturning loads in the defined service case | RectangularLoad("D", 0, 0, 2, 4, -50, 10, 20) | Applies a 2 by 4 rectangular load centered at {0, 0} with a specified uniform pressure of -50 with 10 and 20 overturning loads in the "D" service case | |
| RectangularLoad(X, Y, widthX, widthY, startPressure, endPressure, MX, MY, linearX) | Applies a widthX by widthY rectangular load centered at {X, Y} with a specified linear pressure with MX and MY overturning loads in the current service case | RectangularLoad(0, 0, 2, 4, -50, -100, 10, 20, true) | Applies a 2 by 4 rectangular load centered at {0, 0} with a linear pressure varying from -50 to -100 in the X-direction with 10 and 20 overturning loads in the current service case | |
| RectangularLoad(serviceCase, X, Y, widthX, widthY, startPressure, endPressure, MX, MY, linearX) | Applies a widthX by widthY rectangular load centered at {X, Y} with a specified linear pressure with MX and MY overturning loads in the defined service case | RectangularLoad("D", 0, 0, 2, 4, -50, -100, 10, 20, true) | Applies a 2 by 4 rectangular load centered at {0, 0} with a linear pressure varying from -50 to -100 in the X-direction with 10 and 20 overturning loads in the "D" service case | |
| CircularLoad(X, Y, radius, uniformPressure, MX, MY) | Applies a circular load with a specified radius centered at {X, Y} with a specified uniform pressure with MX and MY overturning loads in the current service case | CircularLoad(0, 0, 4, -50, 10, 20) | Applies a circular load with a 4 radius centered at {0, 0} with a -50 uniform pressure with 10 and 20 overturning loads in the current service case | |
| CircularLoad(serviceCase, X, Y, radius, uniformPressure, MX, MY) | Applies a circular load with a specified radius centered at {X, Y} with a specified uniform pressure with MX and MY overturning loads in the defined service case | CircularLoad("D", 0, 0, 4, -50, 10, 20) | Applies a circular load with a 4 radius centered at {0, 0} with a -50 uniform pressure with 10 and 20 overturning loads in the "D" service case | |
| CircularLoad(X, Y, radius, startPressure, endPressure, MX, MY, linearX) | Applies a circular load with a specified radius centered at {X, Y} with a specified linear pressure with MX and MY overturning loads in the current service case | CircularLoad(0, 0, 4, -50, -100, 10, 20, true) | Applies a circular load with a 4 radius centered at {0, 0} with a -50 to -100 linear pressure in the X-direction with 10 and 20 overturning loads in the current service case | |
| CircularLoad(serviceCase, X, Y, radius, startPressure, endPressure, MX, MY, linearX) | Applies a circular load with a specified radius centered at {X, Y} with a specified linear pressure with MX and MY overturning loads in the defined service case | CircularLoad("D", 0, 0, 4, -50, -100, 10, 20, true) | Applies a circular load with a 4 radius centered at {0, 0} with a -50 to -100 linear pressure in the X-direction with 10 and 20 overturning loads in the "D" service case | |
| TubeLoad(X, Y, widthX, widthY, thickness, uniformPressure, MX, MY) | Applies a widthX by widthY tube load centered at {X, Y} with a specified uniform pressure with MX and MY overturning loads in the current service case | TubeLoad(0, 0, 2, 4, 0.5, -50, 10, 20) | Applies a 2 by 4 tube load centered at {0, 0} with a -50 uniform pressure with 10 and 20 overturning loads in the current service case | |
| TubeLoad(serviceCase, X, Y, widthX, widthY, thickness, uniformPressure, MX, MY) | Applies a widthX by widthY tube load centered at {X, Y} with a specified uniform pressure with MX and MY overturning loads in the defined service case | TubeLoad("D", 0, 0, 2, 4, 0.5, -50, 10, 20) | Applies a 2 by 4 tube load centered at {0, 0} with a -50 uniform pressure in the X-direction with 10 and 20 overturning loads in the "D" service case | |
| TubeLoad(X, Y, widthX, widthY, thickness, startPressure, endPressure, MX, MY, linearX) | Applies a widthX by widthY tube load centered at {X, Y} with a specified linear pressure with MX and MY overturning loads in the current service case | TubeLoad(0, 0, 2, 4, 0.5, -50, -100, 10, 20, true) | Applies a 2 by 4 tube load centered at {0, 0} with a -50 to -100 linear pressure in the X-direction with 10 and 20 overturning loads in the current service case | |
| TubeLoad(serviceCase, X, Y, distanceX, distanceY, thickness, startPressure, endPressure, MX, MY, linearX) | Applies a widthX by widthY tube load centered at {X, Y} with a specified linear pressure with MX and MY overturning loads in the defined service case | TubeLoad("D", 0, 0, 2, 4, 0.5, -50, -100, 10, 20, true) | Applies a 2 by 4 tube load centered at {0, 0} with a -50 to -100 linear pressure in the X-direction with 10 and 20 overturning loads in the "D" service case | |
| RingLoad(X, Y, radius, thickness, uniformPressure, MX, MY) | Applies a ring load with a specified radius and thickness centered at {X, Y} with a specified uniform pressure with MX and MY overturning loads in the current service case | RingLoad(0, 0, 4, 1, -50, 10, 20) | Applies a ring load with a 4 radius and 1 thickness centered at {0, 0} with a -50 uniform pressure with 10 and 20 overturning loads in the current service case | |
| RingLoad(serviceCase, X, Y, radius, thickness, uniformPressure, MX, MY) | Applies a ring load with a specified radius and thickness centered at {X, Y} with a specified uniform pressure with MX and MY overturning loads in the defined service case | RingLoad("D", 0, 0, 4, 1, -50, 10, 20) | Applies a ring load with a 4 radius and 1 thickness centered at {0, 0} with a -50 uniform pressure with 10 and 20 overturning loads in the "D" service case | |
| RingLoad(X, Y, radius, thickness, startPressure, endPressure, MX, MY, linearX) | Applies a ring load with a specified radius and thickness centered at {X, Y} with a specified linear pressure with MX and MY overturning loads in the current service case | RingLoad(0, 0, 4, 1, -50, -100, 10, 20, true) | Applies a ring load with a 4 radius and 1 thickness centered at {0, 0} with a -50 to -100 linear pressure in the X-direction with 10 and 20 overturning loads in the current service case | |
| RingLoad(serviceCase, X, Y, radius, thickness, startPressure, endPressure, MX, MY, linearX) | Applies a ring load with a specified radius and thickness centered at {X, Y} with a specified linear pressure with MX and MY overturning loads in the defined service case | RingLoad("D", 0, 0, 4, 1, -50, -100, 10, 20, true) | Applies a ring load with a 4 radius and 1 thickness centered at {0, 0} with a -50 to -100 linear pressure in the X-direction with 10 and 20 overturning loads in the "D" service case | |
| LoadSlab(uniformPressure, MX, MY) | Applies a uniform pressure with MX and MY overturning loads to the selected slab in the current service case | LoadSlab(-50, 10, 20) | Applies a -50 uniform pressure with 10 and 20 overturning loads to the selected slab in the current service case | |
| LoadSlab(slab, uniformPressure, MX, MY) | Applies a uniform pressure with MX and MY overturning loads to the specified slab in the current service case | LoadSlab("F1", -50, 10, 20) | Applies a -50 uniform pressure with 10 and 20 overturning loads to slab F1 in the current service case | |
| LoadSlab(serviceCase, slab, uniformPressure, MX, MY) | Applies a uniform pressure with MX and MY overturning loads to the specified slab in the defined service case | LoadSlab("D", "F1", -50, 10, 20) | Applies a -50 uniform pressure with 10 and 20 overturning loads to slab F1 in the "D" service case | |
| LoadFullBoundary(uniformPressure, MX, MY) | Applies a uniform pressure with MX and MY overturning loads to the full boundary in the current service case | LoadFullBoundary(-50, 10, 20) | Applies a -50 uniform pressure with 10 and 20 overturning loads to the full boundary in the current service case | |
| LoadFullBoundary(serviceCase, uniformPressure, MX, MY) | Applies a uniform pressure with MX and MY overturning loads to the full boundary in the defined service case | LoadFullBoundary("D", -50, 10, 20) | Applies a -50 uniform pressure with 10 and 20 overturning loads to the full boundary in the "D" service case | |
| LoadFullBoundary(startPressure, endPressure, MX, MY, linearX) | Applies a linear pressure with MX and MY overturning loads to the full boundary in the current service case | LoadFullBoundary(-50, -100, 10, 20, true) | Applies a -50 to -100 linear pressure in the X-direction with 10 and 20 overturning loads to the full boundary in the current service case | |
| LoadFullBoundary(serviceCase, startPressure, endPressure, MX, MY, linearX) | Applies a linear pressure with MX and MY overturning loads to the full boundary in the defined service case | LoadFullBoundary("D", -50, -100, 10, 20, true) | Applies a -50 to -100 linear pressure in the X-direction with 10 and 20 overturning loads to the full boundary in the "D" service case | |
| LoadPier(FX, FY, FZ, MX, MY) | Applies specified forces and moments to the selected pier in the current service case | LoadPier(5, 10, 15, 100, 200) | Applies forces and moments to the selected pier in the current service case | |
| LoadPier(pier, FX, FY, FZ, MX, MY) | Applies specified forces and moments to the defined pier in the current service case | LoadPier("C1", 5, 10, 15, 100, 200) | Applies forces and moments to pier "C1" in the current service case | |
| LoadPier(serviceCase, pier, FX, FY, FZ, MX, MY) | Applies specified forces and moments to the defined pier in the specified service case | LoadPier("D", "C1", 5, 10, 15, 100, 200) | Applies forces and moments to pier "C1" in the D service case | |
| LoadLine(FX, FY, FZ, MX, MY, distributed = false, local = false) | Applies specified forces and moments to the selected grade beam or wall in the current service case as a resultant or distributed load in the global or local direction | LoadLine(5, 10, 15, 100, 200) | Applies forces and moments to the selected grade beam or wall in the current service case. The loads are applied as resultants in the global direction since "distributed" and "local" are false by default. | |
| LoadLine(item, FX, FY, FZ, MX, MY, distributed = false, local = false) | Applies specified forces and moments to the defined grade beam or wall in the current service case as a resultant or distributed load in the global or local direction | LoadLine("GB1", 5, 10, 15, 100, 200, true, true) | Applies forces and moments to grade beam GB1 in the current service case. The loads are applied as distributed loads in the local direction. | |
| LoadLine(serviceCase, item, FX, FY, FZ, MX, MY, distributed = false, local = false) | Applies specified forces and moments to the defined grade beam or wall in the defined service case as a resultant or distributed load in the global or local direction | LoadLine("D", "W1", 5, 10, 15, 100, 200, true, false) | Applies forces and moments in the D service case to the grade beam GB1 in the current service case. The loads are applied as distributed loads in the global direction. | |
| ClearLoads() | Deletes all of the loads in the active service case | |||
| ClearLoads(case) | Deletes all of the loads in the specified service case | ClearLoads("L") | Deletes all of the loads in the L service case | |
| DeleteLoad(object) | Deletes the loads on a specified object in the active service case | DeleteLoad("W1") | Deletes the wall loads on wall W1 in the active service case | |
| DeleteLoad(case, object) | Deletes the loads on a specified object in the specified service case | DeleteLoad("L", "W1") | Deletes the wall loads on wall W1 in the L service case | |
| AddCustomCombo(name, comboType, (factor, case)[]) | Adds a custom load combination to the project | AddCustomCombo("D + 0.75L", "Allowable (ASD)", (1.0, "D"), (0.75, "L")) | Adds custom D + 0.75L Allowable (ASD) load combination | |
| SetMeshCoarse() | Sets the Mesh Refinement to Coarse | |||
| SetMeshMedium() | Sets the Mesh Refinement to Medium | |||
| SetMeshFine() | Sets the Mesh Refinement to Fine | |||
| SetMeshCustom(elementCount) | Sets the Mesh Refinement to User Defined and sets the Element Count to a specified value | SetMeshCustom(6000) | Sets the Mesh Refinement to User Defined and sets the Element Count to 6000 | |
| SetEFactor(factor) | Sets the Concrete Elastic Modulus Factor in the project | SetEFactor(2) | Sets the Concrete Elastic Modulus Factor to 2 in the project | |
| ThicknessOverlap(setting) | Changes the Thickness Overlap setting to the specified value | ThicknessOverlap("Smallest") | Changes the Thickness Overlap setting to Smallest Thickness | |
| SoilOverlap(setting) | Changes the Soil Modulus Overlap setting to the specified value | SoilOverlap("Largest") | Changes the Soil Modulus Overlap setting to Largest Thickness | |
| SetMaterial() | Opens the Material Database dialog box to select the concrete material that is used for the slabs and beams in the project | |||
| SetMaterial(concrete) | Sets the concrete material that is used for the slabs and beams in the project | SetMaterial("Concrete (F'c = 3.5 ksi)") | Sets the concrete material that is used for the slabs and beams in the project to Concrete (F'c = 3.5 ksi) | |
| CheckStabilityService() | Performs the stability checks at the service level | |||
| CheckStabilityStrength() | Performs the stability checks at the strength level | |||
| OverturningFS(FS) | Sets the overturning stability factor of safety to the specified value | OverturningFS(2.5) | Sets the overturning stability factor of safety to 2.5 | |
| UpliftFS(FS) | Sets the uplift stability factor of safety to the specified value | UpliftFS(2.0) | Sets the uplift stability factor of safety to 2.0 | |
| SlidingFS(FS) | Sets the sliding stability factor of safety to the specified value | SlidingFS(2.0) | Sets the sliding stability factor of safety to 2.0 | |
| ReduceSeismicOVT(reduce) | Sets the Reduce Seismic Overturning parameter to yes or no which reduces the seismic overturning by 25% per ASCE 7 | ReduceSeismicOVT(true) | Sets the Reduce Seismic Overturning parameter to yes | |
| SlidingResistanceX(resistance) | Sets the additional sliding resistance force for sliding stability checks in the X-direction to a specified value | SlidingResistanceX(10) | Sets the additional sliding resistance force for sliding stability checks in the X-direction to 10 | |
| SlidingResistanceY(resistance) | Sets the additional sliding resistance force for sliding stability checks in the Y-direction to a specified value | SlidingResistanceY(20) | Sets the additional sliding resistance force for sliding stability checks in the Y-direction to 20 | |
| CheckBearingService() | Performs the bearing checks at the service level | |||
| CheckBearingStrength() | Performs the bearing checks at the strength level | |||
| SetBearingPressure(pressure) | Sets the bearing pressure to a specified value | SetBearingPressure(2000) | Sets the bearing pressure to 2000 | |
| SetBearingIncrease(factor) | Sets the W & E Bearing Increase factor to a specified value | SetBearingIncrease(1.0) | Sets the W & E Bearing Increase factor to 1.0 | |
| SetFriction(coefficient) | Sets the coefficient of sliding friction between the bottom of the footing and the soil to a specified value | SetFriction(0.45) | Sets the coefficient of sliding friction between the bottom of the footing and the soil to 0.45 | |
| SetPassivePressure(pressure) | Sets the average passive pressure across the thickness of the footing to a specified value | SetPassivePressure(50) | Sets the average passive pressure across the thickness of the footing to 50 | |
| Status(itemTitle) |
Returns the Project Status of the specified item. -1 = Failing 0 = Not found or not available 1 = Has a warning 2 = Ok |
Status("Pier Capacity") | Returns the Project Status of the Pier Capacity | |
| Meshing() | Pauses the script until the meshing completes. Note: Only used for external scripts and must be preceded by "await" | await Meshing(); | Pauses the external script until the meshing completes | |
| Stability() | Pauses the script until the stability checks complete. Note: Only used for external scripts and must be preceded by "await" | await Stability(); | Pauses the external script until the stability checks complete | |
| Analysis() | Pauses the script until the analysis completes. Note: Only used for external scripts and must be preceded by "await" | await Analysis(); | Pauses the external script until the analysis completes | |
| Design() | Pauses the script until the design completes. Note: Only used for external scripts and must be preceded by "await" | await Design(); | Pauses the external script until the design completes | |
| Results() | Returns a list of all the result cases in the project | Print(Results()) | Prints the list of all the result cases in the project in a comma-delimited format | |
| ServiceResults() | Returns a list of all the service result cases in the project | Print(ServiceResults()) | Prints the list of all the service result cases in the project in a comma-delimited format | |
| StrengthResults() | Returns a list of all the strength result cases in the project | Print(StrengthResults()) | Prints the list of all the strength result cases in the project in a comma-delimited format | |
| SetVisibleRC(resultCase) | Sets the visible result case in the analysis results | SetVisibleRC("2. D+L") | Sets the visible result case in the analysis results to 2. D+L | |
| Displacement(max) | Returns the maximum or minimum displacement in the global Z-direction across all result cases | Displacement(false) | Returns the minimum displacement in the global Z-direction across all result cases | |
| Displacement(result, max) | Returns the maximum or minimum displacement in the global Z-direction for the defined result case | Displacement("1. D", true) | Returns the maximum displacement in the in the global Z-direction for the "1. D" result case | |
| Displacement(result, X, Y) | Returns the displacement in the global Z-direction at a specified location for the defined result case | Displacement("2. D+L", 6, 12) | Returns the displacement in the global Z-direction at {6, 12} for the "2. D+L" result case | |
| ShearX(max) | Returns the maximum or minimum shear force that acts on the global X-face of the plate elements (VX) across all result cases | ShearX(false) | Returns the minimum shear force that acts on the global X-face of the plate elements (VX) across all result cases | |
| ShearX(result, max) | Returns the maximum or minimum shear force that acts on the global X-face of the plate elements (VX) for the defined result case | ShearX("1. D", true) | Returns the maximum shear force that acts on the global X-face of the plate elements (VX) for the defined result case | |
| ShearX(result, X, Y) | Returns the shear force that acts on the global X-face of the plate elements (VX) at a specified location for the defined result case | ShearX("2. D+L", 6, 12) | Returns the shear force that acts on the global X-face of the plate elements (VX) at {6, 12} for the "2. D+L" result case | |
| ShearY(max) | Returns the maximum or minimum shear force that acts on the global Y-face of the plate elements (VY) across all result cases | ShearY(true) | Returns the maximum shear force that acts on the global Y-face of the plate elements (VY) across all result cases | |
| ShearY(result, max) | Returns the maximum or minimum shear force that acts on the global Y-face of the plate elements (VY) for the defined result case | ShearY("1. D", false) | Returns the minimum shear force that acts on the global Y-face of the plate elements (VY) for the "1. D" result case | |
| ShearY(result, X, Y) | Returns the shear force that acts on the global Y-face of the plate elements (VY) at a specified location for the defined result case | ShearY("2. D+L", 6, 12) | Returns the shear force that acts on the global Y-face of the plate elements (VY) at {6, 12} for the "2. D+L" result case | |
| MomentX(max) | Returns the maximum or minimum bending moment that acts on the global X-face of the plate elements (MX) across all result cases | MomentX(true) | Returns the maximum bending moment that acts on the global X-face of the plate elements (MX) across all result cases | |
| MomentX(result, max) | Returns the maximum or minimum bending moment that acts on the global X-face of the plate elements (MX) for the defined result case | MomentX("1. D", false) | Returns the minimum bending moment that acts on the global X-face of the plate elements (MX) for the "1. D" result case | |
| MomentX(result, X, Y) | Returns the bending moment that acts on the global X-face of the plate elements (MX) at a specified location for the defined result case | MomentX("2. D+L", 6, 12) | Returns the bending moment that acts on the global X-face of the plate elements (MX) at {6, 12} for the "2. D+L" result case | |
| MomentY(max) | Returns the maximum or minimum bending moment that acts on the global Y-face of the plate elements (MY) across all result cases | MomentY(false) | Returns the minimum bending moment that acts on the global Y-face of the plate elements (MY) across all result cases | |
| MomentY(result, max) | Returns the maximum or minimum bending moment that acts on the global Y-face of the plate elements (MY) for the defined result case | MomentY("1. D", true) | Returns the maximum bending moment that acts on the global Y-face of the plate elements (MY) for the "1. D" result case | |
| MomentY(result, X, Y) | Returns the bending moment that acts on the global Y-face of the plate elements (MY) at a specified location for the defined result case | MomentY("2. D+L", 6, 12) | Returns the bending moment that acts on the global Y-face of the plate elements (MY) at a {6, 12} for the "2. D+L" result case | |
| MomentXY(max) | Returns the maximum or minimum twisting moment (MXY) across all result cases | MomentXY(true) | Returns the maximum twisting moment (MXY) across all result cases | |
| MomentXY(result, max) | Returns the maximum or minimum twisting moment (MXY) for the defined result case | MomentXY("1. D", false) | Returns the minimum twisting moment (MXY) for the ""1. D"" result case | |
| MomentXY(result, X, Y) | Returns the twisting moment (MXY) at a specified location for the defined result case | MomentXY("2. D+L", 6, 12) | Returns the twisting moment (MXY) at a {6, 12} for the "2. D+L" result case | |
| Bearing(max) | Returns the maximum or minimum bearing pressure across all result cases | Bearing(false) | Returns the minimum bearing pressure across all result cases | |
| Bearing(result, max) | Returns the maximum or minimum bearing pressure for the defined result case | Bearing("1. D", true) | Returns the maximum bearing pressure for the "1. D" result case | |
| Bearing(result, X, Y) | Returns the bearing pressure at a specified location for the defined result case | Bearing("2. D+L", 6, 12) | Returns the bearing pressure at a {6, 12} for the "2. D+L" result case | |
| SlabDisplacement(slab, max) | Returns the maximum or minimum displacement in the global Z-direction across all result cases for the specified slab | SlabDisplacement("S1", false) | Returns the minimum displacement in the global Z-direction across all result cases for slab S1 | |
| SlabDisplacement(slab, result, max) | Returns the maximum or minimum displacement in the global Z-direction for the defined result case for the specified slab | SlabDisplacement("S1", "1. D", true) | Returns the maximum displacement in the in the global Z-direction for the "1. D" result case for slab S1 | |
| SlabShearX(slab, max) | Returns the maximum or minimum shear force that acts on the global X-face of the plate elements (VX) across all result cases for the specified slab | SlabShearX("S1", false) | Returns the minimum shear force that acts on the global X-face of the plate elements (VX) across all result cases for slab S1 | |
| SlabShearX(slab, result, max) | Returns the maximum or minimum shear force that acts on the global X-face of the plate elements (VX) for the defined result case for the specified slab | SlabShearX("S1", "1. D", true) | Returns the maximum shear force that acts on the global X-face of the plate elements (VX) for the defined result case for slab S1 | |
| SlabShearY(slab, max) | Returns the maximum or minimum shear force that acts on the global Y-face of the plate elements (VY) across all result cases for the specified slab | SlabShearY("S1", true) | Returns the maximum shear force that acts on the global Y-face of the plate elements (VY) across all result cases for slab S1 | |
| SlabShearY(slab, result, max) | Returns the maximum or minimum shear force that acts on the global Y-face of the plate elements (VY) for the defined result case for the specified slab | SlabShearY("S1", "1. D", false) | Returns the minimum shear force that acts on the global Y-face of the plate elements (VY) for the "1. D" result case for slab S1 | |
| SlabMomentX(slab, max) | Returns the maximum or minimum bending moment that acts on the global X-face of the plate elements (MX) across all result cases for the specified slab | SlabMomentX("S1", true) | Returns the maximum bending moment that acts on the global X-face of the plate elements (MX) across all result cases for slab S1 | |
| SlabMomentX(slab, result, max) | Returns the maximum or minimum bending moment that acts on the global X-face of the plate elements (MX) for the defined result case for the specified slab | SlabMomentX("S1", "1. D", false) | Returns the minimum bending moment that acts on the global X-face of the plate elements (MX) for the "1. D" result case for slab S1 | |
| SlabMomentY(slab, max) | Returns the maximum or minimum bending moment that acts on the global Y-face of the plate elements (MY) across all result cases for the specified slab | SlabMomentY("S1", false) | Returns the minimum bending moment that acts on the global Y-face of the plate elements (MY) across all result cases | |
| SlabMomentY(slab, result, max) | Returns the maximum or minimum bending moment that acts on the global Y-face of the plate elements (MY) for the defined result case for the specified slab | SlabMomentY("S1", "1. D", true) | Returns the maximum bending moment that acts on the global Y-face of the plate elements (MY) for the "1. D" result case for slab S1 | |
| SlabMomentXY(slab, max) | Returns the maximum or minimum twisting moment (MXY) across all result cases for the specified slab | SlabMomentXY("S1", true) | Returns the maximum twisting moment (MXY) across all result cases for slab S1 | |
| SlabMomentXY(slab, result, max) | Returns the maximum or minimum twisting moment (MXY) for the defined result case for the specified slab | SlabMomentXY("S1", "1. D", false) | Returns the minimum twisting moment (MXY) for the ""1. D"" result case for slab S1 | |
| SlabBearing(slab, max) | Returns the maximum or minimum bearing pressure across all result cases for the specified slab | SlabBearing("S1", false) | Returns the minimum bearing pressure across all result cases for slab S1 | |
| SlabBearing(slab, result, max) | Returns the maximum or minimum bearing pressure for the defined result case for the specified slab | SlabBearing("S1", "1. D", true) | Returns the maximum bearing pressure for the "1. D" result case for slab S1 | |
| PileResult(pile, max) | Returns the maximum or minimum force in the specified pile across all result cases | PileResult("P1", false) | Returns the minimum force in pile P1 across all result cases | |
| PileResult(result, pile) | Returns the force in the specified pile for the defined result case | PileResult("1. D", "P1") | Returns the force in pile P1 for the "1. D" result case | |
| AddTable(title) | Adds a specified table to the report | AddTable("Sliding Stability") | Adds the Sliding Stability table to the report | |
| SetTableWidth(title, fraction) | Sets the designated table's page width to the specified fraction | SetTableWidth("Vertices", 0.5) | Sets the Vertices table's page width to half | |
| AddGraphicToReport(title) | Adds the current graphic window with a specified title to the report | AddGraphicToReport("Foundation Design") | Adds the current graphic window with a title of "Foundation Design" to the report | |
| ExportReport(path) | Exports the report to a specified path | ExportReport("C:/Users/your.login/Desktop/Report.pdf") | Saves the report as a .pdf on the desktop for the specified user |