Category:Plugins - Revision history

Osskyn at 12:50, 26 November 2024

2024-11-26T12:50:47Z

← Older revision		Revision as of 13:50, 26 November 2024
Line 1:		Line 1:
	[[Category:Reference Manual]]		[[Category:Reference Manual]]
	It is possible to replace some of Heureka's built-in functions with your own plugins. You need to program such functions in C#. When you have built a plugin-function, you can place it in My ~~Dcouments~~ > Heureka > Common > Plugins-folder. After that, when you start a Heureka application (StandWise, PlanWise or RegWise), the program will scan this folder for functions that implements a certain so called interface. For example, if there is a plugin (dll) that implements the cost function interface, it will be imported to the application in run-time, and be available as an option the control tables interface.		It is possible to replace some of Heureka's built-in functions with your own plugins. You need to program such functions in C#. When you have built a plugin-function, you can place it in My Documents > Heureka > Common > Plugins-folder. After that, when you start a Heureka application (StandWise, PlanWise or RegWise), the program will scan this folder for functions that implements a certain so called interface. For example, if there is a plugin (dll) that implements the cost function interface, it will be imported to the application in run-time, and be available as an option the control tables interface.

	Plugins are available for the following models:		Plugins are available for the following models:

LarsSangstuvall: Added sapling and optimization bullets

2023-01-17T10:14:24Z

Added sapling and optimization bullets

← Older revision		Revision as of 11:14, 17 January 2023
Line 5:		Line 5:

	*Single-tree growth		*Single-tree growth
	*Stand-level growth		*Stand-level growth
			*Sapling growth
	*Tree volume		*Tree volume
	*Tree height		*Tree height
Line 13:		Line 14:
	*Age to breast height		*Age to breast height
	*Forwarder and harvester cost (time consumption)		*Forwarder and harvester cost (time consumption)
			*Optimization solvers

	==Writing plugins for Heureka==		==Writing plugins for Heureka==

Peder: /* Writing plugins for Heureka */

2020-11-17T09:33:14Z

Writing plugins for Heureka

← Older revision		Revision as of 10:33, 17 November 2020
Line 15:		Line 15:

	==Writing plugins for Heureka==		==Writing plugins for Heureka==
	The easiest way to start writing ~~plugins~~ is to use ~~templates~~ that we provide as a starting point [https://www.heurekaslu.se/FilerepositoryDev PluginTemplateProject.zip]. Either open the included project in Visual Studio 2015 or later, or start a new project and include only the required templates. All templates need a reference to 'Slu.Heureka.BaseLayer.dll' and to 'Slu.Heureka.DomainLayer.dll'. This library can be found with all installations of Heureka in the root of the installation directory.		The easiest way to start writing a plugin is to use a template that we provide as a starting point [https://www.heurekaslu.se/FilerepositoryDev PluginTemplateProject.zip]. Either open the included project in Visual Studio 2015 or later, or start a new project and include only the required templates. All templates need a reference to 'Slu.Heureka.BaseLayer.dll' and to 'Slu.Heureka.DomainLayer.dll'. This library can be found with all installations of Heureka in the root of the installation directory.

	Comments in the templates will tell you what Heureka expects as a return value from the functions. If a plugin needs to read settings that the user has made to, for example, the ProductionModel control table, Heureka will supply this to the plugin constructor if it finds a matching constructor that accepts a single ProductionModelControlTable as an argument. Otherwise the parameterless constructor will be used. At least one of these two constructors MUST be available.		Comments in the templates will tell you what Heureka expects as a return value from the functions. If a plugin needs to read settings that the user has made to, for example, the ProductionModel control table, Heureka will supply this to the plugin constructor if it finds a matching constructor that accepts a single ProductionModelControlTable as an argument. Otherwise the parameterless constructor will be used. At least one of these two constructors MUST be available.

Peder: /* Custom cost functions */

2017-10-13T07:54:43Z

Custom cost functions

← Older revision		Revision as of 08:54, 13 October 2017
Line 35:		Line 35:
	Code example for harvester and forwarder cost function		Code example for harvester and forwarder cost function
	<div class="mw-collapsible-content">		<div class="mw-collapsible-content">
	<syntaxhighlight lang="c#">		<syntaxhighlight lang="csharp">
	using System.Collections.Generic;		using System.Collections.Generic;
	using Slu.Heureka;		using Slu.Heureka;

Peder: /* Custom cost functions */

2017-10-13T07:48:14Z

Custom cost functions

← Older revision		Revision as of 08:48, 13 October 2017
Line 35:		Line 35:
	Code example for harvester and forwarder cost function		Code example for harvester and forwarder cost function
	<div class="mw-collapsible-content">		<div class="mw-collapsible-content">
	<syntaxhighlight lang="~~csharp~~">		<syntaxhighlight lang="c#">
	using System.Collections.Generic;		using System.Collections.Generic;
	using Slu.Heureka;		using Slu.Heureka;

Peder: /* Custom cost functions */

2017-10-13T07:45:40Z

Custom cost functions

← Older revision		Revision as of 08:45, 13 October 2017
Line 27:		Line 27:

	==Custom cost functions ==		==Custom cost functions ==
	Creating plugins for cost functions is done a bit differently. There is a plugin interface, but it is not really intended for implementing from scratch. Instead, you should either create a class that derives from Slu.Heureka.DomainLayer.ValueModel.CostCalculatorSkogforskAdvanced, or		Creating plugins for cost functions is done a bit differently. There is a plugin interface, but it is not really intended for implementing from scratch. Instead, you should either create a class that derives from *Slu.Heureka.DomainLayer.ValueModel.CostCalculatorSkogforskAdvanced, or
	Slu.Heureka.DomainLayer.ValueModel.CostCalculatorSkogforskSimple, or from the abstract class		*Slu.Heureka.DomainLayer.ValueModel.CostCalculatorSkogforskSimple, or from the abstract class
	Slu.Heureka.DomainLayer.ValueModel.CostCalculatorBase (which the two above derive from).		*Slu.Heureka.DomainLayer.ValueModel.CostCalculatorBase (which the two above derive from).

	Each of these implements IPlugin, so you do not have to worry about anything but overriding for example CostCalculatorSkogforskAdvanced properly. Below is a dummy dode example to calculate cost for a imagined cable logging system.		Each of these implements IPlugin, so you do not have to worry about anything but overriding for example CostCalculatorSkogforskAdvanced properly. Below is a dummy dode example to calculate cost for a imagined cable logging system.

Peder: /* Custom cost functions */

2017-10-13T07:45:20Z

Custom cost functions

← Older revision		Revision as of 08:45, 13 October 2017
Line 27:		Line 27:

	==Custom cost functions ==		==Custom cost functions ==
	Creating plugins for cost functions is done a bit differently. There is a plugin interface, but it is not intended implementing it from scratch. Instead, you should either create a class that derives from Slu.Heureka.DomainLayer.ValueModel.CostCalculatorSkogforskAdvanced, or		Creating plugins for cost functions is done a bit differently. There is a plugin interface, but it is not really intended for implementing from scratch. Instead, you should either create a class that derives from Slu.Heureka.DomainLayer.ValueModel.CostCalculatorSkogforskAdvanced, or
	Slu.Heureka.DomainLayer.ValueModel.CostCalculatorSkogforskSimple, or from the abstract class		Slu.Heureka.DomainLayer.ValueModel.CostCalculatorSkogforskSimple, or from the abstract class
	Slu.Heureka.DomainLayer.ValueModel.CostCalculatorBase (which the two above derive from).		Slu.Heureka.DomainLayer.ValueModel.CostCalculatorBase (which the two above derive from).

Peder: /* Custom cost functions */

2017-10-13T07:44:26Z

Custom cost functions

← Older revision		Revision as of 08:44, 13 October 2017
Line 32:		Line 32:

	Each of these implements IPlugin, so you do not have to worry about anything but overriding for example CostCalculatorSkogforskAdvanced properly. Below is a dummy dode example to calculate cost for a imagined cable logging system.		Each of these implements IPlugin, so you do not have to worry about anything but overriding for example CostCalculatorSkogforskAdvanced properly. Below is a dummy dode example to calculate cost for a imagined cable logging system.
			<div class="toccolours mw-collapsible mw-collapsed" style="width:70%" data-expandtext="Show code" data-collapsetext="Hide">
			Code example for harvester and forwarder cost function
			<div class="mw-collapsible-content">
			<syntaxhighlight lang="csharp">
	using System.Collections.Generic;		using System.Collections.Generic;
	using Slu.Heureka;		using Slu.Heureka;
Line 122:		Line 125:
	}		}

			</syntaxhighlight>
			</div>
			</div>

	<!--		<!--

Peder: /* Custom cost functions */

2017-10-13T07:42:06Z

Custom cost functions

← Older revision		Revision as of 08:42, 13 October 2017
Line 27:		Line 27:

	==Custom cost functions ==		==Custom cost functions ==
			Creating plugins for cost functions is done a bit differently. There is a plugin interface, but it is not intended implementing it from scratch. Instead, you should either create a class that derives from Slu.Heureka.DomainLayer.ValueModel.CostCalculatorSkogforskAdvanced, or
			Slu.Heureka.DomainLayer.ValueModel.CostCalculatorSkogforskSimple, or from the abstract class
			Slu.Heureka.DomainLayer.ValueModel.CostCalculatorBase (which the two above derive from).

			Each of these implements IPlugin, so you do not have to worry about anything but overriding for example CostCalculatorSkogforskAdvanced properly. Below is a dummy dode example to calculate cost for a imagined cable logging system.

			using System.Collections.Generic;
			using Slu.Heureka;
			using Slu.Heureka.BaseLayer;
			using Slu.Heureka.BaseLayer.ConfigurationHandling;
			using Slu.Heureka.DomainLayer.CommonForestModels;
			using Slu.Heureka.DomainLayer.Forest;
			using Slu.Heureka.DomainLayer.TreatmentModel;
			using Slu.Heureka.DomainLayer.ValueModel;

			namespace MyCostFunctions
			{
			public class MyLoggingCostFunction : CostCalculatorSkogforskAdvanced
			{
			private double _area;
			private double _ayd;
			private GenericPropertyArray<double> _functionParameters = new GenericPropertyArray<double>("CableLoggingCoeffs",
			propertyLabel:new string[]
			{
			"A","B","SystemUtilization"
			},
			values:new double[] {0.25d, 3.0d, 0.9d},
			defaultValues:new double[] { 0.25d, 3.0d, 0.9d },
			descriptions:new string[] {"Param A (min/tree)",
			"Param B (min/m3)",
			"Utilization degree expressed as proportion"
			});

			/// <summary>
			/// Empty constructor required for IPlugin handler
			/// </summary>
			public MyLoggingCostFunction () { }

			public MyLoggingCostFunction (IControlCategory cc) : base(cc)
			{
			}

			public override string Name { get { return "MyLoggingCostFunction1"; } }

			public override GenericPropertyArray<double> CustomFunctionParameters
			{
			get { return _functionParameters; }
			set { _functionParameters = value; }
			}

			/// <summary>
			/// Initializes data needed by the models
			/// </summary>
			/// <param name="tUnit"></param>
			/// <param name="period"></param>
			/// <param name="treatment"></param>
			/// <param name="results"></param>
			/// <param name="value">Felling value</param>
			protected override void Initialize(TreatmentUnit tUnit, int period, Treatment treatment, IList<Result> results, FellingValue value)
			{
			base.Initialize(tUnit, period, treatment, results, value);
			int periodIndex = period == 0 ? 0 : period - tUnit.StartPeriod;
			object[] treatmentInfo = (object[])results[periodIndex].Treatment(typeof(TreatmentData));
			int index = FindFirstCuttingTreatment(treatmentInfo);
			CalculateBasicVariables((TreatmentData)treatmentInfo[index], value);

			if (Configuration.CustomHarvesterCostParameters != null &&
			_functionParameters.Label == Configuration.CustomHarvesterCostParameters.Label)
			{
			_functionParameters = Configuration.CustomHarvesterCostParameters;
			}

			}

			protected override double ForwarderCostFinalFelling()
			{
			return 0;
			}

			protected override double HarvesterCostFinalFelling()
			{
			// No cable logging required: use ordinaary function
			if (Slope < SlopeType.ThirtyThreeToFifty)
			return base.HarvesterCostFinalFelling();

			// Add some code for calulating the cost...
			// var cost = ... _functionParameters["B"]*AverageVolumeOfFelledTrees ...

			return _functionParameters["SystemUtilization"] > 0 ? cost / _functionParameters["SystemUtilization"] : cost;

			}

			}
			}




	<!--		<!--

Peder: /* Custom cost functions */

2017-10-13T06:54:53Z

Custom cost functions

← Older revision		Revision as of 07:54, 13 October 2017
Line 28:		Line 28:
	==Custom cost functions ==		==Custom cost functions ==

			<!--
	There are specific functions for different treatments. The plugin interface (ICostCalculator) provided will probably be quite daunting to implement, and a better option is most likely to create a plugin that derives from Heureka's CostCalculatorBase (see below), if you wish to supply custom functions for for example precommercial thinning (cleaning). To add custom functions only for harvesting and forwarding, considered deriving from class SkogforskAdvanced.		There are specific functions for different treatments. The plugin interface (ICostCalculator) provided will probably be quite daunting to implement, and a better option is most likely to create a plugin that derives from Heureka's CostCalculatorBase (see below), if you wish to supply custom functions for for example precommercial thinning (cleaning). To add custom functions only for harvesting and forwarding, considered deriving from class SkogforskAdvanced.

Line 486:		Line 487:
	</div>		</div>

			-->

			<!--
	====Creating a plugin that derives from CostCalculatorBase====		====Creating a plugin that derives from CostCalculatorBase====
	~~<!--~~
	ICostCalculator : IPlugin		ICostCalculator : IPlugin
	CostCalculatorBase : ICostCalculator		CostCalculatorBase : ICostCalculator