#region Namespaces
using System;
#endregion

namespace ScriptCode {
	/// <summary>
	/// Indicator scripts are used for calculating a series of numerical values.
	/// 
	/// This script can be used in several ways:
	/// (1) It can be used on a chart.
	/// (2) It can be used from another script.
	/// (3) It can be used as a script column in a watchlist.
	/// </summary>
	public partial class MyIndicator : IndicatorScriptBase // NEVER CHANGE THE CLASS NAME
	{
#region Variables

		// The underlying symbol index.
		private int _symbolIndex;
		// The number of periods to include in the indicator calculation.
		private int _periods;

#endregion

#region OnInitialize
		/// <summary>
		/// This function accepts the user parameters for the script and is called when a new indicator instance is created. 
		/// One of the parameters accepted by it must be that of a symbol or another script that is
		/// based on a symbol (drawing, indicator, pattern or signal). This symbol will be used as the underlying symbol for the indicator.
		/// 
		/// The parameter values can be specified from the user interface (UI) or from another script, depending on usage.
		/// </summary>
		/// --------------------------------------------------------------------------------------------------
		/// PLEASE USE THE SCRIPT WIZARD (CTRL+W) TO ADD, EDIT AND REMOVE THE SCRIPT PARAMETERS
		/// --------------------------------------------------------------------------------------------------
		/// YOU MUST SET A PARAM TAG FOR EACH PARAMETER ACCEPTED BY THIS FUNCTION.
		/// ALL PARAM TAGS SHOULD BE SET IN THE 'OnInitialize' REGION, RIGHT ABOVE THE 'OnInitialize' FUNCTION.
		/// THE ORDER OF THE TAGS MUST MATCH THE ORDER OF THE ACTUAL PARAMETERS.

		/// REQUIRED ATTRIBUTES:
		/// (1) name: The exact parameter name.
		/// (2) type: The type of data to collect from the user: 
		/// Set to "Integer" when the data type is 'int'
		/// Set to "IntegerArray" when the data type is 'int[]'
		/// Set to "DateTime" when the data type is 'long'  
		/// Set to "DateTimeArray" when the data type is 'long[]'  
		/// Set to "Boolean" when the data type is 'bool'
		/// Set to "BooleanArray" when the data type is 'bool[]'
		/// Set to "Double" when the data type is 'double'
		/// Set to "DoubleArray" when the data type is 'double[]'
		/// Set to "String" when the data type is 'string'
		/// Set to "StringArray" when the data type is 'string[]'
		/// Set to "Indicator" when the data type is 'Indicator'
		/// Set to "Pattern" when the data type is 'Pattern'
		/// Set to "Signal" when the data type is 'Signal'
		/// Set to "Drawing" when the data type is 'Drawing'
		/// Set to "Symbol" when the data type is 'int' representing a symbol index.

		/// OPTIONAL ATTRIBUTES:
		/// (3) default: The default parameter value is only valid when the type is Integer, Boolean, Double, String or an API Type. 
		/// (4) min: The minimum parameter value is only valid when the type is Integer or Double.
		/// (5) max: The maximum parameter value is only valid when the type is Integer or Double.

		/// EXAMPLE: <param name="" type="" default="" min="" max="">Enter the parameter description here.</param> 
		/// --------------------------------------------------------------------------------------------------
		/// <param name="symbolIndex" type="Symbol">The underlying symbol on which to calculate the indicator script.</param>
		/// <param name="periods" type="Integer" default="9" min="1">The number of periods in the indicator script calculation.</param>
		public void OnInitialize(
			 int symbolIndex,
			 int periods) {

			// Set the underlying symbol index to a variable.
			_symbolIndex = symbolIndex;
			// Set the specified number of periods to a variable.
			_periods = periods;

		}
#endregion

#region OnBarUpdate
		/// <summary>
		/// This function is used for calculating the indicator value for the latest bar (see the Indicator functions).
		/// </summary>
		/// <returns>The indicator value for the latest bar.</returns>
		public override double OnBarUpdate() {
			// Check whether the number of periods is invalid.
			if (IndicatorValueCount() < _periods)
				return 0;

			// Use for finding the highest value in the selected number of periods.
			double highest = double.MinValue;
			// Use for finding the lowest value in the selected number of periods.
			double lowest = double.MaxValue;

			//	Iterate over the specified number of periods while finding the highest and lowest prices.
			for (int i = _periods - 1; i >= 0; i--) {
				// Check whether the highest value can be improved.
				if (DataHigh(i) > highest)
				// Keep the highest value.
					highest = DataHigh(i);
				// Check whether the lowest value can be improved.
				if (DataLow(i) < lowest)
				// Keep the lowest value.
					lowest = DataLow(i);
			}

			// Return average of highest and lowest values over time period selected.
			return (highest + lowest) / 2;
		}
#endregion

#region OnChartSetup
		/// <summary>
		/// This function is used for setting up the indicator on the chart and registering its pens (see the IndicatorChartRegisterPenRGB function).
		/// </summary>
		public override void OnChartSetup() {
			// Register a pen.
			IndicatorChartRegisterPenRGB(0, "Pen",new int[] { 22 ,81, 238, 255 }, C_DashStyle.SOLID, 2);
		}
#endregion

#region OnSelectPen
		/// <summary>
		/// This function is used for selecting a registered indicator pen with which to color the latest indicator value.
		/// Call the IndicatorChartRegisterPenRGB function from the OnChartSetup function in order to register an indicator pen.
		/// </summary>
		/// <returns>The indicator pen index to use for coloring the latest indicator value.</returns>
		public override byte OnSelectPen() {
			// Color the indicator value with the zero pen.
			return 0;
		}
#endregion
	}
}