Click or drag to resize

StructuralGeneralCrossSection Class

[This is preliminary documentation and is subject to change.]

Defines a general cross section
Inheritance Hierarchy
SystemObject
  ModelExchanger.AnalysisDataModel.BaseStructuralAnalysisObjectBase
    ModelExchanger.AnalysisDataModel.LibrariesStructuralCrossSection
      ModelExchanger.AnalysisDataModel.LibrariesStructuralGeneralCrossSection

Namespace:  ModelExchanger.AnalysisDataModel.Libraries
Assembly:  ModelExchanger.AnalysisDataModel (in ModelExchanger.AnalysisDataModel.dll) Version: 1.13.0+Branch.master.Sha.d583fc64569355d188a9c0818d257b6d0d3e1339
Syntax
C#
public sealed class StructuralGeneralCrossSection : StructuralCrossSection, 
	IEquatable<StructuralGeneralCrossSection>, IStructuralCrossSectionWithProfile, IStructuralCrossSectionWithDefinition

The StructuralGeneralCrossSection type exposes the following members.

Constructors
  NameDescription
Public methodStructuralGeneralCrossSection
Creates a cross section which is general
Top
Properties
  NameDescription
Public propertyCrossSectionalProperties
Additional properties which define the cross section
(Inherited from StructuralCrossSection.)
Public propertyCrossSectionType
Defines the type of cross section
(Inherited from StructuralCrossSection.)
Public propertyDefinition
Defines the polygons for the profile shape of a cross section
Public propertyId
The ID of the Analysis object. Needs to be unique within the entire model
(Inherited from StructuralAnalysisObjectBase.)
Public propertyMaterial
The material out of which the Cross Section exists.
(Inherited from StructuralCrossSection.)
Public propertyName
The name of the Analysis object. Needs to be unique within it's type
(Inherited from StructuralAnalysisObjectBase.)
Public propertyProfile
Public propertyStructuralName
The name of the cross section in a Structural Model to which this cross section is mapped.
(Inherited from StructuralCrossSection.)
Top
Methods
  NameDescription
Public methodEquals(Object)
Check if this object is the same as the provided object.
(Overrides StructuralCrossSectionEquals(Object).)
Public methodEquals(StructuralAnalysisObjectBase)
Check if this object is the same as the provided object.
(Inherited from StructuralAnalysisObjectBase.)
Public methodEquals(StructuralCrossSection)
Indicates whether the current object is equal to another object of the same type.
(Inherited from StructuralCrossSection.)
Public methodEquals(StructuralGeneralCrossSection)
Indicates whether the current object is equal to another object of the same type.
Public methodGetHashCode
Retrieves the hashcode of the object
(Overrides StructuralCrossSectionGetHashCode.)
Top
Events
  NameDescription
Public eventPropertyChanged (Inherited from StructuralAnalysisObjectBase.)
Top
Examples
Creating an instance
/// <summary>
/// Create general cross sections, specifying the shape of the cross section by using polygons
/// </summary>
/// <param name="materials">The available materials from the model</param>
/// <returns>A collection of general cross sections</returns>
private IReadOnlyCollection<StructuralCrossSection> CreateGeneralCrossSections(
    IReadOnlyDictionary<string, StructuralMaterial> materials)
{
    StructuralMaterial mat2 = materials["MAT2"];

    return new StructuralCrossSection[]
    {
        new StructuralGeneralCrossSection(Guid.NewGuid(), "CS29", mat2, new CompositeProfileDefinition("general1", new PolygonDefinition[]
        {
            new PolygonDefinition(mat2, new []
            {
                new Point2D(Length.FromCentimeters(20), Length.FromCentimeters(20)),
                new Point2D(Length.Zero, Length.FromCentimeters(20)),
                new Point2D(Length.Zero, Length.Zero),
                new Point2D(Length.FromCentimeters(20), Length.Zero)
            })
        }))
    };
}
See Also