Class ScenarioAlbedoData

Namespace: Scripting

Syntax

public class ScenarioAlbedoData

Constructors

ScenarioAlbedoData()

Creates an instance of the ScenarioAlbedoData class.

Declaration

public ScenarioAlbedoData()

Properties

MonthlyAlbedoValues

Declaration

public IList<ScenarioMonthlyAlbedo> MonthlyAlbedoValues { get; }

Property Value

Type	Description
System.Collections.Generic.IList<ScenarioMonthlyAlbedo>

OverallAlbedoValue

Declaration

public double OverallAlbedoValue { get; set; }

Property Value

Type	Description
System.Double

UseMonthlyAlbedoValues

Declaration

public bool UseMonthlyAlbedoValues { get; set; }

Property Value

Type	Description
System.Boolean

Methods

Equals(ScenarioAlbedoData)

Tests a ScenarioAlbedoData against this current ScenarioAlbedoData for equality.

Declaration

public bool Equals(ScenarioAlbedoData val)

Parameters

Type	Name	Description
ScenarioAlbedoData	val

Returns

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

Equals(Object)

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

LoadFromFile(String)

Loads (deserializes) the scenario albedo data object from the XML file.

Declaration

public static ScenarioAlbedoData LoadFromFile(string xmlFilePath)

Parameters

Type	Name	Description
System.String	xmlFilePath	The XML file path containing the ScenarioAlbedoData object data.

Returns

Type	Description
ScenarioAlbedoData	A new ScenarioAlbedoData object initialised from the contents of the file

Operators

Equality(ScenarioAlbedoData, ScenarioAlbedoData)

Tests a ScenarioAlbedoData against this current ScenarioAlbedoData for equality.

Declaration

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

Parameters

Type	Name	Description
ScenarioAlbedoData	a
ScenarioAlbedoData	b

Returns

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

Inequality(ScenarioAlbedoData, ScenarioAlbedoData)

Tests a ScenarioAlbedoData against this current ScenarioAlbedoData for inequality.

Declaration

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

Parameters

Type	Name	Description
ScenarioAlbedoData	a
ScenarioAlbedoData	b

Returns

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