#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 indicator on which to calculate the indicator script.
private Indicator _indicator;
// The number of periods to include in the momentum, not including the current value.
private int _momentumPeriods;
// The number of periods to include in the indicator script calculation.
private int _periods;
// The average gains.
private double _averageGains;
// The average losses.
private double _averageLosses;
#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 or String.
/// (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="indicator" type="Indicator">The underlying indicator on which to calculate the indicator script.</param>
/// <param name="momentumPeriods" type="Integer" default="10" min="1">The number of periods to include in the momentum, not including the current value.</param>
/// <param name="periods" type="Integer" default="10" min="1">The number of periods to include in the indicator script calculation.</param>
public void OnInitialize(
Indicator indicator,
int momentumPeriods,
int periods) {
// Set the indicator.
_indicator = indicator;
// Set the number of momentum periods.
_momentumPeriods = momentumPeriods;
// Set the number of periods.
_periods = periods;
// Initialize the average gains.
_averageGains = 0;
// Initialize the average losses.
_averageLosses = 0;
}
#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 indicator values is lower than the number of values needed.
if (IndicatorValueCount() < _periods + _momentumPeriods)
return 0;
// Calculate the current momentum.
double momentum = _indicator[0] - _indicator[_momentumPeriods];
// Check whether the average gains have never been initialized.
if (_averageGains == 0) {
double gain = 0;
double loss = 0;
// Iterate over the values.
for (int i = _periods - 1; i >= 0; i--) {
// Calculate the gain.
gain += Math.Max(_indicator[i] - _indicator[i + _momentumPeriods], 0);
// Calculate the loss.
loss += Math.Max(_indicator[i + _momentumPeriods] - _indicator[i], 0);
}
// Initialize the gains with the SMA over the first values.
_averageGains = gain / _periods;
// Initialize the losses with the SMA over the first values.
_averageLosses = loss / _periods;
}
// Check whether the momentum is positive.
if (momentum > 0) {
_averageGains = ((_averageGains * (_periods - 1)) + momentum) / _periods;
_averageLosses = ((_averageLosses * (_periods - 1)) + 0) / _periods;
}
// Check whether the momentum is negative.
if (momentum < 0) {
_averageGains = ((_averageGains * (_periods - 1)) + 0) / _periods;
_averageLosses = ((_averageLosses * (_periods - 1)) - momentum) / _periods;
}
// Check whether the average losses are zero.
if (_averageLosses == 0)
_averageLosses = 1;
// Calculate the RM.
double RM = _averageGains / _averageLosses;
// Calculate the RMI.
return 100 - (100 / (1 + RM));
}
#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);
// Set the indicator in a new chart panel.
IndicatorChartSetNewPanel(true);
// Set the plot style.
IndicatorChartSetPlotStyle(C_PlotStyle.BOX_ZERO);
// Set the indicator range.
IndicatorChartSetRange(0, 100);
// Set the overbought range.
IndicatorChartSetColorZone(70, 70, new int[] { 255, 75, 75, 255 }, new int[] { 255, 75, 75, 255 }, C_DashStyle.SOLID, 2);
// Set the oversold range.
IndicatorChartSetColorZone(30, 30, new int[] { 0, 160, 120, 255 }, new int[] { 0, 160, 120, 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
}
}
