Click or drag to resize

StructuralPointActionFree Class

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

Defines a free point load that is related to a StructuralSurfaceMember. The load is not defined by the entity it acts on, but by a specific load point.
Inheritance Hierarchy
SystemObject
  ModelExchanger.AnalysisDataModel.BaseStructuralAnalysisObjectBase
    ModelExchanger.AnalysisDataModel.LoadsStructuralPointActionFree

Namespace:  ModelExchanger.AnalysisDataModel.Loads
Assembly:  ModelExchanger.AnalysisDataModel (in ModelExchanger.AnalysisDataModel.dll) Version: 1.13.0+Branch.master.Sha.d583fc64569355d188a9c0818d257b6d0d3e1339
Syntax
C#
Copy
public sealed class StructuralPointActionFree : StructuralAnalysisObjectBase, 
	ILoadAnalysisObject, IStructuralAnalysisObject, IAnalysisObject, IEquatable<StructuralPointActionFree>, 
	IHasLoadDirectionVector<Force>

The StructuralPointActionFree type exposes the following members.

Constructors
  NameDescription
Public methodStructuralPointActionFree(Guid, String, StructuralLoadCase, Force, Length, Length, Length)
Create a free point load with a given value, which belongs to the provided StructuralLoadCase and which is defined by the given X, Y and Z values
Public methodStructuralPointActionFree(Guid, String, StructuralLoadCase, Force, Force, Force, Length, Length, Length)
Create a free point load with a given direction vector, which belongs to the provided StructuralLoadCase and which is defined by the given X, Y and Z values
Top
Properties
  NameDescription
Public propertyCoordinateSystem
Defines the coordinate system in which the load is applied. Free loads are always applied in Global
Public propertyDirection
Specifies the base direction of the load
Public propertyDirectionVectorX
When Direction is set to Vector, then this property defines the X portion of that vector.
Public propertyDirectionVectorY
When Direction is set to Vector, then this property defines the Y portion of that vector.
Public propertyDirectionVectorZ
When Direction is set to Vector, then this property defines the Z portion of that vector.
Public propertyId
The ID of the Analysis object. Needs to be unique within the entire model
(Inherited from StructuralAnalysisObjectBase.)
Public propertyLoadCase
The StructuralLoadCase to which the free point load belongs
Public propertyName
The name of the Analysis object. Needs to be unique within it's type
(Inherited from StructuralAnalysisObjectBase.)
Public propertyType
Defines what the load is caused by
Public propertyValidity
Defines the validity of the free load
Public propertyValidityFrom
Defines where the validity starts
Public propertyValidityTo
Defines where the validity stops
Public propertyValue
The value of the free point load
Public propertyX
The X value
Public propertyY
The Y value
Public propertyZ
The Z value
Top
Methods
  NameDescription
Public methodEquals(Object)
Check if this object is the same as the provided object.
(Overrides StructuralAnalysisObjectBaseEquals(Object).)
Public methodEquals(StructuralAnalysisObjectBase)
Check if this object is the same as the provided object.
(Inherited from StructuralAnalysisObjectBase.)
Public methodEquals(StructuralPointActionFree)
Indicates whether the current object is equal to another object of the same type.
Public methodGetHashCode
Retrieves the hashcode of the object
(Overrides StructuralAnalysisObjectBaseGetHashCode.)
Top
Events
  NameDescription
Public eventPropertyChanged (Inherited from StructuralAnalysisObjectBase.)
Top
Extension Methods
  NameDescription
Public Extension MethodToObjectIdentifier
Converts the provided IAnalysisObject into an AnalysisObjectIdentifier
(Defined by IAnalysisObjectExtensions.)
Top
Examples
Creating an instance
Copy
using System;
using System.Collections.Generic;
using System.Linq;
using ModelExchanger.AnalysisDataModel.Enums;
using ModelExchanger.AnalysisDataModel.Loads;
using ModelExchanger.AnalysisDataModel.Models;
using UnitsNet;

namespace ModelExchanger.AnalysisDataModel.Example.Loads
{
    public sealed class StructuralPointActionFreeExample : BaseExample<StructuralPointActionFree>
    {
        protected override IReadOnlyCollection<StructuralPointActionFree> CreateAnalysisObjects(AnalysisModel model)
        {
            StructuralLoadCase loadCase = model.OfType<StructuralLoadCase>().Single(x => x.Name == "LC2");

            return new[]
            {
                new StructuralPointActionFree(Guid.NewGuid(), "FF1", loadCase, Force.FromKilonewtons(-1), Length.FromMeters(2),
                    Length.FromMeters(17), Length.FromMeters(0))
                {
                    Validity = Validity.ZIsZero
                },
            };
        }
    }
}
See Also