Click or drag to resize

ModelInformation Class

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

Contains information regarding the model
Inheritance Hierarchy
SystemObject
  ModelExchanger.AnalysisDataModel.BaseStructuralAnalysisObjectBase
    ModelExchanger.AnalysisDataModelModelInformation

Namespace:  ModelExchanger.AnalysisDataModel
Assembly:  ModelExchanger.AnalysisDataModel (in ModelExchanger.AnalysisDataModel.dll) Version: 1.13.0+Branch.master.Sha.d583fc64569355d188a9c0818d257b6d0d3e1339
Syntax
C#
Copy
public sealed class ModelInformation : StructuralAnalysisObjectBase, 
	IAnalysisInformationObject, IAnalysisObject, IEquatable<ModelInformation>

The ModelInformation type exposes the following members.

Constructors
  NameDescription
Public methodModelInformation
Create a model
Top
Properties
  NameDescription
Public propertyCreated
The date and time at which the model is created. Defaults to current UTC time.
Public propertyDescription
The description of the model
Public propertyCode exampleDiscipline
The discipline of the model
Public propertyGlobalCoordinateSystem
Determines how the direction of the Z-axis is defined for this model
Public propertyId
The ID of the Analysis object. Needs to be unique within the entire model
(Inherited from StructuralAnalysisObjectBase.)
Public propertyIgnoredGroups
Types that should be excluded from deletion during update in Scia engineer if the list is empty: this property has no effect if the list is not-empty: types that are in list will be excluded from deletion
Public propertyIgnoredObjects
Types that should be excluded from deletion during update in Scia engineer if the list is empty: this property has no effect if the list is not-empty: types that are in list will be excluded from deletion
Public propertyLastUpdate
The date and time at which the model was last updated. Defaults to current UTC time.
Public propertyCode exampleLevelOfDetail
The level of detail (LoD) of the model.
Public propertyLocalCoordinateSystem
Determines how the local coordinate system is defined for this model.
Public propertyName
The name of the Analysis object. Needs to be unique within it's type
(Inherited from StructuralAnalysisObjectBase.)
Public propertyNationalCode
The national code used for structural analysis
Public propertyCode exampleOwner
The owner of the model
Public propertyCode exampleRevisionNumber
The revision number of the model
Public propertyCode exampleSourceApplication
The application from which the model originated
Public propertyCode exampleSourceCompany
The company from which the model originated
Public propertyCode exampleSourceType
The type of application from which the model originated.
Public propertyStatus
The status of the model.
Public propertySystemOfUnits
Determines in which units the values are expressed throughout the model
Top
Methods
  NameDescription
Public methodEquals(ModelInformation)
Indicates whether the current object is equal to another object of the same type.
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 methodGetHashCode
Retrieves the hashcode of the object
(Overrides StructuralAnalysisObjectBaseGetHashCode.)
Public methodRename
Renames the ModelInformation to the given value
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 ModelExchanger.AnalysisDataModel.Enums;
using ModelExchanger.AnalysisDataModel.Models;

namespace ModelExchanger.AnalysisDataModel.Example.Other
{
    public sealed class ModelInformationExample : BaseExample<ModelInformation>
    {
        protected override IReadOnlyCollection<ModelInformation> CreateAnalysisObjects(AnalysisModel model)
        {
            return new[]
            {
                new ModelInformation(Guid.NewGuid(), "My example model")
                {
                    Description = "This is an example model",
                    Created = new DateTime(2020, 1, 1, 9, 0, 0, DateTimeKind.Utc),
                    LastUpdate = DateTime.UtcNow,
                    GlobalCoordinateSystem = GlobalCoordinateSystem.ZVertical,
                    LocalCoordinateSystem = LocalCoordinateSystem.ZYX,
                    Owner = "SCIA nv",
                    SourceApplication = "SCIA Engineer",
                    SourceCompany = "SCIA nv",
                    RevisionNumber = "Rev. 1",
                    SourceType = "Structural Analysis Software",
                    Status = "Pending",
                    SystemOfUnits = SystemOfUnits.Metric,
                    LevelOfDetail = "LOD100",
                    Discipline = "Structural Analysis"
                },
            };
        }
    }
}
See Also