Click or drag to resize

ProjectInformation Class

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

Contains information regarding the project
Inheritance Hierarchy
SystemObject
  ModelExchanger.AnalysisDataModel.BaseStructuralAnalysisObjectBase
    ModelExchanger.AnalysisDataModelProjectInformation

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

The ProjectInformation type exposes the following members.

Constructors
  NameDescription
Public methodProjectInformation
Create a project
Top
Properties
  NameDescription
Public propertyCode exampleBuildingType
The use type of the building
Public propertyCreated
The date and time at which the model is created. Defaults to current UTC time.
Public propertyDescription
The description of the project
Public propertyId
The ID of the Analysis object. Needs to be unique within the entire model
(Inherited from StructuralAnalysisObjectBase.)
Public propertyLastUpdate
The date and time at which the model was last updated. Defaults to current UTC time.
Public propertyLocation
The location of the building
Public propertyName
The name of the Analysis object. Needs to be unique within it's type
(Inherited from StructuralAnalysisObjectBase.)
Public propertyCode exampleProjectKind
The kind of project
Public propertyProjectNumber
The number of the project
Public propertyCode exampleProjectType
The type of project
Public propertyCode exampleStatus
Status of the project
Top
Methods
  NameDescription
Public methodEquals(Object)
Check if this object is the same as the provided object.
(Overrides StructuralAnalysisObjectBaseEquals(Object).)
Public methodEquals(ProjectInformation)
Indicates whether the current object is equal to another object of the same type.
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.)
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.Models;

namespace ModelExchanger.AnalysisDataModel.Example.Other
{
    public sealed class ProjectInformationExample : BaseExample<ProjectInformation>
    {
        protected override IReadOnlyCollection<ProjectInformation> CreateAnalysisObjects(AnalysisModel model)
        {
            return new[]
            {
                new ProjectInformation(Guid.NewGuid(), "My example project")
                {
                    Description = "This is an example project",
                    BuildingType = "Industrial",
                    Location = "Some undisclosed location, in an undisclosed country",
                    ProjectKind = "A special kind of project",
                    ProjectNumber = "ABCD1289-9876_54321",
                    ProjectType = "A special type of project",
                    Status = "Pending",
                    Created = new DateTime(2020, 1, 1, 9, 0, 0, DateTimeKind.Utc),
                    LastUpdate = DateTime.UtcNow
                }
            };
        }
    }
}
See Also