StructuralStorey Class

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

Object that represents a storey in a building

Inheritance Hierarchy

SystemObject
ModelExchanger.AnalysisDataModel.BaseStructuralAnalysisObjectBase
ModelExchanger.AnalysisDataModel.StructuralElementsStructuralStorey

Namespace: ModelExchanger.AnalysisDataModel.StructuralElements
Assembly: ModelExchanger.AnalysisDataModel (in ModelExchanger.AnalysisDataModel.dll) Version: 1.13.0+Branch.master.Sha.d583fc64569355d188a9c0818d257b6d0d3e1339

Syntax

Copy

public sealed class StructuralStorey : StructuralAnalysisObjectBase, 
	IEquatable<StructuralStorey>

The StructuralStorey type exposes the following members.

Constructors

	Name	Description
	StructuralStorey	Create a new storey with a given height

Top

Properties

	Name	Description
	HeightLevel	The height of the storey, from the horizontal plane of the Global Coordinate System. A value of zero indicates that the height level is the horizontal plane of the Global Coordinate System
	Id	The ID of the Analysis object. Needs to be unique within the entire model (Inherited from StructuralAnalysisObjectBase.)
	Name	The name of the Analysis object. Needs to be unique within it's type (Inherited from StructuralAnalysisObjectBase.)

Top

Methods

	Name	Description
	Equals(Object)	(Overrides StructuralAnalysisObjectBaseEquals(Object).)
	Equals(StructuralAnalysisObjectBase)	Check if this object is the same as the provided object. (Inherited from StructuralAnalysisObjectBase.)
	Equals(StructuralStorey)
	GetHashCode	(Overrides StructuralAnalysisObjectBaseGetHashCode.)

Top

Events

	Name	Description
	PropertyChanged	(Inherited from StructuralAnalysisObjectBase.)

Top

Examples

Creating an instance

Copy

using System;
using System.Collections.Generic;
using ModelExchanger.AnalysisDataModel.Models;
using ModelExchanger.AnalysisDataModel.StructuralElements;
using UnitsNet;

namespace ModelExchanger.AnalysisDataModel.Example.StructuralElements
{
    public sealed class StructuralStoreyExample : BaseExample<StructuralStorey>
    {
        protected override IReadOnlyCollection<StructuralStorey> CreateAnalysisObjects(AnalysisModel model)
        {
            return new[]
            {
                new StructuralStorey(Guid.NewGuid(), "Ground floor", Length.Zero),
                new StructuralStorey(Guid.NewGuid(), "First floor", Length.FromMeters(3.6D))
            };
        }
    }
}

Reference

ModelExchanger.AnalysisDataModel.StructuralElements Namespace