Interface ISheetPileProfile
A sheet pile section profile.
Inherited Members
Namespace: Oasys.Profiles
Assembly: AdSec_API_IDL.dll
Syntax
public interface ISheetPileProfile : IProfile
Remarks
ISheetPileProfile inherits IProfile.
Properties
BottomFlangeWidth
The bottom flange width of the sheet pile section profile.
Declaration
Length BottomFlangeWidth { get; set; }
Property Value
Type | Description |
---|---|
OasysUnits.Length |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | When the bottom flange width is not a positive and finite value. |
Depth
The depth of the sheet pile section profile.
Declaration
Length Depth { get; set; }
Property Value
Type | Description |
---|---|
OasysUnits.Length |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | When the depth is not a positive and finite value. |
FlangeThickness
The flange thickness of the sheet pile section profile.
Declaration
Length FlangeThickness { get; set; }
Property Value
Type | Description |
---|---|
OasysUnits.Length |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | When the flange thickness is not a positive and finite value. |
TopFlangeWidth
The top flange width of the sheet pile section profile.
Declaration
Length TopFlangeWidth { get; set; }
Property Value
Type | Description |
---|---|
OasysUnits.Length |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | When the top flange width is not a positive and finite value. |
WebThickness
The web thickness of the sheet pile section profile.
Declaration
Length WebThickness { get; set; }
Property Value
Type | Description |
---|---|
OasysUnits.Length |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | When the web thickness is not a positive and finite value. |
Width
The overall width of the sheet pile section profile.
Declaration
Length Width { get; set; }
Property Value
Type | Description |
---|---|
OasysUnits.Length |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | When the overall width is not a positive and finite value. |
Methods
Create(Length, Length, Length, Length, Length, Length)
Creates a new ISheetPileProfile profile from its Depth, Width, TopFlangeWidth, BottomFlangeWidth, FlangeThickness and WebThickness.
Declaration
static ISheetPileProfile Create(Length depth, Length width, Length topFlangeWidth, Length bottomFlangeWidth, Length flangeThickness, Length webThickness)
Parameters
Type | Name | Description |
---|---|---|
OasysUnits.Length | depth | Defines the profile's depth. |
OasysUnits.Length | width | Defines the profile's overall width. |
OasysUnits.Length | topFlangeWidth | Defines the profile's top flange width. |
OasysUnits.Length | bottomFlangeWidth | Defines the profile's bottom flange width. |
OasysUnits.Length | flangeThickness | Defines the profile's flange thickness. |
OasysUnits.Length | webThickness | Defines the profile's web thickness. |
Returns
Type | Description |
---|---|
ISheetPileProfile |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | When any of the dimensions is not a positive and finite value. |