API
The AdSec API documentation can be found on the API Documentation site and covers the following topics:
- Classes
- Functions
- Units of Measure
A summary of the capabilities of the API are detailed below.
AdSec API Coverage
The following table outlines all the features, functionality, outputs, and differences between the AdSec main application ("App") and the AdSec API ("API"):
| Category | Sub-Category | Feature | Description | App | API | Notes |
|---|---|---|---|---|---|---|
| Project | File | Read .ads file | ✔️ | ✔️ | Reads .ads file into a list of ISection instances | |
| Write/Save .ads file | ✔️ | ❌ | AdSec API can write a single section to a .ads file. Tasks are not written to file since the API does not use "AdSec Tasks". | |||
| Setup | Project Info | Job Number, titles, notes, etc. | ✔️ | N/A | AdSec API does not have a concept of an "AdSec project" | |
| Unit Settings | Force, Length, dimensions, stress, strain, etc. | ✔️ | N/A | AdSec API allows different units to be used when objects are created, using the OasysUnits namespace. | ||
| Design Codes | AASHTO | LRFD (2017) - US | ✔️ | ❌ | ||
| LRFD (2017) - SI | ✔️ | ✔️ | ||||
| ACI | ACI318 (2002, 2005, 2008, 2011, 2014, 2019) Units: Inch-Pound (US), and SI (Metric) | ✔️ | ✔️ | AdSec API does not support ACI-318 2019 Edition. | ||
| Standards Australia | AS3600 (2001, 2009, 2018) | ✔️ | ✔️ | |||
| AS5100 (2017) | ✔️ | ✔️ | ||||
| British Standards | BS8110 (1985, 1997, 2005) | ✔️ | ✔️ | |||
| BS5400 | ✔️ | ✔️ | AdSec API has 1990, 2006. AdSec Desktop has BS5400 unlabelled, assume it's 1990. | |||
| BS5400 (IAN70_06) | ✔️ | ✔️ | ||||
| Canadian Standards Association | CSA A23 Part 3 (2004, 2014) | ✔️ | ✔️ | |||
| CSA S6 (2014) | ✔️ | ✔️ | ||||
| Eurocode 2 (Part 1) | EN1992 (National Annex: None, Cyprus, Denmark, Finland, France, Germany, Ireland, Italy, Netherlands, Norway, Poland, Singapore, Spain, UK, PD6687-1 (2010)) | ✔️ | ✔️ | 2004 | ||
| Eurocode 2 (Part 2) | EN1992 (National Annex: None, Denmark, France, Germany, Ireland, Italy, Netherlands, Singapore, Spain, UK) | ✔️ | ✔️ | 2005 | ||
| Hong Kong Code of Practice | Hong Kong Code of Practice (1987, 2004, 2007, 2013) | ✔️ | ✔️ | |||
| Hong Kong Structures Design (2002, 2013) | ✔️ | ✔️ | ||||
| Indian Standards | IRS Bridge (1997) | ✔️ | ✔️ | |||
| IS456 (2000) | ✔️ | ✔️ | ||||
| IRC112 2011 | ✔️ | ✔️ | ||||
| IRC112 2020 | ✔️ | ❌ | ||||
| Materials | Standard Materials | Concrete / Normal weight | ✔️ | ✔️ | ||
| Reinforcement - Rebar | ✔️ | ✔️ | ||||
| Reinforcement - Tendons | ✔️ | ✔️ | ||||
| Steel | ✔️ | ✔️ | ||||
| FRP | ✔️ | ✔️ | ||||
| Material Models (Curves) | Tension Compression | ✔️ | ||||
| Bilinear | ✔️ | ✔️ | ||||
| Explicit | ✔️ | ✔️ | ||||
| FibModelCode | ✔️ | |||||
| Linear | ✔️ | ✔️ | ||||
| Mander Confined | ✔️ | ✔️ | ||||
| Mander | ✔️ | ✔️ | ||||
| Parabola Rectangle | ✔️ | ✔️ | ||||
| Park | ✔️ | |||||
| Popovics | ✔️ | ✔️ | ||||
| Rectangular | ✔️ | ✔️ | ||||
| Interpolated | ✔️ | ❌ | ||||
| No-tension | ✔️ | ❌ | ||||
| AISC 360 filled tube | ✔️ | ❌ | Compression | |||
| Explicit envelope | ✔️ | ❌ | ||||
| Elastic plastic | ✔️ | ❌ | ||||
| Strain-hardening | ✔️ | ❌ | ||||
| User-Defined Materials | Concrete | ✔️ | ✔️ | |||
| Reinforcement - Rebar (Steel) | ✔️ | ✔️ | ||||
| Reinforcement - Tendons | ✔️ | ✔️ | ||||
| Steel | ✔️ | ✔️ | ||||
| FRP | ✔️ | ✔️ | ||||
| Material Params (all) | General / Name | ✔️ | N/A | |||
| General / Strength | ✔️ | ✔️ | ||||
| General / Elastic modulus | ✔️ | ✔️ | ||||
| General / Density | ✔️ | ❌ | ||||
| General / Coefficient of thermal expansion | ✔️ | ❌ | ||||
| General / Poisson's ratio | ✔️ | ❌ | ||||
| Material Params (FRP) | General / Bond strain limit | ✔️ | ❌ | In addition to "all" | ||
| General / Environmental factor | ✔️ | ❌ | ||||
| Material Params (Concr/Rebar) | ULS or SLS / Strength reduction factor | ✔️ | ❌ | |||
| ULS or SLS / Stiffness reduction factor | ✔️ | ❌ | ||||
| Creep coefficient | ✔️ | N/A | Illustrative for chart only. | |||
| Material Params (Tendon) | Label | ✔️ | ❌ | In addition to "Concr/Rebar" | ||
| ULS or SLS - only Tension model (no compr.) | ✔️ | ✔️ | ||||
| Material Params (Steel) | Compression and Tension - single material model | ✔️ | ✔️ | |||
| Chart | ULS / SLS / SLS long term | Can adjust creep coefficient to change SLS long-term plot | ||||
| Sections | Create section | Section Name | ✔️ | ❌ | ||
| Components | Material type | |||||
| Material grade | ||||||
| Profile / Standard | Rectangle | ✔️ | ✔️ | |||
| Profile type / Standard / Solid, Hollow, tapered | ✔️ | ✔️ | ||||
| Profile type / Standard / Tapered | ✔️ | ✔️ | ||||
| Circle | ✔️ | ✔️ | ||||
| Hollow, Elliptical | ✔️ | ✔️ | ||||
| Ellipse index, n | ✔️ | ✔️ | Different top/bottom width | |||
| I-Section | ✔️ | ✔️ | ||||
| General, tapered, cellular | ✔️ | ✔️ | ||||
| Tee | ✔️ | ✔️ | ||||
| Channel | ✔️ | ✔️ | ||||
| Angle | ✔️ | ✔️ | ||||
| Cruciform | ✔️ | ✔️ | ||||
| Generic Z | ✔️ | ✔️ | ||||
| Generic C | ✔️ | ✔️ | ||||
| Rectocircular | ✔️ | |||||
| Rectoellipse | ✔️ | ✔️ | ||||
| Secant Pile | ✔️ | ✔️ | ||||
| Sheet Pile | ✔️ | ✔️ | ||||
| Profile / Geometric | Perimeter | ✔️ | ✔️ | |||
| Profile / Catalogue | British | ✔️ | ✔️ | AdSec API uses a profile string (text) to create a catalogue profile. e.g. STD R 300 300 The string may be obtained from the section in AdSec Desktop. There are no helper classes or interfaces to create them. | ||
| Europrofile | ✔️ | ✔️ | ||||
| AISC | ✔️ | ✔️ | ||||
| Australian | ✔️ | ✔️ | ||||
| Chinese | ✔️ | ✔️ | ||||
| Indian | ✔️ | ✔️ | ||||
| Corus Advance (TATA) | ✔️ | ✔️ | ||||
| Russian | ✔️ | ✔️ | ||||
| Korean | ✔️ | ✔️ | ||||
| Japanese | ✔️ | ✔️ | ||||
| EN 10210 | ✔️ | ✔️ | ||||
| EN 10219 | ✔️ | ✔️ | ||||
| South African | ✔️ | ✔️ | ||||
| ASTM A501 | ✔️ | ✔️ | ||||
| CISC | ✔️ | ✔️ | ||||
| British Steel | ✔️ | ✔️ | ||||
| ArcelorMittal | ✔️ | ✔️ | ||||
| Profile options | Reflection: about local y or z | ✔️ | ✔️ | AdSec API: Part of profile string text. | ||
| Rotation: by degrees | ✔️ | ✔️ | AdSec API: Part of profile string text. | |||
| Offset: local y or z | ✔️ | ✔️ | AdSec API: Part of profile string text. | |||
| Reinforcement | Reinforcement - Cover | Uniform | ✔️ | ✔️ | ||
| Variable | ✔️ | ❌ | ||||
| Reinforcement - Group | Link, top, bottom, sides, left side, right side | ✔️ | ✔️ | |||
| Reinforcement - Individual bars | ✔️ | ✔️ | ||||
| Reinforcement - Pre-Load | Preload (none, stress, force, strain) | ✔️ | ✔️ | |||
| Section diagram | ✔️ | ✔️ | API: Export section diagram to SVG | |||
| Analysis | Tasks - Table | Cases: Load/Deformation | ✔️ | ✔️ | AdSec API does not have tasks. Analysis is done with reference to a section. | |
| Inputs | Load | ✔️ | ✔️ | |||
| Deformation | ✔️ | ✔️ | ||||
| Outputs / ULS | Status | ✔️ | ❌ | AdSec API: Can just check if utilisation > 100% | ||
| Utilisation / Load | ✔️ | ✔️ | ||||
| Utilisation / Deformation | ✔️ | ✔️ | ||||
| M/Mu | ✔️ | ❌ | AdSec API: Can be calculated from MomentRanges | |||
| Load / Fx | ✔️ | ✔️ | ||||
| Load / Myy | ✔️ | ✔️ | ||||
| Load / Mzz | ✔️ | ✔️ | ||||
| Outputs / SLS | Cracked | ✔️ | ❌ | |||
| Crack width (mm) | ✔️ | ✔️ | ||||
| Stiffness / EA | ✔️ | ✔️ | AdSec API: SecantStiffness.X | |||
| Stiffness / EIyy | ✔️ | ✔️ | AdSec API: SecantStiffness.YY | |||
| Stiffness / EIzz | ✔️ | ✔️ | AdSec API: SecantStiffness.ZZ | |||
| Advanced options - Load | Load term: short, long, intermediate | ✔️ | ❌ | |||
| Enable/disable components | ✔️ | ❌ | ||||
| Code specific options - IRC112 | Crack equation, Cnom, Cover factor, Mq/Mg ratio | ✔️ | ❌ | |||
| Advanced options - Deformation | ✔️ | ❌ | ||||
| Add more tasks | ✔️ | N/A | ||||
| Tasks - Case Details (Outputs) | Display options (outputs) | Analysis options / load term | ✔️ | ❌ | ||
| Analysis options / Components details | ✔️ | ❌ | ||||
| Analysis options / Code specific options | ✔️ | ❌ | ||||
| ULS / Section diagram | ✔️ | ✔️ | AdSec API: Can save section diagram to SVG image file. | |||
| ULS / Section diagram / Show Section Diagram | ✔️ | ✔️ | ||||
| ULS / Section diagram / Show Bar Numbers | ✔️ | ❌ | ||||
| ULS / Applied load | ✔️ | ✔️ | AdSec API: No report output but data accessible. | |||
| ULS / Applied deformation | ✔️ | ✔️ | ||||
| ULS / Load at failure | ✔️ | ✔️ | ||||
| ULS / Deformation under applied loads | ✔️ | ✔️ | ||||
| Strain | ✔️ | ✔️ | ||||
| Curvature | ✔️ | ✔️ | ||||
| Neutral Axis | ✔️ | ❌ | ||||
| ULS / Section Load under applied deformation | ✔️ | ✔️ | ||||
| ULS / Deformation at failure | ✔️ | ✔️ | AdSec API: Neutral axis position not accessible. | |||
| ULS / Stress/strain at key points | ✔️ | N/A | ||||
| ULS / Stress/strain at key points / section profile stress/strain | ✔️ | N/A | ||||
| ULS / Stress/strain at key points / reinforcement stress/strain | ✔️ | N/A | ||||
| SLS / Section diagram | ✔️ | ✔️ | AdSec API: Can save section diagram to SVG image file. | |||
| - Uncracked | ✔️ | ❌ | Design code specific | |||
| - Cracked | ✔️ | ❌ | Design code specific | |||
| - Interpolated | ✔️ | ❌ | Design code specific | |||
| SLS / Section diagram / Show Section Diagram | ✔️ | ❌ | ||||
| SLS / Section diagram / Show Bar Numbers | ✔️ | ❌ | ||||
| SLS / Applied load | ✔️ | N/A | ||||
| SLS / Applied deformation | ✔️ | N/A | ||||
| SLS / Deformation under applied loads | ✔️ | ✔️ | ||||
| - Uncracked | ✔️ | ❌ | ||||
| - Cracked | ✔️ | ❌ | ||||
| SLS / Interpolated deformation for applied loads | ✔️ | ✔️ | Design code specific | |||
| SLS / Section load under applied deformation | ✔️ | ✔️ | ||||
| SLS / Stiffness | ✔️ | ✔️ | ||||
| SLS / Stress/strain at key points | ✔️ | ✔️ | ||||
| SLS / Stress/strain at key points / section profile stress/strain | AdSec Desktop: Uncracked, Cracked AdSec API: Interpolated | |||||
| - Uncracked | ✔️ | ❌ | ||||
| - Cracked | ✔️ | ❌ | ||||
| - Interpolated | ❌ | ✔️ | ||||
| SLS / Stress/strain at key points / reinforcement stress/strain | ✔️ | ❌ | ||||
| SLS / Crack results at SLS loads | ✔️ | ✔️ | Design code specific. AdSec Desktop heading = "Crack widths at SLS loads" | |||
| - Face | ✔️ | ❌ | ||||
| - Bar | ✔️ | ❌ | ||||
| - Position | ✔️ | ✔️ | ||||
| - Cover | ✔️ | ❌ | ||||
| - h | ✔️ | ❌ | ||||
| - x | ✔️ | ❌ | ||||
| - a_cr | ✔️ | ❌ | ||||
| - εm | ✔️ | ❌ | ||||
| - Crack width (w_k) | ✔️ | ✔️ | ||||
| Advanced Options | Load Term (short, long) | ✔️ | N/A | |||
| Enabled Components | ✔️ | N/A | ||||
| Component Prestrain | ✔️ | N/A | ||||
| Tasks - Interaction Diagram | 3D view | Full, slice, mesh | ✔️ | ✔️ | AdSec API: Onion data accessible. | |
| 2D chart | ULS capacity, ULS No compression, ULS No Tension, ULS Balanced Yield, Analysis cases | ✔️ | ❌ | |||
| Diagram type / NM | ✔️ | ✔️ | ||||
| Diagram type / NM - adjust moment angle (Slice) | ✔️ | ✔️ | ||||
| Diagram type / MM | ✔️ | ✔️ | ||||
| Diagram type / MM - adjust axial force (Slice) | ✔️ | ✔️ | ||||
| Export 2D plots / Copy data | ✔️ | ✔️ | ||||
| Tasks - More Charts | Moment-Stiffness Chart | Adjust moment angle | ✔️ | ❌ | AdSec API: No chart output, but data is accessible. | |
| Adjust axial force | ✔️ | ❌ | ||||
| Export / Copy points | ✔️ | ❌ | ||||
| Moment-Curvature Chart | Adjust moment angle | ✔️ | ❌ | |||
| Adjust axial force | ✔️ | ❌ | ||||
| Export / Copy points | ✔️ | ❌ | ||||
| Tasks - Export Results | Case Details | Format: report / CSV | ✔️ | ❌ | AdSec API: No report output but data accessible. | |
| Choose from same list of "Display options (outputs)" above | ✔️ | ❌ | ||||
| Exports to view that can be printed | ✔️ | ❌ | ||||
| Charts | Interaction diagram | ✔️ | ❌ | AdSec API: No chart output, but data is accessible. | ||
| Moment-curvature | ✔️ | ❌ | ||||
| Moment-stiffness | ✔️ | ❌ | ||||
| Exports to view that can be printed | ✔️ | ❌ |