Click or drag to resize

StructuralLoadCombination Class

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

Defines a load combination. The combination is created from the existing StructuralLoadCase's in the AnalysisModel
Inheritance Hierarchy
SystemObject
  ModelExchanger.AnalysisDataModel.BaseStructuralAnalysisObjectBase
    ModelExchanger.AnalysisDataModel.LoadsStructuralLoadCombination

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 StructuralLoadCombination : StructuralAnalysisObjectBase, 
	ILoadAnalysisObject, IStructuralAnalysisObject, IAnalysisObject, IEquatable<StructuralLoadCombination>, 
	IReadOnlyCollection<StructuralLoadCombinationData>, IEnumerable<StructuralLoadCombinationData>, IEnumerable

The StructuralLoadCombination type exposes the following members.

Constructors
  NameDescription
Public methodStructuralLoadCombination
Create a load combination with the provided LoadCaseCombinationCategory and StructuralLoadCombinationData's
Top
Properties
  NameDescription
Public propertyCategory
The category of the load combination
Public propertyCount
Returns the amount of load cases in the combination
Public propertyDescription
The description of the load combination
Public propertyId
The ID of the Analysis object. Needs to be unique within the entire model
(Inherited from StructuralAnalysisObjectBase.)
Public propertyItem
Returns the load combination data at the provided index
Public propertyName
The name of the Analysis object. Needs to be unique within it's type
(Inherited from StructuralAnalysisObjectBase.)
Public propertyNationalStandard
The national code application
Public propertyType
The type of combination
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(StructuralLoadCombination)
Indicates whether the current object is equal to another object of the same type.
Public methodGetEnumerator
Returns an enumerator that iterates through the collection.
Public methodGetHashCode
Retrieves the hashcode of the object
(Overrides StructuralAnalysisObjectBaseGetHashCode.)
Top
Events
  NameDescription
Public eventPropertyChanged (Inherited from StructuralAnalysisObjectBase.)
Top
Extension Methods
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 ModelExchanger.AnalysisDataModel.Subtypes;

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

            return new[]
            {
                new StructuralLoadCombination(Guid.NewGuid(), "CO1", LoadCaseCombinationCategory.AccidentalLimitState, new []
                {
                    new StructuralLoadCombinationData(loadCases["LC1"], 2.5D, 3D),
                    new StructuralLoadCombinationData(loadCases["LC2"], 1, 2), 
                })
                {
                    Description = "Load combination description"
                },
                new StructuralLoadCombination(Guid.NewGuid(), "CO2", LoadCaseCombinationCategory.ServiceabilityLimitState, new []
                {
                    new StructuralLoadCombinationData(loadCases["LC1"], 1D, 1D),
                    new StructuralLoadCombinationData(loadCases["LC2"], 2D, 1D), 
                })
                {
                    Type = LoadCaseCombinationType.NonLinear
                },
            };
        }
    }
}
See Also