Skip to content

DiGi.Solar.Interfaces

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

DiGi.Solar.Interfaces Namespace

Interfaces

IShadingElement Interface

Defines the properties of an element that provides shading.

public interface IShadingElement : DiGi.Solar.Interfaces.IShadingUniqueObject, DiGi.Solar.Interfaces.IShadingSerializableObject, DiGi.Solar.Interfaces.IShadingObject, DiGi.Solar.Interfaces.ISolarObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject

Derived
ShadingElement

Implements IShadingUniqueObject, IShadingSerializableObject, IShadingObject, ISolarObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject

Properties

IShadingElement.PolygonalFace3D Property

Gets the 3D polygonal face associated with the shading element.

DiGi.Geometry.Spatial.Interfaces.IPolygonalFace3D? PolygonalFace3D { get; }

Property Value

DiGi.Geometry.Spatial.Interfaces.IPolygonalFace3D

IShadingElement.Reference Property

Gets the reference identifier of the shading element.

string? Reference { get; }

Property Value

System.String

IShadingElement.ShadingOnly Property

Gets a value indicating whether the element is used exclusively for shading purposes.

bool ShadingOnly { get; }

Property Value

System.Boolean

IShadingObject Interface

Defines the contract for an object that causes shading within a solar installation.

public interface IShadingObject : DiGi.Solar.Interfaces.ISolarObject, DiGi.Core.Interfaces.IObject

Derived
ShadingElement
ShadingSolverResult
ShadingSolverResultRelation
IShadingElement
IShadingRelation
IShadingSerializableObject
IShadingSolverResult
IShadingUniqueObject

Implements ISolarObject, DiGi.Core.Interfaces.IObject

IShadingRelation Interface

Defines the contract for a shading relation, combining the characteristics of a shading object and a relationship between unique objects.

public interface IShadingRelation : DiGi.Solar.Interfaces.IShadingObject, DiGi.Solar.Interfaces.ISolarObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Relation.Interfaces.IRelation, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject

Derived
ShadingSolverResultRelation

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

IShadingSerializableObject Interface

Defines a contract for shading objects that can be serialized to and from JSON.

public interface IShadingSerializableObject : DiGi.Solar.Interfaces.IShadingObject, DiGi.Solar.Interfaces.ISolarObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject

Derived
ShadingElement
ShadingSolverResult
IShadingElement
IShadingSolverResult
IShadingUniqueObject

Implements IShadingObject, ISolarObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject

IShadingSolverResult Interface

Defines a contract for an object that represents the result of a shading solver operation.

public interface IShadingSolverResult : DiGi.Solar.Interfaces.IShadingUniqueObject, DiGi.Solar.Interfaces.IShadingSerializableObject, DiGi.Solar.Interfaces.IShadingObject, DiGi.Solar.Interfaces.ISolarObject, 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.IResult<DiGi.Solar.Interfaces.IShadingElement>, DiGi.Core.Interfaces.IResult

Derived
ShadingSolverResult

Implements IShadingUniqueObject, IShadingSerializableObject, IShadingObject, ISolarObject, 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.IResult<IShadingElement>, DiGi.Core.Interfaces.IResult

Properties

IShadingSolverResult.Area Property

Gets the calculated area of the shading result.

double Area { get; }

Property Value

System.Double

IShadingSolverResult.DateTime Property

Gets the date and time associated with the shading calculation.

System.DateTime DateTime { get; }

Property Value

System.DateTime

IShadingUniqueObject Interface

Defines a contract for a shading object that is both serializable and possesses a unique identifier.

public interface IShadingUniqueObject : DiGi.Solar.Interfaces.IShadingSerializableObject, DiGi.Solar.Interfaces.IShadingObject, DiGi.Solar.Interfaces.ISolarObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject

Derived
ShadingElement
ShadingSolverResult
IShadingElement
IShadingSolverResult

Implements IShadingSerializableObject, IShadingObject, ISolarObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IUniqueObject

ISolarObject Interface

Defines the contract for an object specifically associated with solar energy components and systems.

public interface ISolarObject : DiGi.Core.Interfaces.IObject

Derived
ShadingElement
ShadingModel
ShadingRelationCluster
ShadingSolverResult
ShadingSolverResultRelation
IShadingElement
IShadingObject
IShadingRelation
IShadingSerializableObject
IShadingSolverResult
IShadingUniqueObject

Implements DiGi.Core.Interfaces.IObject

Clone this wiki locally