#region Namespaces
using System;
using System.IO;
using System.Linq;
#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 for which to calculate the indicator script.
private int _symbolIndex;
// The number of bars to check back.
private int _barCount;
// Use for setting the close to be lower than the open on all bars.
private bool _barDown;
// Use for setting the high of consecutive bars to be lower than the high of the previous bar.
private bool _lowerHigh;
// Use for setting the low of consecutive bars to be lower than the low of the previous bar.
private bool _lowerLow;
#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" default="">The underlying symbol index for which to calculate the indicator script.</param>
/// <param name="barCount" type="Integer" default="3" min="1" max="">The number of bars to check back.</param>
/// <param name="barDown" type="Boolean" default="True">Use for setting the close to be lower than the open for all bars.</param>
/// <param name="lowerHigh" type="Boolean" default="True">Use for setting the high of consecutive bars to be lower than the high of the previous bar.</param>
/// <param name="lowerLow" type="Boolean" default="True">Use for setting the low of consecutive bars to be lower than the low of the previous bar.</param>
public void OnInitialize(int symbolIndex, int barCount, bool barDown, bool lowerHigh, bool lowerLow) {
// Set the symbol index.
_symbolIndex = symbolIndex;
// Set the number of bars.
_barCount = barCount;
// Set the boolean for close to be lower than open on all bars.
_barDown = barDown;
// Set the boolean for highs to be lower then previous high.
_lowerHigh = lowerHigh;
// Set the boolean for lows to be lower then previous low.
_lowerLow = lowerLow;
}
#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() {
// Ensure enough bars of data available to calculate indicator.
if (IndicatorValueCount() < _barCount) {
return 0;
}
else {
// Boolean used to determine indicator output.
bool gotBars = false;
// Iterate through user defined previous bars.
for (int i = 0; i < _barCount + 1; i++) {
// Set true if for loop passes checks for previous bars.
if (i == _barCount) {
gotBars = true;
break;
}
// Break if consecutive bars aren't down.
if (!(DataClose(i) < DataClose(i + 1)))
break;
// Following if statements only break if user also sets the booleans to true.
// Break if close is not lower then open on all bars.
if (_barDown && !(DataClose(i) < DataOpen(i)))
break;
// Break if high is not lower then previous high.
if (_lowerHigh && !(DataHigh(i) < DataHigh(i + 1)))
break;
// Break if low is not lower then previous low.
if (_lowerLow && !(DataLow(i) < DataLow(i + 1)))
break;
}
// Output BARSDOWN.
return (gotBars == true ? 1 : 0);
}
}
#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
}
}
