Class PerformanceStatistics

Namespace: Scripting

Syntax

public class PerformanceStatistics

Constructors

PerformanceStatistics()

Creates an instance of the PerformanceStatistics class.

Declaration

public PerformanceStatistics()

Properties

CurrentMemoryUsageInGB

Declaration

public double CurrentMemoryUsageInGB { get; set; }

Property Value

Type	Description
System.Double

EnergyCalcTimeInMinutes

Declaration

public double EnergyCalcTimeInMinutes { get; set; }

Property Value

Type	Description
System.Double

EnergyCalcTimePer10KInMinutes

Declaration

public double EnergyCalcTimePer10KInMinutes { get; set; }

Property Value

Type	Description
System.Double

ExtraMemoryFromBaselineInGB

Declaration

public double ExtraMemoryFromBaselineInGB { get; set; }

Property Value

Type	Description
System.Double

ExtraMemoryPer10KInGB

Declaration

public double ExtraMemoryPer10KInGB { get; set; }

Property Value

Type	Description
System.Double

MemoryBeforeCalculationStartsInGB

Declaration

public double MemoryBeforeCalculationStartsInGB { get; set; }

Property Value

Type	Description
System.Double

PeakMemoryUsageInGB

Declaration

public double PeakMemoryUsageInGB { get; set; }

Property Value

Type	Description
System.Double

ShadingTimeInMinutes

Declaration

public double ShadingTimeInMinutes { get; set; }

Property Value

Type	Description
System.Double

ShadingTimePer10KInMinutes

Declaration

public double ShadingTimePer10KInMinutes { get; set; }

Property Value

Type	Description
System.Double

TotalTimeInMinutes

Declaration

public double TotalTimeInMinutes { get; set; }

Property Value

Type	Description
System.Double

Methods

Equals(PerformanceStatistics)

Tests a PerformanceStatistics against this current PerformanceStatistics for equality.

Declaration

public bool Equals(PerformanceStatistics val)

Parameters

Type	Name	Description
PerformanceStatistics	val

Returns

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

Equals(Object)

Tests a System.Object against this current PerformanceStatistics 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 performance statistics object from the XML file.

Declaration

public static PerformanceStatistics LoadFromFile(string xmlFilePath)

Parameters

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

Returns

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

SaveToFile(String)

Saves (serializes) the performance statistics object to an XML file.

Declaration

public void SaveToFile(string xmlFilePath)

Parameters

Type	Name	Description
System.String	xmlFilePath	The XML file path.

Operators

Equality(PerformanceStatistics, PerformanceStatistics)

Tests a PerformanceStatistics against this current PerformanceStatistics for equality.

Declaration

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

Parameters

Type	Name	Description
PerformanceStatistics	a
PerformanceStatistics	b

Returns

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

Inequality(PerformanceStatistics, PerformanceStatistics)

Tests a PerformanceStatistics against this current PerformanceStatistics for inequality.

Declaration

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

Parameters

Type	Name	Description
PerformanceStatistics	a
PerformanceStatistics	b

Returns

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