Difference between revisions of "API Timeframes constants"
Jump to navigation
Jump to search
| (8 intermediate revisions by the same user not shown) | |||
| Line 5: | Line 5: | ||
<br> | <br> | ||
=== Definition === | === Definition === | ||
{| class=wikitable cellpadding="10" style="border-style: solid; border-width: 2px" | |||
{| class=" | |||
|- | |- | ||
! Constant name !! Value !! Value in minutes | ! Constant name !! Value !! Value in minutes | ||
|- | |- | ||
| '''PERIOD_CURRENT''' || Current Timeframe || | | '''Timeframe.PERIOD_CURRENT''' || Current Timeframe || 0 | ||
|- | |- | ||
| PERIOD_M1 || Timeframe M1 | | | '''Timeframe.PERIOD_M1''' || Timeframe M1 || 1 | ||
|- | |- | ||
| PERIOD_M5 || Timeframe M5 | | | '''Timeframe.PERIOD_M5''' || Timeframe M5 || 5 | ||
|- | |- | ||
| PERIOD_M15 || Timeframe M15 | | | '''Timeframe.PERIOD_M15''' || Timeframe M15 || 15 | ||
|- | |- | ||
| PERIOD_M30 || Timeframe M30 | | | '''Timeframe.PERIOD_M30''' || Timeframe M30 || 30 | ||
|- | |- | ||
| PERIOD_H1 || Timeframe H1 | | | '''Timeframe.PERIOD_H1''' || Timeframe H1 || 60 | ||
|- | |- | ||
| PERIOD_H4 || Timeframe H4 | | | '''Timeframe.PERIOD_H4''' || Timeframe H4 || 240 | ||
|- | |- | ||
| PERIOD_D1 || Timeframe D1 | | | '''Timeframe.PERIOD_D1''' || Timeframe D1 || 1440 | ||
|- | |- | ||
| PERIOD_W1 || Timeframe W1 | | | '''Timeframe.PERIOD_W1''' || Timeframe W1 || 10080 | ||
|- | |- | ||
| PERIOD_MN1 || Timeframe MN1 | | | '''Timeframe.PERIOD_MN1''' || Timeframe MN1 || 43200 | ||
|} | |} | ||
=== Examples === | |||
C# code snippet : | |||
<code> | |||
public override void OnCalculate(int index) | |||
{ | |||
// Avoid the use of Timeframe equal and higher than D1 | |||
if (index != 0 || Period() >= (int)Timeframe.PERIOD_D1) | |||
return; | |||
[...] | |||
} | |||
</code> | |||
Latest revision as of 04:24, 5 January 2023
Summary
The Timeframes constants are used to define the different timeframes.
It represents the Timeframe value in minutes.
Definition
| Constant name | Value | Value in minutes |
|---|---|---|
| Timeframe.PERIOD_CURRENT | Current Timeframe | 0 |
| Timeframe.PERIOD_M1 | Timeframe M1 | 1 |
| Timeframe.PERIOD_M5 | Timeframe M5 | 5 |
| Timeframe.PERIOD_M15 | Timeframe M15 | 15 |
| Timeframe.PERIOD_M30 | Timeframe M30 | 30 |
| Timeframe.PERIOD_H1 | Timeframe H1 | 60 |
| Timeframe.PERIOD_H4 | Timeframe H4 | 240 |
| Timeframe.PERIOD_D1 | Timeframe D1 | 1440 |
| Timeframe.PERIOD_W1 | Timeframe W1 | 10080 |
| Timeframe.PERIOD_MN1 | Timeframe MN1 | 43200 |
Examples
C# code snippet :
public override void OnCalculate(int index)
{
// Avoid the use of Timeframe equal and higher than D1
if (index != 0 || Period() >= (int)Timeframe.PERIOD_D1)
return;
[...]
}