Skip to content

DiGi.GIS.Classes

github-actions[bot] edited this page Jul 15, 2026 · 2 revisions

DiGi.GIS.Classes Namespace

Classes

AdministrativeAreal2D Class

Represents an abstract base class for administrative areas in a 2D coordinate system.

public abstract class AdministrativeAreal2D : DiGi.GIS.Classes.Areal2D

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Classes.UniqueObjectDiGi.Core.Classes.GuidObjectGISGuidObject2DAreal2D → AdministrativeAreal2D

Derived
AdministrativeDivision
AdministrativeSubdivision

Constructors

AdministrativeAreal2D(AdministrativeAreal2D) Constructor

Initializes a new instance of the AdministrativeAreal2D class as a copy of another AdministrativeAreal2D.

public AdministrativeAreal2D(DiGi.GIS.Classes.AdministrativeAreal2D? administrativeArea2D);

Parameters

administrativeArea2D AdministrativeAreal2D

The source administrative area instance to copy from.

AdministrativeAreal2D(AdministrativeAreal2D, string) Constructor

Initializes a new instance of the AdministrativeAreal2D class as a copy of another AdministrativeAreal2D with a new code.

public AdministrativeAreal2D(DiGi.GIS.Classes.AdministrativeAreal2D? administrativeArea2D, string? code);

Parameters

administrativeArea2D AdministrativeAreal2D

The source administrative area instance to copy from.

code System.String

The new identification code to assign to the copied administrative area.

AdministrativeAreal2D(Guid, string, string, PolygonalFace2D, string) Constructor

Initializes a new instance of the AdministrativeAreal2D class.

public AdministrativeAreal2D(System.Guid guid, string? reference, string? code, DiGi.Geometry.Planar.Classes.PolygonalFace2D? polygonalFace2D, string? name);

Parameters

guid System.Guid

The unique identifier for the administrative area.

reference System.String

The reference string associated with the administrative area.

code System.String

The identification code of the administrative area.

polygonalFace2D DiGi.Geometry.Planar.Classes.PolygonalFace2D

The polygonal face defining the geometry of the administrative area.

name System.String

The descriptive name of the administrative area.

AdministrativeAreal2D(JsonObject) Constructor

Initializes a new instance of the AdministrativeAreal2D class from a JSON object.

public AdministrativeAreal2D(System.Text.Json.Nodes.JsonObject? jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the administrative area data.

Properties

AdministrativeAreal2D.Code Property

Gets the code of the administrative area.

public string? Code { get; }

Property Value

System.String

AdministrativeAreal2D.Name Property

Gets the name of the administrative area.

public string? Name { get; }

Property Value

System.String

AdministrativeAreal2DAdministrativeAreal2DsRelation Class

Represents a one-to-many bidirectional relation between administrative areal 2D entities.

public class AdministrativeAreal2DAdministrativeAreal2DsRelation : DiGi.Core.Relation.Classes.OneToManyBidirectionalRelation<DiGi.GIS.Classes.AdministrativeAreal2D, DiGi.GIS.Classes.AdministrativeAreal2D>, DiGi.GIS.Interfaces.IGISRelation, DiGi.Core.Relation.Interfaces.IRelation, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Relation.Classes.RelationDiGi.Core.Relation.Classes.Relation<AdministrativeAreal2D,AdministrativeAreal2D>DiGi.Core.Relation.Classes.OneToManyRelation<AdministrativeAreal2D,AdministrativeAreal2D>DiGi.Core.Relation.Classes.OneToManyBidirectionalRelation<AdministrativeAreal2D,AdministrativeAreal2D> → AdministrativeAreal2DAdministrativeAreal2DsRelation

Implements IGISRelation, DiGi.Core.Relation.Interfaces.IRelation, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObject

Constructors

AdministrativeAreal2DAdministrativeAreal2DsRelation(AdministrativeAreal2D, IEnumerable<AdministrativeAreal2D>) Constructor

Initializes a new instance of the AdministrativeAreal2DAdministrativeAreal2DsRelation class.

public AdministrativeAreal2DAdministrativeAreal2DsRelation(DiGi.GIS.Classes.AdministrativeAreal2D administrativeAreal2D, System.Collections.Generic.IEnumerable<DiGi.GIS.Classes.AdministrativeAreal2D> administrativeAreal2Ds);

Parameters

administrativeAreal2D AdministrativeAreal2D

The parent administrative areal 2D entity.

administrativeAreal2Ds System.Collections.Generic.IEnumerable<AdministrativeAreal2D>

The collection of related administrative areal 2D entities.

AdministrativeAreal2DAdministrativeAreal2DsRelation(AdministrativeAreal2DAdministrativeAreal2DsRelation) Constructor

Initializes a new instance of the AdministrativeAreal2DAdministrativeAreal2DsRelation class by copying an existing relation.

public AdministrativeAreal2DAdministrativeAreal2DsRelation(DiGi.GIS.Classes.AdministrativeAreal2DAdministrativeAreal2DsRelation administrativeAreal2DAdministrativeAreal2DsRelation);

Parameters

administrativeAreal2DAdministrativeAreal2DsRelation AdministrativeAreal2DAdministrativeAreal2DsRelation

The source relation instance to copy.

AdministrativeAreal2DAdministrativeAreal2DsRelation(JsonObject) Constructor

Initializes a new instance of the AdministrativeAreal2DAdministrativeAreal2DsRelation class from a JSON object.

public AdministrativeAreal2DAdministrativeAreal2DsRelation(System.Text.Json.Nodes.JsonObject jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the relation data.

AdministrativeAreal2DBuilding2DsRelation Class

Represents a one-to-many bidirectional relation between an administrative areal 2D and building 2D entities.

public class AdministrativeAreal2DBuilding2DsRelation : DiGi.Core.Relation.Classes.OneToManyBidirectionalRelation<DiGi.GIS.Classes.AdministrativeAreal2D, DiGi.GIS.Classes.Building2D>, DiGi.GIS.Interfaces.IGISRelation, DiGi.Core.Relation.Interfaces.IRelation, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Relation.Classes.RelationDiGi.Core.Relation.Classes.Relation<AdministrativeAreal2D,Building2D>DiGi.Core.Relation.Classes.OneToManyRelation<AdministrativeAreal2D,Building2D>DiGi.Core.Relation.Classes.OneToManyBidirectionalRelation<AdministrativeAreal2D,Building2D> → AdministrativeAreal2DBuilding2DsRelation

Implements IGISRelation, DiGi.Core.Relation.Interfaces.IRelation, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObject

Constructors

AdministrativeAreal2DBuilding2DsRelation(AdministrativeAreal2D, IEnumerable<Building2D>) Constructor

Initializes a new instance of the AdministrativeAreal2DBuilding2DsRelation class.

public AdministrativeAreal2DBuilding2DsRelation(DiGi.GIS.Classes.AdministrativeAreal2D administrativeAreal2D, System.Collections.Generic.IEnumerable<DiGi.GIS.Classes.Building2D> building2Ds);

Parameters

administrativeAreal2D AdministrativeAreal2D

The administrative areal 2D entity.

building2Ds System.Collections.Generic.IEnumerable<Building2D>

The collection of building 2D entities.

AdministrativeAreal2DBuilding2DsRelation(AdministrativeAreal2DBuilding2DsRelation) Constructor

Initializes a new instance of the AdministrativeAreal2DBuilding2DsRelation class by copying an existing relation.

public AdministrativeAreal2DBuilding2DsRelation(DiGi.GIS.Classes.AdministrativeAreal2DBuilding2DsRelation administrativeAreal2DBuilding2DsRelation);

Parameters

administrativeAreal2DBuilding2DsRelation AdministrativeAreal2DBuilding2DsRelation

The source relation to copy from.

AdministrativeAreal2DBuilding2DsRelation(JsonObject) Constructor

Initializes a new instance of the AdministrativeAreal2DBuilding2DsRelation class from a JSON object.

public AdministrativeAreal2DBuilding2DsRelation(System.Text.Json.Nodes.JsonObject jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the relation data.

AdministrativeAreal2DExternalReferenceGuidResult Class

Represents a result object that provides the external reference GUID for an administrative areal 2D entity.

public abstract class AdministrativeAreal2DExternalReferenceGuidResult : DiGi.Core.Classes.ExternalReferenceGuidResult<DiGi.GIS.Classes.AdministrativeAreal2D, DiGi.Core.Classes.InstanceRelatedExternalReference>, DiGi.GIS.Interfaces.IGISGuidResult, DiGi.GIS.Interfaces.IGISUniqueResult, DiGi.Core.Interfaces.IUniqueResult, DiGi.Core.Interfaces.ISerializableResult, DiGi.Core.Interfaces.IResult, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject, DiGi.GIS.Interfaces.IGISUniqueObject, DiGi.GIS.Interfaces.IGISSerializableObject, DiGi.GIS.Interfaces.IGISObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Classes.UniqueObjectDiGi.Core.Classes.GuidObjectDiGi.Core.Classes.GuidResultDiGi.Core.Classes.GuidResult<AdministrativeAreal2D>DiGi.Core.Classes.ExternalReferenceGuidResult<AdministrativeAreal2D,DiGi.Core.Classes.InstanceRelatedExternalReference> → AdministrativeAreal2DExternalReferenceGuidResult

Implements IGISGuidResult, IGISUniqueResult, DiGi.Core.Interfaces.IUniqueResult, DiGi.Core.Interfaces.ISerializableResult, DiGi.Core.Interfaces.IResult, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject, IGISUniqueObject, IGISSerializableObject, IGISObject

Constructors

AdministrativeAreal2DExternalReferenceGuidResult(InstanceRelatedExternalReference) Constructor

Initializes a new instance of the AdministrativeAreal2DExternalReferenceGuidResult class using the specified external reference.

public AdministrativeAreal2DExternalReferenceGuidResult(DiGi.Core.Classes.InstanceRelatedExternalReference reference);

Parameters

reference DiGi.Core.Classes.InstanceRelatedExternalReference

The instance-related external reference to initialize with.

AdministrativeAreal2DExternalReferenceGuidResult(AdministrativeAreal2DExternalReferenceGuidResult) Constructor

Initializes a new instance of the AdministrativeAreal2DExternalReferenceGuidResult class by copying another result object.

public AdministrativeAreal2DExternalReferenceGuidResult(DiGi.GIS.Classes.AdministrativeAreal2DExternalReferenceGuidResult administrativeAreal2DExternalReferenceGuidResult);

Parameters

administrativeAreal2DExternalReferenceGuidResult AdministrativeAreal2DExternalReferenceGuidResult

The source result object to copy from.

AdministrativeAreal2DExternalReferenceGuidResult(JsonObject) Constructor

Initializes a new instance of the AdministrativeAreal2DExternalReferenceGuidResult class from the specified JSON object.

public AdministrativeAreal2DExternalReferenceGuidResult(System.Text.Json.Nodes.JsonObject jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the data for the result.

AdministrativeAreal2DGeometryCalculationResult Class

Represents the result of a geometry calculation for an administrative areal 2D object.

public class AdministrativeAreal2DGeometryCalculationResult : DiGi.Core.Classes.GuidResult<DiGi.GIS.Classes.AdministrativeAreal2D>, DiGi.GIS.Interfaces.IGISUniqueResult, DiGi.Core.Interfaces.IUniqueResult, DiGi.Core.Interfaces.ISerializableResult, DiGi.Core.Interfaces.IResult, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject, DiGi.GIS.Interfaces.IGISUniqueObject, DiGi.GIS.Interfaces.IGISSerializableObject, DiGi.GIS.Interfaces.IGISObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Classes.UniqueObjectDiGi.Core.Classes.GuidObjectDiGi.Core.Classes.GuidResultDiGi.Core.Classes.GuidResult<AdministrativeAreal2D> → AdministrativeAreal2DGeometryCalculationResult

Implements IGISUniqueResult, DiGi.Core.Interfaces.IUniqueResult, DiGi.Core.Interfaces.ISerializableResult, DiGi.Core.Interfaces.IResult, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject, IGISUniqueObject, IGISSerializableObject, IGISObject

Constructors

AdministrativeAreal2DGeometryCalculationResult(BoundingBox2D, Rectangle2D, Point2D, Point2D, double, double, double) Constructor

Initializes a new instance of the AdministrativeAreal2DGeometryCalculationResult class

public AdministrativeAreal2DGeometryCalculationResult(DiGi.Geometry.Planar.Classes.BoundingBox2D? boundingBox, DiGi.Geometry.Planar.Classes.Rectangle2D? rectangle, DiGi.Geometry.Planar.Classes.Point2D? centroid, DiGi.Geometry.Planar.Classes.Point2D? internalPoint, double thinnessRatio, double rectangularity, double area);

Parameters

boundingBox DiGi.Geometry.Planar.Classes.BoundingBox2D

The bounding box of the administrative area.

rectangle DiGi.Geometry.Planar.Classes.Rectangle2D

The rectangle representation of the administrative area.

centroid DiGi.Geometry.Planar.Classes.Point2D

The centroid point of the administrative area.

internalPoint DiGi.Geometry.Planar.Classes.Point2D

The internal point within the administrative area.

thinnessRatio System.Double

The thinness ratio of the administrative area.

rectangularity System.Double

The rectangularity measure of the administrative area.

area System.Double

The area of the administrative area.

AdministrativeAreal2DGeometryCalculationResult(AdministrativeAreal2DGeometryCalculationResult) Constructor

Initializes a new instance of the AdministrativeAreal2DGeometryCalculationResult class as a copy

public AdministrativeAreal2DGeometryCalculationResult(DiGi.GIS.Classes.AdministrativeAreal2DGeometryCalculationResult? administrativeAreal2DGeometryCalculationResult);

Parameters

administrativeAreal2DGeometryCalculationResult AdministrativeAreal2DGeometryCalculationResult

The source result object to copy from.

AdministrativeAreal2DGeometryCalculationResult(JsonObject) Constructor

Initializes a new instance of the AdministrativeAreal2DGeometryCalculationResult class from a JSON object

public AdministrativeAreal2DGeometryCalculationResult(System.Text.Json.Nodes.JsonObject? jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the result data.

Properties

AdministrativeAreal2DGeometryCalculationResult.Area Property

Gets the area of the administrative area

public double Area { get; }

Property Value

System.Double

AdministrativeAreal2DGeometryCalculationResult.BoundingBox Property

Gets the bounding box of the administrative area

public DiGi.Geometry.Planar.Classes.BoundingBox2D? BoundingBox { get; }

Property Value

DiGi.Geometry.Planar.Classes.BoundingBox2D

AdministrativeAreal2DGeometryCalculationResult.Centroid Property

Gets the centroid point of the administrative area

public DiGi.Geometry.Planar.Classes.Point2D? Centroid { get; }

Property Value

DiGi.Geometry.Planar.Classes.Point2D

AdministrativeAreal2DGeometryCalculationResult.InternalPoint Property

Gets the internal point within the administrative area

public DiGi.Geometry.Planar.Classes.Point2D? InternalPoint { get; }

Property Value

DiGi.Geometry.Planar.Classes.Point2D

AdministrativeAreal2DGeometryCalculationResult.Rectangle2D Property

Gets the rectangle representation of the administrative area

public DiGi.Geometry.Planar.Classes.Rectangle2D? Rectangle2D { get; }

Property Value

DiGi.Geometry.Planar.Classes.Rectangle2D

AdministrativeAreal2DGeometryCalculationResult.Rectangularity Property

Gets the rectangularity measure of the administrative area

public double Rectangularity { get; }

Property Value

System.Double

AdministrativeAreal2DGeometryCalculationResult.ThinnessRatio Property

Gets the thinness ratio of the administrative area

public double ThinnessRatio { get; }

Property Value

System.Double

AdministrativeAreal2DGeometryCalculationResultRelation Class

Represents a one-to-one directional relation between an administrative areal 2D object and its geometry calculation result.

public class AdministrativeAreal2DGeometryCalculationResultRelation : DiGi.Core.Relation.Classes.OneToOneDirectionalRelation<DiGi.GIS.Classes.AdministrativeAreal2D, DiGi.GIS.Classes.AdministrativeAreal2DGeometryCalculationResult>, DiGi.GIS.Interfaces.IGISRelation, DiGi.Core.Relation.Interfaces.IRelation, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Relation.Classes.RelationDiGi.Core.Relation.Classes.Relation<AdministrativeAreal2D,AdministrativeAreal2DGeometryCalculationResult>DiGi.Core.Relation.Classes.OneToOneRelation<AdministrativeAreal2D,AdministrativeAreal2DGeometryCalculationResult>DiGi.Core.Relation.Classes.OneToOneDirectionalRelation<AdministrativeAreal2D,AdministrativeAreal2DGeometryCalculationResult> → AdministrativeAreal2DGeometryCalculationResultRelation

Implements IGISRelation, DiGi.Core.Relation.Interfaces.IRelation, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObject

Constructors

AdministrativeAreal2DGeometryCalculationResultRelation(AdministrativeAreal2D, AdministrativeAreal2DGeometryCalculationResult) Constructor

Initializes a new instance of the AdministrativeAreal2DGeometryCalculationResultRelation class using the specified source and target objects.

public AdministrativeAreal2DGeometryCalculationResultRelation(DiGi.GIS.Classes.AdministrativeAreal2D administrativeAreal2D, DiGi.GIS.Classes.AdministrativeAreal2DGeometryCalculationResult administrativeAreal2DGeometryCalculationResult);

Parameters

administrativeAreal2D AdministrativeAreal2D

The source administrative areal 2D object.

administrativeAreal2DGeometryCalculationResult AdministrativeAreal2DGeometryCalculationResult

The target geometry calculation result object.

AdministrativeAreal2DGeometryCalculationResultRelation(AdministrativeAreal2DGeometryCalculationResultRelation) Constructor

Initializes a new instance of the AdministrativeAreal2DGeometryCalculationResultRelation class by copying another relation instance.

public AdministrativeAreal2DGeometryCalculationResultRelation(DiGi.GIS.Classes.AdministrativeAreal2DGeometryCalculationResultRelation building2DGeometryCalculationResultRelation);

Parameters

building2DGeometryCalculationResultRelation AdministrativeAreal2DGeometryCalculationResultRelation

The existing relation instance to copy from.

AdministrativeAreal2DGeometryCalculationResultRelation(JsonObject) Constructor

Initializes a new instance of the AdministrativeAreal2DGeometryCalculationResultRelation class from a JSON object.

public AdministrativeAreal2DGeometryCalculationResultRelation(System.Text.Json.Nodes.JsonObject jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the relation data.

AdministrativeAreal2DOccupancyCalculationResultRelation Class

Represents a one-to-one directional relation between an administrative areal 2D and an occupancy calculation result.

public class AdministrativeAreal2DOccupancyCalculationResultRelation : DiGi.Core.Relation.Classes.OneToOneDirectionalRelation<DiGi.GIS.Classes.AdministrativeAreal2D, DiGi.GIS.Classes.OccupancyCalculationResult>, DiGi.GIS.Interfaces.IGISRelation, DiGi.Core.Relation.Interfaces.IRelation, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Relation.Classes.RelationDiGi.Core.Relation.Classes.Relation<AdministrativeAreal2D,OccupancyCalculationResult>DiGi.Core.Relation.Classes.OneToOneRelation<AdministrativeAreal2D,OccupancyCalculationResult>DiGi.Core.Relation.Classes.OneToOneDirectionalRelation<AdministrativeAreal2D,OccupancyCalculationResult> → AdministrativeAreal2DOccupancyCalculationResultRelation

Implements IGISRelation, DiGi.Core.Relation.Interfaces.IRelation, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObject

Constructors

AdministrativeAreal2DOccupancyCalculationResultRelation(AdministrativeAreal2D, OccupancyCalculationResult) Constructor

Initializes a new instance of the AdministrativeAreal2DOccupancyCalculationResultRelation class.

public AdministrativeAreal2DOccupancyCalculationResultRelation(DiGi.GIS.Classes.AdministrativeAreal2D administrativeAreal2D, DiGi.GIS.Classes.OccupancyCalculationResult occupancyCalculationResult);

Parameters

administrativeAreal2D AdministrativeAreal2D

The administrative areal 2D entity.

occupancyCalculationResult OccupancyCalculationResult

The occupancy calculation result entity.

AdministrativeAreal2DOccupancyCalculationResultRelation(AdministrativeAreal2DOccupancyCalculationResultRelation) Constructor

Initializes a new instance of the AdministrativeAreal2DOccupancyCalculationResultRelation class by copying another instance.

public AdministrativeAreal2DOccupancyCalculationResultRelation(DiGi.GIS.Classes.AdministrativeAreal2DOccupancyCalculationResultRelation administrativeAreal2DOccupancyCalculationResultRelation);

Parameters

administrativeAreal2DOccupancyCalculationResultRelation AdministrativeAreal2DOccupancyCalculationResultRelation

The existing relation instance to copy from.

AdministrativeAreal2DOccupancyCalculationResultRelation(JsonObject) Constructor

Initializes a new instance of the AdministrativeAreal2DOccupancyCalculationResultRelation class from a JSON object.

public AdministrativeAreal2DOccupancyCalculationResultRelation(System.Text.Json.Nodes.JsonObject jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing relation data.

AdministrativeAreal2DStatisticalUnitsCalculcationRelation Class

Represents a one-to-one directional relation between an administrative areal 2D object and its statistical units calculation result.

public class AdministrativeAreal2DStatisticalUnitsCalculcationRelation : DiGi.Core.Relation.Classes.OneToOneDirectionalRelation<DiGi.GIS.Classes.AdministrativeAreal2D, DiGi.GIS.Classes.AdministrativeAreal2DStatisticalUnitsCalculcationResult>, DiGi.GIS.Interfaces.IGISRelation, DiGi.Core.Relation.Interfaces.IRelation, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Relation.Classes.RelationDiGi.Core.Relation.Classes.Relation<AdministrativeAreal2D,AdministrativeAreal2DStatisticalUnitsCalculcationResult>DiGi.Core.Relation.Classes.OneToOneRelation<AdministrativeAreal2D,AdministrativeAreal2DStatisticalUnitsCalculcationResult>DiGi.Core.Relation.Classes.OneToOneDirectionalRelation<AdministrativeAreal2D,AdministrativeAreal2DStatisticalUnitsCalculcationResult> → AdministrativeAreal2DStatisticalUnitsCalculcationRelation

Implements IGISRelation, DiGi.Core.Relation.Interfaces.IRelation, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObject

Constructors

AdministrativeAreal2DStatisticalUnitsCalculcationRelation(AdministrativeAreal2D, AdministrativeAreal2DStatisticalUnitsCalculcationResult) Constructor

Initializes a new instance of the AdministrativeAreal2DStatisticalUnitsCalculcationRelation class with specified source and target objects.

public AdministrativeAreal2DStatisticalUnitsCalculcationRelation(DiGi.GIS.Classes.AdministrativeAreal2D administrativeAreal2D, DiGi.GIS.Classes.AdministrativeAreal2DStatisticalUnitsCalculcationResult administrativeAreal2DStatisticalUnitsCalculcationResult);

Parameters

administrativeAreal2D AdministrativeAreal2D

The source administrative areal 2D object.

administrativeAreal2DStatisticalUnitsCalculcationResult AdministrativeAreal2DStatisticalUnitsCalculcationResult

The target statistical units calculation result object.

AdministrativeAreal2DStatisticalUnitsCalculcationRelation(AdministrativeAreal2DStatisticalUnitsCalculcationRelation) Constructor

Initializes a new instance of the AdministrativeAreal2DStatisticalUnitsCalculcationRelation class by copying another instance.

public AdministrativeAreal2DStatisticalUnitsCalculcationRelation(DiGi.GIS.Classes.AdministrativeAreal2DStatisticalUnitsCalculcationRelation administrativeAreal2DStatisticalUnitsCalculcationRelation);

Parameters

administrativeAreal2DStatisticalUnitsCalculcationRelation AdministrativeAreal2DStatisticalUnitsCalculcationRelation

The existing relation instance to copy from.

AdministrativeAreal2DStatisticalUnitsCalculcationRelation(JsonObject) Constructor

Initializes a new instance of the AdministrativeAreal2DStatisticalUnitsCalculcationRelation class from a JSON object.

public AdministrativeAreal2DStatisticalUnitsCalculcationRelation(System.Text.Json.Nodes.JsonObject jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing relation data.

AdministrativeAreal2DStatisticalUnitsCalculcationResult Class

Represents the result of calculating statistical units for a 2D administrative area.

public class AdministrativeAreal2DStatisticalUnitsCalculcationResult : DiGi.Core.Classes.GuidResult<DiGi.GIS.Classes.AdministrativeAreal2D>, DiGi.GIS.Interfaces.IGISUniqueResult, DiGi.Core.Interfaces.IUniqueResult, DiGi.Core.Interfaces.ISerializableResult, DiGi.Core.Interfaces.IResult, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject, DiGi.GIS.Interfaces.IGISUniqueObject, DiGi.GIS.Interfaces.IGISSerializableObject, DiGi.GIS.Interfaces.IGISObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Classes.UniqueObjectDiGi.Core.Classes.GuidObjectDiGi.Core.Classes.GuidResultDiGi.Core.Classes.GuidResult<AdministrativeAreal2D> → AdministrativeAreal2DStatisticalUnitsCalculcationResult

Implements IGISUniqueResult, DiGi.Core.Interfaces.IUniqueResult, DiGi.Core.Interfaces.ISerializableResult, DiGi.Core.Interfaces.IResult, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject, IGISUniqueObject, IGISSerializableObject, IGISObject

Constructors

AdministrativeAreal2DStatisticalUnitsCalculcationResult(AdministrativeAreal2DStatisticalUnitsCalculcationResult) Constructor

Initializes a new instance of the AdministrativeAreal2DStatisticalUnitsCalculcationResult class by copying another result instance.

public AdministrativeAreal2DStatisticalUnitsCalculcationResult(DiGi.GIS.Classes.AdministrativeAreal2DStatisticalUnitsCalculcationResult administrativeAreal2DStatisticalUnitsCalculcationResult);

Parameters

administrativeAreal2DStatisticalUnitsCalculcationResult AdministrativeAreal2DStatisticalUnitsCalculcationResult

The source result instance to copy from.

AdministrativeAreal2DStatisticalUnitsCalculcationResult(IEnumerable<StatisticalUnit>) Constructor

Initializes a new instance of the AdministrativeAreal2DStatisticalUnitsCalculcationResult class using a collection of statistical units.

public AdministrativeAreal2DStatisticalUnitsCalculcationResult(System.Collections.Generic.IEnumerable<DiGi.GIS.Classes.StatisticalUnit> statisticalUnits);

Parameters

statisticalUnits System.Collections.Generic.IEnumerable<StatisticalUnit>

The collection of statistical units to assign.

AdministrativeAreal2DStatisticalUnitsCalculcationResult(JsonObject) Constructor

Initializes a new instance of the AdministrativeAreal2DStatisticalUnitsCalculcationResult class from a JSON object.

public AdministrativeAreal2DStatisticalUnitsCalculcationResult(System.Text.Json.Nodes.JsonObject jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the result data.

Properties

AdministrativeAreal2DStatisticalUnitsCalculcationResult.StatisticalUnits Property

Gets or sets the collection of statistical units associated with this calculation result.

public System.Collections.Generic.IEnumerable<DiGi.GIS.Classes.StatisticalUnit> StatisticalUnits { get; private set; }

Property Value

System.Collections.Generic.IEnumerable<StatisticalUnit>

AdministrativeDivision Class

Represents an administrative division with a specific type, extending AdministrativeAreal2D

public class AdministrativeDivision : DiGi.GIS.Classes.AdministrativeAreal2D

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Classes.UniqueObjectDiGi.Core.Classes.GuidObjectGISGuidObject2DAreal2DAdministrativeAreal2D → AdministrativeDivision

Constructors

AdministrativeDivision(AdministrativeDivision) Constructor

Initializes a new instance of the AdministrativeDivision class as a deep copy of another AdministrativeDivision

public AdministrativeDivision(DiGi.GIS.Classes.AdministrativeDivision? administrativeDivision);

Parameters

administrativeDivision AdministrativeDivision

The AdministrativeDivision to copy, or null to create an empty instance

AdministrativeDivision(AdministrativeDivision, string) Constructor

Initializes a new instance of the AdministrativeDivision class as a copy of another AdministrativeDivision with a new code

public AdministrativeDivision(DiGi.GIS.Classes.AdministrativeDivision? administrativeDivision, string? code);

Parameters

administrativeDivision AdministrativeDivision

The AdministrativeDivision to copy, or null to create an empty instance

code System.String

The new code to assign to the copied division

AdministrativeDivision(Guid, string, string, PolygonalFace2D, AdministrativeDivisionType, string) Constructor

Initializes a new instance of the AdministrativeDivision class with all required properties

public AdministrativeDivision(System.Guid guid, string? reference, string? code, DiGi.Geometry.Planar.Classes.PolygonalFace2D? polygonalFace2D, DiGi.GIS.Enums.AdministrativeDivisionType administrativeDivisionType, string name);

Parameters

guid System.Guid

The unique identifier for the division

reference System.String

An optional reference string

code System.String

An optional code for the division

polygonalFace2D DiGi.Geometry.Planar.Classes.PolygonalFace2D

The 2D polygonal face geometry

administrativeDivisionType AdministrativeDivisionType

The type of the administrative division

name System.String

The name of the division

AdministrativeDivision(JsonObject) Constructor

Initializes a new instance of the AdministrativeDivision class from a JSON object

public AdministrativeDivision(System.Text.Json.Nodes.JsonObject? jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the division data

Properties

AdministrativeDivision.AdministrativeDivisionType Property

Gets the type of this administrative division (e.g., country, voivodeship, county, municipality)

public DiGi.GIS.Enums.AdministrativeDivisionType AdministrativeDivisionType { get; }

Property Value

AdministrativeDivisionType

AdministrativeSubdivision Class

Represents an administrative subdivision (e.g., city, village, colony) with optional occupancy data, extending AdministrativeAreal2D

public class AdministrativeSubdivision : DiGi.GIS.Classes.AdministrativeAreal2D

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Classes.UniqueObjectDiGi.Core.Classes.GuidObjectGISGuidObject2DAreal2DAdministrativeAreal2D → AdministrativeSubdivision

Constructors

AdministrativeSubdivision(AdministrativeSubdivision) Constructor

Initializes a new instance of the AdministrativeSubdivision class as a deep copy of another AdministrativeSubdivision

public AdministrativeSubdivision(DiGi.GIS.Classes.AdministrativeSubdivision? administrativeSubdivision);

Parameters

administrativeSubdivision AdministrativeSubdivision

The AdministrativeSubdivision to copy, or null to create an empty instance

AdministrativeSubdivision(AdministrativeSubdivision, string) Constructor

Initializes a new instance of the AdministrativeSubdivision class as a copy of another AdministrativeSubdivision with a new code

public AdministrativeSubdivision(DiGi.GIS.Classes.AdministrativeSubdivision? administrativeSubdivision, string? code);

Parameters

administrativeSubdivision AdministrativeSubdivision

The AdministrativeSubdivision to copy, or null to create an empty instance

code System.String

The new code to assign to the copied subdivision

AdministrativeSubdivision(Guid, string, string, PolygonalFace2D, AdministrativeSubdivisionType, string, Nullable<uint>) Constructor

Initializes a new instance of the AdministrativeSubdivision class with all required properties

public AdministrativeSubdivision(System.Guid guid, string? reference, string code, DiGi.Geometry.Planar.Classes.PolygonalFace2D? polygonalFace2D, DiGi.GIS.Enums.AdministrativeSubdivisionType administrativeSubdivisionType, string? name, System.Nullable<uint> occupancy);

Parameters

guid System.Guid

The unique identifier for the subdivision

reference System.String

An optional reference string

code System.String

A code for the subdivision

polygonalFace2D DiGi.Geometry.Planar.Classes.PolygonalFace2D

The 2D polygonal face geometry

administrativeSubdivisionType AdministrativeSubdivisionType

The type of the administrative subdivision

name System.String

An optional name for the subdivision

occupancy System.Nullable<System.UInt32>

An optional maximum occupancy value

AdministrativeSubdivision(JsonObject) Constructor

Initializes a new instance of the AdministrativeSubdivision class from a JSON object

public AdministrativeSubdivision(System.Text.Json.Nodes.JsonObject? jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the subdivision data

Properties

AdministrativeSubdivision.AdministrativeSubdivisionType Property

Gets the type of this administrative subdivision (e.g., city, village, colony, hamlet)

public DiGi.GIS.Enums.AdministrativeSubdivisionType AdministrativeSubdivisionType { get; }

Property Value

AdministrativeSubdivisionType

AdministrativeSubdivision.Occupancy Property

Gets the maximum occupancy of the subdivision

public System.Nullable<uint> Occupancy { get; }

Property Value

System.Nullable<System.UInt32>

Areal2D Class

Represents a two-dimensional areal object within the GIS coordinate system.

public abstract class Areal2D : DiGi.GIS.Classes.GISGuidObject2D

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Classes.UniqueObjectDiGi.Core.Classes.GuidObjectGISGuidObject2D → Areal2D

Derived
AdministrativeAreal2D
Building2D

Constructors

Areal2D(Areal2D) Constructor

Initializes a new instance of the Areal2D class by copying an existing Areal2D object.

public Areal2D(DiGi.GIS.Classes.Areal2D? areal2D);

Parameters

areal2D Areal2D

The source areal object to copy from.

Areal2D(Guid, string, PolygonalFace2D) Constructor

Initializes a new instance of the Areal2D class.

public Areal2D(System.Guid guid, string? reference, DiGi.Geometry.Planar.Classes.PolygonalFace2D? polygonalFace2D);

Parameters

guid System.Guid

The unique identifier for the object.

reference System.String

An optional reference string associated with the object.

polygonalFace2D DiGi.Geometry.Planar.Classes.PolygonalFace2D

The polygonal face that defines the geometry of the area.

Areal2D(JsonObject) Constructor

Initializes a new instance of the Areal2D class using data from a JSON object.

public Areal2D(System.Text.Json.Nodes.JsonObject? jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the initialization data.

Properties

Areal2D.PolygonalFace2D Property

Gets the polygonal face associated with this areal object.

public DiGi.Geometry.Planar.Classes.PolygonalFace2D? PolygonalFace2D { get; }

Property Value

DiGi.Geometry.Planar.Classes.PolygonalFace2D

Building2D Class

Represents a 2D building with storey count, phase, and functional classification, extending Areal2D

public class Building2D : DiGi.GIS.Classes.Areal2D

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Classes.UniqueObjectDiGi.Core.Classes.GuidObjectGISGuidObject2DAreal2D → Building2D

Constructors

Building2D(Building2D) Constructor

Initializes a new instance of the Building2D class as a deep copy of another Building2D

public Building2D(DiGi.GIS.Classes.Building2D building2D);

Parameters

building2D Building2D

The Building2D to copy, or null to create an empty instance

Building2D(Guid, string, PolygonalFace2D, ushort, Nullable<BuildingPhase>, Nullable<BuildingGeneralFunction>, IEnumerable<BuildingSpecificFunction>) Constructor

Initializes a new instance of the Building2D class with all required properties

public Building2D(System.Guid guid, string? reference, DiGi.Geometry.Planar.Classes.PolygonalFace2D? polygonalFace2D, ushort storeys, System.Nullable<DiGi.GIS.Enums.BuildingPhase> buildingPhase, System.Nullable<DiGi.GIS.Enums.BuildingGeneralFunction> buildingGeneralFunction, System.Collections.Generic.IEnumerable<DiGi.GIS.Enums.BuildingSpecificFunction> buildingSpecificFunctions);

Parameters

guid System.Guid

The unique identifier for the building

reference System.String

An optional reference string

polygonalFace2D DiGi.Geometry.Planar.Classes.PolygonalFace2D

The 2D polygonal face geometry

storeys System.UInt16

The number of storeys

buildingPhase System.Nullable<BuildingPhase>

The current phase of the building

buildingGeneralFunction System.Nullable<BuildingGeneralFunction>

The general function of the building

buildingSpecificFunctions System.Collections.Generic.IEnumerable<BuildingSpecificFunction>

The specific functions of the building

Building2D(JsonObject) Constructor

Initializes a new instance of the Building2D class from a JSON object

public Building2D(System.Text.Json.Nodes.JsonObject? jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the building data

Properties

Building2D.BuildingGeneralFunction Property

Gets the general function of the building (e.g., residential, commercial, industrial, educational)

public System.Nullable<DiGi.GIS.Enums.BuildingGeneralFunction> BuildingGeneralFunction { get; }

Property Value

System.Nullable<BuildingGeneralFunction>

Building2D.BuildingPhase Property

Gets the current phase of the building (e.g., occupied, unoccupied, under construction, destroyed)

public System.Nullable<DiGi.GIS.Enums.BuildingPhase> BuildingPhase { get; }

Property Value

System.Nullable<BuildingPhase>

Building2D.BuildingSpecificFunctions Property

Gets the set of specific functions for this building (e.g., single_family_building, hospital, school)

public System.Collections.Generic.HashSet<DiGi.GIS.Enums.BuildingSpecificFunction> BuildingSpecificFunctions { get; }

Property Value

System.Collections.Generic.HashSet<BuildingSpecificFunction>

Building2D.Storeys Property

Gets the number of storeys in the building

public ushort Storeys { get; }

Property Value

System.UInt16

Methods

Building2D.Clone() Method

Creates a deep copy of this Building2D instance

public override DiGi.Core.Interfaces.ISerializableObject? Clone();

Implements Clone()

Returns

DiGi.Core.Interfaces.ISerializableObject
A new Building2D instance with the same data

Building2DConstructionDateCalculationResult Class

Represents the result of a construction date calculation for a 2D building.

public abstract class Building2DConstructionDateCalculationResult : DiGi.Core.Classes.GuidResult<DiGi.GIS.Classes.Building2D>, DiGi.GIS.Interfaces.IConstructionDateCalculationResult, DiGi.GIS.Interfaces.IGISGuidResult, DiGi.GIS.Interfaces.IGISUniqueResult, DiGi.Core.Interfaces.IUniqueResult, DiGi.Core.Interfaces.ISerializableResult, DiGi.Core.Interfaces.IResult, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject, DiGi.GIS.Interfaces.IGISUniqueObject, DiGi.GIS.Interfaces.IGISSerializableObject, DiGi.GIS.Interfaces.IGISObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Classes.UniqueObjectDiGi.Core.Classes.GuidObjectDiGi.Core.Classes.GuidResultDiGi.Core.Classes.GuidResult<Building2D> → Building2DConstructionDateCalculationResult

Derived
Building2DMachineLearningConstructionDateCalculationResult
Building2DManualConstructionDateCalculationResult

Implements IConstructionDateCalculationResult, IGISGuidResult, IGISUniqueResult, DiGi.Core.Interfaces.IUniqueResult, DiGi.Core.Interfaces.ISerializableResult, DiGi.Core.Interfaces.IResult, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject, IGISUniqueObject, IGISSerializableObject, IGISObject

Constructors

Building2DConstructionDateCalculationResult() Constructor

Initializes a new instance of the Building2DConstructionDateCalculationResult class.

public Building2DConstructionDateCalculationResult();

Building2DConstructionDateCalculationResult(Building2DConstructionDateCalculationResult) Constructor

Initializes a new instance of the Building2DConstructionDateCalculationResult class by copying another result instance.

public Building2DConstructionDateCalculationResult(DiGi.GIS.Classes.Building2DConstructionDateCalculationResult? building2DConstructionDateCalculationResult);

Parameters

building2DConstructionDateCalculationResult Building2DConstructionDateCalculationResult

The source calculation result to copy from.

Building2DConstructionDateCalculationResult(DateTime) Constructor

Initializes a new instance of the Building2DConstructionDateCalculationResult class with a specified date and time.

public Building2DConstructionDateCalculationResult(System.DateTime dateTime);

Parameters

dateTime System.DateTime

The construction date and time.

Building2DConstructionDateCalculationResult(JsonObject) Constructor

Initializes a new instance of the Building2DConstructionDateCalculationResult class from a JSON object.

public Building2DConstructionDateCalculationResult(System.Text.Json.Nodes.JsonObject? jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the result data.

Properties

Building2DConstructionDateCalculationResult.DateTime Property

Gets the calculated construction date and time.

public System.DateTime DateTime { get; }

Implements DateTime

Property Value

System.DateTime

Building2DConstructionDateCalculationResultRelation Class

Represents a one-to-many directional relation between a Building2D entity and its associated Building2DConstructionDateCalculationResult entities.

public class Building2DConstructionDateCalculationResultRelation : DiGi.Core.Relation.Classes.OneToManyDirectionalRelation<DiGi.GIS.Classes.Building2D, DiGi.GIS.Classes.Building2DConstructionDateCalculationResult>, DiGi.GIS.Interfaces.IGISRelation, DiGi.Core.Relation.Interfaces.IRelation, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Relation.Classes.RelationDiGi.Core.Relation.Classes.Relation<Building2D,Building2DConstructionDateCalculationResult>DiGi.Core.Relation.Classes.OneToManyRelation<Building2D,Building2DConstructionDateCalculationResult>DiGi.Core.Relation.Classes.OneToManyDirectionalRelation<Building2D,Building2DConstructionDateCalculationResult> → Building2DConstructionDateCalculationResultRelation

Implements IGISRelation, DiGi.Core.Relation.Interfaces.IRelation, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObject

Constructors

Building2DConstructionDateCalculationResultRelation(Building2D, IEnumerable<Building2DConstructionDateCalculationResult>) Constructor

Initializes a new instance of the Building2DConstructionDateCalculationResultRelation class with a specific building and a collection of calculation results.

public Building2DConstructionDateCalculationResultRelation(DiGi.GIS.Classes.Building2D building2D, System.Collections.Generic.IEnumerable<DiGi.GIS.Classes.Building2DConstructionDateCalculationResult> constructionDateCalculationResults);

Parameters

building2D Building2D

The parent Building2D entity.

constructionDateCalculationResults System.Collections.Generic.IEnumerable<Building2DConstructionDateCalculationResult>

The collection of associated construction date calculation results.

Building2DConstructionDateCalculationResultRelation(Building2DConstructionDateCalculationResultRelation) Constructor

Initializes a new instance of the Building2DConstructionDateCalculationResultRelation class by copying another instance.

public Building2DConstructionDateCalculationResultRelation(DiGi.GIS.Classes.Building2DConstructionDateCalculationResultRelation building2DConstructionDateCalculationResultRelation);

Parameters

building2DConstructionDateCalculationResultRelation Building2DConstructionDateCalculationResultRelation

The existing relation instance to copy from.

Building2DConstructionDateCalculationResultRelation(JsonObject) Constructor

Initializes a new instance of the Building2DConstructionDateCalculationResultRelation class from a JSON object.

public Building2DConstructionDateCalculationResultRelation(System.Text.Json.Nodes.JsonObject jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing relation data.

Building2DExternalReferenceGuidResult Class

Represents a result object containing the GUID for an external reference of a 2D building.

public abstract class Building2DExternalReferenceGuidResult : DiGi.Core.Classes.ExternalReferenceGuidResult<DiGi.GIS.Classes.Building2D, DiGi.Core.Classes.InstanceRelatedExternalReference>, DiGi.GIS.Interfaces.IGISGuidResult, DiGi.GIS.Interfaces.IGISUniqueResult, DiGi.Core.Interfaces.IUniqueResult, DiGi.Core.Interfaces.ISerializableResult, DiGi.Core.Interfaces.IResult, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject, DiGi.GIS.Interfaces.IGISUniqueObject, DiGi.GIS.Interfaces.IGISSerializableObject, DiGi.GIS.Interfaces.IGISObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Classes.UniqueObjectDiGi.Core.Classes.GuidObjectDiGi.Core.Classes.GuidResultDiGi.Core.Classes.GuidResult<Building2D>DiGi.Core.Classes.ExternalReferenceGuidResult<Building2D,DiGi.Core.Classes.InstanceRelatedExternalReference> → Building2DExternalReferenceGuidResult

Implements IGISGuidResult, IGISUniqueResult, DiGi.Core.Interfaces.IUniqueResult, DiGi.Core.Interfaces.ISerializableResult, DiGi.Core.Interfaces.IResult, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject, IGISUniqueObject, IGISSerializableObject, IGISObject

Constructors

Building2DExternalReferenceGuidResult(InstanceRelatedExternalReference) Constructor

Initializes a new instance of the Building2DExternalReferenceGuidResult class using the specified external reference.

public Building2DExternalReferenceGuidResult(DiGi.Core.Classes.InstanceRelatedExternalReference reference);

Parameters

reference DiGi.Core.Classes.InstanceRelatedExternalReference

The external reference used to initialize the result.

Building2DExternalReferenceGuidResult(Building2DExternalReferenceGuidResult) Constructor

Initializes a new instance of the Building2DExternalReferenceGuidResult class by copying another instance.

public Building2DExternalReferenceGuidResult(DiGi.GIS.Classes.Building2DExternalReferenceGuidResult building2DExternalReferenceGuidResult);

Parameters

building2DExternalReferenceGuidResult Building2DExternalReferenceGuidResult

The source result instance to copy from.

Building2DExternalReferenceGuidResult(JsonObject) Constructor

Initializes a new instance of the Building2DExternalReferenceGuidResult class from the specified JSON object.

public Building2DExternalReferenceGuidResult(System.Text.Json.Nodes.JsonObject jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the result data.

Building2DExternalReferenceUniqueResultRelation Class

Represents a one-to-many bidirectional relation between a Building2D entity and its unique external reference results.

public class Building2DExternalReferenceUniqueResultRelation : DiGi.Core.Relation.Classes.OneToManyBidirectionalRelation<DiGi.GIS.Classes.Building2D, DiGi.GIS.Classes.Building2DExternalReferenceGuidResult>, DiGi.GIS.Interfaces.IGISRelation, DiGi.Core.Relation.Interfaces.IRelation, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Relation.Classes.RelationDiGi.Core.Relation.Classes.Relation<Building2D,Building2DExternalReferenceGuidResult>DiGi.Core.Relation.Classes.OneToManyRelation<Building2D,Building2DExternalReferenceGuidResult>DiGi.Core.Relation.Classes.OneToManyBidirectionalRelation<Building2D,Building2DExternalReferenceGuidResult> → Building2DExternalReferenceUniqueResultRelation

Implements IGISRelation, DiGi.Core.Relation.Interfaces.IRelation, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObject

Constructors

Building2DExternalReferenceUniqueResultRelation(Building2D, IEnumerable<Building2DExternalReferenceGuidResult>) Constructor

Initializes a new instance of the Building2DExternalReferenceUniqueResultRelation class.

public Building2DExternalReferenceUniqueResultRelation(DiGi.GIS.Classes.Building2D building2D, System.Collections.Generic.IEnumerable<DiGi.GIS.Classes.Building2DExternalReferenceGuidResult> building2DExternalReferenceUniqueResults);

Parameters

building2D Building2D

The building entity associated with this relation.

building2DExternalReferenceUniqueResults System.Collections.Generic.IEnumerable<Building2DExternalReferenceGuidResult>

The collection of unique external reference results associated with the building.

Building2DExternalReferenceUniqueResultRelation(Building2DExternalReferenceUniqueResultRelation) Constructor

Initializes a new instance of the Building2DExternalReferenceUniqueResultRelation class by copying an existing relation.

public Building2DExternalReferenceUniqueResultRelation(DiGi.GIS.Classes.Building2DExternalReferenceUniqueResultRelation ortoDatasCalculationResultRelation);

Parameters

ortoDatasCalculationResultRelation Building2DExternalReferenceUniqueResultRelation

The source relation to copy from.

Building2DExternalReferenceUniqueResultRelation(JsonObject) Constructor

Initializes a new instance of the Building2DExternalReferenceUniqueResultRelation class from a JSON object.

public Building2DExternalReferenceUniqueResultRelation(System.Text.Json.Nodes.JsonObject jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the relation data.

Building2DGeometryCalculationResult Class

Represents the result of geometry calculations for a 2D building.

public class Building2DGeometryCalculationResult : DiGi.Core.Classes.GuidResult<DiGi.GIS.Classes.Building2D>, DiGi.GIS.Interfaces.IGISGuidResult, DiGi.GIS.Interfaces.IGISUniqueResult, DiGi.Core.Interfaces.IUniqueResult, DiGi.Core.Interfaces.ISerializableResult, DiGi.Core.Interfaces.IResult, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject, DiGi.GIS.Interfaces.IGISUniqueObject, DiGi.GIS.Interfaces.IGISSerializableObject, DiGi.GIS.Interfaces.IGISObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Classes.UniqueObjectDiGi.Core.Classes.GuidObjectDiGi.Core.Classes.GuidResultDiGi.Core.Classes.GuidResult<Building2D> → Building2DGeometryCalculationResult

Implements IGISGuidResult, IGISUniqueResult, DiGi.Core.Interfaces.IUniqueResult, DiGi.Core.Interfaces.ISerializableResult, DiGi.Core.Interfaces.IResult, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject, IGISUniqueObject, IGISSerializableObject, IGISObject

Constructors

Building2DGeometryCalculationResult(BoundingBox2D, Rectangle2D, Point2D, Point2D, double, double, double, double, double, double) Constructor

Initializes a new instance of the Building2DGeometryCalculationResult class.

public Building2DGeometryCalculationResult(DiGi.Geometry.Planar.Classes.BoundingBox2D? boundingBox, DiGi.Geometry.Planar.Classes.Rectangle2D? rectangle, DiGi.Geometry.Planar.Classes.Point2D? centroid, DiGi.Geometry.Planar.Classes.Point2D? internalPoint, double thinnessRatio, double rectangularity, double area, double perimeter, double rectangularThinnessRatio, double isoperimetricRatio);

Parameters

boundingBox DiGi.Geometry.Planar.Classes.BoundingBox2D

The bounding box of the building.

rectangle DiGi.Geometry.Planar.Classes.Rectangle2D

The rectangle representation of the building.

centroid DiGi.Geometry.Planar.Classes.Point2D

The centroid point of the building.

internalPoint DiGi.Geometry.Planar.Classes.Point2D

The internal point within the building.

thinnessRatio System.Double

The thinness ratio of the building.

rectangularity System.Double

The rectangularity measure of the building.

area System.Double

The area of the building.

perimeter System.Double

The perimeter of the building.

rectangularThinnessRatio System.Double

The rectangular thinness ratio of the building.

isoperimetricRatio System.Double

The isoperimetric ratio of the building.

Building2DGeometryCalculationResult(Building2DGeometryCalculationResult) Constructor

Initializes a new instance of the Building2DGeometryCalculationResult class as a copy.

public Building2DGeometryCalculationResult(DiGi.GIS.Classes.Building2DGeometryCalculationResult? building2DGeometryCalculationResult);

Parameters

building2DGeometryCalculationResult Building2DGeometryCalculationResult

The source result object to copy from.

Building2DGeometryCalculationResult(JsonObject) Constructor

Initializes a new instance of the Building2DGeometryCalculationResult class from a JSON object.

public Building2DGeometryCalculationResult(System.Text.Json.Nodes.JsonObject? jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the calculation result data.

Properties

Building2DGeometryCalculationResult.Area Property

Gets the area of the building.

public double Area { get; }

Property Value

System.Double

Building2DGeometryCalculationResult.BoundingBox Property

Gets the bounding box of the building.

public DiGi.Geometry.Planar.Classes.BoundingBox2D? BoundingBox { get; }

Property Value

DiGi.Geometry.Planar.Classes.BoundingBox2D

Building2DGeometryCalculationResult.Centroid Property

Gets the centroid point of the building.

public DiGi.Geometry.Planar.Classes.Point2D? Centroid { get; }

Property Value

DiGi.Geometry.Planar.Classes.Point2D

Building2DGeometryCalculationResult.InternalPoint Property

Gets the internal point within the building.

public DiGi.Geometry.Planar.Classes.Point2D? InternalPoint { get; }

Property Value

DiGi.Geometry.Planar.Classes.Point2D

Building2DGeometryCalculationResult.IsoperimetricRatio Property

Gets the isoperimetric ratio of the building.

public double IsoperimetricRatio { get; }

Property Value

System.Double

Building2DGeometryCalculationResult.Perimeter Property

Gets the perimeter of the building.

public double Perimeter { get; }

Property Value

System.Double

Building2DGeometryCalculationResult.Rectangle2D Property

Gets the rectangle representation of the building.

public DiGi.Geometry.Planar.Classes.Rectangle2D? Rectangle2D { get; }

Property Value

DiGi.Geometry.Planar.Classes.Rectangle2D

Building2DGeometryCalculationResult.Rectangularity Property

Gets the rectangularity measure of the building.

public double Rectangularity { get; }

Property Value

System.Double

Building2DGeometryCalculationResult.RectangularThinnessRatio Property

Gets the rectangular thinness ratio of the building.

public double RectangularThinnessRatio { get; }

Property Value

System.Double

Building2DGeometryCalculationResult.ThinnessRatio Property

Gets the thinness ratio of the building.

public double ThinnessRatio { get; }

Property Value

System.Double

Building2DGeometryCalculationResultRelation Class

Represents a one-to-one directional relation between a Building2D entity and its associated Building2DGeometryCalculationResult.

public class Building2DGeometryCalculationResultRelation : DiGi.Core.Relation.Classes.OneToOneDirectionalRelation<DiGi.GIS.Classes.Building2D, DiGi.GIS.Classes.Building2DGeometryCalculationResult>, DiGi.GIS.Interfaces.IGISRelation, DiGi.Core.Relation.Interfaces.IRelation, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Relation.Classes.RelationDiGi.Core.Relation.Classes.Relation<Building2D,Building2DGeometryCalculationResult>DiGi.Core.Relation.Classes.OneToOneRelation<Building2D,Building2DGeometryCalculationResult>DiGi.Core.Relation.Classes.OneToOneDirectionalRelation<Building2D,Building2DGeometryCalculationResult> → Building2DGeometryCalculationResultRelation

Implements IGISRelation, DiGi.Core.Relation.Interfaces.IRelation, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObject

Constructors

Building2DGeometryCalculationResultRelation(Building2D, Building2DGeometryCalculationResult) Constructor

Initializes a new instance of the Building2DGeometryCalculationResultRelation class with the specified building and geometry calculation result.

public Building2DGeometryCalculationResultRelation(DiGi.GIS.Classes.Building2D building2D, DiGi.GIS.Classes.Building2DGeometryCalculationResult building2DGeometryCalculationResult);

Parameters

building2D Building2D

The source Building2D entity.

building2DGeometryCalculationResult Building2DGeometryCalculationResult

The target Building2DGeometryCalculationResult entity.

Building2DGeometryCalculationResultRelation(Building2DGeometryCalculationResultRelation) Constructor

Initializes a new instance of the Building2DGeometryCalculationResultRelation class by copying an existing relation.

public Building2DGeometryCalculationResultRelation(DiGi.GIS.Classes.Building2DGeometryCalculationResultRelation building2DGeometryCalculationResultRelation);

Parameters

building2DGeometryCalculationResultRelation Building2DGeometryCalculationResultRelation

The source relation to copy from.

Building2DGeometryCalculationResultRelation(JsonObject) Constructor

Initializes a new instance of the Building2DGeometryCalculationResultRelation class from a JSON object.

public Building2DGeometryCalculationResultRelation(System.Text.Json.Nodes.JsonObject jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the relation data.

Building2DMachineLearningConstructionDateCalculationResult Class

Represents the result of a construction date calculation for a 2D building using machine learning.

public class Building2DMachineLearningConstructionDateCalculationResult : DiGi.GIS.Classes.Building2DConstructionDateCalculationResult

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Classes.UniqueObjectDiGi.Core.Classes.GuidObjectDiGi.Core.Classes.GuidResultDiGi.Core.Classes.GuidResult<Building2D>Building2DConstructionDateCalculationResult → Building2DMachineLearningConstructionDateCalculationResult

Constructors

Building2DMachineLearningConstructionDateCalculationResult() Constructor

Initializes a new instance of the Building2DMachineLearningConstructionDateCalculationResult class.

public Building2DMachineLearningConstructionDateCalculationResult();

Building2DMachineLearningConstructionDateCalculationResult(Building2DMachineLearningConstructionDateCalculationResult) Constructor

Initializes a new instance of the Building2DMachineLearningConstructionDateCalculationResult class by copying another instance.

public Building2DMachineLearningConstructionDateCalculationResult(DiGi.GIS.Classes.Building2DMachineLearningConstructionDateCalculationResult building2DMachineLearningConstructionDateCalculationResult);

Parameters

building2DMachineLearningConstructionDateCalculationResult Building2DMachineLearningConstructionDateCalculationResult

The source instance to copy from.

Building2DMachineLearningConstructionDateCalculationResult(DateTime) Constructor

Initializes a new instance of the Building2DMachineLearningConstructionDateCalculationResult class with the specified date and time.

public Building2DMachineLearningConstructionDateCalculationResult(System.DateTime dateTime);

Parameters

dateTime System.DateTime

The construction date and time.

Building2DMachineLearningConstructionDateCalculationResult(JsonObject) Constructor

Initializes a new instance of the Building2DMachineLearningConstructionDateCalculationResult class from the specified JSON object.

public Building2DMachineLearningConstructionDateCalculationResult(System.Text.Json.Nodes.JsonObject jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the calculation result data.

Building2DManualConstructionDateCalculationResult Class

Represents the result of a manual construction date calculation for a 2D building.

public class Building2DManualConstructionDateCalculationResult : DiGi.GIS.Classes.Building2DConstructionDateCalculationResult

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Classes.UniqueObjectDiGi.Core.Classes.GuidObjectDiGi.Core.Classes.GuidResultDiGi.Core.Classes.GuidResult<Building2D>Building2DConstructionDateCalculationResult → Building2DManualConstructionDateCalculationResult

Constructors

Building2DManualConstructionDateCalculationResult() Constructor

Initializes a new instance of the Building2DManualConstructionDateCalculationResult class.

public Building2DManualConstructionDateCalculationResult();

Building2DManualConstructionDateCalculationResult(Building2DManualConstructionDateCalculationResult) Constructor

Initializes a new instance of the Building2DManualConstructionDateCalculationResult class by copying an existing instance.

public Building2DManualConstructionDateCalculationResult(DiGi.GIS.Classes.Building2DManualConstructionDateCalculationResult building2DManualConstructionDateCalculationResult);

Parameters

building2DManualConstructionDateCalculationResult Building2DManualConstructionDateCalculationResult

The source instance to copy from.

Building2DManualConstructionDateCalculationResult(DateTime) Constructor

Initializes a new instance of the Building2DManualConstructionDateCalculationResult class using the specified date and time.

public Building2DManualConstructionDateCalculationResult(System.DateTime dateTime);

Parameters

dateTime System.DateTime

The date and time to be used for the construction date calculation result.

Building2DManualConstructionDateCalculationResult(JsonObject) Constructor

Initializes a new instance of the Building2DManualConstructionDateCalculationResult class from a JSON object.

public Building2DManualConstructionDateCalculationResult(System.Text.Json.Nodes.JsonObject jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the construction date calculation result data.

Building2DOccupancyCalculationResultRelation Class

Represents a one-to-one directional relation between a Building2D entity and an OccupancyCalculationResult entity.

public class Building2DOccupancyCalculationResultRelation : DiGi.Core.Relation.Classes.OneToOneDirectionalRelation<DiGi.GIS.Classes.Building2D, DiGi.GIS.Classes.OccupancyCalculationResult>, DiGi.GIS.Interfaces.IGISRelation, DiGi.Core.Relation.Interfaces.IRelation, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Relation.Classes.RelationDiGi.Core.Relation.Classes.Relation<Building2D,OccupancyCalculationResult>DiGi.Core.Relation.Classes.OneToOneRelation<Building2D,OccupancyCalculationResult>DiGi.Core.Relation.Classes.OneToOneDirectionalRelation<Building2D,OccupancyCalculationResult> → Building2DOccupancyCalculationResultRelation

Implements IGISRelation, DiGi.Core.Relation.Interfaces.IRelation, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObject

Constructors

Building2DOccupancyCalculationResultRelation(Building2D, OccupancyCalculationResult) Constructor

Initializes a new instance of the Building2DOccupancyCalculationResultRelation class with the specified building and occupancy calculation result.

public Building2DOccupancyCalculationResultRelation(DiGi.GIS.Classes.Building2D building2D, DiGi.GIS.Classes.OccupancyCalculationResult occupancyCalculationResult);

Parameters

building2D Building2D

The Building2D entity involved in the relation.

occupancyCalculationResult OccupancyCalculationResult

The OccupancyCalculationResult entity involved in the relation.

Building2DOccupancyCalculationResultRelation(Building2DOccupancyCalculationResultRelation) Constructor

Initializes a new instance of the Building2DOccupancyCalculationResultRelation class by copying an existing relation.

public Building2DOccupancyCalculationResultRelation(DiGi.GIS.Classes.Building2DOccupancyCalculationResultRelation building2DOccupancyCalculationResultRelation);

Parameters

building2DOccupancyCalculationResultRelation Building2DOccupancyCalculationResultRelation

The source relation to copy from.

Building2DOccupancyCalculationResultRelation(JsonObject) Constructor

Initializes a new instance of the Building2DOccupancyCalculationResultRelation class using a JSON object.

public Building2DOccupancyCalculationResultRelation(System.Text.Json.Nodes.JsonObject jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the relation data.

Building2DYearBuiltPredictions Class

Stores and manages predicted year built data for buildings, extending SerializableObject

public class Building2DYearBuiltPredictions : DiGi.Core.Classes.SerializableObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObject → Building2DYearBuiltPredictions

Constructors

Building2DYearBuiltPredictions(Building2DYearBuiltPredictions) Constructor

Initializes a new instance of the Building2DYearBuiltPredictions class by copying another instance

public Building2DYearBuiltPredictions(DiGi.GIS.Classes.Building2DYearBuiltPredictions? building2DYearBuiltPredictions);

Parameters

building2DYearBuiltPredictions Building2DYearBuiltPredictions

The instance to copy

Building2DYearBuiltPredictions(string, IEnumerable<YearBuiltPrediction>) Constructor

Initializes a new instance of the Building2DYearBuiltPredictions class with a reference and a collection of year built predictions

public Building2DYearBuiltPredictions(string? reference, System.Collections.Generic.IEnumerable<DiGi.GIS.Classes.YearBuiltPrediction>? yearBuiltPredictions);

Parameters

reference System.String

An optional reference string

yearBuiltPredictions System.Collections.Generic.IEnumerable<YearBuiltPrediction>

An optional collection of YearBuiltPrediction objects

Building2DYearBuiltPredictions(JsonObject) Constructor

Initializes a new instance of the Building2DYearBuiltPredictions class from a JSON object

public Building2DYearBuiltPredictions(System.Text.Json.Nodes.JsonObject? jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object to deserialize from

Properties

Building2DYearBuiltPredictions.Reference Property

Gets the reference string for this building

public string? Reference { get; }

Property Value

System.String

Building2DYearBuiltPredictions.this[ushort] Property

Gets the year built prediction for the specified year.

public DiGi.GIS.Classes.YearBuiltPrediction? this[ushort year] { get; }

Parameters

year System.UInt16

The year to look up.

Property Value

YearBuiltPrediction

Building2DYearBuiltPredictions.Years Property

Gets the list of years that have year built predictions

public System.Collections.Generic.List<ushort>? Years { get; }

Property Value

System.Collections.Generic.List<System.UInt16>

Methods

Building2DYearBuiltPredictions.GetYearBuiltPrediction(ushort) Method

Gets the year built prediction for the specified year, or the nearest lower year prediction if an exact match is not found.

public DiGi.GIS.Classes.YearBuiltPrediction? GetYearBuiltPrediction(ushort year);

Parameters

year System.UInt16

The year to look up.

Returns

YearBuiltPrediction
A YearBuiltPrediction object if a matching or lower value is found; otherwise, null.

Building2DYearBuiltPredictionsFile Class

Represents a file storage for Building2DYearBuiltPredictions data

public class Building2DYearBuiltPredictionsFile : DiGi.Core.IO.File.Classes.StorageFile<DiGi.GIS.Classes.Building2DYearBuiltPredictions>, DiGi.GIS.Interfaces.IGISObject, DiGi.Core.Interfaces.IObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.IO.File.Classes.FileDiGi.Core.IO.File.Classes.StorageFile<Building2DYearBuiltPredictions> → Building2DYearBuiltPredictionsFile

Implements IGISObject, DiGi.Core.Interfaces.IObject

Constructors

Building2DYearBuiltPredictionsFile(Building2DYearBuiltPredictionsFile) Constructor

Initializes a new instance of the Building2DYearBuiltPredictionsFile class by copying another instance

public Building2DYearBuiltPredictionsFile(DiGi.GIS.Classes.Building2DYearBuiltPredictionsFile? building2DYearBuiltPredictionsFile);

Parameters

building2DYearBuiltPredictionsFile Building2DYearBuiltPredictionsFile

The instance to copy

Building2DYearBuiltPredictionsFile(string) Constructor

Initializes a new instance of the Building2DYearBuiltPredictionsFile class with the specified file path

public Building2DYearBuiltPredictionsFile(string? path);

Parameters

path System.String

The file path

Building2DYearBuiltPredictionsFile(JsonObject) Constructor

Initializes a new instance of the Building2DYearBuiltPredictionsFile class from a JSON object

public Building2DYearBuiltPredictionsFile(System.Text.Json.Nodes.JsonObject? jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object to deserialize from

Methods

Building2DYearBuiltPredictionsFile.GetUniqueReference(Building2DYearBuiltPredictions) Method

Gets the unique reference for the specified building year built predictions

public override DiGi.Core.Classes.UniqueReference? GetUniqueReference(DiGi.GIS.Classes.Building2DYearBuiltPredictions? building2DYearBuiltPredictions);

Parameters

building2DYearBuiltPredictions Building2DYearBuiltPredictions

The building year built predictions to get the reference for

Returns

DiGi.Core.Classes.UniqueReference
The unique reference associated with the provided object, or null if the object is null.

Building2DYearBuiltPredictionsFile.GetUniqueReference(string) Method

Gets the unique reference for the specified reference string

public static DiGi.Core.Classes.UniqueReference? GetUniqueReference(string? reference);

Parameters

reference System.String

The reference string

Returns

DiGi.Core.Classes.UniqueReference
The unique reference created from the reference string, or null if the reference is null.

BuildingShapeSolver Class

Provides functionality to solve and determine the geometric shape of a building based on its 2D representation.

public class BuildingShapeSolver : DiGi.Core.Interfaces.IOneToOneSolver<DiGi.GIS.Classes.Building2D, DiGi.GIS.Enums.BuildingShape>, DiGi.Core.Interfaces.ISolver, DiGi.Core.Interfaces.IEvaluator

Inheritance System.Object → BuildingShapeSolver

Implements DiGi.Core.Interfaces.IOneToOneSolver<Building2D,BuildingShape>, DiGi.Core.Interfaces.ISolver, DiGi.Core.Interfaces.IEvaluator

Constructors

BuildingShapeSolver(double, double, double, double, double, double, double, double) Constructor

Initializes a new instance of the BuildingShapeSolver class.

public BuildingShapeSolver(double offset=1.0, double thinnessRatio=0.9, double microTolerance=1E-06, double macroTolerance=0.001, double areaFactor=0.5, double aspectRatioFactor=0.3, double rectangleThinnessRatioFactor=0.2, double scoreFactor=0.7);

Parameters

offset System.Double

The offset value used during geometry calculations. Must be greater than zero.

thinnessRatio System.Double

The ratio threshold used to determine thinness and shape classification. Must be within the range (0, 1].

microTolerance System.Double

The micro-level distance tolerance for geometric operations. Must be greater than zero.

macroTolerance System.Double

The macro-level distance tolerance for geometric operations. Must be greater than zero.

areaFactor System.Double

The weight applied to a candidate notch's normalized area when scoring notch significance. Must be finite and non-negative.

aspectRatioFactor System.Double

The weight applied to a candidate notch's aspect ratio when scoring notch significance. Must be finite and non-negative.

rectangleThinnessRatioFactor System.Double

The weight applied to a candidate notch's rectangular thinness ratio when scoring notch significance. Must be finite and non-negative.

scoreFactor System.Double

The fraction of the highest notch score used as the cut-off for retaining notches. Must be within the range (0, 1].

Exceptions

System.ArgumentOutOfRangeException
Thrown when any argument falls outside its permitted range.

Properties

BuildingShapeSolver.Input Property

Gets or sets the input building geometry to be analyzed.

public DiGi.GIS.Classes.Building2D? Input { set; }

Implements Input

Property Value

Building2D

BuildingShapeSolver.Output Property

Gets the determined shape of the building after solving.

public DiGi.GIS.Enums.BuildingShape Output { get; }

Implements Output

Property Value

BuildingShape

Methods

BuildingShapeSolver.FallbackShape(bool, double, double) Method

Resolves the shape for a footprint whose external edge fills its bounding rectangle and produced no significant notches.

private DiGi.GIS.Enums.BuildingShape FallbackShape(bool hasHoles, double squareThinnessRatio, double rectangleThinnessRatio);

Parameters

hasHoles System.Boolean

Indicates whether the footprint encloses one or more internal edges (courtyards).

squareThinnessRatio System.Double

The square thinness ratio of the external edge.

rectangleThinnessRatio System.Double

The rectangular thinness ratio of the external edge.

Returns

BuildingShape
The resolved BuildingShape.

BuildingShapeSolver.Solve() Method

Analyzes the input building geometry and determines its corresponding BuildingShape.

public bool Solve();

Implements Solve()

Returns

System.Boolean
True if a shape was successfully determined; otherwise, false.

ComparisonTableConversionOptions Class

Provides options for the conversion of comparison tables.

public class ComparisonTableConversionOptions : DiGi.GIS.Classes.TableConversionOptions

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Classes.SerializableOptionsTableConversionOptions → ComparisonTableConversionOptions

Constructors

ComparisonTableConversionOptions() Constructor

Initializes a new instance of the ComparisonTableConversionOptions class.

public ComparisonTableConversionOptions();

ComparisonTableConversionOptions(ComparisonTableConversionOptions) Constructor

Initializes a new instance of the ComparisonTableConversionOptions class using an existing instance of options.

public ComparisonTableConversionOptions(DiGi.GIS.Classes.ComparisonTableConversionOptions comparisonTableConversionOptions);

Parameters

comparisonTableConversionOptions ComparisonTableConversionOptions

The source conversion options to copy values from.

ComparisonTableConversionOptions(JsonObject) Constructor

Initializes a new instance of the ComparisonTableConversionOptions class from a JSON object.

public ComparisonTableConversionOptions(System.Text.Json.Nodes.JsonObject jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the conversion options.

Properties

ComparisonTableConversionOptions.IncludeOrtoDatasComparison Property

Gets or sets a value indicating whether to include orthodata comparisons in the table conversion.

public bool IncludeOrtoDatasComparison { get; set; }

Property Value

System.Boolean

DirectoryExtractOptions Class

Provides options for directory extraction processes, specifying source and destination paths along with file and directory naming conventions.

public class DirectoryExtractOptions : DiGi.GIS.Classes.ExtractOptions

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Classes.SerializableOptionsExtractOptions → DirectoryExtractOptions

Constructors

DirectoryExtractOptions() Constructor

Initializes a new instance of the DirectoryExtractOptions class.

public DirectoryExtractOptions();

DirectoryExtractOptions(string, string) Constructor

Initializes a new instance of the DirectoryExtractOptions class with specified source and destination paths.

public DirectoryExtractOptions(string? sourcePath, string? destionationDirectory);

Parameters

sourcePath System.String

The path to the source directory.

destionationDirectory System.String

The path to the destination directory.

DirectoryExtractOptions(JsonObject) Constructor

Initializes a new instance of the DirectoryExtractOptions class using a JSON object.

public DirectoryExtractOptions(System.Text.Json.Nodes.JsonObject? jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The System.Text.Json.Nodes.JsonObject containing the configuration options.

Properties

DirectoryExtractOptions.AdministrativeAreal2DFileName Property

Gets or sets the file name used for Administrative Areal 2D data extraction.

public string AdministrativeAreal2DFileName { get; set; }

Property Value

System.String

DirectoryExtractOptions.AdministrativeArealsDirectoryName Property

Gets or sets the directory name used for storing Administrative Areals data.

public string AdministrativeArealsDirectoryName { get; set; }

Property Value

System.String

DirectoryExtractOptions.Building2DFileName Property

Gets or sets the file name used for Building 2D data extraction.

public string Building2DFileName { get; set; }

Property Value

System.String

DirectoryExtractOptions.BuildingsDirectoryName Property

Gets or sets the directory name used for storing Buildings data.

public string BuildingsDirectoryName { get; set; }

Property Value

System.String

DirectoryExtractOptions.DestionationDirectory Property

Gets or sets the path to the destination directory where extracted data will be stored.

public string? DestionationDirectory { get; set; }

Property Value

System.String

DirectoryExtractOptions.SourcePath Property

Gets or sets the path to the source directory from which data is extracted.

public string? SourcePath { get; set; }

Property Value

System.String

DirectoryExtractOptions.UpdateExisting Property

Gets or sets a value indicating whether existing files in the destination directory should be updated.

public bool UpdateExisting { get; set; }

Property Value

System.Boolean

DirectoryNamesOptions Class

Provides options for specifying directory names.

public abstract class DirectoryNamesOptions : DiGi.Core.Classes.SerializableOptions

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Classes.SerializableOptions → DirectoryNamesOptions

Derived
OrtoDatasOptions

Constructors

DirectoryNamesOptions() Constructor

Initializes a new instance of the DirectoryNamesOptions class.

public DirectoryNamesOptions();

DirectoryNamesOptions(DirectoryNamesOptions) Constructor

Initializes a new instance of the DirectoryNamesOptions class based on an existing DirectoryNamesOptions instance.

public DirectoryNamesOptions(DiGi.GIS.Classes.DirectoryNamesOptions? directoryNamesOptions);

Parameters

directoryNamesOptions DirectoryNamesOptions

The source options to copy from.

DirectoryNamesOptions(JsonObject) Constructor

Initializes a new instance of the DirectoryNamesOptions class from a JSON object.

public DirectoryNamesOptions(System.Text.Json.Nodes.JsonObject? jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the options data.

Properties

DirectoryNamesOptions.DirectoryNames Property

Gets or sets the array of directory names.

public string[]? DirectoryNames { get; set; }

Property Value

System.String[]

DirectorySource Class

Represents a source that operates from a directory path

public class DirectorySource : DiGi.GIS.Classes.Source, DiGi.GIS.Interfaces.ISource, DiGi.GIS.Interfaces.IGISUniqueObject, DiGi.GIS.Interfaces.IGISSerializableObject, DiGi.GIS.Interfaces.IGISObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Classes.UniqueObjectDiGi.Core.Classes.GuidObjectSource → DirectorySource

Implements ISource, IGISUniqueObject, IGISSerializableObject, IGISObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject

Constructors

DirectorySource(DirectorySource) Constructor

Initializes a new instance of the DirectorySource class as a copy

public DirectorySource(DiGi.GIS.Classes.DirectorySource? directorySource);

Parameters

directorySource DirectorySource

The DirectorySource instance to copy from.

DirectorySource(string) Constructor

Initializes a new instance of the DirectorySource class

public DirectorySource(string? directory);

Parameters

directory System.String

The path to the directory.

DirectorySource(JsonObject) Constructor

Initializes a new instance of the DirectorySource class from a JSON object

public DirectorySource(System.Text.Json.Nodes.JsonObject? jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object used to initialize the instance.

Fields

DirectorySource.directory Field

The internal storage for the directory path.

public string? directory;

Field Value

System.String

Properties

DirectorySource.Directory Property

Directory path

public string? Directory { get; }

Property Value

System.String

ExtractOptions Class

Provides the base options used for data extraction processes.

public abstract class ExtractOptions : DiGi.Core.Classes.SerializableOptions, DiGi.GIS.Interfaces.IExtractOptions, DiGi.Core.Interfaces.IOptions, DiGi.Core.Interfaces.IObject, DiGi.GIS.Interfaces.IGISObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Classes.SerializableOptions → ExtractOptions

Derived
DirectoryExtractOptions

Implements IExtractOptions, DiGi.Core.Interfaces.IOptions, DiGi.Core.Interfaces.IObject, IGISObject

Constructors

ExtractOptions() Constructor

Initializes a new instance of the ExtractOptions class.

public ExtractOptions();

ExtractOptions(ExtractOptions) Constructor

Initializes a new instance of the ExtractOptions class using an existing options object.

public ExtractOptions(DiGi.GIS.Classes.ExtractOptions? extractOptions);

Parameters

extractOptions ExtractOptions

The source extraction options to copy from.

ExtractOptions(JsonObject) Constructor

Initializes a new instance of the ExtractOptions class from a JSON object.

public ExtractOptions(System.Text.Json.Nodes.JsonObject? jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the option values.

GISGuidObject2D Class

Represents an abstract base class for 2D GIS objects that are identified by a GUID.

public abstract class GISGuidObject2D : DiGi.Core.Classes.GuidObject, DiGi.GIS.Interfaces.IGISGuidObject2D, DiGi.GIS.Interfaces.IGISGuidObject, DiGi.GIS.Interfaces.IGISUniqueObject, DiGi.GIS.Interfaces.IGISSerializableObject, DiGi.GIS.Interfaces.IGISObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject, DiGi.Core.Interfaces.IGuidObject, DiGi.GIS.Interfaces.IGISUniqueObject2D

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Classes.UniqueObjectDiGi.Core.Classes.GuidObject → GISGuidObject2D

Derived
Areal2D

Implements IGISGuidObject2D, IGISGuidObject, IGISUniqueObject, IGISSerializableObject, IGISObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject, DiGi.Core.Interfaces.IGuidObject, IGISUniqueObject2D

Constructors

GISGuidObject2D(GISGuidObject2D) Constructor

Initializes a new instance of the GISGuidObject2D class as a copy of an existing object.

public GISGuidObject2D(DiGi.GIS.Classes.GISGuidObject2D? gISGuidObject2D);

Parameters

gISGuidObject2D GISGuidObject2D

The source object to copy from.

GISGuidObject2D(Guid, string) Constructor

Initializes a new instance of the GISGuidObject2D class.

public GISGuidObject2D(System.Guid guid, string? reference);

Parameters

guid System.Guid

The unique identifier for the object.

reference System.String

The reference string associated with the object.

GISGuidObject2D(JsonObject) Constructor

Initializes a new instance of the GISGuidObject2D class from a JSON object.

public GISGuidObject2D(System.Text.Json.Nodes.JsonObject? jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the data to initialize the instance.

Properties

GISGuidObject2D.Reference Property

Gets the reference identifier.

public string? Reference { get; }

Property Value

System.String

GISModel Class

Represents a GIS model that manages unique objects such as Building2D, AdministrativeAreal2D and their relations

public class GISModel : DiGi.Core.Relation.Classes.UniqueObjectRelationClusterModel<DiGi.GIS.Interfaces.IGISUniqueObject, DiGi.GIS.Interfaces.IGISRelation>, DiGi.GIS.Interfaces.IGISUniqueObject, DiGi.GIS.Interfaces.IGISSerializableObject, DiGi.GIS.Interfaces.IGISObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Classes.UniqueObjectDiGi.Core.Classes.GuidObjectDiGi.Core.Classes.GuidModelDiGi.Core.Relation.Classes.UniqueObjectRelationClusterModel<IGISUniqueObject,IGISRelation> → GISModel

Implements IGISUniqueObject, IGISSerializableObject, IGISObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject

Constructors

GISModel() Constructor

Initializes a new instance of the GISModel class

public GISModel();

GISModel(GISModel) Constructor

Initializes a new instance of the GISModel class by copying another instance

public GISModel(DiGi.GIS.Classes.GISModel? gISModel);

Parameters

gISModel GISModel

The instance to copy

GISModel(string, GISModel) Constructor

Initializes a new instance of the GISModel class with a reference and a source model

public GISModel(string? reference, DiGi.GIS.Classes.GISModel? gISModel);

Parameters

reference System.String

An optional reference string

gISModel GISModel

An optional GISModel to copy from

GISModel(string, ISource) Constructor

Initializes a new instance of the GISModel class with a reference and source

public GISModel(string? reference, DiGi.GIS.Interfaces.ISource? source);

Parameters

reference System.String

An optional reference string

source ISource

An optional source to update from

GISModel(JsonObject) Constructor

Initializes a new instance of the GISModel class from a JSON object

public GISModel(System.Text.Json.Nodes.JsonObject? jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object to deserialize from

Properties

GISModel.Reference Property

Gets the reference string for this GIS model

public string? Reference { get; }

Property Value

System.String

Methods

GISModel.Contains(AdministrativeAreal2D) Method

Determines whether the GIS model contains the specified administrative area.

public bool Contains(DiGi.GIS.Classes.AdministrativeAreal2D? administrativeAreal2D);

Parameters

administrativeAreal2D AdministrativeAreal2D

The administrative area to check for existence within the model.

Returns

System.Boolean
true if the administrative area is found in the model; otherwise, false.

GISModel.Contains(Building2D) Method

Determines whether the GIS model contains the specified building.

public bool Contains(DiGi.GIS.Classes.Building2D? building2D);

Parameters

building2D Building2D

The building to check for existence within the model.

Returns

System.Boolean
true if the building is found in the model; otherwise, false.

GISModel.GetObject<TGISGuidObject2D>(string) Method

Retrieves a GIS object of the specified type by its reference string.

public TGISGuidObject2D? GetObject<TGISGuidObject2D>(string? reference)
    where TGISGuidObject2D : DiGi.GIS.Classes.GISGuidObject2D;

Type parameters

TGISGuidObject2D

The type of GIS object to retrieve, which must derive from GISGuidObject2D.

Parameters

reference System.String

The reference string of the object to be retrieved.

Returns

TGISGuidObject2D
The matching GIS object if found; otherwise, null.

GISModel.GetObjects<TGISGuidObject2D>(IEnumerable<string>) Method

Retrieves a list of GIS objects of the specified type that match the provided references.

public System.Collections.Generic.List<TGISGuidObject2D>? GetObjects<TGISGuidObject2D>(System.Collections.Generic.IEnumerable<string?>? references)
    where TGISGuidObject2D : DiGi.GIS.Classes.GISGuidObject2D;

Type parameters

TGISGuidObject2D

The type of GIS object to retrieve, which must derive from GISGuidObject2D.

Parameters

references System.Collections.Generic.IEnumerable<System.String>

An enumerable collection of reference strings for the objects to be retrieved.

Returns

System.Collections.Generic.List<TGISGuidObject2D>
A System.Collections.Generic.List<> containing the matching GIS objects if found; otherwise, null.

GISModel.GetReferences<TGISGuidObject2D>() Method

Gets the references of all GIS objects of the specified type within the model.

public System.Collections.Generic.HashSet<string>? GetReferences<TGISGuidObject2D>()
    where TGISGuidObject2D : DiGi.GIS.Classes.GISGuidObject2D;

Type parameters

TGISGuidObject2D

The type of GIS object to retrieve references for, which must derive from GISGuidObject2D.

Returns

System.Collections.Generic.HashSet<System.String>
A System.Collections.Generic.HashSet<> containing the reference strings of the objects if they exist; otherwise, null.

GISModel.TryGetObject<TGISGuidObject2D>(string, TGISGuidObject2D) Method

Tries to retrieve a single GIS object of the specified type using its reference.

public bool TryGetObject<TGISGuidObject2D>(string? reference, out TGISGuidObject2D? gISGuidObject2D)
    where TGISGuidObject2D : DiGi.GIS.Classes.GISGuidObject2D;

Type parameters

TGISGuidObject2D

The type of the GIS object to retrieve, which must derive from GISGuidObject2D.

Parameters

reference System.String

The reference string used to identify the object to be retrieved.

gISGuidObject2D TGISGuidObject2D

When this method returns, contains the retrieved object if successful; otherwise, null.

Returns

System.Boolean
True if the object was successfully found and assigned to gISGuidObject2D; otherwise, false.

GISModel.TryGetObjects<TGISGuidObject2D>(IEnumerable<string>, List<TGISGuidObject2D>, int) Method

Tries to retrieve a list of GIS objects of the specified type that match the provided references.

public virtual bool TryGetObjects<TGISGuidObject2D>(System.Collections.Generic.IEnumerable<string?>? references, out System.Collections.Generic.List<TGISGuidObject2D>? gISGuidObject2Ds, int maxCount=int.MaxValue)
    where TGISGuidObject2D : DiGi.GIS.Classes.GISGuidObject2D;

Type parameters

TGISGuidObject2D

The type of GIS objects to retrieve, which must derive from GISGuidObject2D.

Parameters

references System.Collections.Generic.IEnumerable<System.String>

A collection of reference strings used to identify the objects to be retrieved.

gISGuidObject2Ds System.Collections.Generic.List<TGISGuidObject2D>

When this method returns, contains a list of the retrieved objects if successful; otherwise, null.

maxCount System.Int32

The maximum number of objects to retrieve from the model.

Returns

System.Boolean
True if one or more objects were successfully retrieved and assigned to gISGuidObject2Ds; otherwise, false.

GISModel.Update(AdministrativeAreal2D) Method

Updates the GIS model with the specified administrative area.

public bool Update(DiGi.GIS.Classes.AdministrativeAreal2D? administrativeAreal2D);

Parameters

administrativeAreal2D AdministrativeAreal2D

The AdministrativeAreal2D object to be updated.

Returns

System.Boolean
true if the update was successful; otherwise, false.

GISModel.Update(AdministrativeAreal2D, AdministrativeAreal2DGeometryCalculationResult) Method

Updates the GIS model with the specified administrative area and its geometry calculation result, establishing a relationship between them in the relation cluster.

public bool Update(DiGi.GIS.Classes.AdministrativeAreal2D? administrativeAreal2D, DiGi.GIS.Classes.AdministrativeAreal2DGeometryCalculationResult? administrativeAreal2DGeometryCalculationResult);

Parameters

administrativeAreal2D AdministrativeAreal2D

The AdministrativeAreal2D object to be updated.

administrativeAreal2DGeometryCalculationResult AdministrativeAreal2DGeometryCalculationResult

The AdministrativeAreal2DGeometryCalculationResult object to be associated with the administrative area.

Returns

System.Boolean
true if the update and relationship establishment were successful; otherwise, false.

GISModel.Update(AdministrativeAreal2D, AdministrativeAreal2DStatisticalUnitsCalculcationResult) Method

Updates the GIS model with the specified administrative area and its corresponding statistical units calculation result, establishing a relationship between them in the relation cluster.

public bool Update(DiGi.GIS.Classes.AdministrativeAreal2D? administrativeAreal2D, DiGi.GIS.Classes.AdministrativeAreal2DStatisticalUnitsCalculcationResult? administrativeAreal2DStatisticalUnitCalculcationResult);

Parameters

administrativeAreal2D AdministrativeAreal2D

The AdministrativeAreal2D object to be updated.

administrativeAreal2DStatisticalUnitCalculcationResult AdministrativeAreal2DStatisticalUnitsCalculcationResult

The AdministrativeAreal2DStatisticalUnitsCalculcationResult object to be associated with the administrative area.

Returns

System.Boolean
true if the update and relationship establishment were successful; otherwise, false.

GISModel.Update(AdministrativeAreal2D, OccupancyCalculationResult) Method

Updates the GIS model with the specified administrative area and its occupancy calculation result, establishing a relationship between them in the relation cluster.

public bool Update(DiGi.GIS.Classes.AdministrativeAreal2D? administrativeAreal2D, DiGi.GIS.Classes.OccupancyCalculationResult? occupancyCalculationResult);

Parameters

administrativeAreal2D AdministrativeAreal2D

The AdministrativeAreal2D object to be updated.

occupancyCalculationResult OccupancyCalculationResult

The OccupancyCalculationResult object to be associated with the administrative area.

Returns

System.Boolean
true if the update and relationship establishment were successful; otherwise, false.

GISModel.Update(AdministrativeAreal2D, IEnumerable<AdministrativeAreal2D>) Method

Updates the relationship between a specific administrative area and its associated collection of related administrative areas within the GIS model's relation cluster.

public bool Update(DiGi.GIS.Classes.AdministrativeAreal2D administrativeAreal2D, System.Collections.Generic.IEnumerable<DiGi.GIS.Classes.AdministrativeAreal2D> administrativeAreal2Ds);

Parameters

administrativeAreal2D AdministrativeAreal2D

The primary administrative area object to be updated.

administrativeAreal2Ds System.Collections.Generic.IEnumerable<AdministrativeAreal2D>

The collection of related administrative area objects to associate with the primary area.

Returns

System.Boolean
true if the relationship was successfully updated or removed; otherwise, false.

GISModel.Update(AdministrativeAreal2D, IEnumerable<Building2D>) Method

Updates the relationship between a specific administrative area and its associated collection of 2D buildings within the GIS model's relation cluster.

public bool Update(DiGi.GIS.Classes.AdministrativeAreal2D? administrativeAreal2D, System.Collections.Generic.IEnumerable<DiGi.GIS.Classes.Building2D>? building2Ds);

Parameters

administrativeAreal2D AdministrativeAreal2D

The administrative area object to be updated or used as the primary entity in the relation.

building2Ds System.Collections.Generic.IEnumerable<Building2D>

A collection of 2D building objects associated with the specified administrative area.

Returns

System.Boolean
true if the relationship was successfully updated or removed; otherwise, false.

GISModel.Update(Building2D) Method

Updates the GIS model with the specified building.

public bool Update(DiGi.GIS.Classes.Building2D? building2D);

Parameters

building2D Building2D

The Building2D object to be updated.

Returns

System.Boolean
true if the update was successful; otherwise, false.

GISModel.Update(Building2D, Building2DConstructionDateCalculationResult) Method

Updates the GIS model with the specified building and its associated construction date calculation result, establishing or updating the relation between them.

public bool Update(DiGi.GIS.Classes.Building2D? building2D, DiGi.GIS.Classes.Building2DConstructionDateCalculationResult? building2DConstructionDateCalculationResult);

Parameters

building2D Building2D

The 2D building object to be updated in the model.

building2DConstructionDateCalculationResult Building2DConstructionDateCalculationResult

The construction date calculation result to be associated with the building.

Returns

System.Boolean
true if the update was successful; otherwise, false if either provided parameter is null.

GISModel.Update(Building2D, Building2DExternalReferenceGuidResult) Method

Updates the GIS model with the specified building and its external reference GUID result, establishing or updating the relationship between them within the relation cluster.

public bool Update(DiGi.GIS.Classes.Building2D? building2D, DiGi.GIS.Classes.Building2DExternalReferenceGuidResult? building2DExternalReferenceUniqueResult);

Parameters

building2D Building2D

The 2D building object to be updated.

building2DExternalReferenceUniqueResult Building2DExternalReferenceGuidResult

The unique external reference GUID result associated with the building.

Returns

System.Boolean
true if the update was successful; otherwise, false.

GISModel.Update(Building2D, Building2DGeometryCalculationResult) Method

Updates the GIS model with the specified building and its geometry calculation result, establishing a relationship between them in the relation cluster.

public bool Update(DiGi.GIS.Classes.Building2D? building2D, DiGi.GIS.Classes.Building2DGeometryCalculationResult? building2DGeometryCalculationResult);

Parameters

building2D Building2D

The Building2D object to be updated.

building2DGeometryCalculationResult Building2DGeometryCalculationResult

The Building2DGeometryCalculationResult object to be associated with the building.

Returns

System.Boolean
true if the update and relationship establishment were successful; otherwise, false.

GISModel.Update(Building2D, OccupancyCalculationResult) Method

Updates the GIS model with the specified building and its corresponding occupancy calculation result, establishing a relationship between them in the relation cluster.

public bool Update(DiGi.GIS.Classes.Building2D? building2D, DiGi.GIS.Classes.OccupancyCalculationResult? occupancyCalculationResult);

Parameters

building2D Building2D

The Building2D object to be updated.

occupancyCalculationResult OccupancyCalculationResult

The OccupancyCalculationResult object to be associated with the building.

Returns

System.Boolean
true if the update and relationship establishment were successful; otherwise, false.

GISModel.Update(ISource) Method

Updates the GIS model using the specified source.

public bool Update(DiGi.GIS.Interfaces.ISource? source);

Parameters

source ISource

The ISource object to be updated in the model.

Returns

System.Boolean
true if the update was successful; otherwise, false.

GISModelAreal2DReference Class

Represents a reference to an areal 2D object within a GIS model.

public class GISModelAreal2DReference : DiGi.Core.Classes.SerializableObject, DiGi.GIS.Interfaces.IGISSerializableObject, DiGi.GIS.Interfaces.IGISObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.ISerializableReference, DiGi.Core.Interfaces.IReference, System.IEquatable<DiGi.Core.Interfaces.IReference>

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObject → GISModelAreal2DReference

Implements IGISSerializableObject, IGISObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.ISerializableReference, DiGi.Core.Interfaces.IReference, System.IEquatable<DiGi.Core.Interfaces.IReference>

Constructors

GISModelAreal2DReference(GISModelAreal2DReference) Constructor

Initializes a new instance of the GISModelAreal2DReference class as a copy of an existing instance.

public GISModelAreal2DReference(DiGi.GIS.Classes.GISModelAreal2DReference gISModelAreal2DReference);

Parameters

gISModelAreal2DReference GISModelAreal2DReference

The source instance to copy from.

GISModelAreal2DReference(string, string) Constructor

Initializes a new instance of the GISModelAreal2DReference class.

public GISModelAreal2DReference(string? gISModelReference, string? areal2DReference);

Parameters

gISModelReference System.String

The reference to the GIS model.

areal2DReference System.String

The reference to the areal 2D object.

GISModelAreal2DReference(JsonObject) Constructor

Initializes a new instance of the GISModelAreal2DReference class from a JSON object.

public GISModelAreal2DReference(System.Text.Json.Nodes.JsonObject jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the reference data.

Properties

GISModelAreal2DReference.Areal2DReference Property

Gets the reference to the areal 2D object.

public string? Areal2DReference { get; }

Property Value

System.String

GISModelAreal2DReference.GISModelReference Property

Gets the reference to the GIS model.

public string? GISModelReference { get; }

Property Value

System.String

Methods

GISModelAreal2DReference.Clone() Method

Creates a clone of this instance.

public override DiGi.Core.Interfaces.ISerializableObject? Clone();

Implements Clone()

Returns

DiGi.Core.Interfaces.ISerializableObject
A new GISModelAreal2DReference instance that is a copy of the current instance.

GISModelAreal2DReference.Equals(IReference) Method

Indicates whether this instance equals a given reference.

public bool Equals(DiGi.Core.Interfaces.IReference? reference);

Parameters

reference DiGi.Core.Interfaces.IReference

The reference to compare with this instance.

Returns

System.Boolean
True if the instances are equal; otherwise, false.

GISModelAreal2DReference.Equals(object) Method

Indicates whether this instance equals a given object.

public override bool Equals(object? obj);

Parameters

obj System.Object

The object to compare with this instance.

Returns

System.Boolean
True if the objects are equal; otherwise, false.

GISModelAreal2DReference.GetHashCode() Method

Returns the hash code for this instance.

public override int GetHashCode();

Returns

System.Int32
A 32-bit signed integer hash code.

GISModelAreal2DReference.ToString() Method

Returns the string representation of this instance.

public override string ToString();

Returns

System.String
A string representing the GIS model and areal 2D references.

Operators

GISModelAreal2DReference.operator ==(GISModelAreal2DReference, ISerializableReference) Operator

Determines whether the specified GISModelAreal2DReference and ISerializableReference are equal.

public static bool operator ==(DiGi.GIS.Classes.GISModelAreal2DReference gISModelAreal2DReference_1, DiGi.Core.Interfaces.ISerializableReference @object);

Parameters

gISModelAreal2DReference_1 GISModelAreal2DReference

The first reference.

object DiGi.Core.Interfaces.ISerializableReference

The second reference.

Returns

System.Boolean
True if the references are equal; otherwise, false.

GISModelAreal2DReference.operator ==(GISModelAreal2DReference, GISModelAreal2DReference) Operator

Determines whether the specified two GISModelAreal2DReference instances are equal.

public static bool operator ==(DiGi.GIS.Classes.GISModelAreal2DReference gISModelAreal2DReference_1, DiGi.GIS.Classes.GISModelAreal2DReference gISModelAreal2DReference_2);

Parameters

gISModelAreal2DReference_1 GISModelAreal2DReference

The first reference.

gISModelAreal2DReference_2 GISModelAreal2DReference

The second reference.

Returns

System.Boolean
True if the references are equal; otherwise, false.

GISModelAreal2DReference.operator ==(GISModelAreal2DReference, object) Operator

Determines whether the specified GISModelAreal2DReference and object are equal.

public static bool operator ==(DiGi.GIS.Classes.GISModelAreal2DReference gISModelAreal2DReference_1, object @object);

Parameters

gISModelAreal2DReference_1 GISModelAreal2DReference

The first reference.

object System.Object

The second object.

Returns

System.Boolean
True if the references are equal; otherwise, false.

GISModelAreal2DReference.operator ==(object, GISModelAreal2DReference) Operator

Determines whether the specified object and GISModelAreal2DReference are equal.

public static bool operator ==(object serializableReference_1, DiGi.GIS.Classes.GISModelAreal2DReference gISModelAreal2DReference_1);

Parameters

serializableReference_1 System.Object

The first object.

gISModelAreal2DReference_1 GISModelAreal2DReference

The second reference.

Returns

System.Boolean
True if the references are equal; otherwise, false.

GISModelAreal2DReference.operator !=(GISModelAreal2DReference, ISerializableReference) Operator

Determines whether the specified GISModelAreal2DReference and ISerializableReference are not equal.

public static bool operator !=(DiGi.GIS.Classes.GISModelAreal2DReference gISModelAreal2DReference_1, DiGi.Core.Interfaces.ISerializableReference @object);

Parameters

gISModelAreal2DReference_1 GISModelAreal2DReference

The first reference.

object DiGi.Core.Interfaces.ISerializableReference

The second reference.

Returns

System.Boolean
True if the references are not equal; otherwise, false.

GISModelAreal2DReference.operator !=(GISModelAreal2DReference, GISModelAreal2DReference) Operator

Determines whether the specified two GISModelAreal2DReference instances are not equal.

public static bool operator !=(DiGi.GIS.Classes.GISModelAreal2DReference gISModelAreal2DReference_1, DiGi.GIS.Classes.GISModelAreal2DReference gISModelAreal2DReference_2);

Parameters

gISModelAreal2DReference_1 GISModelAreal2DReference

The first reference.

gISModelAreal2DReference_2 GISModelAreal2DReference

The second reference.

Returns

System.Boolean
True if the references are not equal; otherwise, false.

GISModelAreal2DReference.operator !=(GISModelAreal2DReference, object) Operator

Determines whether the specified GISModelAreal2DReference and object are not equal.

public static bool operator !=(DiGi.GIS.Classes.GISModelAreal2DReference gISModelAreal2DReference_1, object @object);

Parameters

gISModelAreal2DReference_1 GISModelAreal2DReference

The first reference.

object System.Object

The second object.

Returns

System.Boolean
True if the references are not equal; otherwise, false.

GISModelAreal2DReference.operator !=(object, GISModelAreal2DReference) Operator

Determines whether the specified object and GISModelAreal2DReference are not equal.

public static bool operator !=(object serializableReference_1, DiGi.GIS.Classes.GISModelAreal2DReference gISModelAreal2DReference_2);

Parameters

serializableReference_1 System.Object

The first object.

gISModelAreal2DReference_2 GISModelAreal2DReference

The second reference.

Returns

System.Boolean
True if the references are not equal; otherwise, false.

GISModelFile Class

Represents a GIS model file that stores GIS model data with external reference support

public class GISModelFile : DiGi.Core.IO.File.Classes.ValueFile<DiGi.GIS.Classes.GISModel>, DiGi.GIS.Interfaces.IGISObject, DiGi.Core.Interfaces.IObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.IO.File.Classes.FileDiGi.Core.IO.File.Classes.ValueFile<GISModel> → GISModelFile

Implements IGISObject, DiGi.Core.Interfaces.IObject

Constructors

GISModelFile(GISModelFile) Constructor

Initializes a new instance of the GISModelFile class by copying another instance

public GISModelFile(DiGi.GIS.Classes.GISModelFile? gISModelFile);

Parameters

gISModelFile GISModelFile

The source GIS model file to copy from.

GISModelFile(string) Constructor

Initializes a new instance of the GISModelFile class from the specified path

public GISModelFile(string? path);

Parameters

path System.String

The file system path to the GIS model file.

GISModelFile(JsonObject) Constructor

Initializes a new instance of the GISModelFile class from a JSON object

public GISModelFile(System.Text.Json.Nodes.JsonObject? jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the data for the GIS model file.

Properties

GISModelFile.GuidExternalReference Property

Gets the external reference for this GIS model file

public DiGi.Core.Classes.GuidExternalReference? GuidExternalReference { get; }

Property Value

DiGi.Core.Classes.GuidExternalReference

GISModelFileGuidObjectReference Class

Represents a reference to a GUID object within a GIS model file

public class GISModelFileGuidObjectReference : DiGi.Core.Classes.SerializableReference, DiGi.Core.Interfaces.IComplexReference, DiGi.Core.Interfaces.IReference, DiGi.Core.Interfaces.IObject, System.IEquatable<DiGi.Core.Interfaces.IReference>

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Classes.SerializableReference → GISModelFileGuidObjectReference

Implements DiGi.Core.Interfaces.IComplexReference, DiGi.Core.Interfaces.IReference, DiGi.Core.Interfaces.IObject, System.IEquatable<DiGi.Core.Interfaces.IReference>

Constructors

GISModelFileGuidObjectReference(GuidExternalReference, GuidReference) Constructor

Represents a reference to a GUID object within a GIS model file

public GISModelFileGuidObjectReference(DiGi.Core.Classes.GuidExternalReference? guidExternalReference, DiGi.Core.Classes.GuidReference? guidReference);

Parameters

guidExternalReference DiGi.Core.Classes.GuidExternalReference

guidReference DiGi.Core.Classes.GuidReference

Properties

GISModelFileGuidObjectReference.GuidExternalReference Property

External GUID reference

public DiGi.Core.Classes.GuidExternalReference? GuidExternalReference { get; }

Property Value

DiGi.Core.Classes.GuidExternalReference

GISModelFileGuidObjectReference.GuidReference Property

Internal GUID reference within the GIS model

public DiGi.Core.Classes.GuidReference? GuidReference { get; }

Property Value

DiGi.Core.Classes.GuidReference

GISModelFileManager Class

Provides functionality for managing GIS model files and implements the IGISObject interface.

public class GISModelFileManager : DiGi.GIS.Interfaces.IGISObject, DiGi.Core.Interfaces.IObject

Inheritance System.Object → GISModelFileManager

Implements IGISObject, DiGi.Core.Interfaces.IObject

Constructors

GISModelFileManager() Constructor

Initializes a new instance of the GISModelFileManager class

public GISModelFileManager();

Methods

GISModelFileManager.GetGISModel(GuidExternalReference) Method

Retrieves the GIS model associated with the specified external reference.

public DiGi.GIS.Classes.GISModel? GetGISModel(DiGi.Core.Classes.GuidExternalReference? guidExternalReference);

Parameters

guidExternalReference DiGi.Core.Classes.GuidExternalReference

The external reference used to identify the GIS model.

Returns

GISModel
The matching GISModel if found; otherwise, null.

GISModelFileManager.GetGuidExternalReference(GISModel) Method

Retrieves the external reference associated with the specified GIS model.

public DiGi.Core.Classes.GuidExternalReference? GetGuidExternalReference(DiGi.GIS.Classes.GISModel? gISModel);

Parameters

gISModel GISModel

The GISModel for which the external reference is being retrieved.

Returns

DiGi.Core.Classes.GuidExternalReference
The matching DiGi.Core.Classes.GuidExternalReference if found; otherwise, null.

GISModelFileManager.GetGuidExternalReference(string) Method

Retrieves the external reference associated with the specified file path.

public DiGi.Core.Classes.GuidExternalReference? GetGuidExternalReference(string? path);

Parameters

path System.String

The file path to search for.

Returns

DiGi.Core.Classes.GuidExternalReference
The matching DiGi.Core.Classes.GuidExternalReference if found; otherwise, null.

GISModelFileManager.GetGuidExternalReferences() Method

Retrieves all external reference identifiers currently managed by the GIS model file manager.

public System.Collections.Generic.HashSet<DiGi.Core.Classes.GuidExternalReference>? GetGuidExternalReferences();

Returns

System.Collections.Generic.HashSet<DiGi.Core.Classes.GuidExternalReference>
A System.Collections.Generic.HashSet<> containing all DiGi.Core.Classes.GuidExternalReference keys, or null if no references are available.

GISModelFileManager.GetPath(GISModel) Method

Retrieves the file path associated with the specified GIS model.

public string? GetPath(DiGi.GIS.Classes.GISModel? gISModel);

Parameters

gISModel GISModel

The GISModel for which to retrieve the file path.

Returns

System.String
The file path of the GIS model if it exists in the manager; otherwise, null.

GISModelFileManager.Open(string) Method

Opens a GIS model file from the specified path and adds it to the manager's collection.

public DiGi.Core.Classes.GuidExternalReference? Open(string? path);

Parameters

path System.String

The file path of the GIS model file to open.

Returns

DiGi.Core.Classes.GuidExternalReference
The DiGi.Core.Classes.GuidExternalReference of the opened GIS model file if successful; otherwise, null.

GISModelFileManager.Remove(GuidExternalReference) Method

Removes the GIS model file associated with the specified external reference.

public bool Remove(DiGi.Core.Classes.GuidExternalReference? guidExternalReference);

Parameters

guidExternalReference DiGi.Core.Classes.GuidExternalReference

The external reference of the GIS model file to remove.

Returns

System.Boolean
true if the GIS model file was successfully removed; otherwise, false.

GISModelFileManager.RemoveAll() Method

Removes all GIS model files from the manager.

public bool RemoveAll();

Returns

System.Boolean
true if one or more GIS model files were successfully removed; otherwise, false.

GISModelFileManager.Save(GuidExternalReference) Method

Saves the GIS model file associated with the specified external reference.

public bool Save(DiGi.Core.Classes.GuidExternalReference? guidExternalReference);

Parameters

guidExternalReference DiGi.Core.Classes.GuidExternalReference

The external reference of the GIS model file to save.

Returns

System.Boolean
true if the GIS model file was successfully saved; otherwise, false.

GISModelFileManager.SaveAs(GuidExternalReference, string) Method

Saves the GIS model file associated with the specified external reference to the given path and updates its reference in the manager.

public DiGi.Core.Classes.GuidExternalReference? SaveAs(DiGi.Core.Classes.GuidExternalReference? guidExternalReference, string path);

Parameters

guidExternalReference DiGi.Core.Classes.GuidExternalReference

The external reference of the GIS model file to save.

path System.String

The destination file path where the GIS model file will be saved.

Returns

DiGi.Core.Classes.GuidExternalReference
The new DiGi.Core.Classes.GuidExternalReference if the operation was successful; otherwise, null.

GISModelFileManager.TryGetObject<TGISGuidObject2D>(GuidExternalReference, string, TGISGuidObject2D, GISModel) Method

Tries to retrieve a GIS unique object of the specified type and its associated GIS model using the provided external reference and reference string.

public bool TryGetObject<TGISGuidObject2D>(DiGi.Core.Classes.GuidExternalReference? guidExternalReference, string reference, out TGISGuidObject2D? gISUniqueObject, out DiGi.GIS.Classes.GISModel? gISModel)
    where TGISGuidObject2D : DiGi.GIS.Classes.GISGuidObject2D;

Type parameters

TGISGuidObject2D

The type of the GIS unique object to retrieve, which must derive from GISGuidObject2D.

Parameters

guidExternalReference DiGi.Core.Classes.GuidExternalReference

The external reference GUID used to locate the GIS model.

reference System.String

The reference string used to identify the specific object within the model.

gISUniqueObject TGISGuidObject2D

When this method returns, contains the retrieved GIS unique object if successful; otherwise, the default value.

gISModel GISModel

When this method returns, contains the retrieved GIS model if successful; otherwise, null.

Returns

System.Boolean
true if the object and its associated model were successfully found; otherwise, false.

GISModelFileManager.TryGetObject<YIGISUniqueObject>(GuidExternalReference, GuidReference, YIGISUniqueObject) Method

Tries to retrieve a GIS unique object of the specified type using the provided external reference and internal reference GUIDs.

public bool TryGetObject<YIGISUniqueObject>(DiGi.Core.Classes.GuidExternalReference? guidExternalReference, DiGi.Core.Classes.GuidReference? guidReference, out YIGISUniqueObject? gISUniqueObject)
    where YIGISUniqueObject : DiGi.GIS.Interfaces.IGISUniqueObject;

Type parameters

YIGISUniqueObject

The type of the GIS unique object to retrieve, which must implement IGISUniqueObject.

Parameters

guidExternalReference DiGi.Core.Classes.GuidExternalReference

The external reference GUID used to locate the GIS model containing the object.

guidReference DiGi.Core.Classes.GuidReference

The internal reference GUID used to identify the specific object within the model.

gISUniqueObject YIGISUniqueObject

When this method returns, contains the retrieved GIS unique object if successful; otherwise, the default value.

Returns

System.Boolean
true if the object was successfully found; otherwise, false.

GISModelFileManager.TryGetObject<YIGISUniqueObject>(GuidExternalReference, GuidReference, YIGISUniqueObject, GISModel) Method

Tries to retrieve a GIS unique object of the specified type and its associated GIS model using the provided external reference and internal reference GUIDs.

public bool TryGetObject<YIGISUniqueObject>(DiGi.Core.Classes.GuidExternalReference? guidExternalReference, DiGi.Core.Classes.GuidReference? guidReference, out YIGISUniqueObject? gISUniqueObject, out DiGi.GIS.Classes.GISModel? gISModel)
    where YIGISUniqueObject : DiGi.GIS.Interfaces.IGISUniqueObject;

Type parameters

YIGISUniqueObject

The type of the GIS unique object to retrieve, which must implement IGISUniqueObject.

Parameters

guidExternalReference DiGi.Core.Classes.GuidExternalReference

The external reference GUID used to locate the GIS model.

guidReference DiGi.Core.Classes.GuidReference

The internal reference GUID used to identify the specific object within the model.

gISUniqueObject YIGISUniqueObject

When this method returns, contains the retrieved GIS unique object if successful; otherwise, the default value.

gISModel GISModel

When this method returns, contains the retrieved GIS model if successful; otherwise, null.

Returns

System.Boolean
true if the object and its associated model were successfully found; otherwise, false.

GISModelFileManager.TryGetObject<YIGISUniqueObject>(GISModelFileGuidObjectReference, YIGISUniqueObject) Method

Tries to retrieve a GIS unique object of the specified type using the provided file and object reference.

public bool TryGetObject<YIGISUniqueObject>(DiGi.GIS.Classes.GISModelFileGuidObjectReference? gISModelFileUniqueObjectReference, out YIGISUniqueObject? gISUniqueObject)
    where YIGISUniqueObject : DiGi.GIS.Interfaces.IGISUniqueObject;

Type parameters

YIGISUniqueObject

The type of the GIS unique object to retrieve, which must implement IGISUniqueObject.

Parameters

gISModelFileUniqueObjectReference GISModelFileGuidObjectReference

The reference containing the external and internal GUIDs used to locate the object.

gISUniqueObject YIGISUniqueObject

When this method returns, contains the retrieved GIS unique object if successful; otherwise, the default value.

Returns

System.Boolean
true if the object was successfully found; otherwise, false.

GISModelFileManager.TryGetObject<YIGISUniqueObject>(GISModelFileGuidObjectReference, YIGISUniqueObject, GISModel) Method

Tries to retrieve a GIS unique object of the specified type and its associated GIS model using the provided file and object reference.

public bool TryGetObject<YIGISUniqueObject>(DiGi.GIS.Classes.GISModelFileGuidObjectReference? gISModelFileUniqueObjectReference, out YIGISUniqueObject? gISUniqueObject, out DiGi.GIS.Classes.GISModel? gISModel)
    where YIGISUniqueObject : DiGi.GIS.Interfaces.IGISUniqueObject;

Type parameters

YIGISUniqueObject

The type of the GIS unique object to retrieve, which must implement IGISUniqueObject.

Parameters

gISModelFileUniqueObjectReference GISModelFileGuidObjectReference

The reference containing the external and internal GUIDs used to locate the object.

gISUniqueObject YIGISUniqueObject

When this method returns, contains the retrieved GIS unique object if successful; otherwise, the default value.

gISModel GISModel

When this method returns, contains the retrieved GIS model if successful; otherwise, null.

Returns

System.Boolean
true if the object and its associated model were successfully found; otherwise, false.

IndexData Class

Represents index data with an index value, reference, and name

public class IndexData : DiGi.Core.Classes.UniqueObject, DiGi.GIS.Interfaces.IGISUniqueObject, DiGi.GIS.Interfaces.IGISSerializableObject, DiGi.GIS.Interfaces.IGISObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Classes.UniqueObject → IndexData

Implements IGISUniqueObject, IGISSerializableObject, IGISObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject

Constructors

IndexData(IndexData) Constructor

Initializes a new instance of the IndexData class by copying another instance

public IndexData(DiGi.GIS.Classes.IndexData? indexData);

Parameters

indexData IndexData

The source IndexData instance to copy from.

IndexData(int, string, string) Constructor

Initializes a new instance of the IndexData class with the specified index, reference, and name

public IndexData(int index, string? reference, string? name);

Parameters

index System.Int32

The numeric index value.

reference System.String

The reference identifier string.

name System.String

The descriptive name string.

IndexData(JsonObject) Constructor

Initializes a new instance of the IndexData class from a JSON object

public IndexData(System.Text.Json.Nodes.JsonObject? jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the data to initialize this instance.

Properties

IndexData.Index Property

Gets the index value

public int Index { get; }

Property Value

System.Int32

IndexData.Name Property

Gets the name string

public string? Name { get; }

Property Value

System.String

IndexData.Reference Property

Gets the reference string

public string? Reference { get; }

Property Value

System.String

IndexData.UniqueId Property

Gets the unique identifier for this instance (the index value as a string)

public override string? UniqueId { get; }

Implements UniqueId

Property Value

System.String

Methods

IndexData.ToString() Method

Returns the string representation of this instance

public override string? ToString();

Returns

System.String
A tab-separated string containing the index, reference, and name.

IndexDataFile Class

Represents an index data file that stores mappings of index values to references and names

public class IndexDataFile : System.Collections.Generic.List<DiGi.GIS.Classes.IndexData>, DiGi.GIS.Interfaces.IGISObject, DiGi.Core.Interfaces.IObject

Inheritance System.ObjectSystem.Collections.Generic.List<IndexData> → IndexDataFile

Implements IGISObject, DiGi.Core.Interfaces.IObject

Constructors

IndexDataFile() Constructor

Initializes a new instance of the IndexDataFile class

public IndexDataFile();

Methods

IndexDataFile.Read(string) Method

Reads index data from the specified file path

public bool Read(string? path);

Parameters

path System.String

The path to the file containing index data.

Returns

System.Boolean
True if the file was read successfully; otherwise, false.

IndexDataFile.ToString() Method

Returns a string representation of all index data entries

public override string ToString();

Returns

System.String
A newline-separated string containing the string representations of each IndexData entry.

IndexDataFile.TryGetIndex(string, int) Method

Tries to get the index value associated with the given reference

public bool TryGetIndex(string? reference, out int index);

Parameters

reference System.String

The reference string to search for.

index System.Int32

When this method returns, contains the index value if found; otherwise, -1.

Returns

System.Boolean
True if the index was successfully retrieved; otherwise, false.

IndexDataFile.Write(string) Method

Writes index data to the specified file path

public bool Write(string? path);

Parameters

path System.String

The path where the index data should be written.

Returns

System.Boolean
True if the file was written successfully; otherwise, false.

OccupancyCalculationResult Class

Represents the result of an occupancy calculation, containing area and count information.

public class OccupancyCalculationResult : DiGi.Core.Classes.GuidResult<DiGi.GIS.Classes.Areal2D>, DiGi.GIS.Interfaces.IGISGuidResult, DiGi.GIS.Interfaces.IGISUniqueResult, DiGi.Core.Interfaces.IUniqueResult, DiGi.Core.Interfaces.ISerializableResult, DiGi.Core.Interfaces.IResult, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject, DiGi.GIS.Interfaces.IGISUniqueObject, DiGi.GIS.Interfaces.IGISSerializableObject, DiGi.GIS.Interfaces.IGISObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Classes.UniqueObjectDiGi.Core.Classes.GuidObjectDiGi.Core.Classes.GuidResultDiGi.Core.Classes.GuidResult<Areal2D> → OccupancyCalculationResult

Implements IGISGuidResult, IGISUniqueResult, DiGi.Core.Interfaces.IUniqueResult, DiGi.Core.Interfaces.ISerializableResult, DiGi.Core.Interfaces.IResult, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject, IGISUniqueObject, IGISSerializableObject, IGISObject

Constructors

OccupancyCalculationResult(OccupancyCalculationResult) Constructor

Initializes a new instance of the OccupancyCalculationResult class as a copy.

public OccupancyCalculationResult(DiGi.GIS.Classes.OccupancyCalculationResult occupancyCalculationResult);

Parameters

occupancyCalculationResult OccupancyCalculationResult

The source result object to copy from.

OccupancyCalculationResult(Nullable<double>, Nullable<uint>) Constructor

Initializes a new instance of the OccupancyCalculationResult class.

public OccupancyCalculationResult(System.Nullable<double> occupancyArea, System.Nullable<uint> occupancy);

Parameters

occupancyArea System.Nullable<System.Double>

The calculated occupancy area.

occupancy System.Nullable<System.UInt32>

The calculated occupancy count.

OccupancyCalculationResult(JsonObject) Constructor

Initializes a new instance of the OccupancyCalculationResult class from a JSON object.

public OccupancyCalculationResult(System.Text.Json.Nodes.JsonObject jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the result data.

Properties

OccupancyCalculationResult.Occupancy Property

Gets the occupancy count.

public System.Nullable<uint> Occupancy { get; }

Property Value

System.Nullable<System.UInt32>

OccupancyCalculationResult.OccupancyArea Property

Gets the occupancy area.

public System.Nullable<double> OccupancyArea { get; }

Property Value

System.Nullable<System.Double>

OccupancyData Class

Represents occupancy data with occupancy count, area, and reference information

public class OccupancyData : DiGi.Core.Classes.GuidObject, DiGi.GIS.Interfaces.IOccupancyData, DiGi.GIS.Interfaces.IGISGuidObject, DiGi.GIS.Interfaces.IGISUniqueObject, DiGi.GIS.Interfaces.IGISSerializableObject, DiGi.GIS.Interfaces.IGISObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject, DiGi.Core.Interfaces.IGuidObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Classes.UniqueObjectDiGi.Core.Classes.GuidObject → OccupancyData

Implements IOccupancyData, IGISGuidObject, IGISUniqueObject, IGISSerializableObject, IGISObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject, DiGi.Core.Interfaces.IGuidObject

Constructors

OccupancyData(OccupancyData) Constructor

Initializes a new instance of the OccupancyData class by copying another instance

public OccupancyData(DiGi.GIS.Classes.OccupancyData occupancyData);

Parameters

occupancyData OccupancyData

The source instance to copy data from.

OccupancyData(string, Nullable<double>, Nullable<uint>) Constructor

Initializes a new instance of the OccupancyData class with the specified reference, occupancy area, and occupancy

public OccupancyData(string? reference, System.Nullable<double> occupancyArea, System.Nullable<uint> occupancy);

Parameters

reference System.String

The reference identifier for the occupancy data.

occupancyArea System.Nullable<System.Double>

The total area associated with the occupancy.

occupancy System.Nullable<System.UInt32>

The count of occupants.

OccupancyData(JsonObject) Constructor

Initializes a new instance of the OccupancyData class from a JSON object

public OccupancyData(System.Text.Json.Nodes.JsonObject jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the data to initialize the instance.

Properties

OccupancyData.Occupancy Property

Gets the occupancy count

public System.Nullable<uint> Occupancy { get; }

Property Value

System.Nullable<System.UInt32>

OccupancyData.OccupancyArea Property

Gets the occupancy area

public System.Nullable<double> OccupancyArea { get; }

Property Value

System.Nullable<System.Double>

OccupancyData.Reference Property

Gets the reference string

public string? Reference { get; }

Implements Reference

Property Value

System.String

OrtoData Class

Represents orthophoto data, containing the image bytes, timestamp, location, and scale factor.

public class OrtoData : DiGi.Core.Classes.SerializableObject, DiGi.GIS.Interfaces.IGISObject, DiGi.Core.Interfaces.IObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObject → OrtoData

Implements IGISObject, DiGi.Core.Interfaces.IObject

Constructors

OrtoData(OrtoData) Constructor

Initializes a new instance of the OrtoData class by copying an existing instance.

public OrtoData(DiGi.GIS.Classes.OrtoData? ortoData);

Parameters

ortoData OrtoData

The source orthophoto data to copy from.

OrtoData(DateTime, byte[], double, Point2D) Constructor

Initializes a new instance of the OrtoData class.

public OrtoData(System.DateTime dateTime, byte[]? bytes, double scale, DiGi.Geometry.Planar.Classes.Point2D? location);

Parameters

dateTime System.DateTime

The date and time associated with the orthophoto data.

bytes System.Byte[]

The bitmap image stored as bytes.

scale System.Double

The scale factor of the image.

location DiGi.Geometry.Planar.Classes.Point2D

The top-left corner coordinates of the picture.

OrtoData(JsonObject) Constructor

Initializes a new instance of the OrtoData class from a JSON object.

public OrtoData(System.Text.Json.Nodes.JsonObject? jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing orthophoto data.

Properties

OrtoData.Bytes Property

Bitmap image stored in bytes

public byte[]? Bytes { get; }

Property Value

System.Byte[]

OrtoData.DateTime Property

Gets the date and time associated with the orthophoto data.

public System.DateTime DateTime { get; }

Property Value

System.DateTime

OrtoData.Location Property

Top left corner of picture stored in bytes

public DiGi.Geometry.Planar.Classes.Point2D? Location { get; }

Property Value

DiGi.Geometry.Planar.Classes.Point2D

OrtoData.Scale Property

Gets the scale factor of the orthophoto.

public double Scale { get; }

Property Value

System.Double

Methods

OrtoData.FromOrto(Point2D) Method

Transforms a point from orthophoto coordinates to world/GIS coordinates.

public DiGi.Geometry.Planar.Classes.Point2D? FromOrto(DiGi.Geometry.Planar.Classes.Point2D? point2D);

Parameters

point2D DiGi.Geometry.Planar.Classes.Point2D

The point in orthophoto coordinates.

Returns

DiGi.Geometry.Planar.Classes.Point2D
The transformed point in world/GIS coordinates, or null if the input is null.

OrtoData.FromOrto(PolygonalFace2D) Method

Transforms a polygonal face from orthophoto coordinates to world/GIS coordinates.

public DiGi.Geometry.Planar.Classes.PolygonalFace2D? FromOrto(DiGi.Geometry.Planar.Classes.PolygonalFace2D? polygonalFace2D);

Parameters

polygonalFace2D DiGi.Geometry.Planar.Classes.PolygonalFace2D

The polygonal face in orthophoto coordinates.

Returns

DiGi.Geometry.Planar.Classes.PolygonalFace2D
The transformed polygonal face in world/GIS coordinates, or null if the input is null.

OrtoData.FromOrto(IPolygonal2D) Method

Transforms a polygonal object from orthophoto coordinates to world/GIS coordinates.

public DiGi.Geometry.Planar.Interfaces.IPolygonal2D? FromOrto(DiGi.Geometry.Planar.Interfaces.IPolygonal2D? polygonal2D);

Parameters

polygonal2D DiGi.Geometry.Planar.Interfaces.IPolygonal2D

The polygonal object in orthophoto coordinates.

Returns

DiGi.Geometry.Planar.Interfaces.IPolygonal2D
The transformed polygonal object in world/GIS coordinates, or null if the input is null.

OrtoData.GetBoundingBox(GeometryContext) Method

Calculates the bounding box of the orthophoto data based on the specified geometry context.

public DiGi.Geometry.Planar.Classes.BoundingBox2D? GetBoundingBox(DiGi.GIS.Enums.GeometryContext geometryContext);

Parameters

geometryContext GeometryContext

The coordinate system context (Local or Global) for the bounding box.

Returns

DiGi.Geometry.Planar.Classes.BoundingBox2D
A DiGi.Geometry.Planar.Classes.BoundingBox2D representing the area, or null if location is missing or context is undefined.

OrtoData.GetSize(GeometryContext) Method

Retrieves the dimensions of the orthophoto image, adjusted for the specified geometry context.

public DiGi.Core.Classes.Size? GetSize(DiGi.GIS.Enums.GeometryContext geometryContext);

Parameters

geometryContext GeometryContext

The coordinate system context (Local or Global) to determine scaling.

Returns

DiGi.Core.Classes.Size
A DiGi.Core.Classes.Size object containing width and height, or null if undefined or bytes are missing.

OrtoData.ToOrto(Point2D) Method

Transforms a point from world/GIS coordinates to orthophoto coordinates.

public DiGi.Geometry.Planar.Classes.Point2D? ToOrto(DiGi.Geometry.Planar.Classes.Point2D? point2D);

Parameters

point2D DiGi.Geometry.Planar.Classes.Point2D

The point in world/GIS coordinates.

Returns

DiGi.Geometry.Planar.Classes.Point2D
The transformed point in orthophoto coordinates, or null if the input is null.

OrtoData.ToOrto(PolygonalFace2D) Method

Transforms a polygonal face from world/GIS coordinates to orthophoto coordinates.

public DiGi.Geometry.Planar.Classes.PolygonalFace2D? ToOrto(DiGi.Geometry.Planar.Classes.PolygonalFace2D? polygonalFace2D);

Parameters

polygonalFace2D DiGi.Geometry.Planar.Classes.PolygonalFace2D

The polygonal face in world/GIS coordinates.

Returns

DiGi.Geometry.Planar.Classes.PolygonalFace2D
The transformed polygonal face in orthophoto coordinates, or null if the input is null.

OrtoData.ToOrto(IPolygonal2D) Method

Transforms a polygonal object from world/GIS coordinates to orthophoto coordinates.

public DiGi.Geometry.Planar.Interfaces.IPolygonal2D? ToOrto(DiGi.Geometry.Planar.Interfaces.IPolygonal2D? polygonal2D);

Parameters

polygonal2D DiGi.Geometry.Planar.Interfaces.IPolygonal2D

The polygonal object in world/GIS coordinates.

Returns

DiGi.Geometry.Planar.Interfaces.IPolygonal2D
The transformed polygonal object in orthophoto coordinates, or null if the input is null.

OrtoDatas Class

Represents a collection of orthophoto data, providing functionality to manage and retrieve spatial and temporal information.

public class OrtoDatas : DiGi.Core.Classes.GuidObject, DiGi.GIS.Interfaces.IGISGuidObject, DiGi.GIS.Interfaces.IGISUniqueObject, DiGi.GIS.Interfaces.IGISSerializableObject, DiGi.GIS.Interfaces.IGISObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject, DiGi.Core.Interfaces.IGuidObject, System.Collections.Generic.IEnumerable<DiGi.GIS.Classes.OrtoData>, System.Collections.IEnumerable

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Classes.UniqueObjectDiGi.Core.Classes.GuidObject → OrtoDatas

Implements IGISGuidObject, IGISUniqueObject, IGISSerializableObject, IGISObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject, DiGi.Core.Interfaces.IGuidObject, System.Collections.Generic.IEnumerable<OrtoData>, System.Collections.IEnumerable

Constructors

OrtoDatas(OrtoDatas) Constructor

Initializes a new instance of the OrtoDatas class by copying an existing instance.

public OrtoDatas(DiGi.GIS.Classes.OrtoDatas? ortoDatas);

Parameters

ortoDatas OrtoDatas

The source orthophoto data collection to copy from.

OrtoDatas(string, IEnumerable<OrtoData>) Constructor

Initializes a new instance of the OrtoDatas class with a specified reference and values.

public OrtoDatas(string? reference, System.Collections.Generic.IEnumerable<DiGi.GIS.Classes.OrtoData>? values);

Parameters

reference System.String

The reference identifier for the orthophoto data.

values System.Collections.Generic.IEnumerable<OrtoData>

The collection of orthophoto data entries.

OrtoDatas(JsonObject) Constructor

Initializes a new instance of the OrtoDatas class from a JSON object.

public OrtoDatas(System.Text.Json.Nodes.JsonObject? jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the orthophoto data.

Properties

OrtoDatas.Reference Property

Gets the reference identifier associated with the orthophoto data collection.

public string? Reference { get; }

Property Value

System.String

Methods

OrtoDatas.GetBoundingBox(GeometryContext) Method

Calculates the bounding box that encompasses all orthophoto data in the collection based on the provided geometry context.

public DiGi.Geometry.Planar.Classes.BoundingBox2D? GetBoundingBox(DiGi.GIS.Enums.GeometryContext geometryContext);

Parameters

geometryContext GeometryContext

The context used to determine the coordinate system or projection for the bounding box.

Returns

DiGi.Geometry.Planar.Classes.BoundingBox2D
A DiGi.Geometry.Planar.Classes.BoundingBox2D containing all entries, or null if no valid data exists or the context is undefined.

OrtoDatas.GetBytes(DateTime) Method

Retrieves the raw bytes of the orthophoto data for a specific date.

public byte[]? GetBytes(System.DateTime dateTime);

Parameters

dateTime System.DateTime

The date for which to retrieve the bytes.

Returns

System.Byte[]
A byte array containing the orthophoto data, or null if no data is found for the specified date.

OrtoDatas.GetEnumerator() Method

Returns an enumerator that iterates through the collection of OrtoData.

public System.Collections.Generic.IEnumerator<DiGi.GIS.Classes.OrtoData> GetEnumerator();

Implements GetEnumerator(), GetEnumerator()

Returns

System.Collections.Generic.IEnumerator<OrtoData>
An enumerator for the orthophoto data collection.

OrtoDatas.GetOrtoData(DateTime) Method

Retrieves the orthophoto data object for a specific date, or the closest available entry preceding that date.

public DiGi.GIS.Classes.OrtoData? GetOrtoData(System.DateTime dateTime);

Parameters

dateTime System.DateTime

The target date to search for.

Returns

OrtoData
The OrtoData object associated with the specified date or the nearest lower value; otherwise, null.

OrtoDatas.Reduce() Method

Reduces the collection by removing redundant entries where the binary data is identical to the preceding entry.

public void Reduce();

OrtoDatas.TryGetDateTime(DateTime, DateTime) Method

Attempts to retrieve the minimum and maximum dates present in the orthophoto data collection.

public bool TryGetDateTime(out System.DateTime dateTime_Min, out System.DateTime dateTime_Max);

Parameters

dateTime_Min System.DateTime

When this method returns, contains the earliest date in the collection if successful.

dateTime_Max System.DateTime

When this method returns, contains the latest date in the collection if successful.

Returns

System.Boolean
True if the dates were successfully retrieved; otherwise, false.

OrtoDatas.TryGetYears(HashSet<int>) Method

Attempts to retrieve the set of years covered by the orthophoto data collection.

public bool TryGetYears(out System.Collections.Generic.HashSet<int>? years);

Parameters

years System.Collections.Generic.HashSet<System.Int32>

When this method returns, contains a hash set of all years between the minimum and maximum dates in the collection, or null if retrieval fails.

Returns

System.Boolean
True if the range of years was successfully determined; otherwise, false.

Explicit Interface Implementations

System.Collections.IEnumerable.GetEnumerator() Method

Returns an enumerator that iterates through the collection.

System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator();

Implements GetEnumerator()

OrtoDatasBuilding2DOptions Class

Provides configuration options for 2D building ortho data.

public class OrtoDatasBuilding2DOptions : DiGi.GIS.Classes.OrtoDatasOptions

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Classes.SerializableOptionsDirectoryNamesOptionsOrtoDatasOptions → OrtoDatasBuilding2DOptions

Constructors

OrtoDatasBuilding2DOptions() Constructor

Initializes a new instance of the OrtoDatasBuilding2DOptions class using default settings and building-specific directory names.

public OrtoDatasBuilding2DOptions();

OrtoDatasBuilding2DOptions(Range<int>, double, double, bool, ulong) Constructor

Initializes a new instance of the OrtoDatasBuilding2DOptions class with specified parameters.

public OrtoDatasBuilding2DOptions(DiGi.Core.Classes.Range<int> years, double offset, double width, bool reduce, ulong maxFileSize);

Parameters

years DiGi.Core.Classes.Range<System.Int32>

The range of years to consider.

offset System.Double

The offset value.

width System.Double

The width value.

reduce System.Boolean

A value indicating whether to reduce the data.

maxFileSize System.UInt64

The maximum allowed file size.

OrtoDatasBuilding2DOptions(OrtoDatasBuilding2DOptions) Constructor

Initializes a new instance of the OrtoDatasBuilding2DOptions class by copying values from another instance.

public OrtoDatasBuilding2DOptions(DiGi.GIS.Classes.OrtoDatasBuilding2DOptions ortoDatasBuilding2DOptions);

Parameters

ortoDatasBuilding2DOptions OrtoDatasBuilding2DOptions

The source options instance to copy from.

OrtoDatasBuilding2DOptions(JsonObject) Constructor

Initializes a new instance of the OrtoDatasBuilding2DOptions class from a JSON object.

public OrtoDatasBuilding2DOptions(System.Text.Json.Nodes.JsonObject jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the configuration data.

Properties

OrtoDatasBuilding2DOptions.Offset Property

Gets or sets the offset value for the 2D building ortho data.

public double Offset { get; set; }

Property Value

System.Double

OrtoDatasBuilding2DOptions.Width Property

Gets or sets the width value for the 2D building ortho data.

public double Width { get; set; }

Property Value

System.Double

OrtoDatasFile Class

Represents a storage file for orthodata information, providing functionality to manage and reference orthodata files.

public class OrtoDatasFile : DiGi.Core.IO.File.Classes.StorageFile<DiGi.GIS.Classes.OrtoDatas>, DiGi.GIS.Interfaces.IGISObject, DiGi.Core.Interfaces.IObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.IO.File.Classes.FileDiGi.Core.IO.File.Classes.StorageFile<OrtoDatas> → OrtoDatasFile

Implements IGISObject, DiGi.Core.Interfaces.IObject

Constructors

OrtoDatasFile(OrtoDatasFile) Constructor

Initializes a new instance of the OrtoDatasFile class by copying an existing instance.

public OrtoDatasFile(DiGi.GIS.Classes.OrtoDatasFile? ortoDatasFile);

Parameters

ortoDatasFile OrtoDatasFile

The source OrtoDatasFile instance to copy from.

OrtoDatasFile(string) Constructor

Initializes a new instance of the OrtoDatasFile class using the specified file path.

public OrtoDatasFile(string? path);

Parameters

path System.String

The system path to the orthodata storage file.

OrtoDatasFile(JsonObject) Constructor

Initializes a new instance of the OrtoDatasFile class using data from a JSON object.

public OrtoDatasFile(System.Text.Json.Nodes.JsonObject? jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The System.Text.Json.Nodes.JsonObject containing the file data.

Methods

OrtoDatasFile.GetUniqueReference(OrtoDatas) Method

Gets the unique reference associated with the specified orthodata object.

public override DiGi.Core.Classes.UniqueReference? GetUniqueReference(DiGi.GIS.Classes.OrtoDatas? ortoDatas);

Parameters

ortoDatas OrtoDatas

The orthodata object for which to retrieve the unique reference.

Returns

DiGi.Core.Classes.UniqueReference
A DiGi.Core.Classes.UniqueReference if the orthodata is provided; otherwise, null.

OrtoDatasFile.GetUniqueReference(string) Method

Creates a unique reference based on the provided string identifier.

public static DiGi.Core.Classes.UniqueReference? GetUniqueReference(string? reference);

Parameters

reference System.String

The string identifier used to create the unique reference.

Returns

DiGi.Core.Classes.UniqueReference
A DiGi.Core.Classes.UniqueReference if the reference is not null; otherwise, null.

OrtoDatasOptions Class

Provides options for configuring orthophoto data retrieval and processing settings.

public abstract class OrtoDatasOptions : DiGi.GIS.Classes.DirectoryNamesOptions

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Classes.SerializableOptionsDirectoryNamesOptions → OrtoDatasOptions

Derived
OrtoDatasBuilding2DOptions
OrtoDatasOrtoRangeOptions

Constructors

OrtoDatasOptions() Constructor

Initializes a new instance of the OrtoDatasOptions class.

public OrtoDatasOptions();

OrtoDatasOptions(Range<int>, bool, ulong) Constructor

Initializes a new instance of the OrtoDatasOptions class with specified years, reduction flag, and maximum file size.

public OrtoDatasOptions(DiGi.Core.Classes.Range<int> years, bool reduce, ulong maxFileSize);

Parameters

years DiGi.Core.Classes.Range<System.Int32>

The range of years to be considered.

reduce System.Boolean

A value indicating whether to reduce data.

maxFileSize System.UInt64

The maximum allowed file size in bytes.

OrtoDatasOptions(OrtoDatasOptions) Constructor

Initializes a new instance of the OrtoDatasOptions class by copying values from an existing OrtoDatasOptions instance.

public OrtoDatasOptions(DiGi.GIS.Classes.OrtoDatasOptions ortoDatasOptions);

Parameters

ortoDatasOptions OrtoDatasOptions

The source options instance to copy from.

OrtoDatasOptions(JsonObject) Constructor

Initializes a new instance of the OrtoDatasOptions class using a JSON object.

public OrtoDatasOptions(System.Text.Json.Nodes.JsonObject jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing configuration data.

Properties

OrtoDatasOptions.MaxFileSize Property

Max file size in bytes. ulong.MaxValue value will keep one file

public ulong MaxFileSize { get; set; }

Property Value

System.UInt64

OrtoDatasOptions.Reduce Property

Gets or sets a value indicating whether to reduce the data size or resolution.

public bool Reduce { get; set; }

Property Value

System.Boolean

OrtoDatasOptions.Years Property

Gets or sets the range of years to be considered for orthophoto data.

public DiGi.Core.Classes.Range<int> Years { get; set; }

Property Value

DiGi.Core.Classes.Range<System.Int32>

OrtoDatasOrtoRangeOptions Class

Represents the options used for filtering and retrieving orthodata within a specific range, including scale settings.

public class OrtoDatasOrtoRangeOptions : DiGi.GIS.Classes.OrtoDatasOptions

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Classes.SerializableOptionsDirectoryNamesOptionsOrtoDatasOptions → OrtoDatasOrtoRangeOptions

Constructors

OrtoDatasOrtoRangeOptions() Constructor

Initializes a new instance of the OrtoDatasOrtoRangeOptions class with default values and initializes directory names.

public OrtoDatasOrtoRangeOptions();

OrtoDatasOrtoRangeOptions(Range<int>, double, bool, ulong) Constructor

Initializes a new instance of the OrtoDatasOrtoRangeOptions class with specified year range, scale, reduction preference, and maximum file size.

public OrtoDatasOrtoRangeOptions(DiGi.Core.Classes.Range<int> years, double scale, bool reduce, ulong maxFileSize);

Parameters

years DiGi.Core.Classes.Range<System.Int32>

The range of years to filter the orthodata.

scale System.Double

The scale factor for the orthodata.

reduce System.Boolean

A value indicating whether to reduce the data.

maxFileSize System.UInt64

The maximum allowed file size.

OrtoDatasOrtoRangeOptions(OrtoDatasOrtoRangeOptions) Constructor

Initializes a new instance of the OrtoDatasOrtoRangeOptions class by copying values from an existing options instance.

public OrtoDatasOrtoRangeOptions(DiGi.GIS.Classes.OrtoDatasOrtoRangeOptions ortoDatasOrtoRangeOptions);

Parameters

ortoDatasOrtoRangeOptions OrtoDatasOrtoRangeOptions

The source options instance to copy from.

OrtoDatasOrtoRangeOptions(JsonObject) Constructor

Initializes a new instance of the OrtoDatasOrtoRangeOptions class from a JSON object.

public OrtoDatasOrtoRangeOptions(System.Text.Json.Nodes.JsonObject jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the options data.

Properties

OrtoDatasOrtoRangeOptions.Scale Property

Gets or sets the scale factor applied to the orthodata range.

public double Scale { get; set; }

Property Value

System.Double

OrtoRange Class

Represents an OrtoRange object that inherits from DiGi.Core.Classes.GuidObject and implements the IGISUniqueObject interface.

public class OrtoRange : DiGi.Core.Classes.GuidObject, DiGi.GIS.Interfaces.IGISUniqueObject, DiGi.GIS.Interfaces.IGISSerializableObject, DiGi.GIS.Interfaces.IGISObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Classes.UniqueObjectDiGi.Core.Classes.GuidObject → OrtoRange

Implements IGISUniqueObject, IGISSerializableObject, IGISObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject

Constructors

OrtoRange(BoundingBox2D, IEnumerable<string>, IEnumerable<string>) Constructor

Initializes a new instance of the OrtoRange class.

public OrtoRange(DiGi.Geometry.Planar.Classes.BoundingBox2D? boundingBox2D, System.Collections.Generic.IEnumerable<string>? references_Inside, System.Collections.Generic.IEnumerable<string>? references_Intersect);

Parameters

boundingBox2D DiGi.Geometry.Planar.Classes.BoundingBox2D

The optional BoundingBox2D that defines the spatial boundaries of the range.

references_Inside System.Collections.Generic.IEnumerable<System.String>

An optional System.Collections.Generic.IEnumerable<> of System.String containing references located inside the range.

references_Intersect System.Collections.Generic.IEnumerable<System.String>

An optional System.Collections.Generic.IEnumerable<> of System.String containing references that intersect with the range.

OrtoRange(OrtoRange) Constructor

Initializes a new instance of the OrtoRange class using the specified OrtoRange instance.

public OrtoRange(DiGi.GIS.Classes.OrtoRange? ortoRange);

Parameters

ortoRange OrtoRange

The OrtoRange instance to copy from.

OrtoRange(Guid, BoundingBox2D, IEnumerable<string>, IEnumerable<string>) Constructor

Initializes a new instance of the OrtoRange class.

public OrtoRange(System.Guid guid, DiGi.Geometry.Planar.Classes.BoundingBox2D? boundingBox2D, System.Collections.Generic.IEnumerable<string>? references_Inside, System.Collections.Generic.IEnumerable<string>? references_Intersect);

Parameters

guid System.Guid

The unique identifier for the OrtoRange.

boundingBox2D DiGi.Geometry.Planar.Classes.BoundingBox2D

The optional BoundingBox2D that defines the spatial boundaries of the range.

references_Inside System.Collections.Generic.IEnumerable<System.String>

An optional collection of System.String references located inside the range.

references_Intersect System.Collections.Generic.IEnumerable<System.String>

An optional collection of System.String references that intersect with the range.

OrtoRange(JsonObject) Constructor

Initializes a new instance of the OrtoRange class using the specified System.Text.Json.Nodes.JsonObject.

public OrtoRange(System.Text.Json.Nodes.JsonObject? jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The System.Text.Json.Nodes.JsonObject used to initialize the current instance.

Properties

OrtoRange.BoundingBox2D Property

Gets or sets the BoundingBox2D that defines the axis-aligned bounding box of the object in two-dimensional space. This value is null if no bounding box is defined.

public DiGi.Geometry.Planar.Classes.BoundingBox2D? BoundingBox2D { get; }

Property Value

DiGi.Geometry.Planar.Classes.BoundingBox2D

OrtoRange.References_InRange Property

Gets or sets the System.Collections.Generic.HashSet<> of System.String references that are within the specified range.

public System.Collections.Generic.HashSet<string>? References_InRange { get; }

Property Value

System.Collections.Generic.HashSet<System.String>
A System.Collections.Generic.HashSet<> containing string references, or null if no references are in range.

OrtoRange.References_Inside Property

Gets or sets a System.Collections.Generic.HashSet<> of System.String values representing the references contained inside the current object.

public System.Collections.Generic.HashSet<string>? References_Inside { get; }

Property Value

System.Collections.Generic.HashSet<System.String>

OrtoRange.References_Intersect Property

Gets or sets a System.Collections.Generic.HashSet<> of System.String objects representing the intersection of references.

public System.Collections.Generic.HashSet<string>? References_Intersect { get; }

Property Value

System.Collections.Generic.HashSet<System.String>

Methods

OrtoRange.Contains(string) Method

Determines whether the collection contains a specific string reference.

public bool Contains(string? reference);

Parameters

reference System.String

The System.String reference to locate in the collection.

Returns

System.Boolean
A System.Boolean value indicating whether the specified System.String was found.

OrtoRange.InRange(string) Method

Determines whether the specified reference is within the valid range.

public bool InRange(string? reference);

Parameters

reference System.String

The System.String reference to evaluate.

Returns

System.Boolean
A System.Boolean value indicating whether the System.String reference is in range.

OrtoRange.Inside(string) Method

Determines whether the specified reference is contained within the current context.

public bool Inside(string? reference);

Parameters

reference System.String

The string reference to evaluate.

Returns

System.Boolean
A boolean value indicating true if the reference is inside; otherwise, false.

OrtoRange.Intersect(string) Method

Determines whether there is an intersection with the specified reference string.

public bool Intersect(string? reference);

Parameters

reference System.String

The nullable System.String reference to intersect with.

Returns

System.Boolean
A System.Boolean value indicating whether the intersection occurred.

OrtoRangeFile Class

Represents a file storage object specifically for OrtoRange data, providing functionality to manage and reference OrtoRange files.

public class OrtoRangeFile : DiGi.Core.IO.File.Classes.StorageFile<DiGi.GIS.Classes.OrtoRange>, DiGi.GIS.Interfaces.IGISObject, DiGi.Core.Interfaces.IObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.IO.File.Classes.FileDiGi.Core.IO.File.Classes.StorageFile<OrtoRange> → OrtoRangeFile

Implements IGISObject, DiGi.Core.Interfaces.IObject

Constructors

OrtoRangeFile(OrtoRangeFile) Constructor

Initializes a new instance of the OrtoRangeFile class by copying an existing OrtoRangeFile instance.

public OrtoRangeFile(DiGi.GIS.Classes.OrtoRangeFile? ortoRangeFile);

Parameters

ortoRangeFile OrtoRangeFile

The source OrtoRangeFile instance to copy from.

OrtoRangeFile(string) Constructor

Initializes a new instance of the OrtoRangeFile class using a specified file path.

public OrtoRangeFile(string path);

Parameters

path System.String

The system path to the OrtoRange file.

OrtoRangeFile(JsonObject) Constructor

Initializes a new instance of the OrtoRangeFile class using data from a JSON object.

public OrtoRangeFile(System.Text.Json.Nodes.JsonObject? jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The System.Text.Json.Nodes.JsonObject containing the file information.

Methods

OrtoRangeFile.GetUniqueReference(OrtoRange) Method

Gets the unique reference for the specified OrtoRange object.

public override DiGi.Core.Classes.UniqueReference? GetUniqueReference(DiGi.GIS.Classes.OrtoRange? ortoRange);

Parameters

ortoRange OrtoRange

The OrtoRange object to retrieve the unique reference from.

Returns

DiGi.Core.Classes.UniqueReference
A DiGi.Core.Classes.UniqueReference associated with the OrtoRange object, or null if the provided object is null.

OrtoRangeFile.GetUniqueReference(string) Method

Gets the unique reference based on a string identifier.

public static DiGi.Core.Classes.UniqueReference? GetUniqueReference(string? reference);

Parameters

reference System.String

The string identifier used to create the unique reference.

Returns

DiGi.Core.Classes.UniqueReference
A DiGi.Core.Classes.UniqueReference created from the provided string, or null if the reference is null.

OrtoRangeOptions Class

Provides options for specifying the range of an orthophoto, including width and height dimensions.

public class OrtoRangeOptions : DiGi.Core.Classes.SerializableOptions

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Classes.SerializableOptions → OrtoRangeOptions

Constructors

OrtoRangeOptions() Constructor

Initializes a new instance of the OrtoRangeOptions class.

public OrtoRangeOptions();

OrtoRangeOptions(OrtoRangeOptions) Constructor

Initializes a new instance of the OrtoRangeOptions class by copying values from an existing OrtoRangeOptions instance.

public OrtoRangeOptions(DiGi.GIS.Classes.OrtoRangeOptions ortoRangeOptions);

Parameters

ortoRangeOptions OrtoRangeOptions

The source options instance to copy from.

OrtoRangeOptions(double, double) Constructor

Initializes a new instance of the OrtoRangeOptions class with specified width and height.

public OrtoRangeOptions(double width, double height);

Parameters

width System.Double

The width of the orthophoto range.

height System.Double

The height of the orthophoto range.

OrtoRangeOptions(JsonObject) Constructor

Initializes a new instance of the OrtoRangeOptions class using a JSON object.

public OrtoRangeOptions(System.Text.Json.Nodes.JsonObject jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the range options data.

Properties

OrtoRangeOptions.Height Property

Gets or sets the height of the orthophoto range.

public double Height { get; set; }

Property Value

System.Double

OrtoRangeOptions.Width Property

Gets or sets the width of the orthophoto range.

public double Width { get; set; }

Property Value

System.Double

OtherYearBuilt Class

Represents a year built value where the source is categorized as other.

public abstract class OtherYearBuilt : DiGi.GIS.Classes.YearBuilt

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectYearBuilt → OtherYearBuilt

Constructors

OtherYearBuilt(short) Constructor

Initializes a new instance of the OtherYearBuilt class with the specified year.

public OtherYearBuilt(short year);

Parameters

year System.Int16

The year to be assigned.

OtherYearBuilt(JsonObject) Constructor

Initializes a new instance of the OtherYearBuilt class using the provided JSON object.

public OtherYearBuilt(System.Text.Json.Nodes.JsonObject jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing year built data.

Properties

OtherYearBuilt.YearBuiltSource Property

Gets the source of the year built, which is always set to Other.

public override DiGi.GIS.Enums.YearBuiltSource YearBuiltSource { get; }

Implements YearBuiltSource

Property Value

YearBuiltSource

PredictedYearBuilt Class

Represents a year built value that has been predicted, including the date and time of the prediction.

public sealed class PredictedYearBuilt : DiGi.GIS.Classes.YearBuilt

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectYearBuilt → PredictedYearBuilt

Constructors

PredictedYearBuilt(PredictedYearBuilt) Constructor

Initializes a new instance of the PredictedYearBuilt class by copying another instance.

public PredictedYearBuilt(DiGi.GIS.Classes.PredictedYearBuilt predictedYearBuilt);

Parameters

predictedYearBuilt PredictedYearBuilt

The existing predicted year built instance to copy from.

PredictedYearBuilt(DateTime, short) Constructor

Initializes a new instance of the PredictedYearBuilt class with a specific date time and year.

public PredictedYearBuilt(System.DateTime dateTime, short year);

Parameters

dateTime System.DateTime

The date and time when the prediction was made.

year System.Int16

The predicted year built.

PredictedYearBuilt(JsonObject) Constructor

Initializes a new instance of the PredictedYearBuilt class from a JSON object.

public PredictedYearBuilt(System.Text.Json.Nodes.JsonObject jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the data for initialization.

Properties

PredictedYearBuilt.DateTime Property

Gets the date and time when the prediction was made.

public System.DateTime DateTime { get; }

Property Value

System.DateTime

PredictedYearBuilt.Source Property

Gets the source identifier for the predicted year built, combining the source type and ticks of the prediction date.

public override string Source { get; }

Implements Source

Property Value

System.String

PredictedYearBuilt.YearBuiltSource Property

Gets the source of the year built value, which is always set to prediction.

public override DiGi.GIS.Enums.YearBuiltSource YearBuiltSource { get; }

Implements YearBuiltSource

Property Value

YearBuiltSource

PredictionTableConversionOptions Class

Provides options for the conversion of prediction tables.

public class PredictionTableConversionOptions : DiGi.GIS.Classes.TableConversionOptions

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Classes.SerializableOptionsTableConversionOptions → PredictionTableConversionOptions

Constructors

PredictionTableConversionOptions() Constructor

Initializes a new instance of the PredictionTableConversionOptions class.

public PredictionTableConversionOptions();

PredictionTableConversionOptions(PredictionTableConversionOptions) Constructor

Initializes a new instance of the PredictionTableConversionOptions class using an existing options object.

public PredictionTableConversionOptions(DiGi.GIS.Classes.PredictionTableConversionOptions predictionTableConversionOptions);

Parameters

predictionTableConversionOptions PredictionTableConversionOptions

The source options instance to copy values from.

PredictionTableConversionOptions(JsonObject) Constructor

Initializes a new instance of the PredictionTableConversionOptions class from a JSON object.

public PredictionTableConversionOptions(System.Text.Json.Nodes.JsonObject jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the configuration data.

Properties

PredictionTableConversionOptions.AdministrativeAreal2DsIndexDataFilePath Property

Gets or sets the file path to the administrative areal 2D index data.

public string? AdministrativeAreal2DsIndexDataFilePath { get; set; }

Property Value

System.String

PredictionTableConversionOptions.IncludeYearBuiltPredictions Property

Gets or sets a value indicating whether year built predictions should be included in the conversion process.

public bool IncludeYearBuiltPredictions { get; set; }

Property Value

System.Boolean

Source Class

Represents an abstract base class for source objects within the GIS system.

public abstract class Source : DiGi.Core.Classes.GuidObject, DiGi.GIS.Interfaces.ISource, DiGi.GIS.Interfaces.IGISUniqueObject, DiGi.GIS.Interfaces.IGISSerializableObject, DiGi.GIS.Interfaces.IGISObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Classes.UniqueObjectDiGi.Core.Classes.GuidObject → Source

Derived
DirectorySource

Implements ISource, IGISUniqueObject, IGISSerializableObject, IGISObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject

Constructors

Source() Constructor

Initializes a new instance of the Source class.

public Source();

Source(Source) Constructor

Initializes a new instance of the Source class as a copy of an existing source.

public Source(DiGi.GIS.Classes.Source? source);

Parameters

source Source

The source object to copy from.

Source(JsonObject) Constructor

Initializes a new instance of the Source class from a JSON object.

public Source(System.Text.Json.Nodes.JsonObject? jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the source data.

StatisticalData Class

Represents the base class for statistical data, providing common properties such as name and reference.

public abstract class StatisticalData : DiGi.Core.Classes.SerializableObject, DiGi.GIS.Interfaces.IStatisticalData, DiGi.GIS.Interfaces.IGISSerializableObject, DiGi.GIS.Interfaces.IGISObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObject → StatisticalData

Derived
StatisticalYearlyData<T>

Implements IStatisticalData, IGISSerializableObject, IGISObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject

Constructors

StatisticalData(StatisticalData) Constructor

Initializes a new instance of the StatisticalData class by copying an existing statistical data object.

public StatisticalData(DiGi.GIS.Classes.StatisticalData? statisticalData);

Parameters

statisticalData StatisticalData

The source statistical data object to copy from.

StatisticalData(string, string) Constructor

Initializes a new instance of the StatisticalData class.

public StatisticalData(string? name, string? reference);

Parameters

name System.String

The name of the statistical data.

reference System.String

The reference identifier for the statistical data.

StatisticalData(JsonObject) Constructor

Initializes a new instance of the StatisticalData class using a JSON object.

public StatisticalData(System.Text.Json.Nodes.JsonObject? jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the data to initialize the instance.

Properties

StatisticalData.Name Property

Gets the name of the statistical data.

public string? Name { get; }

Implements Name

Property Value

System.String

StatisticalData.Reference Property

Gets the reference identifier of the statistical data.

public string? Reference { get; }

Implements Reference

Property Value

System.String

StatisticalDataCollection Class

Represents a collection of statistical data associated with a specific unit code and identifier.

public class StatisticalDataCollection : DiGi.Core.Classes.GuidObject, DiGi.GIS.Interfaces.IGISGuidObject2D, DiGi.GIS.Interfaces.IGISGuidObject, DiGi.GIS.Interfaces.IGISUniqueObject, DiGi.GIS.Interfaces.IGISSerializableObject, DiGi.GIS.Interfaces.IGISObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject, DiGi.Core.Interfaces.IGuidObject, DiGi.GIS.Interfaces.IGISUniqueObject2D

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Classes.UniqueObjectDiGi.Core.Classes.GuidObject → StatisticalDataCollection

Implements IGISGuidObject2D, IGISGuidObject, IGISUniqueObject, IGISSerializableObject, IGISObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject, DiGi.Core.Interfaces.IGuidObject, IGISUniqueObject2D

Constructors

StatisticalDataCollection(StatisticalDataCollection) Constructor

Initializes a new instance of the StatisticalDataCollection class by copying another collection.

public StatisticalDataCollection(DiGi.GIS.Classes.StatisticalDataCollection? statisticalDataCollection);

Parameters

statisticalDataCollection StatisticalDataCollection

The source collection to copy from.

StatisticalDataCollection(Guid, UnitCode) Constructor

Initializes a new instance of the StatisticalDataCollection class with a specified identifier and unit code.

public StatisticalDataCollection(System.Guid guid, DiGi.GIS.Classes.UnitCode? unitCode);

Parameters

guid System.Guid

The unique identifier for the collection.

unitCode UnitCode

The unit code associated with this collection.

StatisticalDataCollection(Guid, UnitCode, IEnumerable<IStatisticalData>) Constructor

Initializes a new instance of the StatisticalDataCollection class with a specified identifier, unit code, and initial statistical data.

public StatisticalDataCollection(System.Guid guid, DiGi.GIS.Classes.UnitCode? unitCode, System.Collections.Generic.IEnumerable<DiGi.GIS.Interfaces.IStatisticalData>? statisticalDatas);

Parameters

guid System.Guid

The unique identifier for the collection.

unitCode UnitCode

The unit code associated with this collection.

statisticalDatas System.Collections.Generic.IEnumerable<IStatisticalData>

An optional sequence of statistical data items to populate the collection.

StatisticalDataCollection(JsonObject) Constructor

Initializes a new instance of the StatisticalDataCollection class from a JSON object.

public StatisticalDataCollection(System.Text.Json.Nodes.JsonObject jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the collection data.

Properties

StatisticalDataCollection.Code Property

Gets or sets the code associated with the unit code of this collection.

public string? Code { get; set; }

Property Value

System.String

StatisticalDataCollection.Names Property

Gets the names of all statistical data items currently stored in the collection.

public System.Collections.Generic.IEnumerable<string> Names { get; }

Property Value

System.Collections.Generic.IEnumerable<System.String>

StatisticalDataCollection.StatisticalDatas Property

Gets or sets the sequence of statistical data items contained in this collection.

public System.Collections.Generic.IEnumerable<DiGi.GIS.Interfaces.IStatisticalData>? StatisticalDatas { get; private set; }

Property Value

System.Collections.Generic.IEnumerable<IStatisticalData>

StatisticalDataCollection.this[string] Property

Gets the statistical data item associated with the specified name.

public DiGi.GIS.Interfaces.IStatisticalData? this[string name] { get; }

Parameters

name System.String

The name of the statistical data item to retrieve.

Property Value

IStatisticalData

StatisticalDataCollection.UnitCode Property

Gets the unit code associated with this collection.

public DiGi.GIS.Classes.UnitCode? UnitCode { get; }

Property Value

UnitCode

Methods

StatisticalDataCollection.Add(IStatisticalData) Method

Adds a statistical data item to the collection.

public bool Add(DiGi.GIS.Interfaces.IStatisticalData? statisticalData);

Parameters

statisticalData IStatisticalData

The statistical data item to add.

Returns

System.Boolean
True if the item was successfully added; false if the item is null or has no name.

StatisticalDataCollection.Contains(string) Method

Determines whether the collection contains a statistical data item with the specified name.

public bool Contains(string name);

Parameters

name System.String

The name of the item to locate.

Returns

System.Boolean
True if an item with the specified name exists; otherwise, false.

StatisticalDataCollection.Find<TStatisticalData>(Func<TStatisticalData,bool>) Method

Searches for a statistical data item of a specific type that satisfies the provided predicate.

public TStatisticalData? Find<TStatisticalData>(System.Func<TStatisticalData?,bool>? func)
    where TStatisticalData : DiGi.GIS.Interfaces.IStatisticalData;

Type parameters

TStatisticalData

The type of statistical data to search for.

Parameters

func System.Func<TStatisticalData,System.Boolean>

A predicate function used to test each element for a match.

Returns

TStatisticalData
The first item that matches the criteria, or the default value if no match is found or the predicate is null.

StatisticalDataCollection.GetStatisticalData(string) Method

Retrieves the statistical data item associated with the specified name.

public DiGi.GIS.Interfaces.IStatisticalData? GetStatisticalData(string? name);

Parameters

name System.String

The name of the statistical data item to retrieve.

Returns

IStatisticalData
The matching IStatisticalData if found; otherwise, null.

StatisticalDataCollection.GetStatisticalDatas<UStatisticalData>() Method

Retrieves all statistical data items in the collection that are of a specific type.

public System.Collections.Generic.IEnumerable<UStatisticalData> GetStatisticalDatas<UStatisticalData>()
    where UStatisticalData : DiGi.GIS.Interfaces.IStatisticalData;

Type parameters

UStatisticalData

The type of statistical data to filter by.

Returns

System.Collections.Generic.IEnumerable<UStatisticalData>
A sequence containing all items of the specified type.

StatisticalDataCollection.Remove(string) Method

Removes the statistical data item with the specified name from the collection.

public bool Remove(string? name);

Parameters

name System.String

The name of the item to remove.

Returns

System.Boolean
True if the item was successfully removed; false if the name is null or the item does not exist.

StatisticalDataCollection.TryGetStatisticalData(string, IStatisticalData) Method

Attempts to retrieve a statistical data item by its name.

public bool TryGetStatisticalData(string? name, out DiGi.GIS.Interfaces.IStatisticalData? statisticalData);

Parameters

name System.String

The name of the item to search for.

statisticalData IStatisticalData

When this method returns, contains the found item if successful; otherwise, null.

Returns

System.Boolean
True if the item was found; otherwise, false.

StatisticalDataCollectionFile Class

Represents a file for storing and loading statistical data collections

public class StatisticalDataCollectionFile : DiGi.Core.IO.File.Classes.StorageFile<DiGi.GIS.Classes.StatisticalDataCollection>, DiGi.GIS.Interfaces.IGISObject, DiGi.Core.Interfaces.IObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.IO.File.Classes.FileDiGi.Core.IO.File.Classes.StorageFile<StatisticalDataCollection> → StatisticalDataCollectionFile

Implements IGISObject, DiGi.Core.Interfaces.IObject

Constructors

StatisticalDataCollectionFile(StatisticalDataCollectionFile) Constructor

Initializes a new instance of the StatisticalDataCollectionFile class by copying another instance

public StatisticalDataCollectionFile(DiGi.GIS.Classes.StatisticalDataCollectionFile? statisticalDataCollectionFile);

Parameters

statisticalDataCollectionFile StatisticalDataCollectionFile

The source file instance to copy from.

StatisticalDataCollectionFile(string) Constructor

Initializes a new instance of the StatisticalDataCollectionFile class from the specified path

public StatisticalDataCollectionFile(string? path);

Parameters

path System.String

The file system path to the statistical data collection file.

StatisticalDataCollectionFile(JsonObject) Constructor

Initializes a new instance of the StatisticalDataCollectionFile class from a JSON object

public StatisticalDataCollectionFile(System.Text.Json.Nodes.JsonObject? jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the data for the file.

Methods

StatisticalDataCollectionFile.GetUniqueReference(StatisticalDataCollection) Method

Gets the unique reference for the given statistical data collection

public override DiGi.Core.Classes.UniqueReference? GetUniqueReference(DiGi.GIS.Classes.StatisticalDataCollection? statisticalDataCollection);

Parameters

statisticalDataCollection StatisticalDataCollection

The statistical data collection to retrieve the unique reference for.

Returns

DiGi.Core.Classes.UniqueReference
The unique reference associated with the statistical data collection, or null if the provided collection is null.

StatisticalDataCollectionFile.GetUniqueReference(string) Method

Gets the unique reference for the given reference string

public static DiGi.Core.Classes.UniqueReference? GetUniqueReference(string? reference);

Parameters

reference System.String

The reference string used to create the unique reference.

Returns

DiGi.Core.Classes.UniqueReference
A new UniqueReference instance based on the provided string, or null if the reference is null.

StatisticalUnit Class

Represents a statistical unit within the GIS system, providing hierarchical organization and identification via unit codes.

public class StatisticalUnit : DiGi.Core.Classes.GuidObject, DiGi.GIS.Interfaces.IGISObject, DiGi.Core.Interfaces.IObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Classes.UniqueObjectDiGi.Core.Classes.GuidObject → StatisticalUnit

Implements IGISObject, DiGi.Core.Interfaces.IObject

Constructors

StatisticalUnit(StatisticalUnit) Constructor

Initializes a new instance of the StatisticalUnit class by copying another statistical unit.

public StatisticalUnit(DiGi.GIS.Classes.StatisticalUnit? statisticalUnit);

Parameters

statisticalUnit StatisticalUnit

The source statistical unit to copy from.

StatisticalUnit(Guid, UnitCode, string, IEnumerable<StatisticalUnit>) Constructor

Initializes a new instance of the StatisticalUnit class.

public StatisticalUnit(System.Guid guid, DiGi.GIS.Classes.UnitCode? unitCode, string? name, System.Collections.Generic.IEnumerable<DiGi.GIS.Classes.StatisticalUnit>? statisticalUnits);

Parameters

guid System.Guid

The unique identifier for the statistical unit.

unitCode UnitCode

The code associated with the statistical unit.

name System.String

The descriptive name of the statistical unit.

statisticalUnits System.Collections.Generic.IEnumerable<StatisticalUnit>

A collection of child statistical units.

StatisticalUnit(JsonObject) Constructor

Initializes a new instance of the StatisticalUnit class from a JSON object.

public StatisticalUnit(System.Text.Json.Nodes.JsonObject? jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object containing the statistical unit data.

Properties

StatisticalUnit.Code Property

Gets or sets the code of the statistical unit.

public string? Code { get; set; }

Property Value

System.String

StatisticalUnit.Name Property

Gets the name of the statistical unit.

public string? Name { get; }

Property Value

System.String

StatisticalUnit.StatisticalUnits Property

Gets the collection of child statistical units associated with this unit.

public System.Collections.Generic.IEnumerable<DiGi.GIS.Classes.StatisticalUnit>? StatisticalUnits { get; private set; }

Property Value

System.Collections.Generic.IEnumerable<StatisticalUnit>

StatisticalUnit.UnitCode Property

Gets the unit code associated with this statistical unit.

public DiGi.GIS.Classes.UnitCode? UnitCode { get; }

Property Value

UnitCode

Methods

StatisticalUnit.Find(UnitCode, bool) Method

Searches for a statistical unit that matches the specified unit code.

public DiGi.GIS.Classes.StatisticalUnit? Find(DiGi.GIS.Classes.UnitCode? unitCode, bool includeNested);

Parameters

unitCode UnitCode

The unit code to search for.

includeNested System.Boolean

If set to true, searches recursively through child units.

Returns

StatisticalUnit
The matching StatisticalUnit if found; otherwise, null.

StatisticalUnit.GetStatisticalUnits(bool, Func<StatisticalUnit,bool>) Method

Retrieves a collection of statistical units, optionally including nested children and

Clone this wiki locally