Click or drag to resize

StructuralLoadCase Class

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

Defines a load case
Inheritance Hierarchy
SystemObject
  ModelExchanger.AnalysisDataModel.BaseStructuralAnalysisObjectBase
    ModelExchanger.AnalysisDataModel.LoadsStructuralLoadCase

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 StructuralLoadCase : StructuralAnalysisObjectBase, 
	ILoadAnalysisObject, IStructuralAnalysisObject, IAnalysisObject, IEquatable<StructuralLoadCase>

The StructuralLoadCase type exposes the following members.

Constructors
  NameDescription
Public methodStructuralLoadCase
Create a load case that is assigned to the provided StructuralLoadGroup with the provided action & load type
Top
Properties
  NameDescription
Public propertyActionType
The type of load in general
Public propertyDescription
A description of the load case
Public propertyDuration
Defines the duration of the load impact
Public propertyId
The ID of the Analysis object. Needs to be unique within the entire model
(Inherited from StructuralAnalysisObjectBase.)
Public propertyLoadGroup
The StructuralLoadGroup to which the load case is assigned
Public propertyLoadType
The subtype of load. Depends on ActionType
Public propertyName
The name of the Analysis object. Needs to be unique within it's type
(Inherited from StructuralAnalysisObjectBase.)
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(StructuralLoadCase)
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;

namespace ModelExchanger.AnalysisDataModel.Example.Loads
{
    public sealed class StructuralLoadCaseExample : BaseExample<StructuralLoadCase>
    {
        protected override IReadOnlyCollection<StructuralLoadCase> CreateAnalysisObjects(AnalysisModel model)
        {
            IReadOnlyDictionary<string, StructuralLoadGroup> loadGroups = model.OfType<StructuralLoadGroup>().ToDictionary(x => x.Name, x => x);

            return new[]
            {
                new StructuralLoadCase(Guid.NewGuid(), "LC1", ActionType.Permanent, loadGroups["LG1"], LoadCaseType.SelfWeight),
                new StructuralLoadCase(Guid.NewGuid(),"LC2", ActionType.Accidental, loadGroups["LG6"], LoadCaseType.Standard),
                new StructuralLoadCase(Guid.NewGuid(), "LC3", ActionType.Variable, loadGroups["LG8"], LoadCaseType.Standard)
                {
                    Duration = Duration.Long
                }
            };
        }
    }
}
See Also