Click or drag to resize

RelConnectsSurfaceEdge Class

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

Defines a hinge on a StructuralSurfaceMember
Inheritance Hierarchy
SystemObject
  ModelExchanger.AnalysisDataModel.BaseStructuralAnalysisObjectBase
    ModelExchanger.AnalysisDataModel.StructuralElementsRelConnectsSurfaceEdge

Namespace:  ModelExchanger.AnalysisDataModel.StructuralElements
Assembly:  ModelExchanger.AnalysisDataModel (in ModelExchanger.AnalysisDataModel.dll) Version: 1.13.0+Branch.master.Sha.d583fc64569355d188a9c0818d257b6d0d3e1339
Syntax
C#
public sealed class RelConnectsSurfaceEdge : StructuralAnalysisObjectBase, 
	IEquatable<RelConnectsSurfaceEdge>, IStructuralElementAnalysisObject, IStructuralAnalysisObject, IAnalysisObject, 
	IHasTranslationConstraints<Pressure?>, IHasTranslationConstraintsBase<Constraint<Pressure?>>, 
	IHasRotationalConstraints<RotationalStiffnessPerLength?>, IHasRotationalConstraintsBase<Constraint<RotationalStiffnessPerLength?>>, 
	IHasEdgeIndexOfStructuralSurfaceMember, IHasEdgeIndex, IHasCoordinateDefinition, IHasParentId

The RelConnectsSurfaceEdge type exposes the following members.

Constructors
  NameDescription
Public methodRelConnectsSurfaceEdge
Create a hinge on the provide StructuralSurfaceMember and the provided edge index
Top
Properties
  NameDescription
Public propertyCoordinateDefinition
Specifies the coordinate system that is used to define the length.
Public propertyEdge
The 0-based index of the edge of the Edges on which the hinge is connected
Public propertyEndPointAbsolute
Defines the position of the end point in absolute coordinates
Public propertyEndPointRelative
Defines the position of the end point in relative coordinates
Public propertyId
The ID of the Analysis object. Needs to be unique within the entire model
(Inherited from StructuralAnalysisObjectBase.)
Public propertyMember2D
The StructuralSurfaceMember on which the hinge is connected
Public propertyName
The name of the Analysis object. Needs to be unique within it's type
(Inherited from StructuralAnalysisObjectBase.)
Public propertyOrigin
Specifies the origin of the coordinate system used for the definition of the length
Public propertyParentId
The ID of the parent object of the same type
Public propertyRotationX
Rotational stiffness & the flexibility in rotation of the connection around local X axis
Public propertyRotationY
Rotational stiffness & the flexibility in rotation of the connection around local Y axis
Public propertyRotationZ
Rotational stiffness & the flexibility in rotation of the connection around local Z axis
Public propertyStartPointAbsolute
Defines the position of the start point in absolute coordinates
Public propertyStartPointRelative
Defines the position of the start point in relative coordinates
Public propertyTranslationX
Translation & flexibility of the connection in the X direction;
Public propertyTranslationY
Translation & flexibility of the connection in the Y direction;
Public propertyTranslationZ
Translation & flexibility of the connection in the Z direction;
Top
Methods
  NameDescription
Public methodEquals(Object)
Check if this object is the same as the provided object.
(Overrides StructuralAnalysisObjectBaseEquals(Object).)
Public methodEquals(RelConnectsSurfaceEdge)
Indicates whether the current object is equal to another object of the same type.
Public methodEquals(StructuralAnalysisObjectBase)
Check if this object is the same as the provided object.
(Inherited from StructuralAnalysisObjectBase.)
Public methodGetHashCode
Retrieves the hashcode of the object
(Overrides StructuralAnalysisObjectBaseGetHashCode.)
Top
Events
  NameDescription
Public eventPropertyChanged (Inherited from StructuralAnalysisObjectBase.)
Top
Extension Methods
  NameDescription
Public Extension MethodGetRotationConstraintsNullableRotationalStiffnessPerLength (Defined by ConstraintExtensions.)
Public Extension MethodGetTranslationConstraintsNullablePressure (Defined by ConstraintExtensions.)
Public Extension MethodToObjectIdentifier
Converts the provided IAnalysisObject into an AnalysisObjectIdentifier
(Defined by IAnalysisObjectExtensions.)
Top
Examples
Creating an instance
using System;
using System.Collections.Generic;
using System.Linq;
using ModelExchanger.AnalysisDataModel.Enums;
using ModelExchanger.AnalysisDataModel.Models;
using ModelExchanger.AnalysisDataModel.StructuralElements;
using ModelExchanger.AnalysisDataModel.Subtypes;
using UnitsNet;

namespace ModelExchanger.AnalysisDataModel.Example.StructuralElements
{
    public sealed class RelConnectsSurfaceEdgeExample : BaseExample<RelConnectsSurfaceEdge>
    {
        protected override IReadOnlyCollection<RelConnectsSurfaceEdge> CreateAnalysisObjects(AnalysisModel model)
        {
            IReadOnlyDictionary<string, StructuralSurfaceMember> surfaces = model.OfType<StructuralSurfaceMember>().ToDictionary(x => x.Name, x => x);

            return new[]
            {
                new RelConnectsSurfaceEdge(Guid.NewGuid(), "L1", surfaces["S8"], 3)
                {
                    RotationX = new Constraint<RotationalStiffnessPerLength?>(ConstraintType.Free, null)
                },
                new RelConnectsSurfaceEdge(Guid.NewGuid(), "L2", surfaces["S8"], 0)
                {
                    CoordinateDefinition = CoordinateDefinition.Absolute,
                    StartPointRelative = null,
                    StartPointAbsolute = Length.Zero,
                    EndPointRelative = null,
                    EndPointAbsolute = Length.FromCentimeters(20D),
                    RotationX = new Constraint<RotationalStiffnessPerLength?>(ConstraintType.Free, null)
                },
                new RelConnectsSurfaceEdge(Guid.NewGuid(), "L3", surfaces["S8"], 2)
                {
                    RotationX = new Constraint<RotationalStiffnessPerLength?>(ConstraintType.Free, null)
                },
            };
        }
    }
}
See Also