InputPeriod Class

Defines a dated period with its energy usage and any extra-predictor figures.

Inheritance Hierarchy

SystemObject
DegreeDays.Api.RegressionsInputPeriod

Namespace: DegreeDays.Api.Regressions
Assembly: DegreeDays (in DegreeDays.dll) Version: 1.4

Syntax

public sealed class InputPeriod

Public NotInheritable Class InputPeriod

The InputPeriod type exposes the following members.

Constructors

	Name	Description
	InputPeriod	Constructs an InputPeriod covering the specified DayRange and with the specified energy usage.

Properties

	Name	Description
	DayRange	Gets the DayRange indicating the period of time covered by this InputPeriod.
	ExtraPredictorKeys	Gets the non-null, possibly-empty, immutable set of extra-predictor keys that this InputPeriod has extra-predictor figures for.
	Usage	Gets the energy usage over this InputPeriod.

Methods

	Name	Description
	Equals	Returns true if obj is an InputPeriod with the same DayRange and Usage as this, and with the same extra-predictor keys and values (the order of the keys is not important for this). (Overrides ObjectEquals(Object))
	GetExtraPredictor	Returns the double value of the extra predictor with the specified string key.
	GetHashCode	Overridden to ensure consistency with Equals. (Overrides ObjectGetHashCode)
	ToString	Returns a non-null, non-empty string representation of this instance for logging and debugging purposes. (Overrides ObjectToString)
	WithExtraPredictor	Returns a new InputPeriod based on this but also including an extra predictor with the specified key and value.

Remarks

A set of InputPeriod items together forms the InputData required for every RegressionRequest.

To create a simple InputPeriod just use the InputPeriod(DayRange, Double) constructor. If, then, you also wish to add extra-predictor figures, use the WithExtraPredictor(String, Double) method.

See the regression API docs on our website for more info and code samples.

Thread Safety

Instances of this class are immutable. You can safely reuse them and call them from multiple threads at once.

Version History

Version	Description
1.4	This was added in version 1.4.