Interface ISecantPileProfile

A secant pile section profile.

Inherited Members

IProfile.Rotation

IProfile.IsReflectedY

IProfile.IsReflectedZ

IProfile.Area()

IProfile.LocalAxisSecondMomentOfArea()

IProfile.PrincipalAxisSecondMomentOfArea()

IProfile.ShearAreaFactor()

IProfile.TorsionConstant()

IProfile.ElasticModulus()

IProfile.PlasticModulus()

IProfile.ElasticCentroid()

IProfile.RadiusOfGyration()

IProfile.SurfaceAreaPerUnitLength()

IProfile.Description()

IProfile.Validate()

Namespace: Oasys.Profiles

Assembly: AdSec_API_IDL.dll

Syntax

public interface ISecantPileProfile : IProfile

Remarks

ISecantPileProfile inherits IProfile.

Properties

Diameter

The diameter of the piles.

Declaration

Length Diameter { get; set; }

Property Value

Type	Description
OasysUnits.Length

Exceptions

Type	Condition
System.ArgumentException	When the diameter is not a positive and finite value.

IsWallNotSection

Converts the profile into a wall secant pile profile if true.
Converts the profile into a section secant pile profile if false.

Declaration

bool IsWallNotSection { get; set; }

Property Value

Type	Description
System.Boolean

PileCentres

The centre to centre distance between adjacent piles.

Declaration

Length PileCentres { get; set; }

Property Value

Type	Description
OasysUnits.Length

Exceptions

Type	Condition
System.ArgumentException	When the distance is not a positive and finite value.

PileCount

The number of piles in the profile.

Declaration

int PileCount { get; set; }

Property Value

Type	Description
System.Int32

Methods

Create(Length, Length, Int32, Boolean)

Creates a new ISecantPileProfile profile from its Diameter, PileCentres, PileCount and IsWallNotSection.

Declaration

static ISecantPileProfile Create(Length diameter, Length pileCentres, int pileCount, bool isWallNotSection)

Parameters

Type	Name	Description
OasysUnits.Length	diameter	Defines the diameter of the piles.
OasysUnits.Length	pileCentres	Defines the centre to centre distance between adjacent piles.
System.Int32	pileCount	Defines the number of piles in the profile.
System.Boolean	isWallNotSection	Converts the profile into a wall secant pile profile if true. Converts the profile into a section secant pile profile if false.

Returns

Type	Description
ISecantPileProfile

Exceptions

Type	Condition
System.ArgumentException	When any of the dimensions is not a positive and finite value.