GrowStand(ApiCompartment,ICollection<ApiTreatment>,Nullable<DateTime>,Boolean) Method

Grow a compartment to a target year (optional) with a list of treatments to perform at specific dates. This can be used to simulate historic treatments on a compartment, or to simulate and see the results of future treatments. A call to this method will initialize the compartment if it isn't already.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Overloads Function GrowStand( _
   ByVal compartment As ApiCompartment, _
   ByVal treatments As ICollection(Of ApiTreatment), _
   Optional ByVal targetYear As Nullable(Of Date), _
   Optional ByVal throwExceptionIfTreatmentCouldNotBePerformed As Boolean _
) As ApiState

'Usage
 
Dim instance As GrowthCalculator
Dim compartment As ApiCompartment
Dim treatments As ICollection(Of ApiTreatment)
Dim targetYear As Nullable(Of Date)
Dim throwExceptionIfTreatmentCouldNotBePerformed As Boolean
Dim value As ApiState
 
value = instance.GrowStand(compartment, treatments, targetYear, throwExceptionIfTreatmentCouldNotBePerformed)

public ApiState GrowStand( 
   ApiCompartment compartment,
   ICollection<ApiTreatment> treatments,
   Nullable<DateTime> targetYear,
   bool throwExceptionIfTreatmentCouldNotBePerformed
)

public:
ApiState^ GrowStand( 
   ApiCompartment^ compartment,
   ICollection<ApiTreatment^>^ treatments,
   Nullable<DateTime> targetYear,
   bool throwExceptionIfTreatmentCouldNotBePerformed
)

Parameters

compartment: Compartment to grow
treatments: List of treatments to perform during growth
targetYear: A date to grow the compratment to after the last treatment has been performed
throwExceptionIfTreatmentCouldNotBePerformed: Determines if exception should be thrown when one of the treatments could not be performed. Otherwise, will silently continue without performing that treatment.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

GrowthCalculator Class
GrowthCalculator Members
Overload List