Class LayoutBoundary

Namespace: Scripting
Syntax
public class LayoutBoundary

Constructors

LayoutBoundary()

Creates an instance of the LayoutBoundary class.

Declaration
public LayoutBoundary()

Properties

ActualHeight

Gets the actual height of the bounding rectangle of this layout boundary.

Declaration
public double ActualHeight { get; }
Property Value
Type Description
System.Double

ActualWidth

Gets the actual width (of the bounding rectangle) of this layout boundary.

Declaration
public double ActualWidth { get; }
Property Value
Type Description
System.Double

AutoFillAutomatically

Declaration
public bool AutoFillAutomatically { get; set; }
Property Value
Type Description
System.Boolean

Bounds

Gets the bounding box of this layout region.

Declaration
public Rect Bounds { get; }
Property Value
Type Description
Rect

Name

Name of the layout boundary

Declaration
public string Name { get; set; }
Property Value
Type Description
System.String

Points

Gets the points that define the boundary of the layout region.

Declaration
public IEnumerable<IReadable2DLocation> Points { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<IReadable2DLocation>

RackLayoutParameters

Declaration
public RackLayoutParameters RackLayoutParameters { get; }
Property Value
Type Description
RackLayoutParameters

Setback

Declaration
public double Setback { get; set; }
Property Value
Type Description
System.Double

TrackerLayoutParameters

Declaration
public TrackerLayoutParameters TrackerLayoutParameters { get; }
Property Value
Type Description
TrackerLayoutParameters

Methods

AddNewTrackerToRowPosition(Int32, Location, TrackerTemplateSpecification, Int32)

Adds a new tracker to the specified row position index.

Declaration
public void AddNewTrackerToRowPosition(int rowPositionIndex, Location trackerLocation, TrackerTemplateSpecification trackerTemplateSpecification, int id)
Parameters
Type Name Description
System.Int32 rowPositionIndex

Index of the row position.
Location trackerLocation

The tracker location.
TrackerTemplateSpecification trackerTemplateSpecification

The tracker template specification.
System.Int32 id

The identifier to give to the new tracker instance.
Exceptions
Type Condition
ScriptingException

Thrown if the specified row position index does not exist.

AddSpacingZonesForTrackers(IList<Double>)

Adds the spacing zones for trackers, one for each distance in the specified list.

Declaration
public void AddSpacingZonesForTrackers(IList<double> distancesFromEnd)
Parameters
Type Name Description
System.Collections.Generic.IList<System.Double> distancesFromEnd

The distances from end (in metres).

Equals(LayoutBoundary)

Tests a LayoutBoundary against this current LayoutBoundary for equality.

Declaration
public bool Equals(LayoutBoundary val)
Parameters
Type Name Description
LayoutBoundary val
Returns
Type Description
System.Boolean

True if equal otherwise false is returned.

Equals(Object)

Tests a System.Object against this current LayoutBoundary for equality.

Declaration
public override bool Equals(object toCompare)
Parameters
Type Name Description
System.Object toCompare
Returns
Type Description
System.Boolean

True if object is equal otherwise false is returned.
Overrides
System.Object.Equals(System.Object)

GetHashCode()

Gets the hash code for this object.

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32

The hash code for this object.
Overrides
System.Object.GetHashCode()

RefreshDisplay()

Refreshes the display of this layout region.

Declaration
public void RefreshDisplay()

RemoveAllMountingInstances()

Removes all mounting instances (racks or trackers) on this layout region.

Declaration
public void RemoveAllMountingInstances()

RemoveAllRowPositions()

Removes all the row positions on this layout region.

Declaration
public void RemoveAllRowPositions()

RunAutoFill()

Runs the automatic fill algorithm on this layout region.

Declaration
public void RunAutoFill()

SetRowsColumns(Int32, Int32, Nullable<Double>, TrackerSystemSpecification, AddCentralInverterAndAssignStringsParameters, CentralInverterLocationParameters, LayoutBoundaryMarginParameters, RoadLocationParameters, RoadLocationParameters)

Fills the specified layout boundary with a number of mounting instances specified by the rows and columns.

Declaration
public void SetRowsColumns(int rows, int columns, double? pitch, TrackerSystemSpecification trackerSystemSpecification, AddCentralInverterAndAssignStringsParameters addCentralInverterAndAssignStringsParameters, CentralInverterLocationParameters centralInverterLocationParameters, LayoutBoundaryMarginParameters layoutBoundaryMarginParameters, RoadLocationParameters verticalRoadLocationParameters, RoadLocationParameters horizontalRoadLocationParameters)
Parameters
Type Name Description
System.Int32 rows

The number of rows of mounting instances to add.
System.Int32 columns

The number of columns of mounting instances to add.
System.Nullable<System.Double> pitch

The pitch (will be used if set. If null will use the existing pitch).
TrackerSystemSpecification trackerSystemSpecification

The tracker system specification.
AddCentralInverterAndAssignStringsParameters addCentralInverterAndAssignStringsParameters

The add central inverter and assign strings parameters.
CentralInverterLocationParameters centralInverterLocationParameters

The central inverter location parameters. If not null, will add and place a central inverter.
LayoutBoundaryMarginParameters layoutBoundaryMarginParameters

The layout boundary margin parameters.
RoadLocationParameters verticalRoadLocationParameters

The vertical (north/south) road location parameters.
RoadLocationParameters horizontalRoadLocationParameters

The horizontal (east/west) road location parameters.

SetRowsColumns(Int32, Int32, Nullable<Double>, Nullable<Double>, RackSystemSpecification, AddCentralInverterAndAssignStringsParameters, CentralInverterLocationParameters, LayoutBoundaryMarginParameters, RoadLocationParameters, RoadLocationParameters)

Fills the specified layout boundary with a number of mounting instances specified by the rows and columns.

Declaration
public void SetRowsColumns(int rows, int columns, double? pitch, double? tilt, RackSystemSpecification rackSystemSpecification, AddCentralInverterAndAssignStringsParameters addCentralInverterAndAssignStringsParameters, CentralInverterLocationParameters centralInverterLocationParameters, LayoutBoundaryMarginParameters layoutBoundaryMarginParameters, RoadLocationParameters verticalRoadLocationParameters, RoadLocationParameters horizontalRoadLocationParameters)
Parameters
Type Name Description
System.Int32 rows

The number of rows of mounting instances to add.
System.Int32 columns

The number of columns of mounting instances to add.
System.Nullable<System.Double> pitch

The pitch (will be used if set. If null will use the existing pitch).
System.Nullable<System.Double> tilt

The tilt (will be used if set and if fixed-tilt racks. If null will use the existing tilt).
RackSystemSpecification rackSystemSpecification

The rack system specification.
AddCentralInverterAndAssignStringsParameters addCentralInverterAndAssignStringsParameters

The add central inverter and assign strings parameters.
CentralInverterLocationParameters centralInverterLocationParameters

The central inverter location parameters. If not null, will add and place a central inverter.
LayoutBoundaryMarginParameters layoutBoundaryMarginParameters

The layout boundary margin parameters.
RoadLocationParameters verticalRoadLocationParameters

The vertical (north/south) road location parameters.
RoadLocationParameters horizontalRoadLocationParameters

The horizontal (east/west) road location parameters.

SetSize(Double, Double, Nullable<Double>, TrackerSystemSpecification, AddCentralInverterAndAssignStringsParameters, CentralInverterLocationParameters, LayoutBoundaryMarginParameters, RoadLocationParameters, RoadLocationParameters)

Sets the size of the specified layout boundary.

Declaration
public void SetSize(double width, double height, double? pitch, TrackerSystemSpecification trackerSystemSpecification, AddCentralInverterAndAssignStringsParameters addCentralInverterAndAssignStringsParameters, CentralInverterLocationParameters centralInverterLocationParameters, LayoutBoundaryMarginParameters layoutBoundaryMarginParameters, RoadLocationParameters verticalRoadLocationParameters, RoadLocationParameters horizontalRoadLocationParameters)
Parameters
Type Name Description
System.Double width

The width (in metres) (must be greater than 0.0).
System.Double height

The height (in metres) (must be greater than 0.0).
System.Nullable<System.Double> pitch

The pitch (will be used if set. If null will use the existing pitch).
TrackerSystemSpecification trackerSystemSpecification

The tracker system specification.
AddCentralInverterAndAssignStringsParameters addCentralInverterAndAssignStringsParameters

The add central inverter and assign strings parameters.
CentralInverterLocationParameters centralInverterLocationParameters

The central inverter location parameters. If not null, will add and place a central inverter.
LayoutBoundaryMarginParameters layoutBoundaryMarginParameters

The layout boundary margin parameters.
RoadLocationParameters verticalRoadLocationParameters

The vertical (north/south) road location parameters.
RoadLocationParameters horizontalRoadLocationParameters

The horizontal (east/west) road location parameters.

SetSize(Double, Double, Nullable<Double>, Nullable<Double>, RackSystemSpecification, AddCentralInverterAndAssignStringsParameters, CentralInverterLocationParameters, LayoutBoundaryMarginParameters, RoadLocationParameters, RoadLocationParameters)

Sets the size of the specified layout boundary.

Declaration
public void SetSize(double width, double height, double? pitch, double? tilt, RackSystemSpecification rackSystemSpecification, AddCentralInverterAndAssignStringsParameters addCentralInverterAndAssignStringsParameters, CentralInverterLocationParameters centralInverterLocationParameters, LayoutBoundaryMarginParameters layoutBoundaryMarginParameters, RoadLocationParameters verticalRoadLocationParameters, RoadLocationParameters horizontalRoadLocationParameters)
Parameters
Type Name Description
System.Double width

The width (in metres) (must be greater than 0.0).
System.Double height

The height (in metres) (must be greater than 0.0).
System.Nullable<System.Double> pitch

The pitch (will be used if set. If null will use the existing pitch).
System.Nullable<System.Double> tilt

The tilt (will be used if set and if fixed-tilt racks. If null will use the existing tilt).
RackSystemSpecification rackSystemSpecification

The rack system specification.
AddCentralInverterAndAssignStringsParameters addCentralInverterAndAssignStringsParameters

The add central inverter and assign strings parameters.
CentralInverterLocationParameters centralInverterLocationParameters

The central inverter location parameters. If not null, will add and place a central inverter.
LayoutBoundaryMarginParameters layoutBoundaryMarginParameters

The layout boundary margin parameters.
RoadLocationParameters verticalRoadLocationParameters

The vertical (north/south) road location parameters.
RoadLocationParameters horizontalRoadLocationParameters

The horizontal (east/west) road location parameters.

SetSizeFromDcAcRatio(Double, Nullable<Double>, TrackerSystemSpecification, AddCentralInverterAndAssignStringsParameters, CentralInverterLocationParameters, LayoutBoundaryMarginParameters, RoadLocationParameters, RoadLocationParameters)

Sets the size from the specified maximum DC power.

Declaration
public void SetSizeFromDcAcRatio(double dcAcRatio, double? pitch, TrackerSystemSpecification trackerSystemSpecification, AddCentralInverterAndAssignStringsParameters addCentralInverterAndAssignStringsParameters, CentralInverterLocationParameters centralInverterLocationParameters, LayoutBoundaryMarginParameters layoutBoundaryMarginParameters, RoadLocationParameters verticalRoadLocationParameters = null, RoadLocationParameters horizontalRoadLocationParameters = null)
Parameters
Type Name Description
System.Double dcAcRatio

The DC/AC ratio.
System.Nullable<System.Double> pitch

The pitch (will be used if set. If null will use the existing pitch).
TrackerSystemSpecification trackerSystemSpecification

The tracker system specification.
AddCentralInverterAndAssignStringsParameters addCentralInverterAndAssignStringsParameters

The add central inverter and assign strings parameters.
CentralInverterLocationParameters centralInverterLocationParameters

The central inverter location parameters.
LayoutBoundaryMarginParameters layoutBoundaryMarginParameters

The layout boundary margin parameters.
RoadLocationParameters verticalRoadLocationParameters

The vertical road location parameters.
RoadLocationParameters horizontalRoadLocationParameters

The horizontal road location parameters.

SetSizeFromDcAcRatio(Double, Nullable<Double>, Nullable<Double>, RackSystemSpecification, AddCentralInverterAndAssignStringsParameters, CentralInverterLocationParameters, LayoutBoundaryMarginParameters, RoadLocationParameters, RoadLocationParameters)

Sets the size from the specified maximum DC power.

Declaration
public void SetSizeFromDcAcRatio(double dcAcRatio, double? pitch, double? tilt, RackSystemSpecification rackSystemSpecification, AddCentralInverterAndAssignStringsParameters addCentralInverterAndAssignStringsParameters, CentralInverterLocationParameters centralInverterLocationParameters, LayoutBoundaryMarginParameters layoutBoundaryMarginParameters, RoadLocationParameters verticalRoadLocationParameters = null, RoadLocationParameters horizontalRoadLocationParameters = null)
Parameters
Type Name Description
System.Double dcAcRatio

The DC/AC ratio.
System.Nullable<System.Double> pitch

The pitch (will be used if set. If null will use the existing pitch).
System.Nullable<System.Double> tilt

The tilt (will be used if set and if fixed-tilt racks. If null will use the existing tilt).
RackSystemSpecification rackSystemSpecification

The rack system specification.
AddCentralInverterAndAssignStringsParameters addCentralInverterAndAssignStringsParameters

The add central inverter and assign strings parameters.
CentralInverterLocationParameters centralInverterLocationParameters

The central inverter location parameters.
LayoutBoundaryMarginParameters layoutBoundaryMarginParameters

The layout boundary margin parameters.
RoadLocationParameters verticalRoadLocationParameters

The vertical road location parameters.
RoadLocationParameters horizontalRoadLocationParameters

The horizontal road location parameters.

SetUniqueMountingInstanceIdsFromZero()

Sets unique IDs for the mounting instance (racks or trackers), starting from zero.

Declaration
public void SetUniqueMountingInstanceIdsFromZero()

Operators

Equality(LayoutBoundary, LayoutBoundary)

Tests a LayoutBoundary against this current LayoutBoundary for equality.

Declaration
public static bool operator ==(LayoutBoundary a, LayoutBoundary b)
Parameters
Type Name Description
LayoutBoundary a
LayoutBoundary b
Returns
Type Description
System.Boolean

True if equal otherwise false is returned.

Inequality(LayoutBoundary, LayoutBoundary)

Tests a LayoutBoundary against this current LayoutBoundary for inequality.

Declaration
public static bool operator !=(LayoutBoundary a, LayoutBoundary b)
Parameters
Type Name Description
LayoutBoundary a
LayoutBoundary b
Returns
Type Description
System.Boolean

True if not equal otherwise false is returned.