Class SolarResource

Namespace: Scripting

Syntax

public class SolarResource

Constructors

SolarResource()

Creates an instance of the SolarResource class.

Declaration

public SolarResource()

Properties

AdditionalInformation

Declaration

public string AdditionalInformation { get; set; }

Property Value

Type	Description
System.String

Elevation

Declaration

public double Elevation { get; set; }

Property Value

Type	Description
System.Double

FilePath

Declaration

public string FilePath { get; set; }

Property Value

Type	Description
System.String

ImportSummary

Declaration

public string ImportSummary { get; set; }

Property Value

Type	Description
System.String

IsTypicalMeteorologicalYear

Declaration

public bool IsTypicalMeteorologicalYear { get; set; }

Property Value

Type	Description
System.Boolean

Latitude

Declaration

public double Latitude { get; set; }

Property Value

Type	Description
System.Double

Longitude

Declaration

public double Longitude { get; set; }

Property Value

Type	Description
System.Double

Name

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

TimeZone

The timezone that the solar resource data was stored in on disc.

Declaration

public double TimeZone { get; set; }

Property Value

Type	Description
System.Double

TimeZoneName

Declaration

public string TimeZoneName { get; set; }

Property Value

Type	Description
System.String

Methods

Equals(SolarResource)

Tests a SolarResource against this current SolarResource for equality.

Declaration

public bool Equals(SolarResource val)

Parameters

Type	Name	Description
SolarResource	val

Returns

Type	Description
System.Boolean	True if equal otherwise false is returned.

Equals(Object)

Tests a System.Object against this current SolarResource 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()

ReadMeteonormFile(String)

Loads climate data from a Meteonorm PVsyst hourly TMY file.

Declaration

public static SolarResource ReadMeteonormFile(string filePath)

Parameters

Type	Name	Description
System.String	filePath	The path of the file to read.

Returns

Type	Description
SolarResource	The imported solar resource.

ReadNSRDBFile(String)

Loads climate data from a National Solar Radiation Data Base file.

Declaration

public static SolarResource ReadNSRDBFile(string filePath)

Parameters

Type	Name	Description
System.String	filePath	The path of the file to read.

Returns

Type	Description
SolarResource

Exceptions

Type	Condition
System.NotImplementedException

ReadPVsystStandardFormatFile(String)

Loads climate data from a PVsyst standard format file.

Declaration

public static SolarResource ReadPVsystStandardFormatFile(string filePath)

Parameters

Type	Name	Description
System.String	filePath	The path of the file to read.

Returns

Type	Description
SolarResource	The imported solar resource.

ReadSolarGISDatabaseFile(String)

Loads climate data from a Solar GIS file.

Declaration

public static SolarResource ReadSolarGISDatabaseFile(string filePath)

Parameters

Type	Name	Description
System.String	filePath	The path of the file to read.

Returns

Type	Description
SolarResource

Exceptions

Type	Condition
System.NotImplementedException

ReadSolcastCsvFile(String)

Loads climate data from a Solcast CSV format file.

Declaration

public static SolarResource ReadSolcastCsvFile(string filePath)

Parameters

Type	Name	Description
System.String	filePath	The path of the file to read.

Returns

Type	Description
SolarResource	The imported solar resource.

ReadTsvFile(String)

Loads climate data from a tab-separated variable file.

Declaration

public static SolarResource ReadTsvFile(string filePath)

Parameters

Type	Name	Description
System.String	filePath	The path of the file to read.

Returns

Type	Description
SolarResource

Exceptions

Type	Condition
System.NotImplementedException

Operators

Equality(SolarResource, SolarResource)

Tests a SolarResource against this current SolarResource for equality.

Declaration

public static bool operator ==(SolarResource a, SolarResource b)

Parameters

Type	Name	Description
SolarResource	a
SolarResource	b

Returns

Type	Description
System.Boolean	True if equal otherwise false is returned.

Inequality(SolarResource, SolarResource)

Tests a SolarResource against this current SolarResource for inequality.

Declaration

public static bool operator !=(SolarResource a, SolarResource b)

Parameters

Type	Name	Description
SolarResource	a
SolarResource	b

Returns

Type	Description
System.Boolean	True if not equal otherwise false is returned.