API Documentation

This section contains a complete description of all the classes and functions available in the API.

In general, all types are exposed as interfaces - an implementation of which can be instantiated using the static Create methods.

For example, to create a new AdSec solver instance:

using Oasys.AdSec;
var mySolver = IAdSec.Create(DesignCode.IS456.Edition_2000);

Interfaces which do not have Create methods will be returned by functions or property accessors. For example, the IAdSec.Analyse method is the only way to create an instance of ISolution.

using Oasys.AdSec;
ISolution mySolution = mySolver.Analyse(mySection);

Units of Measure

All measurements in the API (e.g. a section profile's dimensions) are based on OasysUnits types. This allows you to chose your preferred unit of measure. It also ensures that you cannot accidentally pass a measurement with the wrong dimension to a function.

For example, to create a circular section profile with a diameter of 12 inches:

using Oasys.Profiles;
using OasysUnits;
var diameter = new Length(12, Units.LengthUnit.Inch);
var myProfile = ICircleProfile.Create(diameter);

The measurements get converted to SI units internally and calculations are then carried out with these base units. Hence to access data and results in a specific unit you have to convert them to those units on return.

For example, to access the diameter in inches:

Length outputDiameter =  myProfile.Diameter.ToUnit(Units.LengthUnit.Inch);