Click or drag to resize

RegressionTestPlanBuilderSetCustomTestHeatingBaseTemperatures(Double) Method

Sets custom base temperatures to be used for the HDD in regressions tested by the API, assuming the temperature unit (Celsius or Fahrenheit) this Builder was constructed with.

Namespace: DegreeDays.Api.Regressions
Assembly: DegreeDays (in DegreeDays.dll) Version: 1.4
Syntax
public RegressionTestPlanBuilder SetCustomTestHeatingBaseTemperatures(
	params double[] heatingBaseTemperatures
)

Parameters

heatingBaseTemperatures  Double
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 values that can be converted to Temperature items using Celsius(Double) or Fahrenheit(Double) (according to the temperature unit 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 value that can't be converted into a Temperature using Celsius(Double) or Fahrenheit(Double) (according to the temperature unit 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 this is called with no arguments, like builder.SetCustomTestHeatingBaseTemperatures(), then 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 remember that the values passed in are converted to Temperature items, which means they are rounded to the nearest 0.1 degrees and have maximum and minimum allowed values that depend on the temperature unit this Builder was constructed with. See Celsius(Double) or Fahrenheit(Double) for more.

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

See Also