Class ReadOnlyReceptorResult
A read-only definition of receptor results
Implements
Namespace: Scripting
Syntax
public class ReadOnlyReceptorResult : INamedItem
Properties
Bearing
Gets the bearing
Declaration
public double Bearing { get; }
Property Value
Type | Description |
---|---|
System.Double |
Coordinates
Gets the coordinates of the receptor result
Declaration
public GhPoint Coordinates { get; }
Property Value
Type | Description |
---|---|
GhPoint |
DaysOverDailyLimit
Gets the number of days over the daily limit
Declaration
public int DaysOverDailyLimit { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
HeightAboveGround
Gets the height above ground
Declaration
public double HeightAboveGround { get; }
Property Value
Type | Description |
---|---|
System.Double |
Location
Gets the location of the receptor
Declaration
public I2DLocation Location { get; }
Property Value
Type | Description |
---|---|
I2DLocation |
MinutesOnWorstDay
Gets the minutes on the worst day of the year
Declaration
public double MinutesOnWorstDay { get; }
Property Value
Type | Description |
---|---|
System.Double |
Name
Gets the name of the receptor result
Declaration
public string Name { get; }
Property Value
Type | Description |
---|---|
System.String |
NumberOfDaysWithFlicker
Gets the number of days with flicker
Declaration
public int NumberOfDaysWithFlicker { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
Tilt
Gets the tilt
Declaration
public double Tilt { get; }
Property Value
Type | Description |
---|---|
System.Double |
TotalHoursPerYear
Gets the total hours per year
Declaration
public double TotalHoursPerYear { get; }
Property Value
Type | Description |
---|---|
System.Double |
TurbineFlickers
The collection of turbine flickers
Declaration
public IReadableKeyedEnumerable<string, ReadOnlyTurbineFlicker> TurbineFlickers { get; }
Property Value
Type | Description |
---|---|
IReadableKeyedEnumerable<System.String, ReadOnlyTurbineFlicker> |
WorstDayOfYear
Gets the worst day of the year
Declaration
public int WorstDayOfYear { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
Methods
Equals(ReadOnlyReceptorResult)
Tests a ReadOnlyReceptorResult against this current ReadOnlyReceptorResult for equality.
Declaration
public bool Equals(ReadOnlyReceptorResult val)
Parameters
Type | Name | Description |
---|---|---|
ReadOnlyReceptorResult | val |
Returns
Type | Description |
---|---|
System.Boolean | True if equal otherwise false is returned. |
Equals(Object)
Tests a System.Object against this current ReadOnlyReceptorResult 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
GetFlickerFromTurbine(String)
Gets the shadow flicker result for the given turbine.
Declaration
public ReadOnlyTurbineFlicker GetFlickerFromTurbine(string turbineName)
Parameters
Type | Name | Description |
---|---|---|
System.String | turbineName | Name of the turbine. |
Returns
Type | Description |
---|---|
ReadOnlyTurbineFlicker | The results for the turbine with the given name. |
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
Operators
Equality(ReadOnlyReceptorResult, ReadOnlyReceptorResult)
Tests a ReadOnlyReceptorResult against this current ReadOnlyReceptorResult for equality.
Declaration
public static bool operator ==(ReadOnlyReceptorResult a, ReadOnlyReceptorResult b)
Parameters
Type | Name | Description |
---|---|---|
ReadOnlyReceptorResult | a | |
ReadOnlyReceptorResult | b |
Returns
Type | Description |
---|---|
System.Boolean | True if equal otherwise false is returned. |
Inequality(ReadOnlyReceptorResult, ReadOnlyReceptorResult)
Tests a ReadOnlyReceptorResult against this current ReadOnlyReceptorResult for inequality.
Declaration
public static bool operator !=(ReadOnlyReceptorResult a, ReadOnlyReceptorResult b)
Parameters
Type | Name | Description |
---|---|---|
ReadOnlyReceptorResult | a | |
ReadOnlyReceptorResult | b |
Returns
Type | Description |
---|---|
System.Boolean | True if not equal otherwise false is returned. |