Click or drag to resize

RegressionTestPlanBuilderSetCustomTestHeatingBaseTemperatures(IEnumerableTemperature) Method

Sets custom base temperatures to be used for the HDD in regressions tested by the API.

Namespace: DegreeDays.Api.Regressions
Assembly: DegreeDays (in DegreeDays.dll) Version: 1.4
Syntax
public RegressionTestPlanBuilder SetCustomTestHeatingBaseTemperatures(
	IEnumerable<Temperature> heatingBaseTemperatures
)

Parameters

heatingBaseTemperatures  IEnumerableTemperature
The base temperatures to be used for the HDD in regressions tested by the API. Cannot have more than 120 temperatures, and must contain only temperatures with the same unit (Celsius or Fahrenheit) this Builder was constructed with.

Return Value

RegressionTestPlanBuilder
This Builder, for easy method chaining.
Exceptions
ExceptionCondition
ArgumentExceptionIf heatingBaseTemperatures contains more than 120 temperatures, or contains any temperatures with a unit that isn't the one this Builder was constructed with.
Remarks

By default this is not set at all (as if it had been called with null), and the API will choose the base temperatures of the HDD it tests automatically.

If an empty IEnumerable is passed in, no HDD will be tested unless SetRequestedRegressionSpecs(RegressionSpec) is used to specify regressions with HDD.

This method will accept up to 120 (inclusive) custom test heating base temperatures, but, if you use all 120, you will get an exception on Build unless you have set the custom test cooling base temperatures as empty. At Build time you can have up to 120 custom base temperatures in total. If you don't set any custom test cooling base temperatures (leaving the API to choose the test cooling base temperatures automatically), at Build time you will be allowed up to 60 custom test heating base temperatures.

When calling this method you may want to use CelsiusRange(Double, Double, Double) or FahrenheitRange(Double, Double, Double) to create an evenly-spaced set of Temperature items covering your desired temperature range.

The Temperature items will be copied out of the IEnumerable passed in, so you are free to modify the IEnumerable after calling this method without such modifications affecting the state of this Builder.

See www.degreedays.net/api/regression#custom-base-temperatures for example code.

See Also