Interface ICircleProfile
Defines a circular section profile from Diameter.
Inherited Members
Namespace: Oasys.Profiles
Assembly: AdSec_API_IDL.dll
Syntax
public interface ICircleProfile : IProfile
Remarks
ICircleProfile inherits IProfile.
The circle is centered at the origin of its local coordinate system.
Examples
using Oasys.Profiles;
using OasysUnits;
Length diameter = Length.FromMillimeters(800);
ICircleProfile profile = ICircleProfile.Create(diameter);
Example creating a circular profile.
Properties
Diameter
The diameter of the circle.
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. |
Methods
Create(Length)
Creates a new ICircleProfile profile from its Diameter.
Declaration
static ICircleProfile Create(Length diameter)
Parameters
Type | Name | Description |
---|---|---|
OasysUnits.Length | diameter | Defines the profile's diameter. |
Returns
Type | Description |
---|---|
ICircleProfile | Circle profile with the specified diameter. |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | When the diameter is not a positive and finite value. |