Click or drag to resize

StructuralLoadGroup Class

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

Defines a load group that defines how individual load cases may be combined together
Inheritance Hierarchy
SystemObject
  ModelExchanger.AnalysisDataModel.BaseStructuralAnalysisObjectBase
    ModelExchanger.AnalysisDataModel.LoadsStructuralLoadGroup

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

The StructuralLoadGroup type exposes the following members.

Constructors
  NameDescription
Public methodStructuralLoadGroup
Create a load group of the provided type
Top
Properties
  NameDescription
Public propertyId
The ID of the Analysis object. Needs to be unique within the entire model
(Inherited from StructuralAnalysisObjectBase.)
Public propertyLoad
Defines the type of variable load
Public propertyLoadGroupType
Defines the type of load group
Public propertyName
The name of the Analysis object. Needs to be unique within it's type
(Inherited from StructuralAnalysisObjectBase.)
Public propertyRelation
Defines the relation between load cases in this load group
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(StructuralLoadGroup)
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 CSInfrastructure;
using ModelExchanger.AnalysisDataModel.Enums;
using ModelExchanger.AnalysisDataModel.Loads;
using ModelExchanger.AnalysisDataModel.Models;

namespace ModelExchanger.AnalysisDataModel.Example.Loads
{
    public sealed class StructuralLoadGroupExample : BaseExample<StructuralLoadGroup>
    {
        protected override IReadOnlyCollection<StructuralLoadGroup> CreateAnalysisObjects(AnalysisModel model)
        {
            return new[]
            {
                new StructuralLoadGroup(Guid.NewGuid(), "LG1", LoadGroupType.Permanent),
                new StructuralLoadGroup(Guid.NewGuid(), "LG2", LoadGroupType.Variable)
                {
                    Relation = Relation.Standard,
                    Load = new FlexibleEnum<Load>(Load.Domestic)
                },
                new StructuralLoadGroup(Guid.NewGuid(), "LG3", LoadGroupType.Variable)
                {
                    Relation = Relation.Standard,
                    Load = new FlexibleEnum<Load>(Load.Roofs)
                },
                new StructuralLoadGroup(Guid.NewGuid(), "LG4", LoadGroupType.Variable)
                {
                    Relation = Relation.Standard,
                    Load = new FlexibleEnum<Load>(Load.Snow)
                },
                new StructuralLoadGroup(Guid.NewGuid(), "LG5", LoadGroupType.Variable)
                {
                    Relation = Relation.Standard,
                    Load = new FlexibleEnum<Load>(Load.Wind)
                },
                new StructuralLoadGroup(Guid.NewGuid(), "LG6", LoadGroupType.Accidental)
                {
                    Relation = Relation.Exclusive,
                },
                new StructuralLoadGroup(Guid.NewGuid(), "LG7", LoadGroupType.Seismic)
                {
                    Relation = Relation.Together
                },
                new StructuralLoadGroup(Guid.NewGuid(), "LG8", LoadGroupType.Variable)
                {
                    Relation = Relation.Standard,
                    Load =  Load.Temperature
                }
            };
        }
    }
}
See Also