Handle different time periods - Revision history

Peder at 07:29, 26 May 2010

2010-05-26T07:29:31Z

Peder at 07:02, 26 May 2010

2010-05-26T07:02:23Z

Fkl at 13:25, 19 May 2010

2010-05-19T13:25:54Z

Fkl at 09:13, 19 May 2010

2010-05-19T09:13:35Z

2010-05-19T08:47:19Z

Created page with 'A <tt>Tree</tt> object contains values for all time periods treatments and growth prognosis has been made for. Those values that may change over time can be accessed both by an A�?�'

New page

A <tt>Tree</tt> object contains values for all time periods treatments and growth prognosis has been made for. Those values that may change over time can be accessed both by an Array property and a regular property, such as <tt>DiameterArray</tt> and <tt>Diameter</tt>. With the regular property, the value in the current time period is retrieved; and via the array property the value in any time period can be retreived (the caller is responsible for bounds checking).

Increasing to the complexity is that some properties may change values due to a treatment. Diameter won't change by a treatment, but number of stems will. A property that may have different values before and after treatments also has a residual property (and a residual array property), e.g. <tt>Stems</tt> and <tt>StemsResidual</tt>.

Objects of type <tt>TreeCollection</tt>, <tt>PredictionUnit</tt>, and <tt>TreatmentUnit</tt> also contains values that change over time and due to treatments, but the values are stored in separate classes. Methods named such as <tt>GetBefore(int period)</tt> will get the value in a given period, while a property named <tt>Before</tt> will get the value in the current time period.

A special note should be made about the <tt>TreeCollection</tt>. The trees in the collection are sorted, but the sorting is only valid for the current time period. The <tt>TreeCollection</tt> provides <tt>InnerTreeCollection</tt>s, which allows quick and easy access to all trees of a certain type (such as all saplings); but those collections can only be used in the current time period.

Through the <tt>TreatmentUnit</tt>, relevant information about time periods can be retrieved:

innehåller också värden som förändras över tiden, men dessa lagras i separata klasser. På samma sätt här finns både metoder och properties för att hämta värdet i aktuell period eller i en specifik period, samt före och efter åtgärd.
Periodlängden är vanligtvis fem år men kan faktiskt variera så det går inte att förutsätta femårsperioder. Relevant information om perioder kan hämtas via TreatmentUnit:
;CurrentPeriod: Current time period (of course, each prediction unit and tree has the same current time period as the treatment unit)
;PeriodLength: Period length, in years, from previous time period to current time period (5 if current period is 0)
;GetPeriodLength(int period): Period length in a given period (from the period before periodlängd i en specifik period (från period innan till den givna perioden)
Year Relativt år (period 0 = år 0), i aktuell period
GetYear(int period) Relativt år i en specifik period
FindYear(int year) Returnerar den period som motsvarar givet relativt år.

@@ Line 1: / Line 1: @@
-[[Category:System design]]
+[[Category:System design|Time periods]]
 [[Category:Developer's guide]]
 A <tt>Tree</tt> object contains values for all time periods treatments and growth prognosis has been made for. Those values that may change over time can be accessed both by an Array property and a regular property, such as <tt>DiameterArray</tt> and <tt>Diameter</tt>. With the regular property, the value in the current time period is retrieved; and via the array property the value in any time period can be retreived (the caller is responsible for bounds checking).

← Older revision		Revision as of 07:02, 26 May 2010
Line 1:		Line 1:
		+	[[Category:System design]]
		+	[[Category:Developer's guide]]
	A <tt>Tree</tt> object contains values for all time periods treatments and growth prognosis has been made for. Those values that may change over time can be accessed both by an Array property and a regular property, such as <tt>DiameterArray</tt> and <tt>Diameter</tt>. With the regular property, the value in the current time period is retrieved; and via the array property the value in any time period can be retreived (the caller is responsible for bounds checking).		A <tt>Tree</tt> object contains values for all time periods treatments and growth prognosis has been made for. Those values that may change over time can be accessed both by an Array property and a regular property, such as <tt>DiameterArray</tt> and <tt>Diameter</tt>. With the regular property, the value in the current time period is retrieved; and via the array property the value in any time period can be retreived (the caller is responsible for bounds checking).

@@ Line 3: / Line 3: @@
 Increasing to the complexity is that some properties may change values due to a treatment. Diameter won't change by a treatment, but number of stems will. A property that may have different values before and after treatments also has a residual property (and a residual array property), e.g. <tt>Stems</tt> and <tt>StemsResidual</tt>.
 Objects of type <tt>TreeCollection</tt>, <tt>PredictionUnit</tt>, and <tt>TreatmentUnit</tt> also contains values that change over time and due to treatments, but the values are stored in separate classes. Methods named such as <tt>GetBefore(int period)</tt> will get the value in a given period, while a property named <tt>Before</tt> will get the value in the current time period.
-A special note should be made about the <tt>TreeCollection</tt>. The trees in the collection are sorted, but the sorting is only valid for the current time period. The <tt>TreeCollection</tt> provides <tt>InnerTreeCollection</tt>s, which allows quick and easy access to all trees of a certain type (such as all saplings); but those collections can only be used in the current time period.
+A special note should be made about the <tt>TreeCollection</tt>. The trees in the collection are sorted, but the sorting is only valid for the current time period. The <tt>TreeCollection</tt> provides <tt>InnerTreeCollection</tt>s, which allows quick and easy access to all trees of a certain type (such as all saplings); but those collections can only be used in the current time period. For more information, see [[Handling of tree states]]
 Through the <tt>TreatmentUnit</tt>, relevant information about time periods can be retrieved:

@@ Line 9: / Line 9: @@
 Through the <tt>TreatmentUnit</tt>, relevant information about time periods can be retrieved:
-innehåller också värden som förändras över tiden, men dessa lagras i separata klasser. På samma sätt här finns både metoder och properties för att hämta värdet i aktuell period eller i en specifik period, samt före och efter åtgärd.
+;<tt>CurrentPeriod</tt>: Current time period (of course, each prediction unit and tree has the same current time period as the treatment unit)
-Periodlängden är vanligtvis fem år men kan faktiskt variera så det går inte att förutsätta femårsperioder. Relevant information om perioder kan hämtas via TreatmentUnit:
+;<tt>PeriodLength</tt>: Period length, in years, from previous time period to current time period (5 if current period is 0)
-;CurrentPeriod: Current time period (of course, each prediction unit and tree has the same current time period as the treatment unit)
+;<tt>GetPeriodLength(int period)</tt>: Period length in a given period (from the period before the given period to the given period)
-;PeriodLength: Period length, in years, from previous time period to current time period (5 if current period is 0)
+;<tt>Year</tt>: Relative year (period 0 => year 0) in current period
-;GetPeriodLength(int period): Period length in a given period (from the period before 	periodlängd i en specifik period (från period innan till den givna perioden)
+;<tt>GetYear(int period)</tt>: Relative year in a given period
-Year	Relativt år (period 0 = år 0), i aktuell period
+;<tt>FindYear(int year)</tt>: Gets the period that corrensponds to the given relative year