MQL 5
MQL 5
MQL 5
Content
MQL5 Reference 71
1 Language Basics................................................................................................. 73
Syntax ............................................................................................................................74
Comments......................................................................................................................... 75
I dentifiers......................................................................................................................... 76
Reserved Words
......................................................................................................................... 77
Data Types ............................................................................................................................79
I nteger Types
......................................................................................................................... 80
Char, Short, I................................................................................................................
nt and Long Types 81
Character Constants
................................................................................................................ 85
Datetime Type
................................................................................................................ 88
Color Type ................................................................................................................ 89
Bool Type ................................................................................................................ 90
Enumerations................................................................................................................ 91
Real Types.........................................................................................................................
(double, float) 93
Complex number
.........................................................................................................................
(complex) 99
String Type
......................................................................................................................... 100
Structures,
.........................................................................................................................
Classes and I nterfaces 103
Dynamic .........................................................................................................................
Array Object 130
Matrices.........................................................................................................................
and vectors 131
Typecasting
......................................................................................................................... 138
Void Type
.........................................................................................................................
and NULL Constant 143
User-defined
.........................................................................................................................
Types 144
Object Pointers
......................................................................................................................... 154
References:
.........................................................................................................................
Modifier & and Keyword this 158
Operations............................................................................................................................160
and Expressions
Expressions
......................................................................................................................... 161
Arithmetic
.........................................................................................................................
Operations 162
Assignment
.........................................................................................................................
Operations 163
Operations
.........................................................................................................................
of Relation 164
Boolean Operations
......................................................................................................................... 165
Bitwise Operations
......................................................................................................................... 167
Other Operations
......................................................................................................................... 170
Precedence
.........................................................................................................................
Rules 174
Operators ............................................................................................................................176
Compound
.........................................................................................................................
Operator 177
Expression
.........................................................................................................................
Operator 178
Return Operator
......................................................................................................................... 179
Conditional
.........................................................................................................................
Operator if-else 180
Ternary Operator
.........................................................................................................................
?: 181
Switch Operator
......................................................................................................................... 183
Loop Operator
.........................................................................................................................
while 185
Loop Operator
.........................................................................................................................
for 186
Loop Operator
.........................................................................................................................
do while 187
Break Operator
......................................................................................................................... 188
Continue.........................................................................................................................
Operator 189
Object Create
.........................................................................................................................
Operator new 190
Object Delete
.........................................................................................................................
Operator delete 191
Functions ............................................................................................................................192
Function.........................................................................................................................
Call 194
Passing Parameters
......................................................................................................................... 195
Function.........................................................................................................................
Overloading 198
Operation
.........................................................................................................................
Overloading 201
Description
.........................................................................................................................
of External Functions 214
Exporting
.........................................................................................................................
Functions 216
Event Handling
.........................................................................................................................
Functions 217
Variables ............................................................................................................................228
Local Variables
......................................................................................................................... 232
Formal Parameters
......................................................................................................................... 234
Static Variables
......................................................................................................................... 236
Global Variables
......................................................................................................................... 238
I nput Variables
......................................................................................................................... 239
Extern Variables
......................................................................................................................... 245
z
I nitiali ation
.........................................................................................................................
of Variables 246
Visibility .........................................................................................................................
Scope and Lifetime of Variables 248
Creating.........................................................................................................................
and Deleting Objects 250
............................................................................................................................253
Preprocessor
Macro substitution #
.........................................................................................................................
( define) 255
#
Program.........................................................................................................................
Properties ( property) 258
#
I ncluding.........................................................................................................................
Files ( include) 264
I mporting #
.........................................................................................................................
Functions ( import) 265
Conditional # # # #
.........................................................................................................................
Compilation ( ifdef, ifndef, else, endif) 268
............................................................................................................................270
Object-Oriented Programming
Encapsulation
.........................................................................................................................
and Extensibility of Types 272
I nheritance
......................................................................................................................... 275
Polymorphism
......................................................................................................................... 280
Overload......................................................................................................................... 284
Virtual Functions
......................................................................................................................... 285
Static Members
.........................................................................................................................
of a Class 289
Function.........................................................................................................................
templates 293
Class templates
......................................................................................................................... 297
Abstract.........................................................................................................................
Classes 302
Namespaces............................................................................................................................304
2 Constants, Enumerations
.................................................................................................
and Structures 307
............................................................................................................................308
Chart Constants
Types of .........................................................................................................................
Chart Events 309
Chart Timeframes
......................................................................................................................... 316
Chart Properties
......................................................................................................................... 318
Positioning
.........................................................................................................................
Constants 326
Chart Representation
......................................................................................................................... 327
Examples.........................................................................................................................
of Working with the Chart 329
............................................................................................................................387
Objects Constants
Object Types
......................................................................................................................... 388
OBJ_VLI NE ................................................................................................................ 390
OBJ_HLI NE ................................................................................................................ 395
OBJ_TREND ................................................................................................................ 400
OBJ_TRENDB................................................................................................................
Y ANGLE 407
OBJ_C Y CLES................................................................................................................ 413
OBJ_ARROWED _LI NE
................................................................................................................ 419
OBJ_CHANNEL ................................................................................................................ 425
OBJ_STDDEVCHANNEL
................................................................................................................ 432
OBJ_REGRESSI................................................................................................................
ON 439
OBJ_PI TCHFORK
................................................................................................................ 445
OBJ_GANNLI................................................................................................................
NE 453
OBJ_GANNFAN ................................................................................................................ 460
OBJ_GANNGRI ................................................................................................................
D 467
OBJ_FI BO ................................................................................................................ 474
OBJ_FI BOTI MES
................................................................................................................ 481
OBJ_FI BOFAN................................................................................................................ 488
OBJ_FI BOARC................................................................................................................ 495
OBJ_FI BOCHANNEL
................................................................................................................ 502
OBJ_EX PANSI................................................................................................................
ON 510
OBJ_ELLI OTWAVE5
................................................................................................................ 518
OBJ_ELLI OTWAVE3
................................................................................................................ 526
OBJ_RECTAN................................................................................................................
GLE 533
OBJ_TRI ANG................................................................................................................
LE 539
OBJ_ELLI PSE................................................................................................................ 546
OBJ_ARROW................................................................................................................
_THUMB_UP 552
OBJ_ARROW................................................................................................................
_THUMB_DOWN 558
OBJ_ARROW................................................................................................................
_UP 564
OBJ_ARROW................................................................................................................
_DOWN 570
OBJ_ARROW................................................................................................................
_STOP 576
OBJ_ARROW................................................................................................................
_CHECK 582
OBJ_ARROW................................................................................................................
_LEFT_PRI CE 588
OBJ_ARROW................................................................................................................
_RI GHT_PRI CE 593
OBJ_ARROW................................................................................................................
_BUY 598
OBJ_ARROW................................................................................................................
_SELL 603
OBJ_ARROW................................................................................................................ 608
OBJ_TEX T ................................................................................................................ 614
OBJ_LABEL ................................................................................................................ 620
OBJ_BUTTON ................................................................................................................ 628
OBJ_CHART ................................................................................................................ 635
OBJ_BI TMAP................................................................................................................ 642
OBJ_BI TMAP................................................................................................................
_LABEL 649
OBJ_EDI T ................................................................................................................ 656
OBJ_EVENT ................................................................................................................ 663
OBJ_RECTAN................................................................................................................
GLE_LABEL 668
Object Properties
......................................................................................................................... 674
Methods .........................................................................................................................
of Object Binding 701
Chart Corner
......................................................................................................................... 706
Visibility .........................................................................................................................
of Objects 709
Levels of.........................................................................................................................
Elliott Wave 712
Gann Objects
......................................................................................................................... 713
Web Colors
......................................................................................................................... 715
Wingdings
......................................................................................................................... 717
............................................................................................................................718
Indicator Constants
Price Constants
......................................................................................................................... 719
Smoothing
.........................................................................................................................
Methods 722
I ndicators
.........................................................................................................................
Lines 723
Drawing .........................................................................................................................
Styles 725
Custom I.........................................................................................................................
ndicator Properties 730
I ndicator.........................................................................................................................
Types 736
Data Type
.........................................................................................................................
I dentifiers 738
............................................................................................................................739
Environment State
Client Terminal
.........................................................................................................................
Properties 740
Running MQL5
.........................................................................................................................
Program Properties 746
Symbol Properties
......................................................................................................................... 750
Account .........................................................................................................................
Properties 863
Testing Statistics
......................................................................................................................... 873
............................................................................................................................878
Trade Constants
History Database
.........................................................................................................................
Properties 879
Order Properties
......................................................................................................................... 880
Position Properties
......................................................................................................................... 898
Deal Properties
......................................................................................................................... 902
Trade Operation
.........................................................................................................................
Types 906
Trade Transaction
.........................................................................................................................
Types 918
Trade Orders
.........................................................................................................................
in DOM 920
Signal Properties
......................................................................................................................... 921
............................................................................................................................923
Named Constants
Predefined
.........................................................................................................................
Macro Substitutions 924
Mathematical
.........................................................................................................................
Constants 930
Numerical
.........................................................................................................................
Type Constants 932
z
Uninitiali.........................................................................................................................
ation Reason Codes 935
Checking.........................................................................................................................
Object Pointer 937
Other Constants
......................................................................................................................... 938
............................................................................................................................942
Data Structures
Date Type
.........................................................................................................................
Structure 943
I ndicator.........................................................................................................................
Parameter Structure 944
History Data
.........................................................................................................................
Structure 945
Order Book
.........................................................................................................................
Structure 946
q
Trade Re.........................................................................................................................
uest Structure 947
q
Re uest Check
.........................................................................................................................
Result Structure 960
q
Trade Re.........................................................................................................................
uest Result Structure 961
Trade Transaction
.........................................................................................................................
Structure 964
Price Data
.........................................................................................................................
Structure 972
Economic.........................................................................................................................
Сalendar structures 974
............................................................................................................................983
Codes of Errors and Warnings
Trade Server
.........................................................................................................................
Return Codes 984
Compiler .........................................................................................................................
Warnings 987
Compilation
.........................................................................................................................
Errors 990
Runtime.........................................................................................................................
Errors 1001
............................................................................................................................1014
Input/Output Constants
File Opening
.........................................................................................................................
Flags 1015
File Properties
......................................................................................................................... 1017
I n-File Position
......................................................................................................................... 1018
Use of a.........................................................................................................................
Codepage 1019
MessageBox
......................................................................................................................... 1020
3 MQL5 programs
................................................................................................. 1022
............................................................................................................................1023
Program Running
............................................................................................................................1030
Trade Permission
............................................................................................................................1034
Client Terminal Events
Resources............................................................................................................................1037
............................................................................................................................1049
Call of Imported Functions
............................................................................................................................1051
Runtime Errors
............................................................................................................................1052
Testing Trading Strategies
4 Predefined Variables
................................................................................................. 1078
_AppliedTo............................................................................................................................1079
_Digits ............................................................................................................................1081
_Point ............................................................................................................................1082
_LastError............................................................................................................................1083
_Period ............................................................................................................................1084
............................................................................................................................1085
_RandomSeed
_StopFlag ............................................................................................................................1086
_Symbol ............................................................................................................................1087
............................................................................................................................1088
_UninitReason
_IsX64 ............................................................................................................................1089
5 Common Functions
................................................................................................. 1090
Alert ............................................................................................................................1092
............................................................................................................................1093
CheckPointer
Comment ............................................................................................................................1095
............................................................................................................................1096
CryptEncode
............................................................................................................................1098
CryptDecode
DebugBreak............................................................................................................................1099
............................................................................................................................1100
ExpertRemove
GetPointer............................................................................................................................1102
............................................................................................................................1106
GetTickCount
............................................................................................................................1107
GetTickCount64
............................................................................................................................1108
GetMicrosecondCount
MessageBox............................................................................................................................1110
............................................................................................................................1111
PeriodSeconds
PlaySound............................................................................................................................1112
Print ............................................................................................................................1113
............................................................................................................................1115
PrintFormat
............................................................................................................................1121
ResetLastError
............................................................................................................................1122
ResourceCreate
............................................................................................................................1124
ResourceFree
............................................................................................................................1125
ResourceReadImage
............................................................................................................................1126
ResourceSave
............................................................................................................................1127
SetReturnError
............................................................................................................................1128
SetUserError
Sleep ............................................................................................................................1129
............................................................................................................................1130
TerminalClose
............................................................................................................................1132
TesterHideIndicators
............................................................................................................................1134
TesterStatistics
TesterStop............................................................................................................................1135
............................................................................................................................1136
TesterDeposit
............................................................................................................................1137
TesterWithdrawal
............................................................................................................................1138
TranslateKey
ZeroMemory............................................................................................................................1139
6 Array Functions
................................................................................................. 1140
............................................................................................................................1141
ArrayBsearch
ArrayCopy............................................................................................................................1145
............................................................................................................................1150
ArrayCompare
ArrayFree............................................................................................................................1151
............................................................................................................................1160
ArrayGetAsSeries
............................................................................................................................1163
ArrayInitialize
ArrayFill ............................................................................................................................1165
............................................................................................................................1167
ArrayIsDynamic
............................................................................................................................1169
ArrayIsSeries
............................................................................................................................1171
ArrayMaximum
............................................................................................................................1182
ArrayMinimum
ArrayPrint............................................................................................................................1193
ArrayRange............................................................................................................................1196
ArrayResiz............................................................................................................................1197
e
............................................................................................................................1200
ArrayInsert
............................................................................................................................1203
ArrayRemove
............................................................................................................................1205
ArrayReverse
............................................................................................................................1207
ArraySetAsSeries
ArraySize ............................................................................................................................1210
ArraySort............................................................................................................................1212
ArraySwap............................................................................................................................1217
7 Matrix and Vector
.................................................................................................
Methods 1219
Matrix and............................................................................................................................1226
Vector Types
Enumerations
......................................................................................................................... 1227
............................................................................................................................1232
Initialization
Assign ......................................................................................................................... 1235
CopyI ndicatorBuffer
......................................................................................................................... 1237
CopyRates
......................................................................................................................... 1239
CopyTicks
......................................................................................................................... 1244
CopyTicksRange
......................................................................................................................... 1247
Eye ......................................................................................................................... 1249
I dentity......................................................................................................................... 1251
Ones ......................................................................................................................... 1253
Zeros ......................................................................................................................... 1254
CumSum......................................................................................................................... 1361
CumProd
......................................................................................................................... 1363
Percentile
......................................................................................................................... 1365
Quantile
......................................................................................................................... 1367
Median ......................................................................................................................... 1369
Mean ......................................................................................................................... 1371
Average......................................................................................................................... 1372
Std ......................................................................................................................... 1374
Var ......................................................................................................................... 1376
LinearRegression
......................................................................................................................... 1378
Features ............................................................................................................................1381
Rows ......................................................................................................................... 1382
Cols ......................................................................................................................... 1383
z
Si e ......................................................................................................................... 1384
Norm ......................................................................................................................... 1385
Cond ......................................................................................................................... 1388
Det ......................................................................................................................... 1391
SLogDet......................................................................................................................... 1393
Rank ......................................................................................................................... 1394
Trace ......................................................................................................................... 1397
Spectrum
......................................................................................................................... 1398
Solutions ............................................................................................................................1399
Solve ......................................................................................................................... 1400
LstS q ......................................................................................................................... 1401
I nv ......................................................................................................................... 1402
PI nv ......................................................................................................................... 1404
............................................................................................................................1405
Machine learning
Activation
......................................................................................................................... 1410
Derivative
......................................................................................................................... 1414
Loss ......................................................................................................................... 1416
G
Loss radient
......................................................................................................................... 1418
RegressionMetric
......................................................................................................................... 1420
ConfusionMatrix
......................................................................................................................... 1422
ConfusionMatrixMultilabel
......................................................................................................................... 1424
ClassificationMetric
......................................................................................................................... 1426
ClassificationScore
......................................................................................................................... 1430
8 Conversion Functions
................................................................................................. 1434
............................................................................................................................1436
CharToString
............................................................................................................................1437
CharArrayToString
............................................................................................................................1438
CharArrayToStruct
............................................................................................................................1439
StructToCharArray
............................................................................................................................1440
ColorToARGB
............................................................................................................................1442
ColorToString
............................................................................................................................1443
DoubleToString
............................................................................................................................1444
EnumToString
............................................................................................................................1446
IntegerToString
............................................................................................................................1447
ShortToString
............................................................................................................................1448
ShortArrayToString
............................................................................................................................1449
TimeToString
............................................................................................................................1450
NormalizeDouble
............................................................................................................................1452
StringToCharArray
............................................................................................................................1453
StringToColor
............................................................................................................................1454
StringToDouble
............................................................................................................................1455
StringToInteger
............................................................................................................................1456
StringToShortArray
............................................................................................................................1457
StringToTime
............................................................................................................................1458
StringFormat
9 Math Functions
................................................................................................. 1462
© 2000-2024, MetaQuotes Ltd.
9 Content
MathAbs ............................................................................................................................1464
MathArccos............................................................................................................................1465
MathArcsin............................................................................................................................1466
MathArctan............................................................................................................................1467
............................................................................................................................1468
MathArctan2
............................................................................................................................1469
MathClassify
MathCeil ............................................................................................................................1471
MathCos ............................................................................................................................1472
MathExp ............................................................................................................................1473
MathFloor............................................................................................................................1474
MathLog ............................................................................................................................1475
MathLog10............................................................................................................................1476
MathMax ............................................................................................................................1477
MathMin ............................................................................................................................1478
MathMod ............................................................................................................................1479
MathPow ............................................................................................................................1480
MathRand ............................................................................................................................1481
MathRound............................................................................................................................1482
MathSin ............................................................................................................................1483
MathSq rt ............................................................................................................................1484
MathSrand............................................................................................................................1485
MathTan ............................................................................................................................1488
............................................................................................................................1489
MathIsValidNumber
MathExpm1............................................................................................................................1490
MathLog1p............................................................................................................................1491
............................................................................................................................1492
MathArccosh
............................................................................................................................1493
MathArcsinh
............................................................................................................................1494
MathArctanh
MathCosh ............................................................................................................................1495
MathSinh ............................................................................................................................1496
MathTanh ............................................................................................................................1497
MathSwap............................................................................................................................1498
10 String Functions
................................................................................................. 1499
StringAdd ............................................................................................................................1500
............................................................................................................................1502
StringBufferLen
............................................................................................................................1503
StringCompare
............................................................................................................................1505
StringConcatenate
StringFill ............................................................................................................................1506
StringFind............................................................................................................................1507
............................................................................................................................1508
StringGetCharacter
StringInit ............................................................................................................................1509
StringLen ............................................................................................................................1510
............................................................................................................................1511
StringSetLength
............................................................................................................................1512
StringReplace
............................................................................................................................1513
StringReserve
............................................................................................................................1515
StringSetCharacter
StringSplit............................................................................................................................1517
............................................................................................................................1519
StringSubstr
............................................................................................................................1520
StringToLower
............................................................................................................................1521
StringToUpper
............................................................................................................................1522
StringTrimLeft
............................................................................................................................1523
StringTrimRight
11 Date and Time
................................................................................................. 1524
............................................................................................................................1525
TimeCurrent
............................................................................................................................1526
TimeTradeServer
TimeLocal............................................................................................................................1527
TimeGMT ............................................................................................................................1528
............................................................................................................................1529
TimeDaylightSavings
© 2000-2024, MetaQuotes Ltd.
10 Content
............................................................................................................................1530
TimeGMTOffset
............................................................................................................................1531
TimeToStruct
............................................................................................................................1532
StructToTime
12 Account Information
................................................................................................. 1533
............................................................................................................................1534
AccountInfoDouble
............................................................................................................................1535
AccountInfoInteger
............................................................................................................................1537
AccountInfoString
13 Checkup ................................................................................................. 1538
............................................................................................................................1539
GetLastError
IsStopped ............................................................................................................................1540
............................................................................................................................1541
UninitializeReason
............................................................................................................................1542
TerminalInfoInteger
............................................................................................................................1543
TerminalInfoDouble
............................................................................................................................1544
TerminalInfoString
............................................................................................................................1545
MQLInfoInteger
............................................................................................................................1546
MQLInfoString
Symbol ............................................................................................................................1547
Period ............................................................................................................................1548
Digits ............................................................................................................................1549
Point ............................................................................................................................1550
14 Event Handling
................................................................................................. 1551
OnStart ............................................................................................................................1553
OnInit ............................................................................................................................1556
OnDeinit ............................................................................................................................1559
OnTick ............................................................................................................................1562
............................................................................................................................1568
OnCalculate
OnTimer ............................................................................................................................1572
OnTrade ............................................................................................................................1575
............................................................................................................................1580
OnTradeTransaction
............................................................................................................................1586
OnBookEvent
............................................................................................................................1589
OnChartEvent
OnTester ............................................................................................................................1596
............................................................................................................................1603
OnTesterInit
............................................................................................................................1610
OnTesterDeinit
............................................................................................................................1611
OnTesterPass
15 Market Info ................................................................................................. 1612
............................................................................................................................1613
SymbolsTotal
............................................................................................................................1614
SymbolExist
............................................................................................................................1615
SymbolName
............................................................................................................................1616
SymbolSelect
............................................................................................................................1617
SymbolIsSynchroni zed
............................................................................................................................1618
SymbolInfoDouble
............................................................................................................................1620
SymbolInfoInteger
............................................................................................................................1622
SymbolInfoString
............................................................................................................................1623
SymbolInfoMarginRate
............................................................................................................................1624
SymbolInfoTick
............................................................................................................................1625
SymbolInfoSessionQuote
............................................................................................................................1626
SymbolInfoSessionTrade
............................................................................................................................1627
MarketBookAdd
............................................................................................................................1628
MarketBookRelease
............................................................................................................................1629
MarketBookGet
16 Economic Calendar
................................................................................................. 1630
............................................................................................................................1631
CalendarCountryById
............................................................................................................................1633
CalendarEventById
............................................................................................................................1636
CalendarValueById
............................................................................................................................1639
CalendarCountries
............................................................................................................................1641
CalendarEventByCountry
............................................................................................................................1643
CalendarEventByCurrency
............................................................................................................................1645
CalendarValueHistoryByEvent
............................................................................................................................1648
CalendarValueHistory
............................................................................................................................1651
CalendarValueLastByEvent
............................................................................................................................1656
CalendarValueLast
17 Timeseries and
.................................................................................................
Indicators Access 1661
............................................................................................................................1666
Indexing Direction in Arrays, Buffers and Timeseries
Organizing............................................................................................................................1669
Data Access
............................................................................................................................1678
SeriesInfoInteger
Bars ............................................................................................................................1680
............................................................................................................................1683
BarsCalculated
............................................................................................................................1685
IndicatorCreate
............................................................................................................................1687
IndicatorParameters
............................................................................................................................1689
IndicatorRelease
CopyBuffer............................................................................................................................1691
CopyRates............................................................................................................................1696
CopySeries............................................................................................................................1700
CopyTime............................................................................................................................1704
CopyOpen............................................................................................................................1707
CopyHigh ............................................................................................................................1710
CopyLow ............................................................................................................................1714
CopyClose............................................................................................................................1717
............................................................................................................................1720
CopyTickVolume
............................................................................................................................1724
CopyRealVolume
CopySpread............................................................................................................................1727
CopyTicks............................................................................................................................1731
............................................................................................................................1737
CopyTicksRange
iBars ............................................................................................................................1739
iBarShift ............................................................................................................................1740
iClose ............................................................................................................................1743
iHigh ............................................................................................................................1745
iHighest ............................................................................................................................1747
iLow ............................................................................................................................1748
iLowest ............................................................................................................................1750
iOpen ............................................................................................................................1751
iTime ............................................................................................................................1753
............................................................................................................................1755
iTickVolume
............................................................................................................................1757
iRealVolume
iVolume ............................................................................................................................1759
iSpread ............................................................................................................................1761
18 Custom Symbols
................................................................................................. 1763
............................................................................................................................1764
CustomSymbolCreate
............................................................................................................................1766
CustomSymbolDelete
............................................................................................................................1767
CustomSymbolSetInteger
............................................................................................................................1768
CustomSymbolSetDouble
............................................................................................................................1769
CustomSymbolSetString
............................................................................................................................1770
CustomSymbolSetMarginRate
............................................................................................................................1771
CustomSymbolSetSessionQuote
............................................................................................................................1772
CustomSymbolSetSessionTrade
............................................................................................................................1773
CustomRatesDelete
............................................................................................................................1774
CustomRatesReplace
............................................................................................................................1775
CustomRatesUpdate
............................................................................................................................1776
CustomTicksAdd
............................................................................................................................1778
CustomTicksDelete
............................................................................................................................1779
CustomTicksReplace
............................................................................................................................1781
CustomBookAdd
19 Chart Operations
................................................................................................. 1784
............................................................................................................................1786
ChartApplyTemplate
............................................................................................................................1789
ChartSaveTemplate
............................................................................................................................1794
ChartWindowFind
............................................................................................................................1796
ChartTimePriceToXY
............................................................................................................................1797
ChartXYToTimePrice
ChartOpen............................................................................................................................1799
ChartFirst ............................................................................................................................1800
ChartNext............................................................................................................................1801
ChartClose............................................................................................................................1802
ChartSymbol............................................................................................................................1803
ChartPeriod............................................................................................................................1804
ChartRedraw............................................................................................................................1805
............................................................................................................................1806
ChartSetDouble
............................................................................................................................1807
ChartSetInteger
............................................................................................................................1809
ChartSetString
............................................................................................................................1811
ChartGetDouble
............................................................................................................................1813
ChartGetInteger
............................................................................................................................1815
ChartGetString
............................................................................................................................1817
ChartNavigate
ChartID ............................................................................................................................1820
............................................................................................................................1821
ChartIndicatorAdd
............................................................................................................................1825
ChartIndicatorDelete
............................................................................................................................1828
ChartIndicatorGet
............................................................................................................................1830
ChartIndicatorName
............................................................................................................................1831
ChartIndicatorsTotal
............................................................................................................................1832
ChartWindowOnDropped
............................................................................................................................1833
ChartPriceOnDropped
............................................................................................................................1834
ChartTimeOnDropped
............................................................................................................................1835
ChartXOnDropped
............................................................................................................................1836
ChartYOnDropped
............................................................................................................................1837
ChartSetSymbolPeriod
............................................................................................................................1838
ChartScreenShot
20 Trade Functions
................................................................................................. 1841
............................................................................................................................1843
OrderCalcMargin
............................................................................................................................1844
OrderCalcProfit
OrderCheck............................................................................................................................1845
OrderSend............................................................................................................................1846
............................................................................................................................1851
OrderSendAsync
............................................................................................................................1862
PositionsTotal
............................................................................................................................1863
PositionGetSymbol
............................................................................................................................1864
PositionSelect
............................................................................................................................1865
PositionSelectByTicket
............................................................................................................................1866
PositionGetDouble
............................................................................................................................1867
PositionGetInteger
............................................................................................................................1869
PositionGetString
............................................................................................................................1870
PositionGetTicket
............................................................................................................................1871
OrdersTotal
............................................................................................................................1872
OrderGetTicket
............................................................................................................................1874
OrderSelect
............................................................................................................................1875
OrderGetDouble
............................................................................................................................1876
OrderGetInteger
............................................................................................................................1877
OrderGetString
............................................................................................................................1878
HistorySelect
............................................................................................................................1880
HistorySelectByPosition
............................................................................................................................1881
HistoryOrderSelect
............................................................................................................................1882
HistoryOrdersTotal
............................................................................................................................1883
HistoryOrderGetTicket
© 2000-2024, MetaQuotes Ltd.
13 Content
............................................................................................................................1885
HistoryOrderGetDouble
............................................................................................................................1886
HistoryOrderGetInteger
............................................................................................................................1889
HistoryOrderGetString
............................................................................................................................1890
HistoryDealSelect
............................................................................................................................1891
HistoryDealsTotal
............................................................................................................................1892
HistoryDealGetTicket
............................................................................................................................1894
HistoryDealGetDouble
............................................................................................................................1895
HistoryDealGetInteger
............................................................................................................................1898
HistoryDealGetString
21 Trade Signals................................................................................................. 1899
............................................................................................................................1900
SignalBaseGetDouble
............................................................................................................................1901
SignalBaseGetInteger
............................................................................................................................1902
SignalBaseGetString
............................................................................................................................1903
SignalBaseSelect
............................................................................................................................1904
SignalBaseTotal
............................................................................................................................1905
SignalInfoGetDouble
............................................................................................................................1906
SignalInfoGetInteger
............................................................................................................................1907
SignalInfoGetString
............................................................................................................................1908
SignalInfoSetDouble
............................................................................................................................1909
SignalInfoSetInteger
............................................................................................................................1910
SignalSubscribe
............................................................................................................................1911
SignalUnSubscribe
22 Network Functions
................................................................................................. 1912
............................................................................................................................1914
SocketCreate
............................................................................................................................1917
SocketClose
............................................................................................................................1920
SocketConnect
............................................................................................................................1924
SocketIsConnected
............................................................................................................................1925
SocketIsReadable
............................................................................................................................1928
SocketIsWritable
............................................................................................................................1929
SocketTimeouts
............................................................................................................................1930
SocketRead
............................................................................................................................1934
SocketSend
............................................................................................................................1938
SocketTlsHandshake
............................................................................................................................1939
SocketTlsCertificate
............................................................................................................................1943
SocketTlsRead
............................................................................................................................1947
SocketTlsReadAvailable
............................................................................................................................1948
SocketTlsSend
............................................................................................................................1949
WebRe q uest
SendFTP ............................................................................................................................1952
SendMail ............................................................................................................................1953
............................................................................................................................1954
SendNotification
23 Global Variables
.................................................................................................
of the Terminal 1955
............................................................................................................................1956
GlobalVariableCheck
............................................................................................................................1957
GlobalVariableTime
............................................................................................................................1958
GlobalVariableDel
............................................................................................................................1959
GlobalVariableGet
............................................................................................................................1960
GlobalVariableName
............................................................................................................................1961
GlobalVariableSet
............................................................................................................................1962
GlobalVariablesFlush
............................................................................................................................1963
GlobalVariableTemp
............................................................................................................................1964
GlobalVariableSetOnCondition
............................................................................................................................1965
GlobalVariablesDeleteAll
............................................................................................................................1966
GlobalVariablesTotal
24 File Functions................................................................................................. 1967
............................................................................................................................1970
FileSelectDialog
............................................................................................................................1972
FileFindFirst
............................................................................................................................1974
FileFindNext
© 2000-2024, MetaQuotes Ltd.
14 Content
............................................................................................................................1976
FileFindClose
FileIsExist ............................................................................................................................1978
FileOpen ............................................................................................................................1981
FileClose ............................................................................................................................1984
FileCopy ............................................................................................................................1985
FileDelete............................................................................................................................1988
FileMove ............................................................................................................................1990
FileFlush ............................................................................................................................1992
............................................................................................................................1994
FileGetInteger
FileIsEnding............................................................................................................................1997
............................................................................................................................1999
FileIsLineEnding
............................................................................................................................2004
FileReadArray
FileReadBool............................................................................................................................2006
............................................................................................................................2009
FileReadDatetime
............................................................................................................................2012
FileReadDouble
............................................................................................................................2015
FileReadFloat
............................................................................................................................2018
FileReadInteger
FileReadLong............................................................................................................................2022
............................................................................................................................2025
FileReadNumber
............................................................................................................................2030
FileReadString
............................................................................................................................2032
FileReadStruct
FileSeek ............................................................................................................................2036
FileSize ............................................................................................................................2039
FileTell ............................................................................................................................2041
FileWrite ............................................................................................................................2044
............................................................................................................................2047
FileWriteArray
............................................................................................................................2050
FileWriteDouble
............................................................................................................................2053
FileWriteFloat
............................................................................................................................2055
FileWriteInteger
............................................................................................................................2058
FileWriteLong
............................................................................................................................2060
FileWriteString
............................................................................................................................2063
FileWriteStruct
FileLoad ............................................................................................................................2066
FileSave ............................................................................................................................2068
FolderCreate............................................................................................................................2070
FolderDelete............................................................................................................................2073
FolderClean ............................................................................................................................2076
25 Custom Indicators
................................................................................................. 2079
............................................................................................................................2082
Indicator Styles in Examples
_
DRAW NONE
......................................................................................................................... 2093
_
DRAW LI
.........................................................................................................................
NE 2096
DRAW _SECTI
.........................................................................................................................
ON 2100
DRAW _HI STO GRAM
......................................................................................................................... 2104
DRAW _HI STO GRAM2
......................................................................................................................... 2108
DRAW _ARROW
......................................................................................................................... 2112
DRAW _Z.........................................................................................................................
I GZAG 2117
DRAW _FI LLI NG
......................................................................................................................... 2122
DRAW _BARS
......................................................................................................................... 2127
DRAW _CANDLES
......................................................................................................................... 2133
DRAW _COLOR _LI NE
......................................................................................................................... 2139
DRAW _COLOR _SECTI ON
......................................................................................................................... 2144
DRAW _COLOR _HI STO GRAM
......................................................................................................................... 2150
DRAW _COLOR _HI STO GRAM2
......................................................................................................................... 2155
DRAW _COLOR _ARROW
......................................................................................................................... 2160
DRAW _COLOR _ZI GZAG
......................................................................................................................... 2166
DRAW _COLOR _BARS
......................................................................................................................... 2171
DRAW _COLOR _CANDLES
......................................................................................................................... 2178
............................................................................................................................2185
Connection between Indicator Properties and Functions
© 2000-2024, MetaQuotes Ltd.
15 Content
............................................................................................................................2188
SetIndexBuffer
............................................................................................................................2191
IndicatorSetDouble
............................................................................................................................2195
IndicatorSetInteger
............................................................................................................................2199
IndicatorSetString
............................................................................................................................2202
PlotIndexSetDouble
............................................................................................................................2203
PlotIndexSetInteger
............................................................................................................................2207
PlotIndexSetString
............................................................................................................................2208
PlotIndexGetInteger
26 Object Functions
................................................................................................. 2211
............................................................................................................................2213
ObjectCreate
ObjectName............................................................................................................................2217
............................................................................................................................2218
ObjectDelete
............................................................................................................................2219
ObjectsDeleteAll
ObjectFind............................................................................................................................2220
............................................................................................................................2221
ObjectGetTimeByValue
............................................................................................................................2222
ObjectGetValueByTime
ObjectMove............................................................................................................................2223
............................................................................................................................2224
ObjectsTotal
............................................................................................................................2225
ObjectSetDouble
............................................................................................................................2229
ObjectSetInteger
............................................................................................................................2232
ObjectSetString
............................................................................................................................2234
ObjectGetDouble
............................................................................................................................2236
ObjectGetInteger
............................................................................................................................2238
ObjectGetString
............................................................................................................................2240
TextSetFont
TextOut ............................................................................................................................2242
TextGetSiz............................................................................................................................2246
e
27 Technical Indicators
................................................................................................. 2247
iAC ............................................................................................................................2250
iAD ............................................................................................................................2255
iADX ............................................................................................................................2260
iADXWilder ............................................................................................................................2265
iAlligator ............................................................................................................................2270
iAMA ............................................................................................................................2277
iAO ............................................................................................................................2282
iATR ............................................................................................................................2287
iBearsPower............................................................................................................................2292
iBands ............................................................................................................................2297
iBullsPower............................................................................................................................2303
iCCI ............................................................................................................................2308
iChaikin ............................................................................................................................2313
iCustom ............................................................................................................................2318
iDEMA ............................................................................................................................2322
iDeMarker............................................................................................................................2327
iEnvelopes............................................................................................................................2332
iForce ............................................................................................................................2338
iFractals ............................................................................................................................2343
iFrAMA ............................................................................................................................2348
iGator ............................................................................................................................2353
iIchimoku ............................................................................................................................2360
iBWMFI ............................................................................................................................2367
iMomentum ............................................................................................................................2372
iMFI ............................................................................................................................2377
iMA ............................................................................................................................2382
iOsMA ............................................................................................................................2387
iMACD ............................................................................................................................2392
iOBV ............................................................................................................................2398
iSAR ............................................................................................................................2403
© 2000-2024, MetaQuotes Ltd.
16 Content
iRSI ............................................................................................................................2408
iRVI ............................................................................................................................2413
iStdDev ............................................................................................................................2418
iStochastic............................................................................................................................2423
iTEMA ............................................................................................................................2429
iTriX ............................................................................................................................2434
iWPR ............................................................................................................................2439
iVIDyA ............................................................................................................................2444
iVolumes ............................................................................................................................2449
28 Working with.................................................................................................
Optimization Results 2454
FrameFirst............................................................................................................................2456
FrameFilter............................................................................................................................2457
FrameNext............................................................................................................................2458
............................................................................................................................2459
FrameInputs
FrameAdd............................................................................................................................2460
............................................................................................................................2461
ParameterGetRange
............................................................................................................................2464
ParameterSetRange
29 Working with.................................................................................................
Events 2466
............................................................................................................................2467
EventSetMillisecondTimer
............................................................................................................................2468
EventSetTimer
............................................................................................................................2469
EventKillTimer
............................................................................................................................2470
EventChartCustom
30 Working with.................................................................................................
OpenCL 2476
............................................................................................................................2478
CLHandleType
............................................................................................................................2479
CLGetInfoInteger
............................................................................................................................2482
CLGetInfoString
............................................................................................................................2485
CLContextCreate
............................................................................................................................2486
CLContextFree
............................................................................................................................2487
CLGetDeviceInfo
............................................................................................................................2492
CLProgramCreate
............................................................................................................................2497
CLProgramFree
............................................................................................................................2498
CLKernelCreate
............................................................................................................................2499
CLKernelFree
............................................................................................................................2500
CLSetKernelArg
............................................................................................................................2501
CLSetKernelArgMem
............................................................................................................................2502
CLSetKernelArgMemLocal
............................................................................................................................2503
CLBufferCreate
............................................................................................................................2504
CLBufferFree
............................................................................................................................2505
CLBufferWrite
............................................................................................................................2510
CLBufferRead
CLExecute............................................................................................................................2514
............................................................................................................................2516
CLExecutionStatus
31 Working with.................................................................................................
databases 2517
............................................................................................................................2520
DatabaseOpen
............................................................................................................................2522
DatabaseClose
............................................................................................................................2523
DatabaseImport
............................................................................................................................2526
DatabaseExport
............................................................................................................................2532
DatabasePrint
............................................................................................................................2537
DatabaseTableExists
............................................................................................................................2538
DatabaseExecute
............................................................................................................................2550
DatabasePrepare
............................................................................................................................2559
DatabaseReset
............................................................................................................................2565
DatabaseBind
............................................................................................................................2570
DatabaseBindArray
............................................................................................................................2575
DatabaseRead
............................................................................................................................2576
DatabaseReadBind
............................................................................................................................2580
DatabaseFinali ze
............................................................................................................................2581
DatabaseTransactionBegin
............................................................................................................................2586
DatabaseTransactionCommit
............................................................................................................................2587
DatabaseTransactionRollback
............................................................................................................................2588
DatabaseColumnsCount
............................................................................................................................2589
DatabaseColumnName
............................................................................................................................2590
DatabaseColumnType
............................................................................................................................2591
DatabaseColumnSi ze
............................................................................................................................2592
DatabaseColumnText
............................................................................................................................2593
DatabaseColumnInteger
............................................................................................................................2594
DatabaseColumnLong
............................................................................................................................2595
DatabaseColumnDouble
............................................................................................................................2596
DatabaseColumnBlob
32 Working with.................................................................................................
DirectX 2597
............................................................................................................................2599
DXContextCreate
............................................................................................................................2600
DXContextSetSi ze
............................................................................................................................2601
DXContextGetSi ze
............................................................................................................................2602
DXContextClearColors
............................................................................................................................2603
DXContextClearDepth
............................................................................................................................2604
DXContextGetColors
............................................................................................................................2605
DXContextGetDepth
............................................................................................................................2606
DXBufferCreate
............................................................................................................................2607
DXTextureCreate
............................................................................................................................2613
DXInputCreate
DXInputSet............................................................................................................................2614
............................................................................................................................2615
DXShaderCreate
............................................................................................................................2616
DXShaderSetLayout
............................................................................................................................2617
DXShaderInputsSet
............................................................................................................................2618
DXShaderTexturesSet
DXDraw ............................................................................................................................2619
............................................................................................................................2620
DXDrawIndexed
............................................................................................................................2621
DXPrimiveTopologySet
............................................................................................................................2622
DXBufferSet
............................................................................................................................2623
DXShaderSet
............................................................................................................................2624
DXHandleType
DXRelease............................................................................................................................2625
33 Python Integration
................................................................................................. 2626
initialize ............................................................................................................................2632
login ............................................................................................................................2634
shutdown............................................................................................................................2637
version ............................................................................................................................2638
last_error............................................................................................................................2640
............................................................................................................................2642
account_info
............................................................................................................................2645
terminal_info
............................................................................................................................2648
symbols_total
symbols_get............................................................................................................................2649
symbol_info............................................................................................................................2652
............................................................................................................................2656
symbol_info_tick
............................................................................................................................2658
symbol_select
............................................................................................................................2662
market_book_add
............................................................................................................................2663
market_book_get
............................................................................................................................2666
market_book_release
............................................................................................................................2667
copy_rates_from
............................................................................................................................2671
copy_rates_from_pos
............................................................................................................................2674
copy_rates_range
............................................................................................................................2677
copy_ticks_from
............................................................................................................................2680
copy_ticks_range
............................................................................................................................2683
orders_total
orders_get............................................................................................................................2684
© 2000-2024, MetaQuotes Ltd.
18 Content
............................................................................................................................2687
order_calc_margin
............................................................................................................................2690
order_calc_profit
............................................................................................................................2693
order_check
order_send............................................................................................................................2697
............................................................................................................................2702
positions_total
............................................................................................................................2703
positions_get
............................................................................................................................2706
history_orders_total
............................................................................................................................2708
history_orders_get
............................................................................................................................2711
history_deals_total
............................................................................................................................2713
history_deals_get
34 ONNX models................................................................................................. 2717
............................................................................................................................2718
ONNX Support
............................................................................................................................2720
Format Conversion
Automatic............................................................................................................................2721
data type conversion
Creating a............................................................................................................................2725
Model
Running a............................................................................................................................2732
model
Validation............................................................................................................................2738
in the Strategy Tester
OnnxCreate............................................................................................................................2743
............................................................................................................................2744
OnnxCreateFromBuffer
............................................................................................................................2745
OnnxRelease
OnnxRun ............................................................................................................................2746
............................................................................................................................2749
OnnxGetInputCount
............................................................................................................................2750
OnnxGetOutputCount
............................................................................................................................2751
OnnxGetInputName
............................................................................................................................2752
OnnxGetOutputName
............................................................................................................................2753
OnnxGetInputTypeInfo
............................................................................................................................2754
OnnxGetOutputTypeInfo
............................................................................................................................2755
OnnxSetInputShape
............................................................................................................................2756
OnnxSetOutputShape
............................................................................................................................2757
Data structures
35 Standard Library
................................................................................................. 2760
............................................................................................................................2761
Mathematics
Statistics
......................................................................................................................... 2762
Statistical Characteristics
................................................................................................................ 2765
MathMean ........................................................................................................... 2766
MathVariance
........................................................................................................... 2767
MathSkewness
........................................................................................................... 2768
MathKurtosis
........................................................................................................... 2769
MathMoments
........................................................................................................... 2770
MathMedian
........................................................................................................... 2771
MathStandardDeviation
........................................................................................................... 2772
MathAverageDeviation
........................................................................................................... 2773
Normal Distribution
................................................................................................................ 2774
MathProbabilityDensityNormal
........................................................................................................... 2778
MathCumulativeDistributionNormal
........................................................................................................... 2780
MathQuantileNormal
........................................................................................................... 2782
MathRandomNormal
........................................................................................................... 2784
MathMomentsNormal
........................................................................................................... 2785
Log-normal................................................................................................................
distribution 2786
MathProbabilityDensityLognormal
........................................................................................................... 2790
MathCumulativeDistributionLognormal
........................................................................................................... 2792
MathQuantileLognormal
........................................................................................................... 2794
MathRandomLognormal
........................................................................................................... 2796
MathMomentsLognormal
........................................................................................................... 2797
Beta distribution
................................................................................................................ 2798
MathProbabilityDensityBeta
........................................................................................................... 2802
MathCumulativeDistributionBeta
........................................................................................................... 2804
MathQuantileBeta
........................................................................................................... 2806
MathRandomBeta
........................................................................................................... 2808
MathMomentsBeta
........................................................................................................... 2809
Noncentral................................................................................................................
beta distribution 2810
MathProbabilityDensityNoncentralBeta
........................................................................................................... 2814
MathCumulativeDistributionNoncentralBeta
........................................................................................................... 2816
MathQuantileNoncentralBeta
........................................................................................................... 2818
MathRandomNoncentralBeta
........................................................................................................... 2820
MathMomentsNoncentralBeta
........................................................................................................... 2821
Gamma distribution
................................................................................................................ 2822
MathProbabilityDensity Gamma
........................................................................................................... 2826
MathCumulativeDistribution Gamma
........................................................................................................... 2828
MathQuantile Gamma
........................................................................................................... 2830
MathRandom Gamma
........................................................................................................... 2832
MathMoments Gamma
........................................................................................................... 2833
Chi-s quared
................................................................................................................
distribution 2834
MathProbabilityDensityChiS quare
........................................................................................................... 2838
MathCumulativeDistributionChiS quare
........................................................................................................... 2840
MathQuantileChiS quare
........................................................................................................... 2842
MathRandomChiS quare
........................................................................................................... 2844
MathMomentsChiS quare
........................................................................................................... 2845
chi-s quared distribution
Noncentral................................................................................................................ 2846
MathProbabilityDensityNoncentralChiS quare
........................................................................................................... 2850
MathCumulativeDistributionNoncentralChiS quare
........................................................................................................... 2852
MathQuantileNoncentralChiS quare
........................................................................................................... 2854
MathRandomNoncentralChiS quare
........................................................................................................... 2856
MathMomentsNoncentralChiS quare
........................................................................................................... 2857
Exponential
................................................................................................................
distribution 2858
MathProbabilityDensityExponential
........................................................................................................... 2862
MathCumulativeDistributionExponential
........................................................................................................... 2864
MathQuantileExponential
........................................................................................................... 2866
MathRandomExponential
........................................................................................................... 2868
MathMomentsExponential
........................................................................................................... 2869
F-distribution
................................................................................................................ 2870
MathProbabilityDensityF
........................................................................................................... 2874
MathCumulativeDistributionF
........................................................................................................... 2876
MathQuantileF
........................................................................................................... 2878
MathRandomF
........................................................................................................... 2880
MathMomentsF
........................................................................................................... 2881
Noncentral................................................................................................................
F-distribution 2882
MathProbabilityDensityNoncentralF
........................................................................................................... 2886
MathCumulativeDistributionNoncentralF
........................................................................................................... 2888
MathQuantileNoncentralF
........................................................................................................... 2890
MathRandomNoncentralF
........................................................................................................... 2892
MathMomentsNoncentralF
........................................................................................................... 2893
T-distribution
................................................................................................................ 2894
MathProbabilityDensityT
........................................................................................................... 2898
MathCumulativeDistributionT
........................................................................................................... 2900
MathQuantileT
........................................................................................................... 2902
MathRandomT
........................................................................................................... 2904
MathMomentsT
........................................................................................................... 2905
Noncentral................................................................................................................
t-distribution 2906
MathProbabilityDensityNoncentralT
........................................................................................................... 2910
MathCumulativeDistributionNoncentralT
........................................................................................................... 2912
MathQuantileNoncentralT
........................................................................................................... 2914
MathRandomNoncentralT
........................................................................................................... 2916
MathMomentsNoncentralT
........................................................................................................... 2917
Logistic distribution
................................................................................................................ 2918
MathProbabilityDensityLogistic
........................................................................................................... 2922
MathCumulativeDistributionLogistic
........................................................................................................... 2924
MathQuantileLogistic
........................................................................................................... 2926
MathRandomLogistic
........................................................................................................... 2928
MathMomentsLogistic
........................................................................................................... 2929
Cauchy distribution
................................................................................................................ 2930
MathProbabilityDensityCauchy
........................................................................................................... 2934
MathCumulativeDistributionCauchy
........................................................................................................... 2936
MathQuantileCauchy
........................................................................................................... 2938
MathRandomCauchy
........................................................................................................... 2940
MathMomentsCauchy
........................................................................................................... 2941
Uniform distribution
................................................................................................................ 2942
MathProbabilityDensityUniform
........................................................................................................... 2946
MathCumulativeDistributionUniform
........................................................................................................... 2948
MathQuantileUniform
........................................................................................................... 2950
MathRandomUniform
........................................................................................................... 2952
MathMomentsUniform
........................................................................................................... 2953
Weibull distribution
................................................................................................................ 2954
MathProbabilityDensityWeibull
........................................................................................................... 2958
MathCumulativeDistributionWeibull
........................................................................................................... 2960
MathQuantileWeibull
........................................................................................................... 2962
MathRandomWeibull
........................................................................................................... 2964
MathMomentsWeibull
........................................................................................................... 2965
Binomial distribution
................................................................................................................ 2966
MathProbabilityDensityBinomial
........................................................................................................... 2969
MathCumulativeDistributionBinomial
........................................................................................................... 2971
MathQuantileBinomial
........................................................................................................... 2973
MathRandomBinomial
........................................................................................................... 2975
MathMomentsBinomial
........................................................................................................... 2976
Negative binomial
................................................................................................................
distribution 2977
MathProbabilityDensityNegativeBinomial
........................................................................................................... 2980
MathCumulativeDistributionNegativeBinomial
........................................................................................................... 2982
MathQuantileNegativeBinomial
........................................................................................................... 2984
MathRandomNegativeBinomial
........................................................................................................... 2986
MathMomentsNegativeBinomial
........................................................................................................... 2987
Geometric ................................................................................................................
distribution 2988
MathProbabilityDensity Geometric
........................................................................................................... 2992
MathCumulativeDistribution Geometric
........................................................................................................... 2994
MathQuantile Geometric
........................................................................................................... 2996
MathRandom Geometric
........................................................................................................... 2998
MathMoments Geometric
........................................................................................................... 2999
Hypergeometric
................................................................................................................
distribution 3000
MathProbabilityDensityHypergeometric
........................................................................................................... 3004
MathCumulativeDistributionHypergeometric
........................................................................................................... 3006
MathQuantileHypergeometric
........................................................................................................... 3008
MathRandomHypergeometric
........................................................................................................... 3010
MathMomentsHypergeometric
........................................................................................................... 3011
Poisson distribution
................................................................................................................ 3012
MathProbabilityDensityPoisson
........................................................................................................... 3016
MathCumulativeDistributionPoisson
........................................................................................................... 3018
MathQuantilePoisson
........................................................................................................... 3020
MathRandomPoisson
........................................................................................................... 3022
MathMomentsPoisson
........................................................................................................... 3023
Subfunctions
................................................................................................................ 3024
MathRandomNon Z
...........................................................................................................
ero 3029
MathMoments
........................................................................................................... 3030
MathPowI nt
........................................................................................................... 3031
MathFactorial
........................................................................................................... 3032
MathTrunc........................................................................................................... 3033
MathRound........................................................................................................... 3034
MathArctan2
........................................................................................................... 3036
G
Math amma
........................................................................................................... 3038
G
Math ammaLog
........................................................................................................... 3039
MathBeta ........................................................................................................... 3040
MathBetaLog
........................................................................................................... 3041
MathBetaI ncomplete
........................................................................................................... 3042
G
Math ammaI
...........................................................................................................
ncomplete 3043
MathBinomialCoefficient
........................................................................................................... 3044
MathBinomialCoefficientLog
........................................................................................................... 3045
MathHypergeometric2F2
........................................................................................................... 3046
q
MathSe uence
........................................................................................................... 3047
q
MathSe uenceByCount
........................................................................................................... 3048
MathReplicate
........................................................................................................... 3049
MathReverse
........................................................................................................... 3050
MathI dentical
........................................................................................................... 3051
MathUni ue q
........................................................................................................... 3052
MathQuickSortAscending
........................................................................................................... 3053
MathQuickSortDescending
........................................................................................................... 3054
MathQuickSort
........................................................................................................... 3055
MathOrder........................................................................................................... 3056
MathBitwiseNot
........................................................................................................... 3057
MathBitwiseAnd
........................................................................................................... 3058
MathBitwiseOr
........................................................................................................... 3059
MathBitwise X
...........................................................................................................
or 3060
MathBitwiseShiftL
........................................................................................................... 3061
MathBitwiseShiftR
........................................................................................................... 3062
MathCumulativeSum
........................................................................................................... 3063
MathCumulativeProduct
........................................................................................................... 3064
MathCumulativeMin
........................................................................................................... 3065
MathCumulativeMax
........................................................................................................... 3066
MathSin ........................................................................................................... 3067
MathCos ........................................................................................................... 3068
MathTan ........................................................................................................... 3069
MathArcsin........................................................................................................... 3070
MathArccos
........................................................................................................... 3071
MathArctan
........................................................................................................... 3072
MathSinPi ........................................................................................................... 3073
MathCosPi ........................................................................................................... 3074
MathTanPi ........................................................................................................... 3075
MathAbs ........................................................................................................... 3076
MathCeil ........................................................................................................... 3077
MathFloor ........................................................................................................... 3078
q
MathS rt ........................................................................................................... 3079
MathExp ........................................................................................................... 3080
MathPow ........................................................................................................... 3081
MathLog ........................................................................................................... 3082
MathLog2 ........................................................................................................... 3083
MathLog10........................................................................................................... 3084
MathLog1p........................................................................................................... 3085
MathDifference
........................................................................................................... 3086
MathSample
........................................................................................................... 3088
MathTukeySummary
........................................................................................................... 3091
MathRange........................................................................................................... 3092
MathMin ........................................................................................................... 3093
MathMax ........................................................................................................... 3094
MathSum ........................................................................................................... 3095
MathProduct
........................................................................................................... 3096
MathStandardDeviation
........................................................................................................... 3097
MathAverageDeviation
........................................................................................................... 3098
MathMedian
........................................................................................................... 3099
MathMean ........................................................................................................... 3100
MathVariance
........................................................................................................... 3101
MathSkewness
........................................................................................................... 3102
MathKurtosis
........................................................................................................... 3103
MathExpm1........................................................................................................... 3104
MathSinh ........................................................................................................... 3105
MathCosh ........................................................................................................... 3106
MathTanh ........................................................................................................... 3107
MathArcsinh
........................................................................................................... 3108
MathArccosh
........................................................................................................... 3109
MathArctanh
........................................................................................................... 3110
MathSignif ........................................................................................................... 3111
MathRank ........................................................................................................... 3113
MathCorrelationPearson
........................................................................................................... 3114
MathCorrelationSpearman
........................................................................................................... 3115
MathCorrelationKendall
........................................................................................................... 3116
MathQuantile
........................................................................................................... 3117
MathProbabilityDensityEmpirical
........................................................................................................... 3118
MathCumulativeDistributionEmpirical
........................................................................................................... 3119
zz y Logic
Fu ......................................................................................................................... 3120
Membership
................................................................................................................
functions 3121
CConstantMembershipFunction
........................................................................................................... 3123
GetValue ........................................................................................................... 3125
CCompositeMembershipFunction
........................................................................................................... 3126
CompositionType
........................................................................................................... 3128
MembershipFunctions
........................................................................................................... 3128
GetValue ........................................................................................................... 3128
CDifferencTwoSigmoidalMembershipFunction
........................................................................................................... 3130
A1 ........................................................................................................... 3132
A2 ........................................................................................................... 3132
C1 ........................................................................................................... 3133
C2 ........................................................................................................... 3133
GetValue ........................................................................................................... 3134
C Generaliz...........................................................................................................
edBellShapedMembershipFunction 3135
A ........................................................................................................... 3137
B ........................................................................................................... 3137
C ........................................................................................................... 3138
GetValue ........................................................................................................... 3138
CNormalCombinationMembershipFunction
........................................................................................................... 3139
B1 ........................................................................................................... 3141
B2 ........................................................................................................... 3141
Sigma1 ........................................................................................................... 3142
Sigma2 ........................................................................................................... 3142
GetValue ........................................................................................................... 3143
CNormalMembershipFunction
........................................................................................................... 3144
B ........................................................................................................... 3146
Sigma ........................................................................................................... 3146
GetValue ........................................................................................................... 3147
CP_ShapedMembershipFunction
........................................................................................................... 3148
A ........................................................................................................... 3150
B ........................................................................................................... 3150
C ........................................................................................................... 3151
D ........................................................................................................... 3151
GetValue ........................................................................................................... 3151
CProductTwoSigmoidalMembershipFunctions
........................................................................................................... 3153
A1 ........................................................................................................... 3155
A2 ........................................................................................................... 3155
C1 ........................................................................................................... 3156
C2 ........................................................................................................... 3156
GetValue ........................................................................................................... 3157
CS_ShapedMembershipFunction
........................................................................................................... 3158
A ........................................................................................................... 3160
B ........................................................................................................... 3160
GetValue ........................................................................................................... 3161
CSigmoidalMembershipFunction
........................................................................................................... 3162
A ........................................................................................................... 3164
C ........................................................................................................... 3164
GetValue ........................................................................................................... 3165
CTrapez oidMembershipFunction
........................................................................................................... 3166
X1 ........................................................................................................... 3168
X2 ........................................................................................................... 3168
X3 ........................................................................................................... 3169
X4 ........................................................................................................... 3169
GetValue ........................................................................................................... 3170
CTriangularMembershipFunction
........................................................................................................... 3171
X1 ........................................................................................................... 3173
X2 ........................................................................................................... 3173
X3 ........................................................................................................... 3174
ToNormalMF
........................................................................................................... 3174
GetValue ........................................................................................................... 3174
C Z_ShapedMembershipFunction
........................................................................................................... 3176
A ........................................................................................................... 3178
B ........................................................................................................... 3178
GetValue ........................................................................................................... 3179
I MembershipFunction
........................................................................................................... 3180
GetValue ........................................................................................................... 3180
zz y systems
Fu ................................................................................................................
rules 3181
CMamdaniFu zz yRule
........................................................................................................... 3182
Conclusion........................................................................................................... 3182
Weight ........................................................................................................... 3183
zz
CSugenoFu...........................................................................................................
yRule 3184
Conclusion........................................................................................................... 3184
CSingleCondition
........................................................................................................... 3186
Not ........................................................................................................... 3186
Term ........................................................................................................... 3187
Var ........................................................................................................... 3187
CConditions
........................................................................................................... 3189
ConditionsList
........................................................................................................... 3189
Not ........................................................................................................... 3190
Op ........................................................................................................... 3190
G
C enericFu zz
...........................................................................................................
yRule 3191
Conclusion........................................................................................................... 3191
Condition ........................................................................................................... 3192
CreateCondition
........................................................................................................... 3192
zz y systems
Fu ................................................................................................................
variables 3194
CFuzz yVariable
........................................................................................................... 3195
AddTerm ........................................................................................................... 3196
GetTermByName
........................................................................................................... 3196
Max ........................................................................................................... 3196
Min ........................................................................................................... 3197
Terms ........................................................................................................... 3197
Values ........................................................................................................... 3197
CSugenoVariable
........................................................................................................... 3199
CompareArray
................................................................................................................ 3321
I nsertSort ................................................................................................................ 3322
Search ................................................................................................................ 3323
G
Search reat
................................................................................................................ 3324
SearchLess................................................................................................................ 3325
G
Search reatOrE q
................................................................................................................
ual 3326
SearchLessOrE q
................................................................................................................
ual 3327
SearchFirst................................................................................................................ 3328
SearchLast................................................................................................................ 3329
SearchLinear
................................................................................................................ 3330
Save ................................................................................................................ 3331
Load ................................................................................................................ 3333
Type ................................................................................................................ 3335
CArrayI.........................................................................................................................
nt 3336
Reserve ................................................................................................................ 3339
Resi ez ................................................................................................................ 3340
Shutdown ................................................................................................................ 3341
Add ................................................................................................................ 3342
AddArray ................................................................................................................ 3343
AddArray ................................................................................................................ 3344
I nsert ................................................................................................................ 3346
I nsertArray
................................................................................................................ 3347
I nsertArray
................................................................................................................ 3348
AssignArray
................................................................................................................ 3350
AssignArray
................................................................................................................ 3351
Update ................................................................................................................ 3353
Shift ................................................................................................................ 3354
Delete ................................................................................................................ 3355
DeleteRange
................................................................................................................ 3356
At ................................................................................................................ 3357
CompareArray
................................................................................................................ 3359
CompareArray
................................................................................................................ 3360
I nsertSort ................................................................................................................ 3361
Search ................................................................................................................ 3362
G
Search reat
................................................................................................................ 3363
SearchLess................................................................................................................ 3364
G
Search reatOrE q
................................................................................................................
ual 3365
SearchLessOrE q
................................................................................................................
ual 3366
SearchFirst................................................................................................................ 3367
SearchLast................................................................................................................ 3368
SearchLinear
................................................................................................................ 3369
Save ................................................................................................................ 3370
Load ................................................................................................................ 3372
Type ................................................................................................................ 3374
CArrayLong
......................................................................................................................... 3375
Reserve ................................................................................................................ 3378
Resi ez ................................................................................................................ 3379
Shutdown ................................................................................................................ 3380
Add ................................................................................................................ 3381
AddArray ................................................................................................................ 3382
AddArray ................................................................................................................ 3383
I nsert ................................................................................................................ 3385
I nsertArray
................................................................................................................ 3386
I nsertArray
................................................................................................................ 3387
AssignArray
................................................................................................................ 3389
AssignArray
................................................................................................................ 3390
Update ................................................................................................................ 3392
Shift ................................................................................................................ 3393
I nsertArray
................................................................................................................ 3466
I nsertArray
................................................................................................................ 3467
AssignArray
................................................................................................................ 3469
AssignArray
................................................................................................................ 3470
Update ................................................................................................................ 3472
Shift ................................................................................................................ 3473
Delete ................................................................................................................ 3474
DeleteRange
................................................................................................................ 3475
At ................................................................................................................ 3476
CompareArray
................................................................................................................ 3478
CompareArray
................................................................................................................ 3479
Minimum ................................................................................................................ 3480
Maximum ................................................................................................................ 3481
I nsertSort ................................................................................................................ 3482
Search ................................................................................................................ 3483
G
Search reat
................................................................................................................ 3484
SearchLess................................................................................................................ 3485
G
Search reatOrE q
................................................................................................................
ual 3486
SearchLessOrE q
................................................................................................................
ual 3487
SearchFirst................................................................................................................ 3488
SearchLast................................................................................................................ 3489
SearchLinear
................................................................................................................ 3490
Save ................................................................................................................ 3491
Load ................................................................................................................ 3493
Type ................................................................................................................ 3495
CArrayString
......................................................................................................................... 3496
Reserve ................................................................................................................ 3499
Resi ez ................................................................................................................ 3500
Shutdown ................................................................................................................ 3501
Add ................................................................................................................ 3502
AddArray ................................................................................................................ 3503
AddArray ................................................................................................................ 3504
I nsert ................................................................................................................ 3506
I nsertArray
................................................................................................................ 3507
I nsertArray
................................................................................................................ 3508
AssignArray
................................................................................................................ 3510
AssignArray
................................................................................................................ 3511
Update ................................................................................................................ 3513
Shift ................................................................................................................ 3514
Delete ................................................................................................................ 3515
DeleteRange
................................................................................................................ 3516
At ................................................................................................................ 3517
CompareArray
................................................................................................................ 3519
CompareArray
................................................................................................................ 3520
I nsertSort ................................................................................................................ 3521
Search ................................................................................................................ 3522
G
Search reat
................................................................................................................ 3523
SearchLess................................................................................................................ 3524
G
Search reatOrE q
................................................................................................................
ual 3525
SearchLessOrE q
................................................................................................................
ual 3526
SearchFirst................................................................................................................ 3527
SearchLast................................................................................................................ 3528
SearchLinear
................................................................................................................ 3529
Save ................................................................................................................ 3530
Load ................................................................................................................ 3532
Type ................................................................................................................ 3534
CArrayObj
......................................................................................................................... 3535
FreeMode ................................................................................................................ 3540
SymmetricExceptWith
................................................................................................................ 3682
UnionWith ................................................................................................................ 3683
I sProperSubsetOf
................................................................................................................ 3684
I sProperSupersetOf
................................................................................................................ 3685
I sSubsetOf................................................................................................................ 3686
I sSupersetOf
................................................................................................................ 3687
Overlaps ................................................................................................................ 3688
q
SetE uals ................................................................................................................ 3689
CDefaultComparer < >
.........................................................................................................................
T 3690
Compare ................................................................................................................ 3691
CDefaultE q < >
.........................................................................................................................
ualityComparer T 3692
q
E uals ................................................................................................................ 3693
HashCode ................................................................................................................ 3694
CRedBlackTreeNode < >
.........................................................................................................................
T 3695
Value ................................................................................................................ 3696
Parent ................................................................................................................ 3697
Left ................................................................................................................ 3698
Right ................................................................................................................ 3699
Color ................................................................................................................ 3700
I sLeaf ................................................................................................................ 3701
CreateEmptyNode
................................................................................................................ 3702
CLinkedListNode < >
.........................................................................................................................
T 3703
List ................................................................................................................ 3704
Next ................................................................................................................ 3705
Previous ................................................................................................................ 3706
Value ................................................................................................................ 3707
CKeyValuePair < >
.........................................................................................................................
TKey,TValue 3708
Key ................................................................................................................ 3709
Value ................................................................................................................ 3710
Clone ................................................................................................................ 3711
Compare ................................................................................................................ 3712
q
E uals ................................................................................................................ 3713
HashCode ................................................................................................................ 3714
CArrayList < >
.........................................................................................................................
T 3715
Capacity ................................................................................................................ 3717
Count ................................................................................................................ 3718
Contains ................................................................................................................ 3719
TrimExcess................................................................................................................ 3720
G
Try etValue
................................................................................................................ 3721
TrySetValue
................................................................................................................ 3722
Add ................................................................................................................ 3723
AddRange ................................................................................................................ 3724
I nsert ................................................................................................................ 3725
I nsertRange
................................................................................................................ 3726
CopyTo ................................................................................................................ 3727
BinarySearch
................................................................................................................ 3728
I ndexOf ................................................................................................................ 3729
LastI ndexOf
................................................................................................................ 3730
Clear ................................................................................................................ 3731
Remove ................................................................................................................ 3732
RemoveAt ................................................................................................................ 3733
RemoveRange
................................................................................................................ 3734
Reverse ................................................................................................................ 3735
Sort ................................................................................................................ 3736
CHashMap < >
.........................................................................................................................
TKey,TValue 3737
Add ................................................................................................................ 3739
Count ................................................................................................................ 3740
Comparer ................................................................................................................ 3741
ReadI ntegerArray
................................................................................................................ 3927
ReadLongArray
................................................................................................................ 3928
ReadFloatArray
................................................................................................................ 3929
ReadDoubleArray
................................................................................................................ 3930
ReadObject
................................................................................................................ 3931
CFileTxt......................................................................................................................... 3932
Open ................................................................................................................ 3933
WriteString
................................................................................................................ 3934
ReadString ................................................................................................................ 3935
Strings ............................................................................................................................3936
CString ......................................................................................................................... 3937
Str ................................................................................................................ 3939
Len ................................................................................................................ 3940
Copy ................................................................................................................ 3941
Fill ................................................................................................................ 3942
Assign ................................................................................................................ 3943
Append ................................................................................................................ 3944
I nsert ................................................................................................................ 3945
Compare ................................................................................................................ 3946
CompareNoCase
................................................................................................................ 3947
Left ................................................................................................................ 3948
Right ................................................................................................................ 3949
Mid ................................................................................................................ 3950
Trim ................................................................................................................ 3951
TrimLeft ................................................................................................................ 3952
TrimRight ................................................................................................................ 3953
Clear ................................................................................................................ 3954
ToUpper ................................................................................................................ 3955
ToLower ................................................................................................................ 3956
Reverse ................................................................................................................ 3957
Find ................................................................................................................ 3958
FindRev ................................................................................................................ 3959
Remove ................................................................................................................ 3960
Replace ................................................................................................................ 3961
............................................................................................................................3962
Graphic Objects
CChartObject
......................................................................................................................... 3963
ChartI d ................................................................................................................ 3966
Window ................................................................................................................ 3967
Name ................................................................................................................ 3968
NumPoints ................................................................................................................ 3969
Attach ................................................................................................................ 3970
SetPoint ................................................................................................................ 3971
Delete ................................................................................................................ 3972
Detach ................................................................................................................ 3973
ShiftObject................................................................................................................ 3974
ShiftPoint ................................................................................................................ 3975
Time ................................................................................................................ 3976
Price ................................................................................................................ 3978
Color ................................................................................................................ 3980
Style ................................................................................................................ 3981
Width ................................................................................................................ 3982
Background
................................................................................................................ 3983
Selected ................................................................................................................ 3984
Selectable ................................................................................................................ 3985
Description................................................................................................................ 3986
Tooltip ................................................................................................................ 3987
Timeframes................................................................................................................ 3988
Z_Order ................................................................................................................ 3989
CreateTime................................................................................................................ 3990
LevelsCount
................................................................................................................ 3991
LevelColor ................................................................................................................ 3992
LevelStyle ................................................................................................................ 3994
LevelWidth................................................................................................................ 3996
LevelValue ................................................................................................................ 3998
LevelDescription
................................................................................................................ 4000
GetI nteger................................................................................................................ 4002
SetI nteger ................................................................................................................ 4004
GetDouble ................................................................................................................ 4006
SetDouble ................................................................................................................ 4008
GetString ................................................................................................................ 4010
SetString ................................................................................................................ 4012
Save ................................................................................................................ 4014
Load ................................................................................................................ 4015
Type ................................................................................................................ 4016
Line Objects
......................................................................................................................... 4017
CChartObjectVLine
................................................................................................................ 4018
Create ........................................................................................................... 4019
Type ........................................................................................................... 4020
CChartObjectHLine
................................................................................................................ 4021
Create ........................................................................................................... 4022
Type ........................................................................................................... 4023
CChartObjectTrend
................................................................................................................ 4024
Create ........................................................................................................... 4026
RayLeft ........................................................................................................... 4027
RayRight ........................................................................................................... 4028
Save ........................................................................................................... 4029
Load ........................................................................................................... 4030
Type ........................................................................................................... 4031
CChartObjectTrendByAngle
................................................................................................................ 4032
Create ........................................................................................................... 4034
Angle ........................................................................................................... 4035
Type ........................................................................................................... 4036
CChartObjectCycles
................................................................................................................ 4037
Create ........................................................................................................... 4038
Type ........................................................................................................... 4039
Channel.........................................................................................................................
Objects 4040
CChartObjectChannel
................................................................................................................ 4041
Create ........................................................................................................... 4043
Type ........................................................................................................... 4044
CChartObjectRegression
................................................................................................................ 4045
Create ........................................................................................................... 4047
Type ........................................................................................................... 4048
CChartObjectStdDevChannel
................................................................................................................ 4049
Create ........................................................................................................... 4051
Deviations ........................................................................................................... 4052
Save ........................................................................................................... 4053
Load ........................................................................................................... 4054
Type ........................................................................................................... 4055
CChartObjectPitchfork
................................................................................................................ 4056
Create ........................................................................................................... 4058
Type ........................................................................................................... 4059
Gann Tools
......................................................................................................................... 4060
CChartObject GannLine
................................................................................................................ 4061
Create ........................................................................................................... 4063
PipsPerBar........................................................................................................... 4064
Save ........................................................................................................... 4065
z
BarMinSi e................................................................................................................ 4397
BarBorder ................................................................................................................ 4398
Create ................................................................................................................ 4399
SeriesAdd ................................................................................................................ 4400
SeriesI nsert
................................................................................................................ 4401
SeriesUpdate
................................................................................................................ 4402
SeriesDelete
................................................................................................................ 4403
ValueUpdate
................................................................................................................ 4404
DrawData ................................................................................................................ 4405
DrawBar ................................................................................................................ 4406
GradientBrush
................................................................................................................ 4407
CLineChart
......................................................................................................................... 4408
Filled ................................................................................................................ 4412
Create ................................................................................................................ 4413
SeriesAdd ................................................................................................................ 4414
SeriesI nsert
................................................................................................................ 4415
SeriesUpdate
................................................................................................................ 4416
SeriesDelete
................................................................................................................ 4417
ValueUpdate
................................................................................................................ 4418
DrawChart................................................................................................................ 4419
DrawData ................................................................................................................ 4420
CalcArea ................................................................................................................ 4421
CPieChart
......................................................................................................................... 4422
Create ................................................................................................................ 4426
SeriesSet ................................................................................................................ 4427
ValueAdd ................................................................................................................ 4428
ValueI nsert................................................................................................................ 4429
ValueUpdate
................................................................................................................ 4430
ValueDelete
................................................................................................................ 4431
DrawChart................................................................................................................ 4432
DrawPie ................................................................................................................ 4433
LabelMake ................................................................................................................ 4434
............................................................................................................................4435
3D Graphics
CCanvas3D
......................................................................................................................... 4436
AmbientColor G
................................................................................................................
et 4438
AmbientColorSet
................................................................................................................ 4439
Attach ................................................................................................................ 4440
Create ................................................................................................................ 4441
Destroy ................................................................................................................ 4442
X
D Context................................................................................................................ 4443
D X Dispatcher
................................................................................................................ 4444
I nputScene................................................................................................................ 4445
etG
LightColor ................................................................................................................ 4446
LightColorSet
................................................................................................................ 4447
LightDirection G
................................................................................................................
et 4448
LightDirectionSet
................................................................................................................ 4449
ObjectAdd ................................................................................................................ 4450
ProjectionMatrix G
................................................................................................................
et 4451
ProjectionMatrixSet
................................................................................................................ 4452
Render ................................................................................................................ 4453
RenderBegin
................................................................................................................ 4454
RenderEnd ................................................................................................................ 4455
G
ViewMatrix................................................................................................................
et 4456
ViewMatrixSet
................................................................................................................ 4457
ViewPositionSet
................................................................................................................ 4458
ViewRotationSet
................................................................................................................ 4459
ViewTargetSet
................................................................................................................ 4460
ViewUpDirectionSet
................................................................................................................ 4461
............................................................................................................................4462
Price Charts
ChartI D......................................................................................................................... 4467
Mode ......................................................................................................................... 4468
Foreground
......................................................................................................................... 4469
Shift ......................................................................................................................... 4470
z
ShiftSi e
......................................................................................................................... 4471
AutoScroll
......................................................................................................................... 4472
Scale ......................................................................................................................... 4473
ScaleFix......................................................................................................................... 4474
11_
ScaleFix......................................................................................................................... 4475
FixedMax
......................................................................................................................... 4476
FixedMin
......................................................................................................................... 4477
PointsPerBar
......................................................................................................................... 4478
ScalePPB
......................................................................................................................... 4479
ShowOHLC
......................................................................................................................... 4480
ShowLineBid
......................................................................................................................... 4481
ShowLineAsk
......................................................................................................................... 4482
ShowLastLine
......................................................................................................................... 4483
ShowPeriodSep
......................................................................................................................... 4484
Show ridG
......................................................................................................................... 4485
ShowVolumes
......................................................................................................................... 4486
ShowObjectDescr
......................................................................................................................... 4487
ShowDateScale
......................................................................................................................... 4488
ShowPriceScale
......................................................................................................................... 4489
ColorBackground
......................................................................................................................... 4490
ColorForeground
......................................................................................................................... 4491
G
Color rid
......................................................................................................................... 4492
ColorBarUp
......................................................................................................................... 4493
ColorBarDown
......................................................................................................................... 4494
ColorCandleBull
......................................................................................................................... 4495
ColorCandleBear
......................................................................................................................... 4496
ColorChartLine
......................................................................................................................... 4497
ColorVolumes
......................................................................................................................... 4498
ColorLineBid
......................................................................................................................... 4499
ColorLineAsk
......................................................................................................................... 4500
ColorLineLast
......................................................................................................................... 4501
ColorStopLevels
......................................................................................................................... 4502
VisibleBars
......................................................................................................................... 4503
WindowsTotal
......................................................................................................................... 4504
WindowI
.........................................................................................................................
sVisible 4505
WindowHandle
......................................................................................................................... 4506
FirstVisibleBar
......................................................................................................................... 4507
WidthI nBars
......................................................................................................................... 4508
WidthI nPixels
......................................................................................................................... 4509
HeightI nPixels
......................................................................................................................... 4510
PriceMin
......................................................................................................................... 4511
PriceMax
......................................................................................................................... 4512
Attach ......................................................................................................................... 4513
FirstChart
......................................................................................................................... 4514
NextChart
......................................................................................................................... 4515
Open ......................................................................................................................... 4516
Detach ......................................................................................................................... 4517
Close ......................................................................................................................... 4518
BringToTop
......................................................................................................................... 4519
EventObjectCreate
......................................................................................................................... 4520
EventObjectDelete
......................................................................................................................... 4521
I ndicatorAdd
......................................................................................................................... 4522
I ndicatorDelete
......................................................................................................................... 4523
I ndicatorsTotal
......................................................................................................................... 4524
I ndicatorName
......................................................................................................................... 4525
Navigate
......................................................................................................................... 4526
Symbol ......................................................................................................................... 4527
Period ......................................................................................................................... 4528
Redraw......................................................................................................................... 4529
GetI nteger
......................................................................................................................... 4530
SetI nteger
......................................................................................................................... 4531
GetDouble
......................................................................................................................... 4532
SetDouble
......................................................................................................................... 4533
GetString
......................................................................................................................... 4534
SetString
......................................................................................................................... 4535
SetSymbolPeriod
......................................................................................................................... 4536
ApplyTemplate
......................................................................................................................... 4537
ScreenShot
......................................................................................................................... 4538
WindowOnDropped
......................................................................................................................... 4539
PriceOnDropped
......................................................................................................................... 4540
TimeOnDropped
......................................................................................................................... 4541
X OnDropped
......................................................................................................................... 4542
Y OnDropped
......................................................................................................................... 4543
Save ......................................................................................................................... 4544
Load ......................................................................................................................... 4545
Type ......................................................................................................................... 4546
Scientific ............................................................................................................................4547
Charts
GraphPlot
......................................................................................................................... 4548
CAxis ......................................................................................................................... 4552
AutoScale ................................................................................................................ 4554
Min ................................................................................................................ 4555
Max ................................................................................................................ 4556
Step ................................................................................................................ 4557
Name ................................................................................................................ 4558
Color ................................................................................................................ 4559
z
ValuesSi e ................................................................................................................ 4560
ValuesWidth
................................................................................................................ 4561
ValuesFormat
................................................................................................................ 4562
ValuesDateTimeMode
................................................................................................................ 4563
ValuesFunctionFormat
................................................................................................................ 4564
ValuesFunctionFormatCBData
................................................................................................................ 4566
z
NameSi e ................................................................................................................ 4567
ZeroLever ................................................................................................................ 4568
DefaultStep
................................................................................................................ 4569
MaxLabels ................................................................................................................ 4570
G
Min race ................................................................................................................ 4571
G
Max race ................................................................................................................ 4572
SelectAxisScale
................................................................................................................ 4573
G
CColor .........................................................................................................................
enerator 4574
Next ................................................................................................................ 4575
Reset ................................................................................................................ 4576
CCurve......................................................................................................................... 4577
Type ................................................................................................................ 4579
Name ................................................................................................................ 4580
Color ................................................................................................................ 4581
X Max ................................................................................................................ 4582
X Min ................................................................................................................ 4583
Y Max ................................................................................................................ 4584
Y Min ................................................................................................................ 4585
Siz e ................................................................................................................ 4586
z
PointsSi e ................................................................................................................ 4587
G
Font et ................................................................................................................ 4656
Attach ................................................................................................................ 4657
CalculateMaxMinValues
................................................................................................................ 4658
Height ................................................................................................................ 4659
I ndentDown
................................................................................................................ 4660
I ndentLeft ................................................................................................................ 4661
I ndentRight
................................................................................................................ 4662
I ndentUp ................................................................................................................ 4663
Redraw ................................................................................................................ 4664
ResetParameters
................................................................................................................ 4665
Scale X ................................................................................................................ 4666
Scale Y ................................................................................................................ 4667
SetDefaultParameters
................................................................................................................ 4668
Width ................................................................................................................ 4669
Indicators............................................................................................................................4670
Base classes
......................................................................................................................... 4671
CSpreadBuffer
................................................................................................................ 4672
z
Si e ........................................................................................................... 4674
SetSymbolPeriod
........................................................................................................... 4675
At ........................................................................................................... 4676
Refresh ........................................................................................................... 4677
RefreshCurrent
........................................................................................................... 4678
CTimeBuffer
................................................................................................................ 4679
z
Si e ........................................................................................................... 4681
SetSymbolPeriod
........................................................................................................... 4682
At ........................................................................................................... 4683
Refresh ........................................................................................................... 4684
RefreshCurrent
........................................................................................................... 4685
CTickVolumeBuffer
................................................................................................................ 4686
z
Si e ........................................................................................................... 4688
SetSymbolPeriod
........................................................................................................... 4689
At ........................................................................................................... 4690
Refresh ........................................................................................................... 4691
RefreshCurrent
........................................................................................................... 4692
CRealVolumeBuffer
................................................................................................................ 4693
z
Si e ........................................................................................................... 4695
SetSymbolPeriod
........................................................................................................... 4696
At ........................................................................................................... 4697
Refresh ........................................................................................................... 4698
RefreshCurrent
........................................................................................................... 4699
CDoubleBuffer
................................................................................................................ 4700
z
Si e ........................................................................................................... 4702
SetSymbolPeriod
........................................................................................................... 4703
At ........................................................................................................... 4704
Refresh ........................................................................................................... 4705
RefreshCurrent
........................................................................................................... 4706
COpenBuffer
................................................................................................................ 4707
Refresh ........................................................................................................... 4708
RefreshCurrent
........................................................................................................... 4709
CHighBuffer
................................................................................................................ 4710
Refresh ........................................................................................................... 4711
RefreshCurrent
........................................................................................................... 4712
CLowBuffer................................................................................................................ 4713
Refresh ........................................................................................................... 4714
RefreshCurrent
........................................................................................................... 4715
CCloseBuffer
................................................................................................................ 4716
Refresh ........................................................................................................... 4717
RefreshCurrent
........................................................................................................... 4718
CI ndicatorBuffer
................................................................................................................ 4719
Offset ........................................................................................................... 4721
Name ........................................................................................................... 4722
At ........................................................................................................... 4723
Refresh ........................................................................................................... 4724
RefreshCurrent
........................................................................................................... 4725
CSeries ................................................................................................................ 4726
Name ........................................................................................................... 4728
BuffersTotal
........................................................................................................... 4729
Timeframe ........................................................................................................... 4730
Symbol ........................................................................................................... 4731
Period ........................................................................................................... 4732
RefreshCurrent
........................................................................................................... 4733
z
BufferSi e ........................................................................................................... 4734
e z
BufferResi ........................................................................................................... 4735
Refresh ........................................................................................................... 4736
PeriodDescription
........................................................................................................... 4737
CPriceSeries
................................................................................................................ 4738
e z
BufferResi ........................................................................................................... 4740
GetData ........................................................................................................... 4741
Refresh ........................................................................................................... 4742
MinI ndex ........................................................................................................... 4743
MinValue ........................................................................................................... 4744
MaxI ndex ........................................................................................................... 4745
MaxValue ........................................................................................................... 4746
CI ndicator ................................................................................................................ 4747
Handle ........................................................................................................... 4749
Status ........................................................................................................... 4750
FullRelease........................................................................................................... 4751
Create ........................................................................................................... 4752
e z
BufferResi ........................................................................................................... 4753
BarsCalculated
........................................................................................................... 4754
GetData ........................................................................................................... 4755
Refresh ........................................................................................................... 4758
Minimum ........................................................................................................... 4759
MinValue ........................................................................................................... 4760
Maximum ........................................................................................................... 4761
MaxValue ........................................................................................................... 4762
MethodDescription
........................................................................................................... 4763
PriceDescription
........................................................................................................... 4764
VolumeDescription
........................................................................................................... 4765
AddToChart
........................................................................................................... 4766
DeleteFromChart
........................................................................................................... 4767
CI ndicators
................................................................................................................ 4768
Create ........................................................................................................... 4769
Refresh ........................................................................................................... 4770
Timeseries
.........................................................................................................................
classes 4771
CiSpread ................................................................................................................ 4772
Create ........................................................................................................... 4774
e z
BufferResi ........................................................................................................... 4775
GetData ........................................................................................................... 4776
Refresh ........................................................................................................... 4778
CiTime ................................................................................................................ 4779
Create ........................................................................................................... 4781
e z
BufferResi ........................................................................................................... 4782
GetData ........................................................................................................... 4783
Refresh ........................................................................................................... 4785
CiTickVolume
................................................................................................................ 4786
KijunSenPeriod
........................................................................................................... 4862
SenkouSpanBPeriod
........................................................................................................... 4863
Create ........................................................................................................... 4864
TenkanSen........................................................................................................... 4865
KijunSen ........................................................................................................... 4866
SenkouSpanA
........................................................................................................... 4867
SenkouSpanB
........................................................................................................... 4868
ChinkouSpan
........................................................................................................... 4869
Type ........................................................................................................... 4870
CiMA ................................................................................................................ 4871
MaPeriod ........................................................................................................... 4873
MaShift ........................................................................................................... 4874
MaMethod ........................................................................................................... 4875
Applied ........................................................................................................... 4876
Create ........................................................................................................... 4877
Main ........................................................................................................... 4878
Type ........................................................................................................... 4879
CiSAR ................................................................................................................ 4880
SarStep ........................................................................................................... 4882
Maximum ........................................................................................................... 4883
Create ........................................................................................................... 4884
Main ........................................................................................................... 4885
Type ........................................................................................................... 4886
CiStdDev ................................................................................................................ 4887
MaPeriod ........................................................................................................... 4889
MaShift ........................................................................................................... 4890
MaMethod ........................................................................................................... 4891
Applied ........................................................................................................... 4892
Create ........................................................................................................... 4893
Main ........................................................................................................... 4894
Type ........................................................................................................... 4895
CiDEMA ................................................................................................................ 4896
MaPeriod ........................................................................................................... 4898
I ndShift ........................................................................................................... 4899
Applied ........................................................................................................... 4900
Create ........................................................................................................... 4901
Main ........................................................................................................... 4902
Type ........................................................................................................... 4903
CiTEMA ................................................................................................................ 4904
MaPeriod ........................................................................................................... 4906
I ndShift ........................................................................................................... 4907
Applied ........................................................................................................... 4908
Create ........................................................................................................... 4909
Main ........................................................................................................... 4910
Type ........................................................................................................... 4911
CiFrAMA ................................................................................................................ 4912
MaPeriod ........................................................................................................... 4914
I ndShift ........................................................................................................... 4915
Applied ........................................................................................................... 4916
Create ........................................................................................................... 4917
Main ........................................................................................................... 4918
Type ........................................................................................................... 4919
CiAMA ................................................................................................................ 4920
MaPeriod ........................................................................................................... 4922
FastEmaPeriod
........................................................................................................... 4923
SlowEmaPeriod
........................................................................................................... 4924
I ndShift ........................................................................................................... 4925
Applied ........................................................................................................... 4926
z
Free eLevel
................................................................................................................ 5189
Bid ................................................................................................................ 5190
BidHigh ................................................................................................................ 5191
BidLow ................................................................................................................ 5192
Ask ................................................................................................................ 5193
AskHigh ................................................................................................................ 5194
AskLow ................................................................................................................ 5195
Last ................................................................................................................ 5196
LastHigh ................................................................................................................ 5197
LastLow ................................................................................................................ 5198
TradeCalcMode
................................................................................................................ 5199
TradeCalcModeDescription
................................................................................................................ 5200
TradeMode................................................................................................................ 5201
TradeModeDescription
................................................................................................................ 5202
TradeExecution
................................................................................................................ 5203
TradeExecutionDescription
................................................................................................................ 5204
SwapMode ................................................................................................................ 5205
SwapModeDescription
................................................................................................................ 5206
SwapRollover3days
................................................................................................................ 5207
SwapRollover3daysDescription
................................................................................................................ 5208
MarginI nitial
................................................................................................................ 5209
MarginMaintenance
................................................................................................................ 5210
MarginLong................................................................................................................ 5211
MarginShort
................................................................................................................ 5212
MarginLimit
................................................................................................................ 5213
MarginStop................................................................................................................ 5214
MarginStopLimit
................................................................................................................ 5215
TradeTimeFlags
................................................................................................................ 5216
TradeFillFlags
................................................................................................................ 5217
Digits ................................................................................................................ 5218
Point ................................................................................................................ 5219
TickValue ................................................................................................................ 5220
TickValueProfit
................................................................................................................ 5221
TickValueLoss
................................................................................................................ 5222
TickSi e z ................................................................................................................ 5223
e z
ContractSi................................................................................................................ 5224
LotsMin ................................................................................................................ 5225
LotsMax ................................................................................................................ 5226
LotsStep ................................................................................................................ 5227
LotsLimit ................................................................................................................ 5228
SwapLong ................................................................................................................ 5229
SwapShort ................................................................................................................ 5230
CurrencyBase
................................................................................................................ 5231
CurrencyProfit
................................................................................................................ 5232
CurrencyMargin
................................................................................................................ 5233
Bank ................................................................................................................ 5234
Description................................................................................................................ 5235
Path ................................................................................................................ 5236
SessionDeals
................................................................................................................ 5237
SessionBuyOrders
................................................................................................................ 5238
SessionSellOrders
................................................................................................................ 5239
SessionTurnover
................................................................................................................ 5240
SessionI nterest
................................................................................................................ 5241
SessionBuyOrdersVolume
................................................................................................................ 5242
SessionSellOrdersVolume
................................................................................................................ 5243
SessionOpen
................................................................................................................ 5244
SessionClose
................................................................................................................ 5245
SessionAW ................................................................................................................ 5246
SessionPriceSettlement
................................................................................................................ 5247
SessionPriceLimitMin
................................................................................................................ 5248
SessionPriceLimitMax
................................................................................................................ 5249
I nfoI nteger................................................................................................................ 5250
I nfoDouble ................................................................................................................ 5251
I nfoString ................................................................................................................ 5252
z
Normali ePrice
................................................................................................................ 5253
COrderI.........................................................................................................................
nfo 5254
Ticket ................................................................................................................ 5256
TimeSetup ................................................................................................................ 5257
TimeSetupMsc
................................................................................................................ 5258
OrderType................................................................................................................ 5259
TypeDescription
................................................................................................................ 5260
State ................................................................................................................ 5261
StateDescription
................................................................................................................ 5262
TimeExpiration
................................................................................................................ 5263
TimeDone ................................................................................................................ 5264
TimeDoneMsc
................................................................................................................ 5265
TypeFilling ................................................................................................................ 5266
TypeFillingDescription
................................................................................................................ 5267
TypeTime ................................................................................................................ 5268
TypeTimeDescription
................................................................................................................ 5269
Magic ................................................................................................................ 5270
PositionI d ................................................................................................................ 5271
VolumeI nitial
................................................................................................................ 5272
VolumeCurrent
................................................................................................................ 5273
PriceOpen ................................................................................................................ 5274
StopLoss ................................................................................................................ 5275
TakeProfit ................................................................................................................ 5276
PriceCurrent
................................................................................................................ 5277
PriceStopLimit
................................................................................................................ 5278
Symbol ................................................................................................................ 5279
Comment ................................................................................................................ 5280
I nfoI nteger................................................................................................................ 5281
I nfoDouble ................................................................................................................ 5282
I nfoString ................................................................................................................ 5283
StoreState................................................................................................................ 5284
CheckState................................................................................................................ 5285
Select ................................................................................................................ 5286
SelectByI ndex
................................................................................................................ 5287
CHistoryOrderI
.........................................................................................................................
nfo 5288
TimeSetup ................................................................................................................ 5290
TimeSetupMsc
................................................................................................................ 5291
OrderType................................................................................................................ 5292
TypeDescription
................................................................................................................ 5293
State ................................................................................................................ 5294
StateDescription
................................................................................................................ 5295
TimeExpiration
................................................................................................................ 5296
TimeDone ................................................................................................................ 5297
TimeDoneMsc
................................................................................................................ 5298
TypeFilling ................................................................................................................ 5299
TypeFillingDescription
................................................................................................................ 5300
TypeTime ................................................................................................................ 5301
TypeTimeDescription
................................................................................................................ 5302
Magic ................................................................................................................ 5303
PositionI d ................................................................................................................ 5304
VolumeI nitial
................................................................................................................ 5305
VolumeCurrent
................................................................................................................ 5306
CheckResult
................................................................................................................ 5430
CheckResultRetcode
................................................................................................................ 5431
CheckResultRetcodeDescription
................................................................................................................ 5432
CheckResultBalance
................................................................................................................ 5433
CheckResultE q
................................................................................................................
uity 5434
CheckResultProfit
................................................................................................................ 5435
CheckResultMargin
................................................................................................................ 5436
CheckResultMarginFree
................................................................................................................ 5437
CheckResultMarginLevel
................................................................................................................ 5438
CheckResultComment
................................................................................................................ 5439
q
PrintRe uest
................................................................................................................ 5440
PrintResult................................................................................................................ 5441
FormatRe uest q
................................................................................................................ 5442
q
FormatRe uestResult
................................................................................................................ 5443
CTerminalI
.........................................................................................................................
nfo 5444
Build ................................................................................................................ 5446
I sConnected
................................................................................................................ 5447
I sDLLsAllowed
................................................................................................................ 5448
I sTradeAllowed
................................................................................................................ 5449
I sEmailEnabled
................................................................................................................ 5450
I sFtpEnabled
................................................................................................................ 5451
MaxBars ................................................................................................................ 5452
CodePage ................................................................................................................ 5453
CPUCores ................................................................................................................ 5454
MemoryPhysical
................................................................................................................ 5455
MemoryTotal
................................................................................................................ 5456
MemoryAvailable
................................................................................................................ 5457
MemoryUsed
................................................................................................................ 5458
X
I s 64 ................................................................................................................ 5459
OpenCLSupport
................................................................................................................ 5460
DiskSpace ................................................................................................................ 5461
Language ................................................................................................................ 5462
Name ................................................................................................................ 5463
Company ................................................................................................................ 5464
Path ................................................................................................................ 5465
DataPath ................................................................................................................ 5466
CommonDataPath
................................................................................................................ 5467
I nfoI nteger................................................................................................................ 5468
I nfoString ................................................................................................................ 5469
............................................................................................................................5470
Strategy Modules
Base classes
.........................................................................................................................
for Expert Advisors 5473
CExpertBase
................................................................................................................ 5474
I nitPhase ........................................................................................................... 5476
TrendType........................................................................................................... 5477
UsedSeries........................................................................................................... 5478
EveryTick ........................................................................................................... 5479
Open ........................................................................................................... 5480
High ........................................................................................................... 5481
Low ........................................................................................................... 5482
Close ........................................................................................................... 5483
Spread ........................................................................................................... 5484
Time ........................................................................................................... 5485
TickVolume........................................................................................................... 5486
RealVolume........................................................................................................... 5487
I nit ........................................................................................................... 5488
Symbol ........................................................................................................... 5489
Period ........................................................................................................... 5490
Magic ........................................................................................................... 5491
ValidationSettings
........................................................................................................... 5492
SetPriceSeries
........................................................................................................... 5493
SetOtherSeries
........................................................................................................... 5494
I nitI ndicators
........................................................................................................... 5495
I nitOpen ........................................................................................................... 5496
I nitHigh ........................................................................................................... 5497
I nitLow ........................................................................................................... 5498
I nitClose ........................................................................................................... 5499
I nitSpread ........................................................................................................... 5500
I nitTime ........................................................................................................... 5501
I nitTickVolume
........................................................................................................... 5502
I nitRealVolume
........................................................................................................... 5503
PriceLevelUnit
........................................................................................................... 5504
StartI ndex........................................................................................................... 5505
CompareMagic
........................................................................................................... 5506
CExpert ................................................................................................................ 5507
I nit ........................................................................................................... 5512
Magic ........................................................................................................... 5513
I nitSignal ........................................................................................................... 5514
I nitTrailing........................................................................................................... 5515
I nitMoney ........................................................................................................... 5516
I nitTrade ........................................................................................................... 5517
Deinit ........................................................................................................... 5518
OnTickProcess
........................................................................................................... 5519
OnTradeProcess
........................................................................................................... 5520
OnTimerProcess
........................................................................................................... 5521
OnChartEventProcess
........................................................................................................... 5522
OnBookEventProcess
........................................................................................................... 5523
MaxOrders........................................................................................................... 5524
Signal ........................................................................................................... 5525
ValidationSettings
........................................................................................................... 5526
I nitI ndicators
........................................................................................................... 5527
OnTick ........................................................................................................... 5528
OnTrade ........................................................................................................... 5529
OnTimer ........................................................................................................... 5530
OnChartEvent
........................................................................................................... 5531
OnBookEvent
........................................................................................................... 5532
I nitParameters
........................................................................................................... 5533
DeinitTrade
........................................................................................................... 5534
DeinitSignal
........................................................................................................... 5535
DeinitTrailing
........................................................................................................... 5536
DeinitMoney
........................................................................................................... 5537
DeinitI ndicators
........................................................................................................... 5538
Refresh ........................................................................................................... 5539
Processing........................................................................................................... 5540
SelectPosition
........................................................................................................... 5542
CheckOpen........................................................................................................... 5543
CheckOpenLong
........................................................................................................... 5544
CheckOpenShort
........................................................................................................... 5545
OpenLong ........................................................................................................... 5546
OpenShort ........................................................................................................... 5547
CheckReverse
........................................................................................................... 5548
CheckReverseLong
........................................................................................................... 5549
CheckReverseShort
........................................................................................................... 5550
ReverseLong
........................................................................................................... 5551
ReverseShort
........................................................................................................... 5553
CheckClose........................................................................................................... 5555
CheckCloseLong
........................................................................................................... 5556
CheckCloseShort
........................................................................................................... 5557
CloseAll ........................................................................................................... 5558
Close ........................................................................................................... 5559
CloseLong ........................................................................................................... 5560
CloseShort ........................................................................................................... 5561
CheckTrailingStop
........................................................................................................... 5562
CheckTrailingStopLong
........................................................................................................... 5563
CheckTrailingStopShort
........................................................................................................... 5564
TrailingStopLong
........................................................................................................... 5565
TrailingStopShort
........................................................................................................... 5566
CheckTrailingOrderLong
........................................................................................................... 5567
CheckTrailingOrderShort
........................................................................................................... 5568
TrailingOrderLong
........................................................................................................... 5569
TrailingOrderShort
........................................................................................................... 5570
CheckDeleteOrderLong
........................................................................................................... 5571
CheckDeleteOrderShort
........................................................................................................... 5572
DeleteOrders
........................................................................................................... 5573
DeleteOrder
........................................................................................................... 5574
DeleteOrderLong
........................................................................................................... 5575
DeleteOrderShort
........................................................................................................... 5576
LotOpenLong
........................................................................................................... 5577
LotOpenShort
........................................................................................................... 5578
LotReverse........................................................................................................... 5579
PrepareHistoryDate
........................................................................................................... 5580
HistoryPoint
........................................................................................................... 5581
CheckTradeState
........................................................................................................... 5582
WaitEvent ........................................................................................................... 5583
NoWaitEvent
........................................................................................................... 5584
TradeEventPositionStopTake
........................................................................................................... 5585
TradeEventOrderTriggered
........................................................................................................... 5586
TradeEventPositionOpened
........................................................................................................... 5587
TradeEventPositionVolumeChanged
........................................................................................................... 5588
TradeEventPositionModified
........................................................................................................... 5589
TradeEventPositionClosed
........................................................................................................... 5590
TradeEventOrderPlaced
........................................................................................................... 5591
TradeEventOrderModified
........................................................................................................... 5592
TradeEventOrderDeleted
........................................................................................................... 5593
TradeEventNotI
...........................................................................................................
dentified 5594
TimeframeAdd
........................................................................................................... 5595
TimeframesFlags
........................................................................................................... 5596
CExpertSignal
................................................................................................................ 5597
BasePrice ........................................................................................................... 5600
UsedSeries........................................................................................................... 5601
Weight ........................................................................................................... 5602
PatternsUsage
........................................................................................................... 5603
General ........................................................................................................... 5604
I gnore ........................................................................................................... 5605
I nvert ........................................................................................................... 5606
ThresholdOpen
........................................................................................................... 5607
ThresholdClose
........................................................................................................... 5608
PriceLevel........................................................................................................... 5609
StopLevel ........................................................................................................... 5610
TakeLevel ........................................................................................................... 5611
Expiration ........................................................................................................... 5612
Magic ........................................................................................................... 5613
ValidationSettings
........................................................................................................... 5614
I nitI ndicators
........................................................................................................... 5615
AddFilter ........................................................................................................... 5616
CheckOpenLong
........................................................................................................... 5617
CheckOpenShort
........................................................................................................... 5618
OpenLongParams
........................................................................................................... 5619
OpenShortParams
........................................................................................................... 5620
CheckCloseLong
........................................................................................................... 5621
CheckCloseShort
........................................................................................................... 5622
CloseLongParams
........................................................................................................... 5623
CloseShortParams
........................................................................................................... 5624
CheckReverseLong
........................................................................................................... 5625
CheckReverseShort
........................................................................................................... 5626
CheckTrailingOrderLong
........................................................................................................... 5627
CheckTrailingOrderShort
........................................................................................................... 5628
LongCondition
........................................................................................................... 5629
ShortCondition
........................................................................................................... 5630
Direction ........................................................................................................... 5631
CExpertTrailing
................................................................................................................ 5632
CheckTrailingStopLong
........................................................................................................... 5634
CheckTrailingStopShort
........................................................................................................... 5635
CExpertMoney
................................................................................................................ 5636
Percent ........................................................................................................... 5637
ValidationSettings
........................................................................................................... 5638
CheckOpenLong
........................................................................................................... 5639
CheckOpenShort
........................................................................................................... 5640
CheckReverse
........................................................................................................... 5641
CheckClose........................................................................................................... 5642
Modules.........................................................................................................................
of Trade Signals 5643
Signals of the
................................................................................................................
I ndicator Accelerator Oscillator 5646
Signals of the
................................................................................................................
I ndicator Adaptive Moving Average 5649
Signals of the
................................................................................................................
I ndicator Awesome Oscillator 5653
Signals of the
................................................................................................................
Oscillator Bears Power 5657
Signals of the
................................................................................................................
Oscillator Bulls Power 5659
Signals of the
................................................................................................................
Oscillator Commodity Channel I ndex 5661
Signals of the
................................................................................................................
Oscillator DeMarker 5665
Signals of the
................................................................................................................
I ndicator Double Exponential Moving Average 5669
Signals of the
................................................................................................................
I ndicator Envelopes 5673
Signals of the
................................................................................................................
I ndicator Fractal Adaptive Moving Average 5676
Signals of the
................................................................................................................
I ntraday Time Filter 5680
Signals of the
................................................................................................................
Oscillator MACD 5682
Signals of the
................................................................................................................
I ndicator Moving Average 5688
Signals of the
................................................................................................................
I ndicator Parabolic SAR 5692
Signals of the
................................................................................................................
Oscillator Relative Strength I ndex 5694
Signals of the
................................................................................................................
Oscillator Relative Vigor I ndex 5700
Signals of the
................................................................................................................
Oscillator Stochastic 5702
Signals of the
................................................................................................................
Oscillator Triple Exponential Average 5707
Signals of the
................................................................................................................
I ndicator Triple Exponential Moving Average 5711
Signals of the
................................................................................................................
Oscillator Williams Percent Range 5715
Trailing .........................................................................................................................
Stop Classes 5718
CTrailingFixedPips
................................................................................................................ 5719
StopLevel ........................................................................................................... 5721
ProfitLevel........................................................................................................... 5722
ValidationSettings
........................................................................................................... 5723
CheckTrailingStopLong
........................................................................................................... 5724
CheckTrailingStopShort
........................................................................................................... 5725
CTrailingMA
................................................................................................................ 5726
Period ........................................................................................................... 5728
Shift ........................................................................................................... 5729
Method ........................................................................................................... 5730
Applied ........................................................................................................... 5731
I nitI ndicators
........................................................................................................... 5732
ValidationSettings
........................................................................................................... 5733
CheckTrailingStopLong
........................................................................................................... 5734
CheckTrailingStopShort
........................................................................................................... 5735
CTrailingNone
................................................................................................................ 5736
CheckTrailingStopLong
........................................................................................................... 5737
CheckTrailingStopShort
........................................................................................................... 5738
CTrailingPSAR
................................................................................................................ 5739
Step ........................................................................................................... 5741
Maximum ........................................................................................................... 5742
I nitI ndicators
........................................................................................................... 5743
CheckTrailingStopLong
........................................................................................................... 5744
CheckTrailingStopShort
........................................................................................................... 5745
Money Management
.........................................................................................................................
Classes 5746
CMoneyFixedLot
................................................................................................................ 5747
Lots ........................................................................................................... 5749
ValidationSettings
........................................................................................................... 5750
CheckOpenLong
........................................................................................................... 5751
CheckOpenShort
........................................................................................................... 5752
CMoneyFixedMargin
................................................................................................................ 5753
CheckOpenLong
........................................................................................................... 5754
CheckOpenShort
........................................................................................................... 5755
CMoneyFixedRisk
................................................................................................................ 5756
CheckOpenLong
........................................................................................................... 5757
CheckOpenShort
........................................................................................................... 5758
CMoneyNone
................................................................................................................ 5759
ValidationSettings
........................................................................................................... 5760
CheckOpenLong
........................................................................................................... 5761
CheckOpenShort
........................................................................................................... 5762
z
CMoneySi eOptimi z
................................................................................................................
ed 5763
DecreaseFactor
........................................................................................................... 5765
ValidationSettings
........................................................................................................... 5766
CheckOpenLong
........................................................................................................... 5767
CheckOpenShort
........................................................................................................... 5768
Panels and............................................................................................................................5769
Dialogs
CRect ......................................................................................................................... 5771
Left ................................................................................................................ 5772
Top ................................................................................................................ 5773
Right ................................................................................................................ 5774
Bottom ................................................................................................................ 5775
Width ................................................................................................................ 5776
Height ................................................................................................................ 5777
SetBound ................................................................................................................ 5778
Move ................................................................................................................ 5779
Shift ................................................................................................................ 5780
Contains ................................................................................................................ 5781
Format ................................................................................................................ 5782
CDateTime
......................................................................................................................... 5783
MonthName................................................................................................................ 5785
ShortMonthName
................................................................................................................ 5786
DayName ................................................................................................................ 5787
ShortDayName
................................................................................................................ 5788
DaysI nMonth
................................................................................................................ 5789
DateTime ................................................................................................................ 5790
Date ................................................................................................................ 5791
Time ................................................................................................................ 5792
Sec ................................................................................................................ 5793
Min ................................................................................................................ 5794
MouseFocusKill
................................................................................................................ 5856
OnCreate ................................................................................................................ 5857
OnDestroy ................................................................................................................ 5858
OnMove ................................................................................................................ 5859
z
OnResi e ................................................................................................................ 5860
OnEnable ................................................................................................................ 5861
OnDisable ................................................................................................................ 5862
OnShow ................................................................................................................ 5863
OnHide ................................................................................................................ 5864
OnActivate................................................................................................................ 5865
OnDeactivate
................................................................................................................ 5866
OnClick ................................................................................................................ 5867
OnChange ................................................................................................................ 5868
OnMouseDown
................................................................................................................ 5869
OnMouseUp
................................................................................................................ 5870
OnDragStart
................................................................................................................ 5871
OnDragProcess
................................................................................................................ 5872
OnDragEnd................................................................................................................ 5873
DragObjectCreate
................................................................................................................ 5874
DragObjectDestroy
................................................................................................................ 5875
CWndObj
......................................................................................................................... 5876
OnEvent ................................................................................................................ 5878
Text ................................................................................................................ 5879
Color ................................................................................................................ 5880
ColorBackground
................................................................................................................ 5881
ColorBorder
................................................................................................................ 5882
Font ................................................................................................................ 5883
FontSi ez ................................................................................................................ 5884
ZOrder ................................................................................................................ 5885
OnObjectCreate
................................................................................................................ 5886
OnObjectChange
................................................................................................................ 5887
OnObjectDelete
................................................................................................................ 5888
OnObjectDrag
................................................................................................................ 5889
OnSetText ................................................................................................................ 5890
OnSetColor................................................................................................................ 5891
OnSetColorBackground
................................................................................................................ 5892
OnSetFont ................................................................................................................ 5893
OnSetFontSi z
................................................................................................................
e 5894
Z
OnSet Order
................................................................................................................ 5895
OnDestroy ................................................................................................................ 5896
OnChange ................................................................................................................ 5897
CWndContainer
......................................................................................................................... 5898
Destroy ................................................................................................................ 5900
OnEvent ................................................................................................................ 5901
OnMouseEvent
................................................................................................................ 5902
ControlsTotal
................................................................................................................ 5903
Control ................................................................................................................ 5904
ControlFind
................................................................................................................ 5905
Add ................................................................................................................ 5906
Delete ................................................................................................................ 5907
Move ................................................................................................................ 5908
Shift ................................................................................................................ 5909
Id ................................................................................................................ 5910
Enable ................................................................................................................ 5911
Disable ................................................................................................................ 5912
Show ................................................................................................................ 5913
Hide ................................................................................................................ 5914
MouseFocusKill
................................................................................................................ 5915
OnSetColor................................................................................................................ 5994
OnSetColorBackground
................................................................................................................ 5995
OnSetColorBorder
................................................................................................................ 5996
OnSetFont ................................................................................................................ 5997
OnSetFontSi z
................................................................................................................
e 5998
Z
OnSet Order
................................................................................................................ 5999
OnCreate ................................................................................................................ 6000
OnShow ................................................................................................................ 6001
OnHide ................................................................................................................ 6002
OnMove ................................................................................................................ 6003
z
OnResi e ................................................................................................................ 6004
OnChange ................................................................................................................ 6005
OnClick ................................................................................................................ 6006
CPanel ......................................................................................................................... 6007
Create ................................................................................................................ 6012
BorderType................................................................................................................ 6013
OnSetText ................................................................................................................ 6014
OnSetColorBackground
................................................................................................................ 6015
OnSetColorBorder
................................................................................................................ 6016
OnCreate ................................................................................................................ 6017
OnShow ................................................................................................................ 6018
OnHide ................................................................................................................ 6019
OnMove ................................................................................................................ 6020
z
OnResi e ................................................................................................................ 6021
OnChange ................................................................................................................ 6022
CPicture
......................................................................................................................... 6023
Create ................................................................................................................ 6028
Border ................................................................................................................ 6029
BmpName ................................................................................................................ 6030
OnCreate ................................................................................................................ 6031
OnShow ................................................................................................................ 6032
OnHide ................................................................................................................ 6033
OnMove ................................................................................................................ 6034
OnChange ................................................................................................................ 6035
CScroll ......................................................................................................................... 6036
Create ................................................................................................................ 6038
OnEvent ................................................................................................................ 6039
MinPos ................................................................................................................ 6040
MaxPos ................................................................................................................ 6041
CurrPos ................................................................................................................ 6042
CreateBack
................................................................................................................ 6043
CreateI nc ................................................................................................................ 6044
CreateDec ................................................................................................................ 6045
CreateThumb
................................................................................................................ 6046
OnClickI nc ................................................................................................................ 6047
OnClickDec................................................................................................................ 6048
OnShow ................................................................................................................ 6049
OnHide ................................................................................................................ 6050
OnChangePos
................................................................................................................ 6051
OnThumbDragStart
................................................................................................................ 6052
OnThumbDragProcess
................................................................................................................ 6053
OnThumbDragEnd
................................................................................................................ 6054
CalcPos ................................................................................................................ 6055
CScrollV......................................................................................................................... 6056
CreateI nc ................................................................................................................ 6062
CreateDec ................................................................................................................ 6063
CreateThumb
................................................................................................................ 6064
z
OnResi e ................................................................................................................ 6065
OnChangePos
................................................................................................................ 6066
OnThumbDragStart
................................................................................................................ 6067
OnThumbDragProcess
................................................................................................................ 6068
OnThumbDragEnd
................................................................................................................ 6069
CalcPos ................................................................................................................ 6070
CScrollH......................................................................................................................... 6071
CreateI nc ................................................................................................................ 6077
CreateDec ................................................................................................................ 6078
CreateThumb
................................................................................................................ 6079
z
OnResi e ................................................................................................................ 6080
OnChangePos
................................................................................................................ 6081
OnThumbDragStart
................................................................................................................ 6082
OnThumbDragProcess
................................................................................................................ 6083
OnThumbDragEnd
................................................................................................................ 6084
CalcPos ................................................................................................................ 6085
CWndClient
......................................................................................................................... 6086
Create ................................................................................................................ 6089
OnEvent ................................................................................................................ 6090
ColorBackground
................................................................................................................ 6091
ColorBorder
................................................................................................................ 6092
BorderType................................................................................................................ 6093
VScrolled ................................................................................................................ 6094
HScrolled ................................................................................................................ 6095
CreateBack
................................................................................................................ 6096
CreateScrollV
................................................................................................................ 6097
CreateScrollH
................................................................................................................ 6098
z
OnResi e ................................................................................................................ 6099
OnVScrollShow
................................................................................................................ 6100
OnVScrollHide
................................................................................................................ 6101
OnHScrollShow
................................................................................................................ 6102
OnHScrollHide
................................................................................................................ 6103
OnScrollLineDown
................................................................................................................ 6104
OnScrollLineUp
................................................................................................................ 6105
OnScrollLineLeft
................................................................................................................ 6106
OnScrollLineRight
................................................................................................................ 6107
Rebound ................................................................................................................ 6108
CListView
......................................................................................................................... 6109
Create ................................................................................................................ 6115
OnEvent ................................................................................................................ 6116
TotalView ................................................................................................................ 6117
AddI tem ................................................................................................................ 6118
Select ................................................................................................................ 6119
SelectByText
................................................................................................................ 6120
SelectByValue
................................................................................................................ 6121
Value ................................................................................................................ 6122
CreateRow................................................................................................................ 6123
z
OnResi e ................................................................................................................ 6124
OnVScrollShow
................................................................................................................ 6125
OnVScrollHide
................................................................................................................ 6126
OnScrollLineDown
................................................................................................................ 6127
OnScrollLineUp
................................................................................................................ 6128
OnI temClick
................................................................................................................ 6129
Redraw ................................................................................................................ 6130
RowState ................................................................................................................ 6131
CheckView................................................................................................................ 6132
CComboBox
......................................................................................................................... 6133
Create ................................................................................................................ 6139
OnEvent ................................................................................................................ 6140
OnChangeI................................................................................................................
tem 6215
Redraw ................................................................................................................ 6216
RowState ................................................................................................................ 6217
Select ................................................................................................................ 6218
CSpinEdit
......................................................................................................................... 6219
Create ................................................................................................................ 6224
OnEvent ................................................................................................................ 6225
MinValue ................................................................................................................ 6226
MaxValue ................................................................................................................ 6227
Value ................................................................................................................ 6228
CreateEdit................................................................................................................ 6229
CreateI nc ................................................................................................................ 6230
CreateDec ................................................................................................................ 6231
OnClickI nc ................................................................................................................ 6232
OnClickDec................................................................................................................ 6233
OnChangeValue
................................................................................................................ 6234
CDialog ......................................................................................................................... 6235
Create ................................................................................................................ 6237
OnEvent ................................................................................................................ 6238
Caption ................................................................................................................ 6239
Add ................................................................................................................ 6240
CreateWhiteBorder
................................................................................................................ 6241
CreateBackground
................................................................................................................ 6242
CreateCaption
................................................................................................................ 6243
CreateButtonClose
................................................................................................................ 6244
CreateClientArea
................................................................................................................ 6245
OnClickCaption
................................................................................................................ 6246
OnClickButtonClose
................................................................................................................ 6247
ClientAreaVisible
................................................................................................................ 6248
ClientAreaLeft
................................................................................................................ 6249
ClientAreaTop
................................................................................................................ 6250
ClientAreaRight
................................................................................................................ 6251
ClientAreaBottom
................................................................................................................ 6252
ClientAreaWidth
................................................................................................................ 6253
ClientAreaHeight
................................................................................................................ 6254
OnDialogDragStart
................................................................................................................ 6255
OnDialogDragProcess
................................................................................................................ 6256
OnDialogDragEnd
................................................................................................................ 6257
CAppDialog
......................................................................................................................... 6258
Create ................................................................................................................ 6261
Destroy ................................................................................................................ 6262
OnEvent ................................................................................................................ 6263
Run ................................................................................................................ 6264
ChartEvent................................................................................................................ 6265
z
Minimi ed ................................................................................................................ 6266
I niFileSave ................................................................................................................ 6267
I niFileLoad................................................................................................................ 6268
I niFileName................................................................................................................ 6269
I niFileExt ................................................................................................................ 6270
CreateCommon
................................................................................................................ 6271
CreateExpert
................................................................................................................ 6272
CreateI ndicator
................................................................................................................ 6273
CreateButtonMinMax
................................................................................................................ 6274
OnClickButtonClose
................................................................................................................ 6275
OnClickButtonMinMax
................................................................................................................ 6276
OnAnotherApplicationClose
................................................................................................................ 6277
Rebound ................................................................................................................ 6278
Minimi e z ................................................................................................................ 6279
z
Maximi e ................................................................................................................ 6280
CreateI nstanceI
................................................................................................................
d 6281
ProgramName
................................................................................................................ 6282
SubwinOff ................................................................................................................ 6283
MQL5 Reference
MetaQuotes Language 5 (MQL5) is a high-level language designed for developing technical indicators,
trading robots and utility applications, which automate financial trading. MQL5 has been developed by
MetaQuotes for their trading platform. The language syntax is very close to C++ enabling programmers
to develop applications in the object-oriented programming (OOP) style.
In addition to the MQL5 language, the trading platform package also includes the MetaEditor IDE with
highly advanced code writing tools, such as templates, snippets, debugging, profiling and auto
completion tools, as well as built-in MQL5 S torage enabling file versioning.
The language support is available on the MQL5.community website, which contains a huge free
CodeBase and a plethora of articles. These articles cover all the aspects of the modern trading,
including neural networks, statistics and analysis, high-frequency trading, arbitrage, testing and
optimization of trading strategies, use of trading automation robots, and more.
Traders and MQL5 program developers can communicate on the forum, order and develop applications
using the Freelance service, as well as buy and sell protected programs in the Market of automated
trading applications.
The MQL5 language provides specialized trading functions and predefined event handlers to help
programmers develop Expert Advisors (EAs), which automatically control trading processes following
specific trading rules. In addition to EAs, MQL5 allows developing custom technical indicators, scripts
and libraries.
This MQL5 language reference contains functions, operations, reserved words and other language
constructions divided into categories. The reference also provides descriptions of S tandard Library
classes used for developing trading strategies, control panels, custom graphics and enabling file
access.
Additionally, the CodeBase contains the ALGLIB numerical analysis library, which can be used for
solving various mathematical problems.
· Script is a program for a single execution of an action. Unlike Expert Advisors, scripts do not handle
any event except for trigger. A script code must contain the OnS tart handler function.
S cripts are stored in <Terminal_DIrectory>\MQL5\Scripts.
· Service is a program that, unlik e indicators, Expert Advisors and scripts, does not require to be
bound to a chart to work. Like scripts, services do not handle any event except for trigger. To
launch a service, its code should contain the OnS tart handler function. S ervices do not accept any
other events except S tart, but they are able to send custom events to charts using
EventChartCustom. S ervices are stored in <terminal_directory>\MQL5\S ervices.
· Library is a set of custom functions. Libraries are intended to store and distribute commonly used
algorithms of custom programs.
Libraries are stored in <Terminal_Directory>\MQL5\Libraries .
· Include File is a source text of the most frequently used block s of custom programs. S uch files can
be included into the source texts of Expert Advisors, scripts, custom indicators, and libraries at the
compiling stage. The use of included files is more preferable than the use of libraries because of
additional burden occurring at calling library functions.
Include files can be stored in the same directory where the original file is located. In this case the
#include directive with double quotes is used. Another option is to store include files in
<Terminal_Directory>\MQL5\Include. In this case #include with angle brack ets should be used.
Language Basics
The MetaQuotes Language 5 (MQL5) is an object-oriented high-level programming language intended
for writing automated trading strategies, custom technical indicators for the analysis of various
financial markets. It allows not only to write a variety of expert systems, designed to operate in real
time, but also create their own graphical tools to help you make trade decisions.
MQL5 is based on the concept of the popular programming language C++. As compared to MQL4, the
new language now has enumerations, structures, classes and event handling. By increasing the number
of embedded main types, the interaction of executable programs in MQL5 with other applications
through dll is now as easy as possible. MQL5 syntax is similar to the syntax of C++, and this makes it
easy to translate into it programs from modern programming languages.
To help you study the MQL5 language, all topics are grouped into the following sections :
· S yntax
· Data Types
· Operations and Expressions
· Operators
· Functions
· Variables
· Preprocessor
· Object-Oriented Programming
· Namespaces
Syntax
Asto the syntax, THE MQL5 language for programming trading strategies is very much similar to the
C++ programming language, except for some features :
· no address arithmetic;
· no goto operator;
· an anonymous enumeration can't be declared;
· no multiple inheritance.
See also
Enumerations, S tructures and Classes, Inheritance
Comments
Multi-line comments start with the /* pair of symbols and end with the */ one. S uch kind of comments
cannot be nested. S ingle-line comments begin with the // pair of symbols and end with the newline
character, they can be nested in other multi-line comments. Comments are allowed everywhere where
the spaces are allowed, they can have any number of spaces in them.
Examples:
Identifiers
Identifiers are used as names of variables and functions. The length of the identifier can not exceed
63 characters.
Characters allowed to be written in an identifier: figures 0-9, the Latin uppercase and lowercase
letters a-z and A-Z, recognized as different characters, the underscore character (_).The first
character can not be a digit.
The identifier must not coincide with reserved word.
Examples:
See also
Variables, Functions
Reserved Words
The following identifiers are recorded as reserved words, each of them corresponds to a certain
action, and cannot be used in another meaning:
Data Types
Access Specificators
Memory Classes
Operators
Other
Data Types
Any program operates with data. Data can be of different types depending on their purposes. For
example, integer data are used to access to array components. Price data belong to those of double
precision with floating point. This is related to the fact that no special data type for price data is
provided in MQL5.
Data of different types are processed with different rates. Integer data are processed at the fastest.
To process the double precision data, a special co-processor is used. However, because of complexity
of internal representation of data with floating point, they are processed slower than the integer ones.
S tring data are processed at the longest because of dynamic computer memory allocation/reallocation.
The basic data types are:
· integers (char, short, int, long, uchar, ushort, uint, ulong);
· logical (bool);
· literals (ushort);
· strings (string);
· floating-point numbers (double, float);
· color (color);
· date and time (datetime);
· enumerations (enum).
Complex data types are:
· structures ;
· classes.
In terms of OOP complex data types are called abstract data types.
The color and datetime types make sense only to facilitate visualization and input of parameters
defined from outside - from the table of Expert Advisor or custom indicator properties (the Inputs
tab). Data of color and datetime types are represented as integers. Integer types and floating-point
types are called arithmetic (numeric) types.
Only implicit type casting is used in expressions, unless the explicit casting is specified.
See also
Typecasting
Integer Types
In MQL5 integers are represented by eleven types. S ome types can be used together with other ones,
if required by the program logic, but in this case it's necessary to remember the rules of typecasting.
The table below lists the characteristics of each type. Besides, the last column features a type in C++
corresponding to each type.
Integer type values can also be presented as numeric constants, color literals, date-time literals,
character constants and enumerations.
See also
Conversion Functions, Numerical Type Constants
uchar
The uchar integer type also occupies 1 byte of memory, as well as the char type, but unlike it uchar is
intended only for positive values. The minimum value is zero, the maximum value is 255. The first
letter u in the name of the uchar type is the abbreviation for unsigned.
short
The size of the short type is 2 bytes (16 bits) and, accordingly, it allows expressing the range of values
equal to 2 to the power 16: 2^16 = 65 536.S ince the short type is a signed one, and contains both
positive and negative values, the range of values is between -32 768 and 32 767.
ushort
The unsigned short type is the type ushort, which also has a size of 2 bytes. The minimum value is 0,
the maximum value is 65 535.
int
The size of the int type is 4 bytes (32 bits). The minimal value is -2 147 483 648, the maximal one is 2
147 483 647.
uint
The unsigned integer type is uint. It takes 4 bytes of memory and allows expressing integers from 0 to
4 294 967 295.
long
The size of the long type is 8 bytes (64 bits). The minimum value is -9 223 372 036 854 775 808, the
maximum value is 9 223 372 036 854 775 807.
ulong
The ulong type also occupies 8 bytes and can store values from 0 to 18 446 744 073 709 551 615.
Examples:
char ch=12;
short sh=-5000;
int in=2445777;
S incethe unsigned integer types are not designed for storing negative values, the attempt to set a
negative value can lead to unexpected consequences. S uch a simple script will lead to an infinite loop:
//--- Infinite loop
void OnStart()
{
uchar u_ch;
for(char ch=-128;ch<128;ch++)
{
u_ch=ch;
Print("ch = ",ch," u_ch = ",u_ch);
}
}
for(char ch=-128;ch<=127;ch++)
{
u_ch=ch;
Print("ch = ",ch," u_ch = ",u_ch);
if(ch==127) break;
}
}
Result:
...
Examples:
H exadecimal: numbers 0-9, the letters a-f or A-F for the values of 10-15; start with 0x or 0X.
Examples:
For integer variables, the values can be set in binary form using B prefix. For example, you can encode
the working hours of a trading session into int type variable and use information about them according
to the required algorithm:
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- set 1 for working hours and 0 for nonworking ones
int AsianSession =B'111111111'; // Asian session from 0:00 to 9:00
int EuropeanSession=B'111111111000000000'; // European session 9:00 - 18:00
int AmericanSession =B'111111110000000000000011'; // American session 16:00 - 02:00
//--- derive numerical values of the sessions
PrintFormat("Asian session hours as value =%d",AsianSession);
PrintFormat("European session hours as value is %d",EuropeanSession);
PrintFormat("American session hours as value is %d",AmericanSession);
//--- and now let's display string representations of the sessions' working hours
Print("Asian session ",GetHoursForSession(AsianSession));
Print("European session ",GetHoursForSession(EuropeanSession));
Print("American session ",GetHoursForSession(AmericanSession));
//---
}
//+------------------------------------------------------------------+
//| return the session's working hours as a string |
//+------------------------------------------------------------------+
string GetHoursForSession(int session)
{
//--- in order to check, use AND bit operations and left shift by 1 bit <<=1
//--- start checking from the lowest bit
int bit=1;
string out="working hours: ";
//--- check all 24 bits starting from the zero and up to 23 inclusively
for(int i=0;i<24;i++)
{
//--- receive bit state in number
bool workinghour=(session&bit)==bit;
//--- add the hour's number to the message
if(workinghour )out=out+StringFormat("%d ",i);
//--- shift by one bit to the left to check the value of the next one
bit<<=1;
}
//--- result string
return out;
}
See also
Typecasting
Character Constants
Characters as elements of a string in MQL5 are indexes in the Unicode character set. They are
hexadecimal values that can be cast into integers, and that can be manipulated by integer operations
like addition and subtraction.
Any single character in quotation marks or a hexadecimal AS CII code of a character as '\x10' is a
character constant and is of ushort type. For example, a record of '0' type is a numerical value 30, that
corresponds to the index of zero in the table of characters.
Example:
void OnStart()
{
//--- define character constants
int symbol_0='0';
int symbol_9=symbol_0+9; // get symbol '9'
//--- output values of constants
printf("In a decimal form: symbol_0 = %d, symbol_9 = %d",symbol_0,symbol_9);
printf("In a hexadecimal form: symbol_0 = 0x%x, symbol_9 = 0x%x",symbol_0,symbol_9);
//--- enter constants into a string
string test="";
StringSetCharacter(test,0,symbol_0);
StringSetCharacter(test,1,symbol_9);
//--- this is what they look like in a string
Print(test);
}
A backslash is a control character for a compiler when dealing with constant strings and character
constants in a source text of a program. S ome symbols, for example a single quote ('), double quotes
(" ), backslash (\) and control characters can be represented as a combination of symbols that start
with a backslash (\), according to the below table:
backslash \ '\\' 92
If a backslash is followed by a character other than those described above, result is undefined.
Example
void OnStart()
{
//--- declare character constants
int a='A';
int b='$';
int c='©'; // code 0xA9
int d='\xAE'; // code of the symbol ®
//--- output print constants
Print(a,b,c,d);
//--- add a character to the string
string test="";
StringSetCharacter(test,0,a);
Print(test);
//--- replace a character in a string
StringSetCharacter(test,0,b);
Print(test);
//--- replace a character in a string
StringSetCharacter(test,0,c);
Print(test);
//--- replace a character in a string
StringSetCharacter(test,0,d);
Print(test);
//--- represent characters as a number
int a1=65;
int b1=36;
int c1=169;
int d1=174;
//--- add a character to the string
StringSetCharacter(test,1,a1);
Print(test);
//--- add a character to the string
StringSetCharacter(test,1,b1);
Print(test);
//--- add a character to the string
StringSetCharacter(test,1,c1);
Print(test);
//--- add a character to the string
StringSetCharacter(test,1,d1);
Print(test);
}
As it was mentioned above, the value of a character constant (or variable) is an index in the table of
characters. Index being an integer, it can be written in different ways.
void OnStart()
{
//---
int a=0xAE; // the code of ® corresponds to the '\xAE' literal
int b=0x24; // the code of $ corresponds to the '\x24' literal
int c=0xA9; // the code of © corresponds to the '\xA9' literal
int d=0x263A; // the code of ☺ corresponds to the '\x263A' literal
//--- show values
Print(a,b,c,d);
//--- add a character to the string
string test="";
StringSetCharacter(test,0,a);
Print(test);
//--- replace a character in a string
StringSetCharacter(test,0,b);
Print(test);
//--- replace a character in a string
StringSetCharacter(test,0,c);
Print(test);
//--- replace a character in a string
StringSetCharacter(test,0,d);
Print(test);
//--- codes of suits
int a1=0x2660;
int b1=0x2661;
int c1=0x2662;
int d1=0x2663;
//--- add a character of spades
StringSetCharacter(test,1,a1);
Print(test);
//--- add a character of hearts
StringSetCharacter(test,2,b1);
Print(test);
//--- add a character of diamonds
StringSetCharacter(test,3,c1);
Print(test);
//--- add a character of clubs
StringSetCharacter(test,4,d1);
Print(test);
//--- Example of character literals in a string
test="Queen\x2660Ace\x2662";
printf("%s",test);
}
The internal representation of a character literal is the ushort type. Character constants can accept
values from 0 to 65535.
See also
S tring S etCharacter(), S tring GetCharacter(), S hortToS tring(), S hortArrayToS tring(),
S tringToS hortArray()
Datetime Type
The datetime type is intended for storing the date and time as the number of seconds elapsed since
January 01, 1970. This type occupies 8 bytes of memory.
Constants of the date and time can be represented as a literal string, which consists of 6 parts
showing the numerical value of the year, month, day (or day, month, year), hours, minutes and
seconds. The constant is enclosed in single quotation marks and starts with the D character.
Values range from 1 January, 1970 to 31 December, 3000. Either date (year , month, day) or time
(hours, minutes, seconds), or all together can be omitted.
W ithliteral date specification, it is desirable that you specify year, month and day. Otherwise the
compiler returns a warning about an incomplete entry.
Examples:
See also
S tructure of the Date Type, Date and Time, TimeToS tring, S tringToTime
Color Type
The color type is intended for storing information about color and occupies 4 bytes in memory. The
first byte is ignored, the remaining 3 bytes contain the RGB-components.
Color constants can be represented in three ways : literally, by integers, or by name (for named W eb-
colors only).
Literal representation consists of three parts representing numerical rate values of the three main
color components : red, green, blue. The constant starts with C and is enclosed in single quotes.
Numerical rate values of a color component lie in the range from 0 to 255.
//--- Literals
C'128,128,128' // Gray
C'0x00,0x00,0xFF' // Blue
//color names
clrRed // Red
clrYellow // Yellow
clrBlack // Black
//--- Integral representations
0xFFFFFF // White
16777215 // White
0x008000 // Green
32768 // Green
See also
W eb Colors, ColorToS tring, S tringToColor, Typecasting
Bool Type
The bool type is intended to store the logical values of true or false, numeric representation of them is
1 or 0, respectively.
Examples:
bool a = true;
bool b = false;
bool c = 1;
The internal representation is a whole number 1 byte large. It should be noted that in logical
expressions you can use other integer or real types or expressions of these types - the compiler will
not generate any error. In this case, the zero value will be interpreted as false, and all other values -
as true.
Examples:
int i=5;
double d=-2.5;
if(i) Print("i = ",i," and is set to true");
else Print("i = ",i," and is set to false");
i=0;
if(i) Print("i = ",i," and has the true value");
else Print("i = ",i," and has the false value");
d=0.0;
if(d) Print("d = ",d," and has the true value");
else Print("d = ",d," and has the false value");
See also
Boolean Operations, Precedence Rules
Enumerations
Data of the enum type belong to a certain limited set of data. Defining the enumeration type:
enum name of enumerable type
{
list of values
};
After the enumeration is declared, a new integer-valued 4-byte data type appears. Declaration of the
new data type allows the compiler to strictly control types of passed parameters, because enumeration
introduces new named constants. In the above example, the January named constant has the value of
0, February - 1, December - 11.
Rule: If a certain value is not assigned to a named constant that is a member of the enumeration, its
new value will be formed automatically. If it is the first member of the enumeration, the 0 value will
be assigned to it. For all subsequent members, values will be calculated based on the value of the
previous members by adding one.
Example:
Notes
· Unlik e C++, the size of the internal representation of the enumerated type in MQL5 is always equal
to 4 bytes. That is, sizeof (months) returns the value 4.
· Unlik e C++, an anonymous enumeration can't be declared in MQL5. That is, a unique name must be
always specified after the enum keyword.
See also
Typecasting
double
double real number type occupies 64 bits (1 sign bit, 11 exponent bits and 52 mantissa bits).
float
float real number type occupies 32 bits (1 sign bit, 8 exponent bits and 23 mantissa bits).
vector
One-dimensional array of double type numbers. Memory for data is allocated dynamically. Vector
properties can be obtained using the methods, while the vector size can be changed. The
vector<double> entry can be used in template functions.
vectorf
One-dimensional array of float type numbers can be used instead of vector if the loss of precision does
not matter. The vector<float> entry can be used in template functions.
vectorc
One-dimensional array of complex type numbers is meant to handle complex numbers. The
vector<complex> entry can be used in template functions. Operations on vectorc type vectors are not
implemented yet.
matrix
Matrix is a two-dimensional array of double type numbers. Memory for matrix elements is distributed
dynamically. Matrix properties can be obtained using the methods, while the matrix shape can be
changed. The matrix<double> entry can be used in template functions.
matrixf
Two-dimensional array of float type numbers can be used instead of matrix if the loss of precision
does not matter. The matrix<float> entry can be used in template functions.
matrixc
Two-dimensional array of complex type numbers is meant to handle complex numbers. The
matrix<complex> entry can be used in template functions. Operations on matrixc type matrices are
not implemented yet.
The double name means that the accuracy of these numbers is twice the accuracy of the float type
numbers. In most cases, the double type is the most convenient one. In many cases the limited
precision of float numbers is not enough. The reason why the float type is still used is saving the
memory (this is important for large arrays of real numbers).
Floating-point constants consist of an integer part, a point (.) and the fractional part. The integer and
fractional parts are sequences of decimal digits.
Examples:
double a=12.111;
double b=-956.1007;
float c =0.0001;
float d =16;
There is a scientific way of writing real constants, often this method of recording is more compact
than the traditional one.
Example:
double c1=1.12123515e-25;
double c2=0.000000000000000000000000112123515; // 24 zero after the decimal point
Print("1. c1 =",DoubleToString(c1,16));
// Result: 1. c1 = 0.0000000000000000
Print("2. c1 =",DoubleToString(c1,-16));
// Result: 2. c1 = 1.1212351499999999e-025
Print("3. c2 =",DoubleToString(c2,-16));
// Result: 3. c2 = 1.1212351499999999e-025
It should be remembered that real numbers are stored in memory with some limited accuracy in the
binary system, while generally the decimal notation is used. That's why many numbers that are
precisely represented in the decimal system can be written only as an infinite fraction in the binary
system.
Forexample, numbers 0.3 and 0.7 are represented in the computer as infinite fractions, while the
number of 0.25 is stored exactly, because it represents the power of two.
In this regard, it is strongly recommended not to compare two real numbers for equality, because such
a comparison is not correct.
Example:
void OnStart()
{
//---
double three=3.0;
double x,y,z;
x=1/three;
y=4/three;
z=5/three;
if(x+y==z)
Print("1/3 + 4/3 == 5/3");
else
Print("1/3 + 4/3 != 5/3");
// Result: 1/3 + 4/3 != 5/3
}
If you still need to compare the equality of two real numbers, then you can do this in two different
ways. The first way is to compare the difference between two numbers with some small quantity that
specifies the accuracy of comparison.
Example:
Note that the value of epsilon in the above example can not be less than the predefined constant
DBL _EPS ILON. The value of this constant is 2.2204460492503131e-016. The constant corresponding to
the float type is FLT_EPS ILON = 1.192092896e-07. The meaning of these values is the following: it is
the lowest value that satisfies the condition 1.0 + DBL_EPS ILON! = 1.0 (for numbers of float type 1.0
+ FLT_EPS ILON! = 1.0).
The second way offers comparing the normalized difference of two real numbers with zero. It's
meaningless to compare the difference of normalized numbers with a zero, because any mathematical
operation with normalized numbers gives a non-normalized result.
Example:
S ome operations of the mathematical co-processor can result in the invalid real number, which can't be
used in mathematical operations and operations of comparison, because the result of operations with
invalid real numbers is undefined. For example, when trying to calculate the arcsine of 2, the result is
the negative infinity.
Example:
Besides the minus infinity there is the plus infinity and NaN (not a number). To determine that this
number is invalid, you can use MathIs ValidNumber(). According to the IEEE standard, they have a
special machine representation. For example, plus infinity for the double type has the bit
representation of 0x7FF0 0000 0000 0000.
Examples:
struct str1
{
double d;
};
struct str2
{
long l;
};
//--- Start
str1 s1;
str2 s2;
//---
s1.d=MathArcsin(2.0); // Get the invalid number -1.#IND
s2=s1;
printf("1. %f %I64X",s1.d,s2.l);
//---
s2.l=0xFFFF000000000000; // invalid number -1.#QNAN
s1=s2;
printf("2. %f %I64X",s1.d,s2.l);
//---
s2.l=0x7FF7000000000000; // greatest non-number SNaN
s1=s2;
printf("3. %f %I64X",s1.d,s2.l);
//---
s2.l=0x7FF8000000000000; // smallest non-number QNaN
s1=s2;
printf("4. %f %I64X",s1.d,s2.l);
//---
s2.l=0x7FFF000000000000; // greatest non-number QNaN
s1=s2;
printf("5. %f %I64X",s1.d,s2.l);
//---
s2.l=0x7FF0000000000000; // Positive infinity 1.#INF and smallest non-number SNaN
s1=s2;
printf("6. %f %I64X",s1.d,s2.l);
//---
s2.l=0xFFF0000000000000; // Negative infinity -1.#INF
s1=s2;
printf("7. %f %I64X",s1.d,s2.l);
//---
s2.l=0x8000000000000000; // Negative zero -0.0
s1=s2;
printf("8. %f %I64X",s1.d,s2.l);
//---
s2.l=0x3FE0000000000000; // 0.5
s1=s2;
printf("9. %f %I64X",s1.d,s2.l);
//---
s2.l=0x3FF0000000000000; // 1.0
s1=s2;
printf("10. %f %I64X",s1.d,s2.l);
//---
s2.l=0x7FEFFFFFFFFFFFFF; // Greatest normalized number (MAX_DBL)
s1=s2;
See also
DoubleToS tring, NormalizeDouble, Numeric Type Constants
The " complex" type can be passed by value as a parameter for MQL5 functions (in contrast to ordinary
structures, which are only passed by reference). For functions imported from DLLs, the " complex" type
must be passed only by reference.
The 'i' suffix is used to describe complex constants :
complex square(complex c)
{
return(c*c);
}
void OnStart()
{
Print(square(1+2i)); // A constant is passed as a parameter
}
// "(-3,4)" will be output, which is a string representation of the complex number
Only simple operations are currently available for complex numbers : =, +, -, *, /, +=, -=, *=, /=, ==,!=.
S upport for additional mathematical functions will be added later, enabling the calculation of the
absolute value, sine, cosine and others.
vectorc
One-dimensional array of complex type numbers is meant to handle complex numbers. The
vector<complex> entry can be used in template functions. Operations on vectorc type vectors are not
implemented yet.
matrixc
Two-dimensional array of complex type numbers is meant to handle complex numbers. The
matrix<complex> entry can be used in template functions. Operations on matrixc type matrices are
not implemented yet.
String Type
The string type is used for storing text strings. A text string is a sequence of characters in the
Unicode format with the final zero at the end of it. A string constant can be assigned to a string
variable. A string constant is a sequence of Unicode characters enclosed in double quotes : " This is a
string constant" .
If you need to include a double quote (" ) into a string, the backslash character (\) must be put before
it. Any special character constants can be written in a string, if the backslash character (\) is typed
before them.
Examples:
To make the source code readable, long constant strings can be split into parts without addition
operation. During compilation, these parts will be combined into one long string:
//--- Declare a long constant string
string HTML_head="<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\""
" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n"
"<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
"<head>\n"
"<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n"
"<title>Trade Operations Report</title>\n"
"</head>";
//--- Output the constant string into log
Print(HTML_head);
}
See also
Conversion Functions, S tring Functions, FileOpen, FileReadS tring, FileW riteS tring
Structure Declaration
The structure name can't be used as an identifier (name of a variable or function). It should be noted
that in MQL5 structure elements follow one another directly, without alignment. In C++ such an order
is made to the compiler using the following instruction:
#pragma pack(1)
If you want to do another alignment in the structure, use auxiliary members, " fillers " to the right size.
Example:
struct trade_settings
{
uchar slippage; // value of the permissible slippage-size 1 byte
char reserved1; // skip 1 byte
short reserved2; // skip 2 bytes
int reserved4; // another 4 bytes are skipped. ensure alignment of the boundary 8 bytes
double take; // values of the price of profit fixing
double stop; // price value of the protective stop
};
S uch a description of aligned structures is necessary only for transferring to imported dll-functions.
Attention: This example illustrates incorrectly designed data. It would be better first to declare the
take and stop large data of the double type, and then declare the slippage member of the uchar type.
In this case, the internal representation of data will always be the same regardless of the value
specified in #pragma pack().
If a structure contains variables of the string type and/or object of a dynamic array, the compiler
assigns an implicit constructor to such a structure. This constructor resets all the structure members
of string type and correctly initializes objects of the dynamic array.
Simple Structures
S tructuresthat do not contain strings, class objects, pointers and objects of dynamic arrays are called
simple structures. Variables of simple structures, as well as their arrays can be passed as parameters
to functions imported from DLL.
Therefore, only one option is left – copying the values of the structure elements one by one. It is still
allowed to copy the values of the same type of CustomM qlTick.
CustomMqlTick my_tick1,my_tick2;
//--- it is allowed to copy the objects of the same type of CustomMqlTick the following way
my_tick2=my_tick1;
//--- create an array out of the objects of the simple CustomMqlTick structure and write valu
CustomMqlTick arr[2];
arr[0]=my_tick1;
arr[1]=my_tick2;
The ArrayPrint() function is called for a check to display the arr[] array value in the journal.
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- develop the structure similar to the built-in MqlTick
struct CustomMqlTick
{
datetime time; // Last price update time
double bid; // Current Bid price
double ask; // Current Ask price
double last; // Current price of the last trade (Last)
ulong volume; // Volume for the current Last price
long time_msc; // Last price update time in milliseconds
uint flags; // Tick flags
};
//--- get the last tick value
MqlTick last_tick;
CustomMqlTick my_tick1,my_tick2;
//--- attempt to copy data from MqlTick to CustomMqlTick
if(SymbolInfoTick(Symbol(),last_tick))
{
//--- it is allowed to copy the objects of the same type of CustomMqlTick the following way
my_tick2=my_tick1;
//--- create an array out of the objects of the simple CustomMqlTick structure and write valu
CustomMqlTick arr[2];
arr[0]=my_tick1;
arr[1]=my_tick2;
ArrayPrint(arr);
//--- example of displaying values of the array containing the objects of CustomMqlTick type
/*
[time] [bid] [ask] [last] [volume] [time_msc] [flags]
[0] 2017.05.29 15:04:37 1.11854 1.11863 +0.00000 1450000 1496070277157 2
[1] 2017.05.29 15:04:37 1.11854 1.11863 +0.00000 1450000 1496070277157 2
*/
}
else
Print("SymbolInfoTick() failed, error = ",GetLastError());
}
The second example shows the features of copying simple structures by the lineage. S uppose that we
have the Animal basic structure, from which the Cat and Dog structures are derived. W e can copy the
Animal and Cat objects, as well as the Animal and Dog objects to each other but we cannot copy Cat
and Dog to each other, although both are descendants of the Animal structure.
//--- structure for describing dogs
struct Dog: Animal
{
bool hunting; // hunting breed
};
//--- structure for describing cats
struct Cat: Animal
{
bool home; // home breed
};
//--- create objects of child structures
Dog dog;
Cat cat;
//--- can be copied from ancestor to descendant (Animal ==> Dog)
dog=some_animal;
dog.swim=true; // dogs can swim
//--- you cannot copy objects of child structures (Dog != Cat)
cat=dog; // compiler returns an error
dog=some_animal;
dog.swim=true; // dogs can swim
//--- you cannot copy objects of child structures (Dog != Cat)
//cat=dog; // compiler returns an error here
//--- therefore, it is possible to copy elements one by one only
cat.head=dog.head;
cat.legs=dog.legs;
cat.wings=dog.wings;
cat.tail=dog.tail;
cat.fly=dog.fly;
cat.swim=false; // cats cannot swim
//--- it is possible to copy the values from descendant to ancestor
Animal elephant;
elephant=cat;
elephant.run=false;// elephants cannot run
elephant.swim=true;// elephants can swim
//--- create an array
Animal animals[4];
animals[0]=some_animal;
animals[1]=dog;
animals[2]=cat;
animals[3]=elephant;
//--- print out
ArrayPrint(animals);
//--- execution result
/*
[head] [legs] [wings] [tail] [fly] [swim] [run]
[0] 1 4 0 true false false true
[1] 1 4 0 true false true true
[2] 1 4 0 true false false false
[3] 1 4 0 true false true false
*/
}
Anotherway to copy simple types is using a union. The objects of the structures should be members of
the same union – see the example in union.
The name of a structure becomes a new data type, so you can declare variables of this type. The
structure can be declared only once within a project. The structure members are accessed using the
point operation (.).
Example:
struct trade_settings
{
double take; // values of the profit fixing price
double stop; // value of the protective stop price
uchar slippage; // value of the acceptable slippage
};
//--- create up and initialize a variable of the trade_settings type
trade_settings my_set={0.0,0.0,5};
if (input_TP>0) my_set.take=input_TP;
The special pack attribute allows setting the alignment of structure or class fields.
pack([n])
'pack (1)'
is applied by default for structures. This means that the structure members are located one
after another in memory, and the structure size is equal to the sum of its members ' size.
Example:
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- simple structure with no alignment
struct Simple_Structure
{
char c; // sizeof(char)=1
short s; // sizeof(short)=2
int i; // sizeof(int)=4
double d; // sizeof(double)=8
};
//--- declare a simple structure instance
Simple_Structure s;
//--- display the size of each structure member
Print("sizeof(s.c)=",sizeof(s.c));
Print("sizeof(s.s)=",sizeof(s.s));
Print("sizeof(s.i)=",sizeof(s.i));
Print("sizeof(s.d)=",sizeof(s.d));
//--- make sure the size of POD structure is equal to the sum of its members' size
Print("sizeof(simple_structure)=",sizeof(simple_structure));
/*
Result:
sizeof(s.c)=1
sizeof(s.s)=2
sizeof(s.i)=4
sizeof(s.d)=8
sizeof(simple_structure)=15
*/
}
Alignment of the structure fields may be needed when exchanging data with third-party libraries
(*.DLL) where such alignment is applied.
Let's use some examples to show how alignment works. We will apply a structure consisting of four
members with no alignment.
//--- simple structure with no alignment
struct Simple_Structure pack() // no size is specified, alignment to the boundary of 1 byte is t
{
char c; // sizeof(char)=1
short s; // sizeof(short)=2
int i; // sizeof(int)=4
double d; // sizeof(double)=8
};
//--- declare a simple structure instance
Simple_Structure s;
S tructure fields are to be located in memory one after another according to the declaration order and
type size. The structure size is 15, while an offset to the structure fields in the arrays is undefined.
Now declare the same structure with the alignment of 4 bytes and run the code.
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- simple structure with the 4-byte alignment
struct Simple_Structure pack(4)
{
char c; // sizeof(char)=1
short s; // sizeof(short)=2
int i; // sizeof(int)=4
double d; // sizeof(double)=8
};
The structure size has changed so that all members of 4 bytes and more has an offset from the
beginning of the structure multiple of 4 bytes. S maller members are to be aligned to their own size
boundary (for example, 2 for 'short'). This is how it looks (the added byte is shown in gray).
In this case, 1 byte is added after the s.c member, so that the s.s (sizeof(short)==2) field has the
boundary of 2 bytes (alignment for 'short' type).
The offset to the beginning of the structure in the array is also aligned to the 4-byte boundary, i.e. the
addresses of the a[0], a[1] and a[n] elements are to be multiple of 4 bytes for S imple_S tructure arr[].
Let's consider two more structures consisting of similar types with 4-bytes alignment but different
member order. In the first structure, the members are located in type size ascending order.
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- simple structure aligned to the 4-byte boundary
struct CharShortInt pack(4)
{
char c; // sizeof(char)=1
short s; // sizeof(short)=2
int i; // sizeof(double)=4
};
//--- make sure the size of POD structure is equal to the sum of its members' size
Print("sizeof(CharShortInt)=",sizeof(CharShortInt));
/*
Result:
sizeof(ch_sh_in.c)=1
sizeof(ch_sh_in.s)=2
sizeof(ch_sh_in.i)=4
sizeof(CharShortInt)=8
*/
}
As we can see, the structure size is 8 and consists of the two 4-byte blocks. The first block contains
the fields with 'char' and 'short' types, while the second one contains the field with 'int' type.
Now let's turn the first structure into the second one, which differs only in the field order, by moving
the 'short' type member to the end.
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- simple structure aligned to the 4-byte boundary
struct CharIntShort pack(4)
{
char c; // sizeof(char)=1
int i; // sizeof(double)=4
short s; // sizeof(short)=2
};
//--- declare a simple structure instance
CharIntShort ch_in_sh;
//--- display the size of each structure member
Print("sizeof(ch_in_sh.c)=",sizeof(ch_in_sh.c));
Print("sizeof(ch_in_sh.i)=",sizeof(ch_in_sh.i));
Print("sizeof(ch_in_sh.s)=",sizeof(ch_in_sh.s));
//--- make sure the size of POD structure is equal to the sum of its members' size
Print("sizeof(CharIntShort)=",sizeof(CharIntShort));
/*
Result:
sizeof(ch_in_sh.c)=1
sizeof(ch_in_sh.i)=4
sizeof(ch_in_sh.s)=2
sizeof(CharIntShort)=12
*/
}
Although the structure content has not changed, altering the member sequence has increased its size.
Alignment should also be considered when inheriting. Let's demonstrate this using the simple Parent
structure having a single 'char' type member. The structure size without alignment is 1.
struct Parent
{
char c; // sizeof(char)=1
};
Let's create the Children child class featuring the 'short' (sizeof(short)=2) type member.
struct Children pack(2) : Parent
{
short s; // sizeof(short)=2
};
As a result, when setting alignment to 2 bytes, the structure size is equal to 4, although the size of its
members is 3. In this example, 2 bytes are to be allocated to the Parent class, so that the access to
the 'short' field of the child class is aligned to 2 bytes.
The knowledge of how memory is allocated for the structure members is necessary if an MQL5
application interacts with third-party data by writing/reading on the files or streams level.
The MQL5\Include\W inAPI directory of the S tandard Library contains the functions for working with the
W inAPI functions. These functions apply the structures with a specified alignment for the cases when
it is required for working with W inAPI.
offsetof is a special command directly related to the pack attribute. It allows us to obtain a member
offset from the beginning of the structure.
//--- declare the Children type variable
Children child;
//--- detect offsets from the beginning of the structure
Print("offsetof(Children,c)=",offsetof(Children,c));
Print("offsetof(Children,s)=",offsetof(Children,s));
/*
Result:
offsetof(Children,c)=0
offsetof(Children,s)=2
*/
Specifier 'final'
The use of the 'final' specifier during structure declaration prohibits further inheritance from this
structure. If a structure requires no further modifications, or modifications are not allowed for
security reasons, declare this structure with the 'final' modifier. In addition, all the members of the
structure will also be implicitly considered final.
struct settings final
{
//--- Structure body
};
If you try to inherit from a structure with the 'final' modifier as shown in the above example, the
compiler will return an error:
cannot inherit from 'settings' as it has been declared as 'final'
see declaration of 'settings'
Classes
Classes differ from structures in the following:
· the keyword class is used in declaration;
· by default, all class members have access specifier private, unless otherwise indicated. Data-
members of the structure have the default type of access as public, unless otherwise indicated;
· class objects always have a table of virtual functions, even if there are no virtual functions declared
in the class. S tructures cannot have virtual functions ;
· the new operator can be applied to class objects ; this operator cannot be applied to structures ;
· classes can be inherited only from classes, structures can be inherited only from structures.
Classes and structures can have an explicit constructor and destructor. If your constructor is explicitly
defined, the initialization of a structure or class variable using the initializing sequence is impossible.
Example:
struct trade_settings
{
double take; // values of the profit fixing price
double stop; // value of the protective stop price
uchar slippage; // value of the acceptable slippage
//--- Constructor
trade_settings() { take=0.0; stop=0.0; slippage=5; }
//--- Destructor
~trade_settings() { Print("This is the end"); }
};
//--- Compiler will generate an error message that initialization is impossible
trade_settings my_set={0.0,0.0,5};
A constructor is a special function, which is called automatically when creating an object of a structure
or class and is usually used to initialize class members. Further we will talk only about classes, while
the same applies to structures, unless otherwise indicated. The name of a constructor must match the
class name. The constructor has no return type (you can specify the void type).
Defined class members – strings, dynamic arrays and objects that require initialization – will be in any
case initialized, regardless of whether there is a constructor.
Each class can have multiple constructors, differing by the number of parameters and the initialization
list. A constructor that requires specifying parameters is called a parametric constructor.
A constructor with no parameters is called a default constructor. If no constructors are declared in a
class, the compiler creates a default constructor during compilation.
//+------------------------------------------------------------------+
//| A class for working with a date |
//+------------------------------------------------------------------+
class MyDateClass
{
private:
int m_year; // Year
int m_month; // Month
int m_day; // Day of the month
int m_hour; // Hour in a day
int m_minute; // Minutes
int m_second; // Seconds
public:
//--- Default constructor
MyDateClass(void);
//--- Parametric constructor
MyDateClass(int h,int m,int s);
};
A constructor can be declared in the class description and then its body can be defined. For example,
two constructors of MyDateClass can be defined the following way:
//+------------------------------------------------------------------+
//| Default constructor |
//+------------------------------------------------------------------+
MyDateClass::MyDateClass(void)
{
//---
MqlDateTime mdt;
datetime t=TimeCurrent(mdt);
m_year=mdt.year;
m_month=mdt.mon;
m_day=mdt.day;
m_hour=mdt.hour;
m_minute=mdt.min;
m_second=mdt.sec;
Print(__FUNCTION__);
}
//+------------------------------------------------------------------+
//| Parametric constructor |
//+------------------------------------------------------------------+
MyDateClass::MyDateClass(int h,int m,int s)
{
MqlDateTime mdt;
datetime t=TimeCurrent(mdt);
m_year=mdt.year;
m_month=mdt.mon;
m_day=mdt.day;
m_hour=h;
m_minute=m;
m_second=s;
Print(__FUNCTION__);
}
In the default constructor, all members of the class are filled using the TimeCurrent() function. In the
parametric constructor only hour values are filled in. Other members of the class (m_year, m_month
and m_day) will be automatically initialized with the current date.
The default constructor has a special purpose when initializing an array of objects of its class. The
constructor, all parameters of which have default values, is not a default constructor. Here is an
example:
//+------------------------------------------------------------------+
//| A class with a default constructor |
//+------------------------------------------------------------------+
class CFoo
{
datetime m_call_time; // Time of the last object call
public:
//--- Constructor with a parameter that has a default value is not a default constructor
CFoo(const datetime t=0){m_call_time=t;};
//--- Copy constructor
CFoo(const CFoo &foo){m_call_time=foo.m_call_time;};
string ToString(){return(TimeToString(m_call_time,TIME_DATE|TIME_SECONDS));};
};
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
// CFoo foo; // This variant cannot be used - a default constructor is not set
//--- Possible options to create the CFoo object
or
//CFoo foo_dyn_array[]; // This variant cannot be used - a default constructor is not set
then the compiler will return an error for them " default constructor is not defined" .
If a class has a user-defined constructor, the default constructor is not generated by the compiler. This
means that if a parametric constructor is declared in a class, but a default constructor is not declared,
you can not declare the arrays of objects of this class. The compiler will return an error for this script:
//+------------------------------------------------------------------+
//| A class without a default constructor |
//+------------------------------------------------------------------+
class CFoo
{
string m_name;
public:
In this example, the CFoo class has a declared parametric constructor - in such cases, the compiler
does not create a default constructor automatically during compilation. At the same time when you
declare an array of objects, it is assumed that all objects should be created and initialized
automatically. During auto-initialization of an object, it is necessary to call a default constructor, but
since the default constructor is not explicitly declared and not automatically generated by the compiler,
it is impossible to create such an object. For this reason, the compiler generates an error at the
compilation stage.
There is a special syntax to initialize an object using a constructor. Constructor initializers (special
constructions for initialization) for the members of a struct or class can be specified in the
initialization list.
An initialization list is
a list of initializers separated by commas, which comes after the colon after the
list of parameters of a constructor and precedes the body (goes before an opening brace). There are
several requirements :
· Initialization lists can be used only in constructors ;
· Parent members cannot be initialized in the initialization list;
· The initialization list must be followed by a definition (implementation) of a function.
H ere is an example of several constructors for initializing class members.
//+------------------------------------------------------------------+
//| A class for storing the name of a character |
//+------------------------------------------------------------------+
class CPerson
{
string m_first_name; // First name
string m_second_name; // Second name
public:
//--- An empty default constructor
CPerson() {Print(__FUNCTION__);};
//--- A parametric constructor
CPerson(string full_name);
//--- A constructor with an initialization list
CPerson(string surname,string name): m_second_name(surname), m_first_name(name
void PrintName(){PrintFormat("Name=%s Surname=%s",m_first_name,m_second_name);};
};
//+------------------------------------------------------------------+
//| |
//+------------------------------------------------------------------+
CPerson::CPerson(string full_name)
{
int pos=StringFind(full_name," ");
if(pos>=0)
{
m_first_name=StringSubstr(full_name,0,pos);
m_second_name=StringSubstr(full_name,pos+1);
}
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- Get an error "default constructor is not defined"
CPerson people[5];
CPerson Tom="Tom Sawyer"; // Tom Sawyer
CPerson Huck("Huckleberry","Finn"); // Huckleberry Finn
CPerson *Pooh = new CPerson("Winnie","Pooh"); // Winnie the Pooh
//--- Output values
Tom.PrintName();
Huck.PrintName();
Pooh.PrintName();
In the initialization list, members can go in any order, but all members of the class will be initialized
according to the order of their announcement. This means that in the third constructor, first the
m_first_name member will be initialized, as it is announced first, and only after it m_second_name is
initialized. This should be taken into account in cases where the initialization of some members of the
class depends on the values in other class members.
If a default constructor is not declared in the base class, and at the same time one or more
constructors with parameters are declared, you should always call one of the base class constructors in
the initialization list. It goes through the comma as ordinary members of the list and will be called first
during object initialization, no matter where in the initialization list it is located.
//+------------------------------------------------------------------+
//| Base class |
//+------------------------------------------------------------------+
class CFoo
{
string m_name;
public:
//--- A constructor with an initialization list
CFoo(string name) : m_name(name) { Print(m_name);}
};
//+------------------------------------------------------------------+
//| Class derived from CFoo |
//+------------------------------------------------------------------+
class CBar : CFoo
{
CFoo m_member; // A class member is an object of the parent
public:
//--- A default constructor in the initialization list calls the constructor of a parent
CBar(): m_member(_Symbol), CFoo("CBAR") {Print(__FUNCTION__);}
};
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
CBar bar;
}
In this example, when creating the bar object, a default constructor CBar() will be called, in which first
a constructor for the parent CFoo is called, and then comes a constructor for the m_member class
member.
A destructor is a special function that is called automatically when a class object is destroyed. The
name of the destructor is written as a class name with a tilde (~). S trings, dynamic arrays and objects,
requiring deinitialization, will be de-initialized anyway, regardless of the destructor presence or
absence. If there is a destructor, these actions will be performed after calling the destructor.
Destructors are always virtual, regardless of whether they are declared with the virtual keyword or not.
Class function-methods can be defined both inside the class and outside the class declaration. If the
method is defined within a class, then its body comes right after the method declaration.
Example:
class CTetrisShape
{
protected:
int m_type;
int m_xpos;
int m_ypos;
int m_xsize;
int m_ysize;
int m_prev_turn;
int m_turn;
int m_right_border;
public:
void CTetrisShape();
void SetRightBorder(int border) { m_right_border=border; }
void SetYPos(int ypos) { m_ypos=ypos; }
void SetXPos(int xpos) { m_xpos=xpos; }
int GetYPos() { return(m_ypos); }
int GetXPos() { return(m_xpos); }
int GetYSize() { return(m_ysize); }
int GetXSize() { return(m_xsize); }
int GetType() { return(m_type); }
void Left() { m_xpos-=SHAPE_SIZE; }
void Right() { m_xpos+=SHAPE_SIZE; }
void Rotate() { m_prev_turn=m_turn; if(++m_turn>3) m_turn=0; }
virtual void Draw() { return; }
virtual bool CheckDown(int& pad_array[]);
virtual bool CheckLeft(int& side_row[]);
virtual bool CheckRight(int& side_row[]);
};
Functions from S etR ightBorder(int border) to Draw() are declared and defined directly inside the
CTetris S hape class.
The CTetris S hape() constructor and methods CheckDown(int& pad_array[]), CheckLeft(int&
side_row[]) and CheckRight(int& side_row[]) are only declared inside the class, but not defined yet.
Definitions of these functions will be further in the code. In order to define the method outside the
class, the scope resolution operator is used, the class name is used as the scope.
Example:
//+------------------------------------------------------------------+
//| Constructor of the basic class |
//+------------------------------------------------------------------+
void CTetrisShape::CTetrisShape()
{
m_type=0;
m_ypos=0;
m_xpos=0;
m_xsize=SHAPE_SIZE;
m_ysize=SHAPE_SIZE;
m_prev_turn=0;
m_turn=0;
m_right_border=0;
}
//+------------------------------------------------------------------+
//| Checking ability to move down (for the stick and cube) |
//+------------------------------------------------------------------+
bool CTetrisShape::CheckDown(int& pad_array[])
{
int i,xsize=m_xsize/SHAPE_SIZE;
//---
for(i=0; i<xsize; i++)
{
if(m_ypos+m_ysize>=pad_array[i]) return(false);
}
//---
return(true);
}
W hen developing a new class, it is recommended to restrict access to the members from
the outside.
For this purpose k eywords private or protected are used. In this case, hidden data can
be accessed
only from function-methods of the same class. If the protected keyword is used, hidden
data can be
accessed also from methods of classes - inheritors of this class. The same method can be used to
restrict the access to functions-methods of a class.
If you need to completely open access to members and/or methods of a class, use the keyword public.
Example:
class CTetrisField
{
private:
int m_score; // Score
int m_ypos; // Current position of the figures
int m_field[FIELD_HEIGHT][FIELD_WIDTH]; // Matrix of the well
int m_rows[FIELD_HEIGHT]; // Numbering of the well rows
int m_last_row; // Last free row
CTetrisShape *m_shape; // Tetris figure
bool m_bover; // Game over
public:
void CTetrisField() { m_shape=NULL; m_bover=false; }
void Init();
void Deinit();
void Down();
void Left();
void Right();
void Rotate();
void Drop();
private:
void NewShape();
void CheckAndDeleteRows();
void LabelOver();
};
Any class members and methods declared after the specifier public: (and before the next access
specifier) are available in any reference to the class object by the program. In this example these are
the following members : functions CTetris Field(), Init(), Deinit(), Down(), Left(), Right(), Rotate() and
Drop().
Any members that are declared after the access specifier to the elements private: (and before the
next access specifier) are available only to members-functions of this class. S pecifiers of access to
elements always end with a colon (:) and can appear in the class definition many times.
Any class members declared after the protected: access specifier (and up to the next access specifier)
are available only to members-functions of this class and members-functions of the class descendants.
W hen attempting to refer to the members featuring the private and protected specifiers from the
outside, we get the compilation stage error. Example:
class A
{
protected:
//--- the copy operator is available only inside class A and its descendants
void operator=(const A &)
{
}
};
class B
{
//--- class A object declared
A a;
};
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- declare two B type variables
B b1, b2;
//--- attempt to copy one object into another
b2=b1;
}
W hen compiling the code, the error message is received — an attempt to call the remote copy
operator:
attempting to reference deleted function 'void B::operator=(const B&)' trash3.mq5 32 6
The second string below provides a more detailed description — the copy operator in class B was
explicitly deleted, since the unavailable copy operator of class A is called:
function 'void B::operator=(const B&)' was implicitly deleted because it invokes inaccessible fu
Access to the members of the basis class can be redefined during inheritance in derived classes.
'delete' specifier
The delete specifier marks the class members-functions that cannot be used. This means if the
program refers to such a function explicitly or implicitly, the error is received at the compilation stage
already. For example, this specifier allows you to make parent methods unavailable in a child class.
The same result can be achieved if we declare the function in the private area of the parent class
(declarations in the private section). Here, using delete makes the code more readable and
manageable at the level of descendants.
class A
{
public:
A(void) {value=5;};
double GetValue(void) {return(value);}
private:
double value;
};
class B: public A
{
double GetValue(void)=delete;
};
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- declare the A type variable
A a;
Print("a.GetValue()=", a.GetValue());
//--- attempt to get value from the B type variable
B b;
Print("b.GetValue()=", b.GetValue()); // the compiler displays an error at this string
}
The 'delete' specifier allows disabling auto casting or the copy constructor, which otherwise would have
to be hidden in the private section as well. Example:
class A
{
public:
void SetValue(double v) {value=v;}
//--- disable int type call
void SetValue(int) = delete;
//--- disable the copy operator
Specifier 'final'
The use of the 'final' specifier during class declaration prohibits further inheritance from this class. If
the class interface requires no further modifications, or modifications are not allowed for security
reasons, declare this class with the 'final' modifier. In addition, all the members of the class will also
be implicitly considered final.
class CFoo final
{
//--- Class body
};
If you try to inherit form a class with the 'final' specifier as shown in the above example, the compiler
will return an error:
cannot inherit from 'CFoo' as it has been declared as 'final'
see declaration of 'CFoo'
Unions (union)
Union isa special data type consisting of several variables sharing the same memory area. Therefore,
the union provides the ability to interpret the same bit sequence in two (or more) different ways.
Union declaration is similar to structure declaration and starts with the union k eyword.
union LongDouble
{
long long_value;
double double_value;
};
Unlik ethe structure, various union members belong to the same memory area. In this example, the
union of LongDouble is declared with long and double type values sharing the same memory area.
Please note that it is impossible to make the union store a long integer value and a double real value
simultaneously (unlike a structure), since long_value and double_value variables overlap (in memory).
On the other hand, an MQL5 program is able to process data containing in the union as an integer
(long) or real (double) value at any time. Therefore, the union allows receiving two (or more) options
for representing the same data sequence.
During the union declaration, the compiler automatically allocates the memory area sufficient to store
the largest type (by volume) in the variable union. The same syntax is used for accessing the union
element as for the structures – point operator.
union LongDouble
{
long long_value;
double double_value;
};
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//---
LongDouble lb;
//--- get and display the invalid -nan(ind) number
lb.double_value=MathArcsin(2.0);
printf("1. double=%f integer=%I64X",lb.double_value,lb.long_value);
//--- largest normalized value (DBL_MAX)
lb.long_value=0x7FEFFFFFFFFFFFFF;
printf("2. double=%.16e integer=%I64X",lb.double_value,lb.long_value);
//--- smallest positive normalized (DBL_MIN)
lb.long_value=0x0010000000000000;
printf("3. double=%.16e integer=%.16I64X",lb.double_value,lb.long_value);
}
/* Execution result
1. double=-nan(ind) integer=FFF8000000000000
2. double=1.7976931348623157e+308 integer=7FEFFFFFFFFFFFFF
3. double=2.2250738585072014e-308 integer=0010000000000000
*/
S incethe unions allow the program to interpret the same memory data in different ways, they are
often used when an unusual type conversion is required.
The unions cannot be involved in the inheritance, and they also cannot have static members due to
their very nature. In all other aspects, the union behaves like a structure with all its members having a
zero offset. The following types cannot be the union members :
· dynamic arrays
· strings
· pointers to objects and functions
· class objects
· structure objects having constructors or destructors
· structure objects having members from the points 1-5
S imilarto classes, the union is capable of having constructors and destructors, as well as methods. By
default, the union members are of public access type. In order to create private elements, use the
private keyword. All these possibilities are displayed in the example illustrating how to convert a color
of the color type to ARGB as does the ColorToARGB() function.
//+------------------------------------------------------------------+
//| Union for color(BGR) conversion to ARGB |
//+------------------------------------------------------------------+
union ARGB
{
uchar argb[4];
color clr;
//--- constructors
ARGB(color col,uchar a=0){Color(col,a);};
~ARGB(){};
//--- public methods
public:
uchar Alpha(){return(argb[3]);};
void Alpha(const uchar alpha){argb[3]=alpha;};
color Color(){ return(color(clr));};
//--- private methods
private:
//+------------------------------------------------------------------+
//| set the alpha channel value and color |
//+------------------------------------------------------------------+
void Color(color col,uchar alpha)
{
//--- set color to clr member
clr=col;
//--- set the Alpha component value - opacity level
argb[3]=alpha;
//--- interchange the bytes of R and B components (Red and Blue)
uchar t=argb[0];argb[0]=argb[2];argb[2]=t;
};
};
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- 0x55 means 55/255=21.6 % (0% - fully transparent)
uchar alpha=0x55;
//--- color type is represented as 0x00BBGGRR
color test_color=clrDarkOrange;
//--- values of bytes from the ARGB union are accepted here
uchar argb[];
PrintFormat("0x%.8X - here is how the 'color' type look like for %s, BGR=(%s)",
test_color,ColorToString(test_color,true),ColorToString(test_color));
//--- ARGB type is represented as 0x00RRGGBB, RR and BB components are swapped
ARGB argb_color(test_color);
//--- copy the bytes array
ArrayCopy(argb,argb_color.argb);
//--- here is how it looks in ARGB representation
PrintFormat("0x%.8X - ARGB representation with the alpha channel=0x%.2x, ARGB=(%d,%d,%d,%d)",
argb_color.clr,argb_color.Alpha(),argb[3],argb[2],argb[1],argb[0]);
//--- add opacity level
argb_color.Alpha(alpha);
//--- try defining ARGB as 'color' type
Print("ARGB as color=(",argb_color.clr,") alpha channel=",argb_color.Alpha());
//--- copy the bytes array
ArrayCopy(argb,argb_color.argb);
//--- here is how it looks in ARGB representation
PrintFormat("0x%.8X - ARGB representation with the alpha channel=0x%.2x, ARGB=(%d,%d,%d,%d)",
argb_color.clr,argb_color.Alpha(),argb[3],argb[2],argb[1],argb[0]);
//--- check with the ColorToARGB() function results
PrintFormat("0x%.8X - result of ColorToARGB(%s,0x%.2x)",ColorToARGB(test_color,alpha),
ColorToString(test_color,true),alpha);
}
/* Execution result
0x00008CFF - here is how the color type looks for clrDarkOrange, BGR=(255,140,0)
0x00FF8C00 - ARGB representation with the alpha channel=0x00, ARGB=(0,255,140,0)
ARGB as color=(0,140,255) alpha channel=85
0x55FF8C00 - ARGB representation with the alpha channel=0x55, ARGB=(85,255,140,0)
0x55FF8C00 - result of ColorToARGB(clrDarkOrange,0x55)
*/
Interfaces
An interface allows determining specific functionality, which a class can then implement. In fact, an
interface is a class that cannot contain any members, and may not have a constructor and/or a
destructor. All methods declared in an interface are purely virtual, even without an explicit definition.
An interface is defined using the " interface" keyword. Example:
//--- Basic interface for describing animals
interface IAnimal
{
//--- The methods of the interface have public access by default
void Sound(); // The sound produced by the animal
};
//+------------------------------------------------------------------+
//| The CCat class is inherited from the IAnimal interface |
//+------------------------------------------------------------------+
class CCat : public IAnimal
{
public:
CCat() { Print("Cat was born"); }
~CCat() { Print("Cat is dead"); }
//--- Implementing the Sound method of the IAnimal interface
void Sound(){ Print("meou"); }
};
//+------------------------------------------------------------------+
//| The CDog class is inherited from the IAnimal interface |
//+------------------------------------------------------------------+
class CDog : public IAnimal
{
public:
CDog() { Print("Dog was born"); }
~CDog() { Print("Dog is dead"); }
//--- Implementing the Sound method of the IAnimal interface
void Sound(){ Print("guaf"); }
};
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- An array of pointers to objects of the IAnimal type
IAnimal *animals[2];
//--- Creating child classes of IAnimal and saving pointers to them into an array
animals[0]=new CCat;
animals[1]=new CDog;
//--- Calling the Sound() method of the basic IAnimal interface for each child
for(int i=0;i<ArraySize(animals);++i)
animals[i].Sound();
//--- Deleting objects
for(int i=0;i<ArraySize(animals);++i)
delete animals[i];
//--- Execution result
/*
Cat was born
Dog was born
meou
guaf
Cat is dead
Dog is dead
*/
}
Like with abstract classes, an interface object cannot be created without inheritance. An interface can
only be inherited from other interfaces and can be a parent for a class. An interface is always publicly
visible.
An interface cannot be declared within a class or structure declaration, but a pointer to the interface
can be saved in a variable of type void *. Generally speaking, a pointer to an object of any class can be
saved into a variable of type void *. In order to convert a void * pointer to a pointer to an object of a
particular class, use the dynamic_cast operator. If conversion is not possible, the result of the
dynamic_cast operation will be NULL.
See also
Object-Oriented Programming
Maximum 4-dimension array can be declared. W hen declaring a dynamic array (an array of unspecified
value in the first pair of s quare brackets), the compiler automatically creates a variable of the above
structure (a dynamic array object) and provides a code for the correct initialization.
Dynamic arrays are automatically freed when going beyond the visibility area of the block they are
declared in.
Example:
Static Arrays
W hen all significant array dimensions are explicitly specified, the compiler pre-allocates the necessary
memory size. S uch an array is called static. Nevertheless, the compiler allocates additional memory for
the object of a dynamic array, which (object) is associated with the pre-allocated static buffer
(memory part for storing the array).
Creating a dynamic array object is due to the possible need to pass this static array as a parameter to
some function.
Examples:
Arrays in Structures
W hen a static array is declared as a member of a structure, a dynamic array object is not created.
This is done to ensure compatibility of data structures used in the W indows API.
H owever, static arrays that are declared as members of structures can also be passed to MQL5
functions. In this case, when passing the parameter, a temporary object of a dynamic array will be
created. S uch an object is linked with the static array - member of structure.
See also
Array Functions, Initialization of Variables, Visibility S cope and Lifetime of Variables, Creating and
Deleting Objects
obtained by means of certain transformations. In practice, normal forms that have additional
properties, such as for example stability, are used.
The use of vectors and matrices, or rather, of special methods of the relevant types, enables the
creation of simpler, briefer and clearer code, which is close to mathematical notation. W ith these
methods, you can avoid the need to create nested loops or to mind correct indexing of arrays in
calculations. Therefore, the use of these methods increases reliability and speed in developing
complex programs.
Analogous method
Method matrix/vector Description
in NumPy
Analogous method
Method matrix/vector Description
in NumPy
Analogous method
Method matrix/vector Description
in NumPy
bool matrix.Eig(matrix&
Compute the eigenvalues and right
eigen_vectors, vector& eig
eigenvectors of a s quare matrix
eigen_values)
bool matrix.EigH(matrix&
R eturn the eigenvalues and
eigen_vectors, vector& eigh
eigenvectors of a Hermitian matrix
eigen_values)
bool matrix.EigVals(vector& Compute the eigenvalues of a
eigvals
eigen_values) general matrix
bool matrix.EigVals H(vector& Compute the eigenvalues of a
eigvalsh
eigen_values) H ermitian matrix
Analogous method
Method matrix/vector Description
in NumPy
Analogous method
Method matrix/vector Description
in NumPy
Analogous method
Method matrix/vector Description
in NumPy
Typecasting
Casting Numeric Types
Often a necessity occurs to convert one numeric type into another. Not all numeric types can be
converted into another. Here is the scheme of allowed casting:
S olidlines with arrows indicate changes that are performed almost without any loss of information.
Instead of the char type, the bool type can be used (both take 1 byte of memory), instead of type int,
the color type can be used (4 bytes), instead of the long type, datetime can be used (take 8 bytes).
The four dashed grey lines, also arrowed, denote conversions, when the loss of precision can occur.
For example, the number of digits in an integer equal to 123456789 (int) is higher than the number of
digits that can be represented by float.
int n=123456789;
float f=n; // the content of f is equal to 1.234567892E8
Print("n = ",n," f = ",f);
// result n= 123456789 f= 123456792.00000
A number converted into float has the same order, but is less accurate. Conversions, contrary to black
arrows, can be performed with possible data loss. Conversions between char and uchar, short and
ushort, int and uint, long and ulong (conversions to both sides), may lead to the loss of data.
As a result of converting floating point values to integer type, the fractional part is always deleted. If
you want to round off a float to the nearest whole number (which in many cases is more useful), you
should use MathRound().
Example:
If two values are combined by a binary operator, before the operation execution the operand of a
lower type is converted to the higher type in accordance with the priority given in the below scheme:
The data types char, uchar, short, and ushort unconditionally are converted to the int type.
Examples:
char c1=3;
//--- First example
double d2=c1/2+0.3;
Print("c1/2 + 0.3 = ",d2);
// Result: c1/2+0.3 = 1.3
The calculated expression consists of two operations. In the first example, the variable c1 of the char
type is converted to a temporary variable of the int type, because the second operand in the division
operation, the constant 2, is of the higher type int. As a result of the integer division 3/2 we get the
value 1, which is of the int type.
In the second operation of the first example, the second operand is the constant 0.3, which is of the
double type, so the result of the first operation is converted into a temporary variable of the double
type with a value of 1.0.
In the second example the variable of the char type c1 is converted to a temporary variable of the
double type, because the second operand in the division operation, the constant 2.0, is of the double
type; no further conversions are made.
In the expressions of the MQL5 language both explicit and implicit typecasting can be used. The
explicit typecasting is written as follows :
var_1 = (type)var_2;
An expression or function execution result can be used as the var_2 variable. The function style
notation of the explicit typecasting is also possible:
var_1 = type(var_2);
Before the division operation is performed, the c1 variable is explicitly cast to the double type. Now
the integer constant 2 is cast to the value 2.0 of the double type, because as a result of converting the
first operand has taken the double type. In fact, the explicit typecasting is a unary operation.
Besides, when trying to cast types, the result may go beyond the permissible range. In this case, the
truncation occurs. For example:
char c;
uchar u;
c=400;
u=400;
Print("c = ",c); // Result c=-112
Print("u = ",u); // Result u=144
Beforeoperations (except for the assignment ones) are performed, the data are converted into the
maximum priority type. Before assignment operations are performed, the data are cast into the target
type.
Examples:
double x=1/2; // the expression of the int type is cast to the double target typr,
Print("x = 1/2; ",x); // the result is 0.0
W hen converting long/ulong type into double, precision may be lost in case the integer value is
greater than 9223372036854774784 or less than -9223372036854774784.
void OnStart()
{
long l_max=LONG_MAX;
long l_min=LONG_MIN+1;
//--- define the highest integer value, which does not lose accuracy when being cast to double
while(l_max!=long((double)l_max))
l_max--;
//--- define the lowest integer value, which does not lose accuracy when being cast to double
while(l_min!=long((double)l_min))
l_min++;
//--- derive the found interval for integer values
The string type has the highest priority among simple types. Therefore, if one of operands of an
operation is of the string type, the second operand will be cast to a string automatically. Note that for
a string, a single dyadic two-place operation of addition is possible. The explicit casting of string to
any numeric type is allowed.
Examples:
string str1="true";
string str2="0,255,0";
string str3="2009.06.01";
string str4="1.2345e2";
Print(bool(str1));
Print(color(str2));
Print(datetime(str3));
Print(double(str4));
Objects of the open generated class can also be viewed as objects of the corresponding base class.
This leads to some interesting consequences. For example, despite the fact that objects of different
classes, generated by a single base class, may differ significantly from each other, we can create a
linked list (List) of them, as we view them as objects of the base type. But the converse is not true:
the base class objects are not automatically objects of a derived class.
You can use the explicit casting to convert the base class pointers to the pointers of a derived class.
But you must be fully confident in the admissibility of such a transformation, because otherwise a
critical runtime error will occur and the mql5 program will be stopped.
Dynamic typecasting is performed using dynamic_cast operator that can be applied only to pointers to
classes. Type validation is performed at runtime. This means that the compiler does not check the
data type applied for typecasting when dynamic_cast operator is used. If a pointer is converted to a
data type which is not the actual type of an object, the result is NULL.
dynamic_cast <type-id> ( expression )
The type-id parameter in angle brackets should point to a previously defined class type. Unlike C++,
expression operand type can be of any value except for void.
Example:
class CBar { };
class CFoo : public CBar { };
void OnStart()
{
CBar bar;
//--- dynamic casting of *bar pointer type to *foo pointer is allowed
CFoo *foo = dynamic_cast<CFoo *>(&bar); // no critical error
Print(foo); // foo=NULL
//--- an attempt to explicitly cast a Bar type object reference to a Foo type object is forbidden
foo=(CFoo *)&bar; // critical runtime error
Print(foo); // this string is not executed
}
See also
Data Types
//--- If the string is not initialized, then assign our predefined value to it
if(some_string==NULL) some_string="empty";
Also NULL can be compared to pointers to objects created with the new operator.
See also
Variables, Functions
User-defined types
The typedef keyword in C++ allows creating user-defined data types. To do this, simply specify a new
data type name for an already existing data type. The new data type is not created. A new name for
the existing type is defined instead. User-defined types make applications more flexible: sometimes,
it is enough to change typedef instructions using substitution macros (#define). User-defined types
also improve code readability since it is possible to apply custom names to standard data types using
typedef. The general format of the entry for creating a user-defined type:
typedef type new_name;
H ere,type means any acceptable data type, while new_name is a new name of the type. A new name
is set only as an addition (not as a replacement) to an existing type name. MQL5 allows creating
pointers to functions using typedef.
where after typedef, the function signature (number and type of input parameters, as well as a type of
a result returned by the function) is set. Below is a simple example of creating and applying a pointer
to a function:
//--- declare a pointer to a function that accepts two int parameters
typedef int (*TFunc)(int,int);
//--- TFunc is a type, and it is possible to declare the variable pointer to the function
TFunc func_ptr; // pointer to the function
//--- declare the functions corresponding to the TFunc description
int sub(int x,int y) { return(x-y); } // subtract one number from another
int add(int x,int y) { return(x+y); } // addition of two numbers
int neg(int x) { return(~x); } // invert bits in the variable
//--- the func_ptr variable may store the function address to declare it later
func_ptr=sub;
Print(func_ptr(10,5));
func_ptr=add;
Print(func_ptr(10,5));
func_ptr=neg; // error: neg does not have int (int,int) type
Print(func_ptr(10)); // error: two parameters needed
In this example, the func_ptr variable may receive the sub and add functions since they have two
inputs each of int type as defined in the TFunc pointer to the function. On the contrary, the neg
function cannot be assigned to the func_ptr pointer since its signature is different.
Pointers to functions allow you to easily create processing of events when creating a user interface.
Let's use an example from the CButton section to show how to create buttons and add the functions for
handling pressing to them. First, define a pointer to the TAction function to be called by pressing the
button and create three functions according to the TAction description.
Then, create the MyButton class from CButton, where we should add the TAction pointer to the
function.
//+------------------------------------------------------------------+
//| Create the button class with the events processing function |
//+------------------------------------------------------------------+
class MyButton: public CButton
{
private:
TAction m_action; // chart events handler
public:
MyButton(void){}
~MyButton(void){}
//--- constructor specifying the button text and the pointer to the events handling function
MyButton(string text, TAction act)
{
Text(text);
m_action=act;
}
//--- set the custom function called from the OnEvent() events handler
void SetAction(TAction act){m_action=act;}
Create the CControls Dialog derivative class from CAppDialog, add the m_buttons array to it for storing
the buttons of the MyButton type, as well as the AddButton(MyButton &button) and CreateButtons()
methods.
//+------------------------------------------------------------------+
//| CControlsDialog class |
//| Objective: graphical panel for managing the application |
//+------------------------------------------------------------------+
class CControlsDialog : public CAppDialog
{
private:
CArrayObj m_buttons; // button array
public:
CControlsDialog(void){};
~CControlsDialog(void){};
//--- create
virtual bool Create(const long chart,const string name,const int subwin,const int x1,const
//--- add the button
bool AddButton(MyButton &button){return(m_buttons.Add(GetPointer(button)));m_button
protected:
//--- create the buttons
bool CreateButtons(void);
};
//+------------------------------------------------------------------+
//| Create the CControlsDialog object on the chart |
//+------------------------------------------------------------------+
bool CControlsDialog::Create(const long chart,const string name,const int subwin,const int x1,const
{
if(!CAppDialog::Create(chart,name,subwin,x1,y1,x2,y2))
return(false);
return(CreateButtons());
//---
}
//+------------------------------------------------------------------+
//| defines |
//+------------------------------------------------------------------+
//--- indents and gaps
#define INDENT_LEFT (11) // indent from left (with allowance for borde
#define INDENT_TOP (11) // indent from top (with allowance for border
#define CONTROLS_GAP_X (5) // gap by X coordinate
#define CONTROLS_GAP_Y (5) // gap by Y coordinate
//--- for buttons
#define BUTTON_WIDTH (100) // size by X coordinate
#define BUTTON_HEIGHT (20) // size by Y coordinate
//--- for the indication area
#define EDIT_HEIGHT (20) // size by Y coordinate
//+------------------------------------------------------------------+
//| Create and add buttons to the CControlsDialog panel |
//+------------------------------------------------------------------+
bool CControlsDialog::CreateButtons(void)
{
//--- calculate buttons coordinates
int x1=INDENT_LEFT;
int y1=INDENT_TOP+(EDIT_HEIGHT+CONTROLS_GAP_Y);
int x2;
int y2=y1+BUTTON_HEIGHT;
//--- add buttons objects together with pointers to functions
AddButton(new MyButton("Open",Open));
AddButton(new MyButton("Save",Save));
AddButton(new MyButton("Close",Close));
//--- create the buttons graphically
for(int i=0;i<m_buttons.Total();i++)
{
MyButton *b=(MyButton*)m_buttons.At(i);
x1=INDENT_LEFT+i*(BUTTON_WIDTH+CONTROLS_GAP_X);
x2=x1+BUTTON_WIDTH;
if(!b.Create(m_chart_id,m_name+"bt"+b.Text(),m_subwin,x1,y1,x2,y2))
{
PrintFormat("Failed to create button %s %d",b.Text(),i);
return(false);
}
//--- add each button to the CControlsDialog container
if(!Add(b))
return(false);
}
//--- succeed
return(true);
}
Now, we can develop the program using the CControls Dialog control panel having 3 buttons : Open,
S ave and Close. W hen click ing a button, the appropriate function in the form of the TAction pointer is
called.
//--- declare the object on the global level to automatically create it when launching the program
CControlsDialog MyDialog;
//+------------------------------------------------------------------+
//| Expert initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- now, create the object on the chart
if(!MyDialog.Create(0,"Controls",0,40,40,380,344))
return(INIT_FAILED);
//--- launch the application
MyDialog.Run();
//--- application successfully initialized
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Expert deinitialization function |
//+------------------------------------------------------------------+
void OnDeinit(const int reason)
{
//--- destroy dialog
MyDialog.Destroy(reason);
}
//+------------------------------------------------------------------+
//| Expert chart event function |
//+------------------------------------------------------------------+
void OnChartEvent(const int id, // event ID
const long& lparam, // event parameter of the long type
const double& dparam, // event parameter of the double type
const string& sparam) // event parameter of the string type
{
//--- call the handler from the parent class (here it is CAppDialog) for the chart events
MyDialog.ChartEvent(id,lparam,dparam,sparam);
}
The launched application's appearance and button clicking results are provided on the screenshot.
}
//+------------------------------------------------------------------+
//| Expert chart event function |
//+------------------------------------------------------------------+
void OnChartEvent(const int id, // event ID
const long& lparam, // event parameter of the long type
const double& dparam, // event parameter of the double type
const string& sparam) // event parameter of the string type
{
//--- call the handler from the parent class (here it is CAppDialog) for the chart events
MyDialog.ChartEvent(id,lparam,dparam,sparam);
}
See also
Variables, Functions
Object Pointers
MQL5 enables the dynamic creation of complex type objects. This is done by using the ‘new’
operatorwhich returns a descriptor of the created object. The descriptor size is 8 bytes. S yntactically,
object descriptors in MQL5 are similar to C++ pointers.
Example:
Unlik eC++, the ‘hobject’ variable from the example above is not a pointer to memory, but is an
object descriptor. Furthermore, in MQL5, all objects in function parameters must be passed by
reference. The examples below show the passing of objects as function parameters :
class Foo
{
public:
string m_name;
int m_id;
static int s_counter;
//--- constructors and destructors
Foo(void){Setup("noname");};
Foo(string name){Setup(name);};
~Foo(void){};
//--- initialize the Foo object
void Setup(string name)
{
m_name=name;
s_counter++;
m_id=s_counter;
}
};
int Foo::s_counter=0;
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- declare the object as a variable, with automatic creation
Foo foo1;
//--- variant of passing an object by reference
PrintObject(foo1);
//--- declare a pointer to an object and create it using the 'new' operator
Foo *foo2=new Foo("foo2");
//--- variant of passing a pointer to an object by reference
PrintObject(foo2); // the pointer to the object is converted by the compiler automatically
An attempt to access an invalid pointer causes the critical shutdown of the program. The CheckPointer
function is utilized to check a pointer before use. The pointer can be invalid in the following cases :
· the pointer is equal to NULL;
· the object was destroyed using the delete operator.
This function can be used to validate of a pointer. A non-zero value indicates that data can be
accessed at this pointer.
class CMyObject
{
protected:
double m_value;
public:
CMyObject(void);
CMyObject(double value) {m_value=value;};
~CMyObject(void){};
//---
double Value(void) {return(m_value);}
};
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- create a non-initialized object
CMyObject *pointer;
if(CheckPointer(pointer)==POINTER_INVALID)
Print("1. pointer is ", EnumToString(CheckPointer(pointer)));
else
Print("1. pointer.Value()=", pointer.Value());
*/
To quickly validate the pointer, you can also use operator "!" (LNOT) which checks it via an implicit call
of the CheckPointer function. This allows a more concise and clear code writing. Below are the checks
from the previous example:
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- create a non-initialized object
CMyObject *pointer;
if(!pointer)
Print("1. pointer is ", EnumToString(CheckPointer(pointer)));
else
Print("1. pointer.Value()=", pointer.Value());
Operator "==" is used for a quick check for NULL. For example: ptr==NULL or ptr!=NULL.
See also
Variables, Initialization of Variables, Visibility S cope and Lifetime of Variables, Creating and
Deleting Objects
class CDemoClass
{
private:
double m_array[];
public:
void setArray(double &array[]);
};
//+------------------------------------------------------------------+
//| filling the array |
//+------------------------------------------------------------------+
void CDemoClass::setArray(double &array[])
{
if(ArraySize(array)>0)
{
ArrayResize(m_array,ArraySize(array));
ArrayCopy(m_array, array);
}
}
In the above example class CDemoClass is declared, which contains the private member - array
m_array[] of double type. Function setArray() is declared, to which array[] is passed by reference. If
the function header doesn't contain the indication about passing by reference, i.e. doesn't contain the
ampersand character, an error message will be generated at the attempt to compile such a code.
Despite the fact that the array is
passed by reference, we can't assign one array to another. W e need
to perform the element-wise copying of contents of the source array to the recipient array. The
presence of & in the function description is the obligatory condition for arrays and structures when
passed as the function parameter.
Keyword this
A variable of class type (object) can be passed both by reference and by pointer. As well as reference,
the pointer allows having access to an object. After the object pointer is declared, the new operator
should be applied to it to create and initialize it.
The reserved word this is intended for obtaining the reference of the object to itself, which is
available inside class or structure methods. this always references to the object, in the method of
which it is used, and the expression GetPointer(this) gives the pointer of the object, whose member is
the function, in which call of GetPointer() is performed. In MQL5 functions can't return objects, but
they can return the object pointer.
Thus, if we need a function to return an object, we can return the pointer of this object in the form of
GetPointer(this). Let's add function getDemoClass() that returns pointer of the object of this class,
into the description of CDemoClass.
class CDemoClass
{
private:
double m_array[];
public:
void setArray(double &array[]);
CDemoClass *getDemoClass();
};
//+------------------------------------------------------------------+
//| filling the array |
//+------------------------------------------------------------------+
void CDemoClass::setArray(double &array[])
{
if(ArraySize(array)>0)
{
ArrayResize(m_array,ArraySize(array));
ArrayCopy(m_array,array);
}
}
//+------------------------------------------------------------------+
//| returns its own pointer |
//+------------------------------------------------------------------+
CDemoClass *CDemoClass::getDemoClass(void)
{
return(GetPointer(this));
}
S tructures don't have pointers, operators new and delete can't be applied to them, GetPointer(this)
can't be used.
See also
Object Pointers, Creating and Deleting Objects, Visibility S cope and Lifetime of Variables
Operation symbols are used in expressions and have sense when appropriate operands are given to
them. Punctuation marks are emphasized, as well. These are parentheses, braces, comma, colon, and
semicolon.
Operation symbols, punctuation marks, and spaces are used to separate language elements from each
other.
This section contains the description of the following topics :
· Expressions
· Arithmetic Operations
· Assignment Operations
· Operations of Relation
· Boolean Operations
· Bitwise Operations
· Other Operations
· Priorities and Operations Order
Expressions
An expression consists of one or more operands and operation symbols. An expression can be written
in several lines.
Examples:
Arithmetic Operations
Arithmetic operations include additive and multiplicative operations :
Sum of variables i = j + 2;
Difference of variables i = j - 3;
Changing the sign x = - x;
Product of variables z = 3 * x;
Division quotient i = j / 5;
Remainder of division minutes = time % 60;
Adding 1 to the variable value i++;
Adding 1 to the variable value ++i;
Subtracting 1 from the variable value k--;
Subtracting 1 from the variable value --k;
Increment and decrement operations are applied only to variables, they can't be applied to constants.
The prefix increment (++i) and decrement (--k) are applied to the variable right before this variable is
used in an expression.
Post-increment (i++) and post-decrement (k--) are applied to the variable right after this variable is
used in an expression.
Important Notice
int i=5;
int k = i++ + ++i;
Computational problems may occur while moving the above expression from one programming
environment to another one (for example, from Borland C++ to MQL5). In general, the order of
computations depends on the compiler implementation. In practice, there are two ways to implement
the post-decrement (post-increment):
1. The post-decrement (post-increment) is applied to the variable after calculating the whole
expression.
2. The post-decrement (post-increment) is applied to the variable immediately at the operation.
Currently the first way of post-decrement (post-increment) calculation is implemented in MQL5. But
even knowing this peculiarity, it is not recommended to experiment with its use.
Examples:
int a=3;
a++; // valid expression
int b=(a++)*3; // invalid expression
See also
Precedence Rules
Assignment Operations
The value of the expression that includes the given operation is the value of the left operand after
assignment:
Assigning the value of x to the y variable y = x;
The following operations unite arithmetic or bitwise operations with operation of assignment:
Adding x to the y variable y += x;
Subtracting x from the y variable y -= x;
Multiplying the y variable by x y *= x;
Dividing the y variable by x y /= x;
Reminder of division of the y variable by x y %= x;
Shift of the binary representation of y to the right by x bits y >>= x;
Shift of the binary representation of y to the left by x bits y <<= x;
AND bitwise operation of binary representations of y and x y &= x;
OR bitwise operation of binary representations of y and x y |= x;
Excluding OR bitwise operation of binary representations of y and x y ^= x;
Bitwise operations can be applied to integers only. W hen performing the operation of the logical shift
of the y representation to the right/left by x bits, the 5 smallest binary digits of the x value are used,
the highest ones are dropped, i.e. the shift is made to 0-31 bits.
By %= operation (y value by module of x), the result sign is equal to the sign of divided number.
The assignment operator can be used several times in an expression . In this case the processing of
the expression is performed from left to right:
y=x=3;
First, the variable x will be assigned the value 3, then the y variable will be assigned the value of x,
i.e. also 3.
See also
Precedence Rules
Operations of Relation
Boolean FAL SE is represented with an integer zero value, while the boolean TRUE is represented by any
non-zero value.
The value of expressions containing operations of relation or logical operations is FAL SE (0) or TRUE
(1).
True if a is equal to b a == b;
True if a is not equal to b a != b;
True if a is less than b a < b;
True if a is greater than b a > b;
True if a is less than or equal to b a <= b;
True if a is greater than or equal to b a >= b;
The equality of two real numbers can't be compared. In most cases, two seemingly identical numbers
can be unequal because of different values in the 15th decimal place. In order to correctly compare two
real numbers, compare the normalized difference of these numbers with zero.
Example:
See also
Precedence Rules
Boolean Operations
Logical Negation NOT (!)
Operand of the logical negation (!) must be of arithmetic type. The result is TRUE (1), if the operand
value is FALSE (0); and it is equal to FALSE (0), if the operand differs from FALSE (0).
if(!a) Print("not 'a'");
Logical OR operation (||) of x and y values. The expression value is TRUE (1), if x or y value is true
(not null). Otherwise - FALSE (0).
if(x<0 || x>=max_bars) Print("out of range");
Logical operation AND (&&) of x and y values. The expression value is TRUE (1), if the values of x and
y are true (not null). Otherwise - FALSE (0).
The scheme of the so called " brief estimate" is applied to boolean operations, i.e. the calculation of
the expression is terminated when the result of the expression can be precisely estimated.
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- the first example of the brief estimate
if(func_false() && func_true())
{
Print("Operation &&: You will never see this expression");
}
else
{
Print("Operation &&: Result of the first expression is false, so the second wasn't calculated
}
//--- the second example of the brief estimate
if(!func_false() || !func_true())
{
Print("Operation ||: Result of the first expression is true, so the second wasn't calculated"
}
else
{
Print("Operation ||: You will never see this expression");
}
}
//+------------------------------------------------------------------+
See also
Precedence Rules
Bitwise Operations
Complement to One
Complement of the variable value up to one. The value of the expression contains 1 in all digits where
the variable value contains 0, and 0 in all digits where the variable contains 1.
b = ~n;
Example:
char a='a',b;
b=~a;
Print("a = ",a, " b = ",b);
// The result will be:
// a = 97 b = -98
Right Shift
The binary representation of x is shifted to the right by y digits. If the value to shift is of the unsigned
type, the logical right shift is made, i.e. the freed left-side bits will be filled with zeroes.
If the value to shift is of a sign type, the arithmetic right shift is made, i.e. the freed left-side digits
will be filled with the value of a sign bit (if the number is positive, the value of the sign bit is 0; if the
number is negative, the value of the sign bit is 1).
x = x >> y;
Example:
char a='a',b='b';
Print("Before: a = ",a, " b = ",b);
//--- shift to the right
b=a>>1;
Print("After: a = ",a, " b = ",b);
// The result will be:
// Before: a = 97 b = 98
// After: a = 97 b = 48
Left Shift
The binary representation of x is shifted to the left by y digits, the freed right-side digits are filled
with zeros.
x = x << y;
Example:
char a='a',b='b';
Print("Before: a = ",a, " b = ",b);
//--- shift to the left
b=a<<1;
Print("After: a = ",a, " b = ",b);
It is not recommended to shift by the number of bits larger or equal to the length of the variable
shifted, because the result of such an operation is undefined.
The bitwise AND operation of binary-coded x and y representations. The value of the expression
contains a 1 (TRUE) in all digits where both x and y contain non-zero, and it contains 0 (FALSE) in all
other digits.
b = ((x & y) != 0);
Example:
char a='a',b='b';
//--- AND operation
char c=a&b;
Print("a = ",a," b = ",b);
Print("a & b = ",c);
// The result will be:
// a = 97 b = 98
// a & b = 96
Bitwise OR Operation
The bitwise OR operation of binary representations of x and y. The value of the expression contains 1
in all digits where x or y does not contain 0, and it contains 0 in all other digits.
b = x | y;
Example:
char a='a',b='b';
//--- OR operation
char c=a|b;
Print("a = ",a," b = ",b);
Print("a | b = ",c);
// The result will be:
// a = 97 b = 98
// a | b = 99
The bitwise exclusive OR (eXclusive OR) operation of binary representations of x and y. The value of
the expression contains a 1 in all digits where x and y have different binary values, and it contains 0 in
all other digits.
b = x ^ y;
Example:
Other operations
Indexing ( [] )
W hen addressing the i-th element of the array, the expression value is the value of a variable with the
serial number i.
Example:
Only an integer can be index of an array. Four-dimensional and below arrays are allowed. Each
dimension is indexed from 0 to dimension size-1. In particular case, for a one-dimensional array
consisting of 50 elements, the reference to the first element will look like array [0], that to the last
element will be array [49].
W hen addressing beyond the array, the executing subsystem will generate a critical error, and the
program will be stopped.
int length=1000000;
string a="a",b="b",c;
//---Other Operations
int start=GetTickCount(),stop;
long i;
for(i=0;i<length;i++)
{
c=a+b;
}
stop=GetTickCount();
Print("time for 'c = a + b' = ",(stop-start)," milliseconds, i = ",i);
Comma Operation ( , )
Expressions separated by commas are executed from left to right. All side effects of the left
expression calculation can appear before the right expression is calculated. The result type and value
coincide with those of the right expression. The list of parameters to be passed (see above) can be
considered as an example.
Example:
Dot Operator ( . )
For the direct access to the public members of structures and classes the dot operation is used.
S yntax :
Variable_name_of_structure_type.Member_name
Example:
struct SessionTime
{
string sessionName;
int startHour;
int startMinutes;
int endHour;
int endMinutes;
} st;
st.sessionName="Asian";
st.startHour=0;
st.startMinutes=0;
st.endHour=9;
st.endMinutes=0;
If there is no scope name, this is the explicit direction to use the global scope. If there is no scope
resolution operation, the function is sought in the nearest scope. If there is no function in the local
scope, the search is conducted in the global scope.
The scope resolution operation is also used to define function-class member.
type Class_name::Function_name(parameters_description)
{
// function body
}
Use ofseveral functions of the same name from different execution contexts in a program may cause
ambiguity. The priority order of function calls without explicit scope specification is the following:
1. Class methods. If no function with the specified name is set in the class, move to the next level.
2. MQL5 functions. If the language does not have such a function, move to the next level.
3. User defined global functions. If no function with the specified name is found, move to the next
level.
4. Imported functions. If no function with the specified name is found, the compiler returns an error.
To avoid the ambiguity of function calls, always explicitly specify the function scope using the scope
resolution operation.
Example:
#property script_show_inputs
#import "kernel32.dll"
int GetLastError(void);
#import
class CCheckContext
{
int m_id;
public:
CCheckContext() { m_id=1234; }
protected:
int GetLastError() { return(m_id); }
};
class CCheckContext2 : public CCheckContext
{
int m_id2;
public:
CCheckContext2() { m_id2=5678; }
void Print();
protected:
int GetLastError() { return(m_id2); }
};
void CCheckContext2::Print()
{
::Print("Terminal GetLastError",::GetLastError());
::Print("kernel32 GetLastError",kernel32::GetLastError());
::Print("parent GetLastError",CCheckContext::GetLastError());
::Print("our GetLastError",GetLastError());
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//---
CCheckContext2 test;
test.Print();
}
//+------------------------------------------------------------------+
sizeof(expression)
Any identifier, or type name enclosed in brackets can be used as an expression. Note that the void
type name can't be used, and the identifier cannot belong to the field of bits, or be a function name.
If the expression is the name of a static array (i.e. the first dimension is given), then the result is the
size of the whole array (i.e. the product of the number of elements and the length of the type). If the
expression is the name of a dynamic array (the first dimension is not specified), the result will be the
size of the object of the dynamic array.
W hen sizeof is applied to the name of structure or class type, or to the identifier of the structure or
class type, the result is the actual size of the structure or class.
Example:
struct myStruct
{
char h;
int b;
double f;
} str;
Print("sizeof(str) = ",sizeof(str));
Print("sizeof(myStruct) = ",sizeof(myStruct));
Precedence Rules
Each group of operations in the table has the same priority. The higher the priority of operations is,
the higher it is position of the group in the table. The precedence rules determine the grouping of
operations and operands.
Attention: Precedence of operations in the MQL5 language corresponds to the priority adopted in C++,
and differs from the priority given in the MQL4 language.
To change the operation execution order, parenthesis that are of higher priority are used.
Operators
Language operators describe some algorithmic operations that must be executed to accomplish a tas k.
The program body is a sequence of such operators. Operators following one by one are separated by
semicolons.
Operator Description
Compound operator {} One or more operators of any type, enclosed in curly braces {}
Expression operator (;) Any expression that ends with a semicolon (;)
return operator Terminates the current function and returns control to the calling
program
if-else conditional operator Is used when it's necessary to make a choice
?: conditional operator A simple analog of the if-else conditional operator
switch selection operator Passes control to the operator, which corresponds to the
expression value
while loop operator Performs an operator until the expression checked becomes false.
The expression is checked before each iteration
for loop operator Performs an operator until the expression checked becomes false.
The expression is checked before each iteration
do-while loop operator Performs an operator until the expression checked becomes false.
The end condition is checked, after each loop. The loop body is
always executed at least once.
break operator Terminates the execution of the nearest attached external
operator switch, while, do-while or for
continue operator Passes control to the beginning of the nearest external loop
operator while, do-while or for
new operator Creates an object of the appropriate size and returns a descriptor
of the created object.
delete operator Deletes the object created by the new operator
One operator can occupy one or more lines. Two or more operators can be located in the same line.
Operators that control over the execution order (if, if-else, switch, while and for), can be nested into
each other.
Example:
if(Month() == 12)
if(Day() == 31) Print("Happy New Year!");
See also
Initialization of Variables, Visibility S cope and Lifetime of Variables, Creating and Deleting Objects
Compound Operator
A compound operator (a block) consists of one or more operators of any type, enclosed in braces {}.
The closing brace must not be followed by a semicolon (;).
Example:
if(x==0)
{
Print("invalid position x = ",x);
return;
}
See also
Initialization of Variables, Visibility S cope and Lifetime of Variables, Creating and Deleting Objects
Expression Operator
Any expression followed by a semicolon (;) is the operator. Here are some examples of expression
operators.
Assignment Operator
Identifier = expression;
x=3;
y=x=3;
bool equal=(x==y);
Assignment operator can be used many times in an expression. In this case, the expression is
processed from right to left.
Empty Operator
Consists only of a semicolon (;) and is used to denote an empty body of a control operator.
See also
Initialization of Variables, Visibility S cope and Lifetime of Variables, Creating and Deleting Objects
Return Operator
The return operator terminates the current function execution and returns control to the calling
program. The expression calculation result is returned to the calling function. The expression can
contain an assignment operator.
Example:
In functions with the void return type, the return operator without expression must be used:
void SomeFunction()
{
Print("Hello!");
return; // this operator can be removed
}
The right brace of the function means implicit execution of the return operator without expression.
W hat can be returned: simple types, simple structures, object pointers. W ith the return operator you
can't return any arrays, class objects, variables of compound structure type.
See also
Initialization of Variables, Visibility S cope and Lifetime of Variables, Creating and Deleting Objects
If the expression is true, operator1 is executed and control is given to the operator that follows
operator2 (operator2 is not executed). If the expression is false, operator2 is executed.
The else part of the if operator can be omitted. Thus, a divergence may appear in nested if operators
with omitted else part. In this case, else addresses to the nearest previous if operator in the same
block that has no else part.
Examples:
See also
Initialization of Variables, Visibility S cope and Lifetime of Variables, Creating and Deleting Objects
Ternary Operator ?:
The general form of the ternary operator is as follows :
expression1 ? expression2 : expression3
For the first operand - " expression1" - any expression that results in a bool type value can be used. If
the result is true, then the operator set by the second operand, i.e. " expression2" is executed.
If the first operand is false, the third operand - " expression3" is performed. The second and third
operands, i.e. " expression2" and " expression3" should return values of one type and should not be of
void type. The result of the conditional operator execution is the result of expression2 or result of the
expression3, depending on the result of expression1.
//--- normalize difference between open and close prices for a day range
double true_range = (High==Low)?0:(Close-Open)/(High-Low);
Be careful when using the conditional operator as an argument of an overloaded function, because the
type of the result of a conditional operator is defined at the time of program compilation. And this
type is determined as the larger of the types " expression2" and " expression3" .
Example:
bool Expression1=true;
double Expression2=M_PI;
string Expression3="3.1415926";
void OnStart()
{
func(Expression2);
func(Expression3);
// Result:
// double argument: 3.141592653589793
// string argument: 3.1415926
// string argument: 3.141592653589793
// string argument: 3.1415926
See also
Initialization of Variables, Visibility S cope and Lifetime of Variables, Creating and Deleting Objects
Switch Operator
Compares the expression value with constants in all the case variants and passes control to the
operator that corresponds to the expression value. Each variant of case can be marked with an integer
constant, a literal constant or a constant expression. The constant expression can't contain variables
or function calls. Expression of the switch operator must be of integer type – int or uint.
switch(expression)
{
case constant: operators
case constant: operators
...
default: operators
}
Operators marked by the default label are executed if none of the constants in case operators is equal
to the expression value. The default variant should not be necessarily declared and should not be
necessarily the last one. If none of the constants corresponds to the expression value and the default
variant is not available, no actions are executed.
The case keyword with a constant are just labels, and if operators are executed for some case variant,
the program will further execute the operators of all subsequent variants until the break operator
occurs. It allows to bind a sequence of operators with several variants.
A constant expression is calculated during compilation. No two constants in one switch operator can
have the same value.
Examples:
default:
res="default";break;
case 2:
res=i;break;
case 3:
res=i;break;
}
Print(res);
/*
Result
default
*/
See also
Initialization of Variables, Visibility S cope and Lifetime of Variables, Creating and Deleting Objects
If the expression is true, the operator is executed until the expression becomes false. If the
expression is false, the control is passed to the next operator. The expression value is defined before
the operator is executed. Therefore, if the expression is false from the very beginning, the operator
will not be executed at all.
Note
If it is expected that a large number of iterations will be handled in a loop, it is advisable that you
check the fact of forced program termination using the Is S topped() function.
Example:
See also
Initialization of Variables, Visibility S cope and Lifetime of Variables, Creating and Deleting Objects
Expression1 describes the loop initialization. Expression2 checks the conditions of the loop
termination. If it is true, the loop body for is executed. The loop repeats expression2 until it becomes
false. If it is false, the loop is terminated, and control is given to the next operator. Expression3 is
calculated after each iteration.
The for operator is equivalent to the following succession of operators :
expression1;
while(expression2)
{
operator;
expression3;
};
Any of the three or all three expressions can be absent in the for operator, but the semicolons (;) that
separate them must not be omitted. If expression2 is omitted, it is considered constantly true. The
for(;;) operator is a continuous loop, equivalent to the while(1) operator. Each expression 1 or 3 can
consist of several expressions combined by a comma operator ','.
Note
If it is expected that a large number of iterations will be handled in a loop, it is advisable that you
check the fact of forced program termination using the Is S topped() function.
Examples:
for(x=1;x<=7000; x++)
{
if(IsStopped())
break;
Print(MathPower(x,2));
}
//--- Another example
for(;!IsStopped();)
{
Print(MathPower(x,2));
x++;
if(x>10) break;
}
//--- Third example
for(i=0,j=n-l;i<n && !IsStopped();i++,j--) a[i]=a[j];
See also
Initialization of Variables, Visibility S cope and Lifetime of Variables, Creating and Deleting Objects
Firstthe operator is executed, then the expression is calculated. If it is true, then the operator is
executed again, and so on. If the expression becomes false, the loop terminates.
Note
If it is expected that a large number of iterations will be handled in a loop, it is advisable that you
check the fact of forced program termination using the Is S topped() function.
Example:
See also
Initialization of Variables, Visibility S cope and Lifetime of Variables, Creating and Deleting Objects
Break Operator
The break operator terminates the execution of the nearest nested outward switch, while, do-while or
for operator. The control is passed to the operator that follows the terminated one. One of the
purposes of this operator is to finish the looping execution when a certain value is assigned to a
variable.
Example:
See also
Initialization of Variables, Visibility S cope and Lifetime of Variables, Creating and Deleting Objects
Continue Operator
The continue operator passes control to the beginning of the nearest outward loop while, do-while or
for operator, the next iteration being called. The purpose of this operator is opposite to that of break
operator.
Example:
See also
Initialization of Variables, Visibility S cope and Lifetime of Variables, Creating and Deleting Objects
//+------------------------------------------------------------------+
//| Figure creation |
//+------------------------------------------------------------------+
void CTetrisField::NewShape()
{
m_ypos=HORZ_BORDER;
//--- randomly create one of the 7 possible shapes
int nshape=rand()%7;
switch(nshape)
{
case 0: m_shape=new CTetrisShape1; break;
case 1: m_shape=new CTetrisShape2; break;
case 2: m_shape=new CTetrisShape3; break;
case 3: m_shape=new CTetrisShape4; break;
case 4: m_shape=new CTetrisShape5; break;
case 5: m_shape=new CTetrisShape6; break;
case 6: m_shape=new CTetrisShape7; break;
}
//--- draw
if(m_shape!=NULL)
{
//--- pre-settings
m_shape.SetRightBorder(WIDTH_IN_PIXELS+VERT_BORDER);
m_shape.SetYPos(m_ypos);
m_shape.SetXPos(VERT_BORDER+SHAPE_SIZE*8);
//--- draw
m_shape.Draw();
}
//---
}
See also
Initialization of Variables, Visibility S cope and Lifetime of Variables, Creating and Deleting Objects
Functions
Every tas k can be divided into subtas ks, each of which can either be directly represented in the form
of a code, or divided into smaller sub-tas ks. This method is called stepwise refinement. Functions are
used for writing the code of sub-tas ks to be solved. The code that describes what a function does is
called function definition:
function_header
{
instructions
}
All that is
before the first brace is the header of the function definition, and what is between braces is
the body of the function definition. The function header includes a description of the return value
type, name (identifier) and formal parameters. The number of parameters passed to the function is
limited and cannot exceed 64.
The function can be called from other parts of the program as many times as necessary. In fact, the
return type, function identifier and parameter types constitute the function prototype.
Function prototype is the function declaration, but not its definition. Due to the explicit declaration of
the return type and a list of argument types, the strict type checking and implicit typecasting are
possible during function calls. Very often function declarations are used in classes to improve the code
readability.
The function definition must exactly match its declaration. Each declared function must be defined.
Example:
The return operator can return the value of an expression located in this operator. If necessary, the
expression value is converted to the function result type. W hat can be returned: simple types, simple
structures, object pointers. W ith the return operator you can't return any arrays, class objects,
variables of compound structure type.
A function that returns no value should be described as that of void type.
Example:
void errmesg(string s)
{
Print("error: "+s);
}
Parameters passed to the function can have default values, which are defined by constants of that
type.
Example:
int somefunc(double a,
double d=0.0001,
int n=5,
bool b=true,
string s="passed string")
{
Print("Required parameter a = ",a);
Print("Pass the following parameters: d = ",d," n = ",n," b = ",b," s = ",s);
return(0);
}
If any of parameters has a default value, all subsequent parameters must also have default values.
Example of incorrect declaration:
int somefunc(double a,
double d=0.0001, // default value 0.0001 declared
int n, // default value is not specified !
bool b, // default value is not specified !
string s="passed string")
{
}
See also
Overload, Virtual Functions, Polymorphism
Function Call
If a name that has not been described before, appears in the expression and is followed by the left
parenthesis, it is contextually considered as the name of a function.
function_name (x1, x2,..., xn)
Arguments (formal parameters) are passed by value, i.e. each expression x1,..., xn is calculated, and
the value is passed to the function. The order of expressions calculation and the order of values
loading are not guaranteed. During the execution, the system checks the number and type of
arguments passed to the function. S uch way of addressing to the function is called a value call.
Function call is an expression, the value of which is the value returned by the function. The function
type described above must correspond with the type of the return value. The function can be declared
or described in any part of the program on the global scope, i.e., outside other functions. The function
cannot be declared or described inside of another function.
Examples:
int start()
{
double some_array[4]={0.3, 1.4, 2.5, 3.6};
double a=linfunc(some_array, 10.5, 8);
//...
}
double linfunc(double x[], double a, double b)
{
return (a*x[0] + b);
}
At calling of a function with default parameters, the list of parameters to be passed can be limited,
but not before the first default parameter.
Examples:
W hen calling a function, one may not s kip parameters, even those having default values :
somefunc(3.14, , 10); // Wrong call -> the second parameter was skipped.
See also
Overload, Virtual Functions, Polymorphism
Passing Parameters
There are two methods, by which the machine language can pass arguments to a subprogram
(function). The first method is to send a parameter by value. This method copies the argument value
into a formal function parameter. Therefore, any changes in this parameter within the function have
no influence on the corresponding call argument.
//+------------------------------------------------------------------+
//| Passing parameters by value |
//+------------------------------------------------------------------+
double FirstMethod(int i,int j)
{
double res;
//---
i*=2;
j/=2;
res=i+j;
//---
return(res);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//---
int a=14,b=8;
Print("a and b before call:",a," ",b);
double d=FirstMethod(a,b);
Print("a and b after call:",a," ",b);
}
//--- Result of script execution
// a and b before call: 14 8
// a and b after call: 14 8
The second method is to pass by reference. In this case, reference to a parameter (not its value) is
passed to a function parameter. Inside the function, it is used to refer to the actual parameter
specified in the call. This means that the parameter changes will affect the argument used to call the
function.
//+------------------------------------------------------------------+
//| Passing parameters by reference |
//+------------------------------------------------------------------+
double SecondMethod(int &i,int &j)
{
double res;
//---
i*=2;
j/=2;
res=i+j;
//---
return(res);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//---
int a=14,b=8;
Print("a and b before call:",a," ",b);
double d=SecondMethod(a,b);
Print("a and b after call:",a," ",b);
}
//+------------------------------------------------------------------+
//--- result of script execution
// a and b before call: 14 8
// a and b after call: 28 4
MQL5 uses both methods, with one exception: arrays, structure type variables and class objects are
always passed by reference. In order to avoid changes in actual parameters (arguments passed at
function call) use the access specifier const. W hen trying to change the contents of a variable declared
with the const specifier, the compiler will generate an error.
Note
It should be noted that parameters are passed to a function in reversed order, i.e., first the last
parameter is calculated and passed, and then the last but one, etc. The last calculated and passed
parameter is the one that stands first after opening parenthesis.
Example:
void OnStart()
{
//---
int a[]={0,1,2};
int i=0;
}
//+------------------------------------------------------------------+
//| |
//+------------------------------------------------------------------+
void func(int par1,int par2,string comment)
{
In first call (see example above) the i variable is first used in strings concatenation:
"First call (i = "+string(i)+")"
H ere its value doesn't change. Then the i variable is used in calculation of the a[i++] array element,
i.e. when array element with index i is accessed, the i variable is incremented. And only after that the
first parameter with changed value of i variable is calculated.
In the second call the same value of i (calculated on the first phase of function calling) is used when
calculating all three parameters. Only after the first parameters is calculated the i variable is changed
again.
See also
Visibility S cope and Lifetime of Variables, Overload, Virtual Functions, Polymorphism
Function Overloading
Usually the function name tends to reflect its main purpose. As a rule, readable programs contain
various well selected identifiers. S ometimes different functions are used for the same purposes. Let's
consider, for example, a function that calculates the average value of an array of double precision
numbers and the same function, but operating with an array of integers. Both are convenient to be
called AverageFromArray:
//+------------------------------------------------------------------+
//| The calculation of average for an array of double type |
//+------------------------------------------------------------------+
double AverageFromArray(const double & array[],int size)
{
if(size<=0) return 0.0;
double sum=0.0;
double aver;
//---
for(int i=0;i<size;i++)
{
sum+=array[i]; // Summation for the double
}
aver=sum/size; // Just divide the sum by the number
//---
Print("Calculation of the average for an array of double type");
return aver;
}
//+------------------------------------------------------------------+
//| The calculation of average for an array of int type |
//+------------------------------------------------------------------+
double AverageFromArray(const int & array[],int size)
{
if(size<=0) return 0.0;
double aver=0.0;
int sum=0;
//---
for(int i=0;i<size;i++)
{
sum+=array[i]; // Summation for the int
}
aver=(double)sum/size;// Give the amount of type double, and divide
//---
Print("Calculation of the average for an array of int type");
return aver;
}
Each function contains the message output via the Print() function;
Print("Calculation of the average for an array of int type");
The compiler selects a necessary function in accordance with the types of arguments and their
quantity. The rule, according to which the choice is made, is called the signature matching algorithm.
A signature is a list of types used in the function declaration.
Example:
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//---
int a[5]={1,2,3,4,5};
double b[5]={1.1,2.2,3.3,4.4,5.5};
double int_aver=AverageFromArray(a,5);
double double_aver=AverageFromArray(b,5);
Print("int_aver = ",int_aver," double_aver = ",double_aver);
}
//--- Result of the script
// Calculate the average for an array of int type
// Calculate the average for an array of double type
// int_aver= 3.00000000 double_aver= 3.30000000
Function overloading is a process of creating several functions with the same name, but different
parameters. This means that in overloaded variants of a function, the number of arguments and/or
their type must be different. A specific function variant is selected based on the correspondence of
the list of arguments when calling the function, to the list of parameters in the function declaration.
W hen an overloaded function is called, the compiler must have an algorithm to select the appropriate
function. The algorithm that performs this choice depends on castings of what types are present. The
best correspondence must be unique. An overloaded function must be the best match among all the
other variants for at least one argument. At the same time it must match for all other arguments not
worse than other variants.
Below is a matching algorithm for each argument.
The standard type increase is better than other standard conversions. Increase is the conversion of
float to double, of bool, char, short or enum to int. Typecasting of arrays of similar integer types also
belongs to typecasting. S imilar types are: bool, char, uchar, since all the three types are single-byte
integers ; double-byte integers short and ushort; 4-byte integers int, uint, and color; long, ulong, and
datetime.
Of course, the strict matching is the best. To achieve such a consistency typecasting can be used. The
compiler cannot cope with ambiguous situations. Therefore you should not rely on subtle differences of
types and implicit conversions that make the overloaded function unclear.
Overloading of system functions is allowed, but it should be observed that the compiler is able to
accurately select the necessary function. For example, we can overload the system function MathMax()
in 4 different ways, but only two variants are correct.
Example:
// 1. overload is allowed - function differs from built-in MathMax() function in the number of para
double MathMax(double a,double b,double c);
See also
Overload, Virtual Functions, Polymorphism
Operation Overloading
For ease of code reading and writing, overloading of some operations is allowed. Overloading operator
is written using the keyword operator. The following operators can be overloaded:
· binary +,-,/,*,%,<<,>>,==,!=,<,>,<=,>=,=,+=,-=,/=,*=,%=,&=,|=,^=,<<=,>>=,&&,||,&,|,^
· unary +,-,++,--,!,~
· assignment operator =
· indexing operator []
Operation overloading allows the use of the operating notation (written in the form of simple
expressions) for complex objects - structures and classes. W riting expressions using overloaded
operations simplifies the view of the source code, because a more complex implementation is hidden.
For example, consider complex numbers, which consist of real and imaginary parts. They are widely
used in mathematics. The MQL5 language has no data type to represent complex numbers, but it is
possible to create a new data type in the form of a structure or class. Declare the complex structure
and define four methods that implement four arithmetic operations :
//+------------------------------------------------------------------+
//| A structure for operations with complex numbers |
//+------------------------------------------------------------------+
struct complex
{
double re; // Real part
double im; // Imaginary part
//--- Constructors
complex():re(0.0),im(0.0) { }
complex(const double r):re(r),im(0.0) { }
complex(const double r,const double i):re(r),im(i) { }
complex(const complex &o):re(o.re),im(o.im) { }
//--- Arithmetic operations
complex Add(const complex &l,const complex &r) const; // Addition
complex Sub(const complex &l,const complex &r) const; // Subtraction
complex Mul(const complex &l,const complex &r) const; // Multiplication
complex Div(const complex &l,const complex &r) const; // Division
};
Now, in our code we can declare variables representing complex numbers, and work with them.
For example:
void OnStart()
{
//--- Declare and initialize variables of a complex type
complex a(2,4),b(-4,-2);
PrintFormat("a=%.2f+i*%.2f, b=%.2f+i*%.2f",a.re,a.im,b.re,b.im);
//--- Sum up two numbers
complex z;
z=a.Add(a,b);
PrintFormat("a+b=%.2f+i*%.2f",z.re,z.im);
//--- Multiply two numbers
z=a.Mul(a,b);
PrintFormat("a*b=%.2f+i*%.2f",z.re,z.im);
//--- Divide two numbers
z=a.Div(a,b);
PrintFormat("a/b=%.2f+i*%.2f",z.re,z.im);
//---
}
But it would be more convenient to use usual operators " +" , " -" , "*" and "/" for ordinary arithmetic
operations with complex numbers.
Keyword operator is used for defining a member function that performs type conversion. Unary and
binary operations for class object variables can be overloaded as non-static member functions. They
implicitly act on the class object.
Most binary operations can be overloaded like regular functions that take one or both arguments as a
class variable or a pointer to an object of this class. For our type complex, overloading in the
declaration will look like this :
//--- Operators
complex operator+(const complex &r) const { return(Add(this,r)); }
complex operator-(const complex &r) const { return(Sub(this,r)); }
complex operator*(const complex &r) const { return(Mul(this,r)); }
complex operator/(const complex &r) const { return(Div(this,r)); }
z=a*b;
PrintFormat("a*b=%.2f+i*%.2f",z.re,z.im);
//--- Divide two numbers
z=a/b;
PrintFormat("a/b=%.2f+i*%.2f",z.re,z.im);
//---
}
//+------------------------------------------------------------------+
//| A structure for operations with complex numbers |
//+------------------------------------------------------------------+
struct complex
{
double re; // Real part
double im; // Imaginary part
//--- Constructors
complex():re(0.0),im(0.0) { }
complex(const double r):re(r),im(0.0) { }
complex(const double r,const double i):re(r),im(i) { }
complex(const complex &o):re(o.re),im(o.im) { }
//--- Arithmetic operations
complex Add(const complex &l,const complex &r) const; // Addition
complex Sub(const complex &l,const complex &r) const; // Subtraction
complex Mul(const complex &l,const complex &r) const; // Multiplication
complex Div(const complex &l,const complex &r) const; // Division
//--- Binary operators
complex operator+(const complex &r) const { return(Add(this,r)); }
complex operator-(const complex &r) const { return(Sub(this,r)); }
complex operator*(const complex &r) const { return(Mul(this,r)); }
complex operator/(const complex &r) const { return(Div(this,r)); }
};
//+------------------------------------------------------------------+
//| Addition |
//+------------------------------------------------------------------+
complex complex::Add(const complex &l,const complex &r) const
{
complex res;
//---
res.re=l.re+r.re;
res.im=l.im+r.im;
//--- Result
return res;
}
//+------------------------------------------------------------------+
//| Subtraction |
//+------------------------------------------------------------------+
complex complex::Sub(const complex &l,const complex &r) const
{
complex res;
//---
res.re=l.re-r.re;
res.im=l.im-r.im;
//--- Result
return res;
}
//+------------------------------------------------------------------+
//| Multiplication |
//+------------------------------------------------------------------+
complex complex::Mul(const complex &l,const complex &r) const
{
complex res;
//---
res.re=l.re*r.re-l.im*r.im;
res.im=l.re*r.im+l.im*r.re;
//--- Result
return res;
}
//+------------------------------------------------------------------+
//| Division |
//+------------------------------------------------------------------+
complex complex::Div(const complex &l,const complex &r) const
{
//--- Empty complex number
complex res(EMPTY_VALUE,EMPTY_VALUE);
//--- Check for zero
if(r.re==0 && r.im==0)
{
Print(__FUNCTION__+": number is zero");
return(res);
}
//--- Auxiliary variables
double e;
double f;
//--- Selecting calculation variant
if(MathAbs(r.im)<MathAbs(r.re))
{
e = r.im/r.re;
f = r.re+r.im*e;
res.re=(l.re+l.im*e)/f;
res.im=(l.im-l.re*e)/f;
}
else
{
e = r.re/r.im;
f = r.im+r.re*e;
res.re=(l.im+l.re*e)/f;
res.im=(-l.re+l.im*e)/f;
}
//--- Result
return res;
}
Most unary operations for classes can be overloaded as ordinary functions that accept a single class
object argument or a pointer to it. Add overloading of unary operations " -" and "!" .
//+------------------------------------------------------------------+
//| A structure for operations with complex numbers |
//+------------------------------------------------------------------+
struct complex
{
double re; // Real part
double im; // Imaginary part
...
//--- Unary operators
complex operator-() const; // Unary minus
bool operator!() const; // Negation
};
...
//+------------------------------------------------------------------+
//| Overloading the "unary minus" operator |
//+------------------------------------------------------------------+
complex complex::operator-() const
{
complex res;
//---
res.re=-re;
res.im=-im;
//--- Result
return res;
}
//+------------------------------------------------------------------+
//| Overloading the "logical negation" operator |
//+------------------------------------------------------------------+
bool complex::operator!() const
{
//--- Are the real and imaginary parts of the complex number equal to zero?
return (re!=0 && im!=0);
}
Now we can check the value of a complex number for zero and get a negative value:
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- Declare and initialize variables of type complex
complex a(2,4),b(-4,-2);
PrintFormat("a=%.2f+i*%.2f, b=%.2f+i*%.2f",a.re,a.im,b.re,b.im);
//--- Divide the two numbers
complex z=a/b;
PrintFormat("a/b=%.2f+i*%.2f",z.re,z.im);
//--- A complex number is equal to zero by default (in the default constructor re==0 and im==0)
complex zero;
Print("!zero=",!zero);
//--- Assign a negative value
zero=-z;
PrintFormat("z=%.2f+i*%.2f, zero=%.2f+i*%.2f",z.re,z.im, zero.re,zero.im);
PrintFormat("-zero=%.2f+i*%.2f",-zero.re,-zero.im);
//--- Check for zero once again
Print("!zero=",!zero);
//---
}
Note that we did not have to overload the assignment operator "=" , as structures of simple types can
be directly copied one into each other. Thus, we can now write a code for calculations involving
complex numbers in the usual manner.
Overloading of the indexing operator allows to obtain the values of the arrays enclosed in an object, in
a simple and familiar way, and it also contributes to a better readability of the source code. For
example, we need to provide access to a symbol in the string at the specified position. A string in
MQL5 is a separate type string, which is not an array of symbols, but with the help of an overloaded
indexing operation we can provide a simple and transparent work in the generated CS tring class :
//+------------------------------------------------------------------+
//| Class to access symbols in string as in array of symbols |
//+------------------------------------------------------------------+
class CString
{
string m_string;
public:
CString(string str=NULL):m_string(str) { }
ushort operator[] (int x) { return(StringGetCharacter(m_string,x)); }
};
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- An array for receiving symbols from a string
int x[]={ 19,4,18,19,27,14,15,4,17,0,19,14,17,27,26,28,27,5,14,
17,27,2,11,0,18,18,27,29,30,19,17,8,13,6 };
CString str("abcdefghijklmnopqrstuvwxyz[ ]CS");
string res;
//--- Make up a phrase using symbols from the str variable
for(int i=0,n=ArraySize(x);i<n;i++)
{
res+=ShortToString(str[x[i]]);
}
Another example of overloading of the indexing operation is operations with matrices. The matrix
represents a two-dimensional dynamic array, the array size is not defined in advance. Therefore, you
cannot declare an array of form array[][] without specifying the size of the second dimension, and
then pass this array as a parameter. A possible solution is a special class CMatrix, which contains an
array of CRow class objects.
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- Operations of addition and multiplication of matrices
CMatrix A(3),B(3),C();
//--- Prepare an array for rows
double a1[3]={1,2,3}, a2[3]={2,3,1}, a3[3]={3,1,2};
double b1[3]={3,2,1}, b2[3]={1,3,2}, b3[3]={2,1,3};
//--- Fill the matrices
A[0]=a1; A[1]=a2; A[2]=a3;
B[0]=b1; B[1]=b2; B[2]=b3;
//--- Output the matrices in the Experts log
Print("---- Elements of matrix A");
Print(A.String());
Print("---- Elements of matrix B");
Print(B.String());
//--- Now we show how to get values in the style of dynamic arrays matrix[i][j]
Print("Output the values of matrix C elementwise");
//--- Go through the matrix rows - CRow objects - in a loop
for(int i=0;i<3;i++)
{
string com="| ";
//--- Form rows from the matrix for the value
for(int j=0;j<3;j++)
{
//--- Get the matrix element by the number of the row and column
double element=C[i][j];// [i] - Access to CRow in the array m_rows[] ,
// [j] - Overloaded operator of indexing in CRow
com=com+StringFormat("a(%d,%d)=%G ; ",i,j,element);
}
com+="|";
//--- Output the values of the row
Print(com);
}
}
//+------------------------------------------------------------------+
//| Class "Row" |
//+------------------------------------------------------------------+
class CRow
{
private:
double m_array[];
public:
//--- Constructors and a destructor
CRow(void) { ArrayResize(m_array,0); }
CRow(const CRow &r) { this=r; }
CRow(const double &array[]);
~CRow(void){};
//--- Number of elements in the row
int Size(void) const { return(ArraySize(m_array));}
//--- Returns a string with values
string String(void) const;
//--- Indexing operator
double operator[](int i) const { return(m_array[i]); }
//--- Assignment operators
void operator=(const double &array[]); // An array
void operator=(const CRow & r); // Another CRow object
double operator*(const CRow &o); // CRow object for multiplication
};
//+------------------------------------------------------------------+
//| Constructor for initializing a row with an array |
//+------------------------------------------------------------------+
void CRow::CRow(const double &array[])
{
int size=ArraySize(array);
//--- If the array is not empty
if(size>0)
{
ArrayResize(m_array,size);
//--- Fill with values
for(int i=0;i<size;i++)
m_array[i]=array[i];
}
//---
}
//+------------------------------------------------------------------+
//| Assignment operation for the array |
//+------------------------------------------------------------------+
void CRow::operator=(const double &array[])
{
int size=ArraySize(array);
if(size==0) return;
//--- Fill the array with values
ArrayResize(m_array,size);
for(int i=0;i<size;i++) m_array[i]=array[i];
//---
}
//+------------------------------------------------------------------+
//| Assignment operation for CRow |
//+------------------------------------------------------------------+
void CRow::operator=(const CRow &r)
{
int size=r.Size();
if(size==0) return;
//--- Fill the array with values
ArrayResize(m_array,size);
for(int i=0;i<size;i++) m_array[i]=r[i];
//---
}
//+------------------------------------------------------------------+
//| Operator of multiplication by another row |
//+------------------------------------------------------------------+
double CRow::operator*(const CRow &o)
{
double res=0;
//--- Verifications
int size=Size();
if(size!=o.Size() || size==0)
{
Print(__FUNCSIG__,": Failed to multiply two matrices, their sizes are different");
return(res);
}
//--- Multiply arrays elementwise and add the products
for(int i=0;i<size;i++)
res+=m_array[i]*o[i];
//--- Result
return(res);
}
//+------------------------------------------------------------------+
//| Returns a formatted string representation |
//+------------------------------------------------------------------+
string CRow::String(void) const
{
string out="";
//--- If the size of the array is greater than zero
int size=ArraySize(m_array);
//--- We work only with a non-zero number of array elements
if(size>0)
{
out="{";
for(int i=0;i<size;i++)
{
//--- Collect the values to a string
out+=StringFormat(" %G;",m_array[i]);
}
out+=" }";
}
//--- Result
return(out);
}
//+------------------------------------------------------------------+
//| Class "Matrix" |
//+------------------------------------------------------------------+
class CMatrix
{
private:
CRow m_rows[];
public:
//--- Constructors and a destructor
CMatrix(void);
CMatrix(int rows) { ArrayResize(m_rows,rows); }
~CMatrix(void){};
//--- Get the matrix sizes
int Rows() const { return(ArraySize(m_rows)); }
int Cols() const { return(Rows()>0? m_rows[0].Size():0); }
//--- Returns the value of the column in the form of a CRow row
CRow GetColumnAsRow(const int col_index) const;
//--- Returns a string with the matrix values
string String(void) const;
//--- The indexing operator returns a string by its number
CRow *operator[](int i) const { return(GetPointer(m_rows[i])); }
//--- Addition operator
CMatrix operator+(const CMatrix &m);
//--- Multiplication operator
CMatrix operator*(const CMatrix &m);
//--- Assignment operator
CMatrix *operator=(const CMatrix &m);
};
//+------------------------------------------------------------------+
//| A default constructor, create an array of rows of zero size |
//+------------------------------------------------------------------+
CMatrix::CMatrix(void)
{
//--- The zero number of rows in the matrix
ArrayResize(m_rows,0);
//---
}
//+------------------------------------------------------------------+
//| Returns the column value in the form of CRow |
//+------------------------------------------------------------------+
CRow CMatrix::GetColumnAsRow(const int col_index) const
{
//--- A variable to get the values from the column
CRow row();
//--- The number of rows in the matrix
int rows=Rows();
//--- If the number of rows is greater than zero, execute the operation
if(rows>0)
{
//--- An array to receive the values of the column with index col_index
double array[];
ArrayResize(array,rows);
//--- Filling the array
for(int i=0;i<rows;i++)
{
//--- Check the number of the column for row i - it may exceed the boundaries of the array
if(col_index>=this[i].Size())
{
Print(__FUNCSIG__,": Error! Column number ",col_index,"> row size ",i);
break; // row will be uninitialized object
}
array[i]=this[i][col_index];
}
//--- Create a CRow row based on the array values
row=array;
}
//--- Result
return(row);
}
//+------------------------------------------------------------------+
//| Addition of two matrices |
//+------------------------------------------------------------------+
CMatrix CMatrix::operator+(const CMatrix &m)
{
//--- The number of rows and columns in the passed matrix
int cols=m.Cols();
int rows=m.Rows();
//--- The matrix to receive the addition results
CMatrix res(rows);
//--- The sizes of the matrix must match
if(cols!=Cols() || rows!=Rows())
{
//--- Addition impossible
Print(__FUNCSIG__,": Failed to add two matrices, their sizes are different");
return(res);
}
//--- Auxiliary array
double arr[];
ArrayResize(arr,cols);
//--- Go through rows to add
for(int i=0;i<rows;i++)
{
//--- Write the results of addition of matrix strings in the array
for(int k=0;k<cols;k++)
{
arr[k]=this[i][k]+m[i][k];
}
//--- Place the array to the matrix row
res[i]=arr;
}
//--- return the result of addition of matrices
return(res);
}
//+------------------------------------------------------------------+
//| Multiplication of two matrices |
//+------------------------------------------------------------------+
CMatrix CMatrix::operator*(const CMatrix &m)
{
//--- Number of columns of the first matrix, number of rows passed in the matrix
int cols1=Cols();
int rows2=m.Rows();
int rows1=Rows();
int cols2=m.Cols();
//--- Matrix to receive the addition result
CMatrix res(rows1);
//--- Matrices should be coordinated
if(cols1!=rows2)
{
//--- Multiplication impossible
Print(__FUNCSIG__,": Failed to multiply two matrices, format is not compatible "
"- number of columns in the first factor should be equal to the number of rows in the s
return(res);
}
//--- Auxiliary array
double arr[];
ArrayResize(arr,cols1);
//--- Fill the rows in the multiplication matrix
for(int i=0;i<rows1;i++)// Go through rows
{
See also
Overloading, Arithmetic Operations, Function Overloading, Precedence Rules
#import "user32.dll"
int MessageBoxW(int hWnd ,string szText,string szCaption,int nType);
int SendMessageW(int hWnd,int Msg,int wParam,int lParam);
#import "lib.ex5"
double round(double value);
#import
W ith the help of import, it is easy to describe functions that are called from external DLL or compiled
EX5 libraries. EX5 libraries are compiled ex5 files, which have the library property. Only function
described with the export modifier can be imported from EX5 libraries.
Please keep in mind that DLL and EX5 libraries should have different names (regardless of the
directories they are located in) if they are imported together. All imported functions have the scope
resolution corresponding to the library's " file name" .
Example:
#import "kernel32.dll"
int GetLastError();
#import "lib.ex5"
int GetLastError();
#import
class CFoo
{
public:
int GetLastError() { return(12345); }
void func()
{
Print(GetLastError()); // call of the class method
Print(::GetLastError()); // call of the MQL5 function
Print(kernel32::GetLastError()); // call of the DLL library function from kernel32.dll
Print(lib::GetLastError()); // call of the EX5 library function from lib.ex5
}
};
void OnStart()
{
CFoo foo;
foo.func();
}
See also
Overload, Virtual Functions, Polymorphism
Exporting Functions
A function declared in a mql5 program with the export postmodifier can be used in another mql5
program. S uch a function is called exportable, and it can be called from other programs after
compilation.
int Function() export
{
}
This modifier orders the compiler to add the function into the table of EX5 functions exported by this
ex5 file. Only function with such a modifier are accessible (" visible" ) from other mql5 programs.
The library property tells the compiler that the EX5-file will be a library, and the compiler will show it in
the header of EX5.
All functions that are planned as exportable ones must be marked with the export modifier.
See also
Overload, Virtual Functions, Polymorphism
OnStart
The OnS tart() function is the S tart event handler, which is automatically generated only for running
scripts. It must be of void type, with no parameters :
void OnStart();
For the OnS tart() function, the int return type can be specified.
OnInit
The OnInit() function is the Init event handler. It must be of void or int type, with no parameters :
void OnInit();
The Init event is generated immediately after an Expert Advisor or an indicator is downloaded; this
event is not generated for scripts. The OnInit() function is used for initialization. If OnInit() has the
int type of the return value, the non-zero return code means unsuccessful initialization, and it
generates the Deinit event with the code of deinitialization reason REAS ON_INITFAILED.
To optimize input parameters of an Expert Advisor, it is recommended to use values of the
ENUM _INIT _RETCODE enumeration as the return code. These values are used for organizing the course
of optimization, including the selection of the most appropriate testing agents. During initialization of
an Expert Advisor before the start of testing you can request information about the configuration and
resources of an agent (the number of cores, amount of free memory, etc.) using the
TerminalInfoInteger() function. Based on the information obtained, you can either allow to use this
testing agent, or reject using it during the optimization of this Expert Advisor.
ENUM_INIT_RETCODE
Identifier Description
Identifier Description
INIT_PARAM ETERS_INCORRECT This value means the incorrect set of input parameters. The
result string containing this return code is highlighted in red in
the general optimization table.
Testing for the given set of parameters of the Expert Advisor
will not be executed, the agent is free to receive a new tas k.
Upon receiving this value, the strategy tester will reliably not
pass this tas k to other agents for retry.
INIT_AGENT_NOT_SUITABLE No errors during initialization, but for some reason the agent is
not suitable for testing. For example, not enough memory, no
OpenCL support, etc.
After the return of this code, the agent will not receive tas k s
until the end of this optimization.
The OnInit() function of the void type always denotes successful initialization.
OnDeinit
The OnDeinit() function is called during deinitialization and is the Deinit event handler. It must be
declared as the void type and should have one parameter of the const int type, which contains the
code of deinitialization reason. If a different type is declared, the compiler will generate a warning,
but the function will not be called. For scripts the Deinit event is not generated and therefore the
OnDeinit() function can't be used in scripts.
void OnDeinit(const int reason);
The Deinit event is generated for Expert Advisors and indicators in the following cases :
· before reinitialization due to the change of a symbol or chart period, to which the mql5 program is
attached;
· before reinitialization due to the change of input parameters ;
· before unloading the mql5 program.
OnTick
The NewTick event is generated for Expert Advisors only when a new tick for a symbol is received, to
the chart of which the Expert Advisor is attached. It's useless to define the OnTick() function in a
custom indicator or script, because the NewTick event is not generated for them.
The Tick event is generated only for Expert Advisors, but this does not mean that Expert Advisors
required the OnTick() function, since not only NewTick events are generated for Expert Advisors, but
also events of Timer, BookEvent and ChartEvent are generated. It must be declared as the void type,
with no parameters :
void OnTick();
OnTimer
The OnTimer() function is called when the Timer event occurs, which is generated by the system timer
only for Expert Advisors and indicators - it can't be used in scripts. The frequency of the event
occurrence is set when subscribing to notifications about this event to be received by the
EventS etTimer() function.
You can unsubscribe from receiving timer events for a particular Expert Advisor using the
EventKillTimer() function. The function must be defined with the void type, with no parameters :
void OnTimer();
It is recommended to call the EventS etTimer() function once in the OnInit() function, and the
EventKillTimer() function should be called once in OnDeinit().
Every Expert Advisor, as well as every indicator work s with its own timer and receives events only
from it. As soon as the mql5 program stops operating, the timer is destroyed forcibly, if it was created
but hasn't been disabled by the EventKillTimer() function.
OnTrade
The function is called when the Trade event occurs, which appears when you change the list of placed
orders and open positions, the history of orders and history of deals. W hen a trade activity is
performed (pending order opening, position opening/closing, stops setting, pending order triggering,
etc.) the history of orders and deals and/or list of positions and current orders is changed accordingly.
void OnTrade();
Users must independently implement in the code the verification of a trade account state when such
an event is received (if this is required by the trade strategy conditions). If the OrderS end() function
call has been completed successfully and returned a value of true, this means that the trading server
has put the order into the queue for execution and assigned a ticket number to it. As soon as the
server processes this order, the Trade event will be generated. And if a user remembers the ticket
value, he/she will be able to find out what happened to the order using this value during OnTrade()
event handling.
OnTradeTransaction
W hen performing some definite actions on a trade account, its state changes. S uch actions include:
· S ending a trade request from any MQL5 application in the client terminal using OrderS end and
OrderS endAsync functions and its further execution;
· S ending a trade request via the terminal graphical interface and its further execution;
· Pending orders and stop orders activation on the server;
· Performing operations on a trade server side.
The following trade transactions are performed as a result of these actions :
· handling a trade request;
· changing open orders ;
· changing orders history;
· changing deals history;
· changing positions.
For example, when sending a market buy order, it is handled, an appropriate buy order is created for
the account, the order is then executed and removed from the list of the open ones, then it is added
to the orders history, an appropriate deal is added to the history and a new position is created. All
these actions are trade transactions. Arrival of such a transaction at the terminal is a
TradeTransaction event. It calls OnTradeTransaction handler
void OnTradeTransaction(
const MqlTradeTransaction& trans, // trade transaction structure
const MqlTradeRequest& request, // request structure
const MqlTradeResult& result // result structure
);
The last two request and result parameters are filled by values only for
TRADE_TRANSACTION_REQUES T type transaction, data on transaction can be received from type
parameter of trans variable. Note that in this case, request_id field in result variable contains ID of
request trade request, after the execution of which the trade transaction described in trans variable
has been performed. Request ID allows to associate the performed action (OrderS end or
OrderS endAsync functions call) with the result of this action sent to OnTradeTransaction().
One trade request manually sent from the terminal or via OrderS end()/OrderS endAsync() functions can
generate several consecutive transactions on the trade server. Priority of these transactions ' arrival at
the terminal is not guaranteed. Thus, you should not expect that one group of transactions will arrive
after another one when developing your trading algorithm.
After applying trade transactions for a client account, they are consistently placed to the terminal
trade transactions queue, from which they consistently sent to OnTradeTransaction entry point in
order of arrival at the terminal.
W hen handling trade transactions by an Expert Advisor using OnTradeTransaction handler, the
terminal continues handling newly arrived trade transactions. Therefore, the state of a trade account
can change during OnTradeTransaction operation already. For example, while an MQL5 program
handles an event of adding a new order, it may be executed, deleted from the list of the open ones
and moved to the history. Further on, the application will be notified of these events.
Transactions queue length comprises 1024 elements. If OnTradeTransaction handles a new transaction
for too long, the old ones in the queue may be superseded by the newer ones.
· Generally, there is no accurate ratio of the number of OnTrade and OnTradeTransaction calls.
One OnTrade call corresponds to one or several OnTradeTransaction calls.
· OnTrade is called after appropriate OnTradeTransaction calls.
OnTester
The OnTester() function is the handler of the Tester event that is automatically generated after a
history testing of an Expert Advisor on the chosen interval is over. The function must be defined with
the double type, with no parameters :
double OnTester();
The function is called right before the call of OnDeinit() and has the same type of the return value -
double. OnTester() can be used only in the testing of Expert Advisors. Its main purpose is to calculate
a certain value that is used as the Custom max criterion in the genetic optimization of input
parameters.
In the genetic optimization descending sorting is applied to results within one generation. I.e. from
the point of view of the optimization criterion, the best results are those with largest values (for the
Custom max optimization criterion values returned by the OnTester function are taken into account).
In such a sorting, the worst values are positioned at the end and further thrown off and do not
participate in the forming of the next generation.
OnTesterInit
The OnTesterInit() function is the handler of the TesterInit event, which is automatically generated
before the start of Expert Advisor optimization in the strategy tester. The function must be defined
with the void type. It has no parameters :
void OnTesterInit();
W ith the start of optimization, an Expert Advisor with the OnTesterDeinit() or OnTesterPass() handler
is automatically loaded in a separate terminal chart with the symbol and period specified in the tester,
and receives the TesterInit event. The function is used for Expert Advisor initialization before the
start of optimization for further processing of optimization results.
OnTesterPass
The OnTesterPass() function is the handler of the TesterPass event, which is automatically generated
when a frame is received during Expert Advisor optimization in the strategy tester. The function must
be defined with the void type. It has no parameters :
void OnTesterPass();
An Expert Advisor with the OnTesterPass() handler is automatically loaded in a separate terminal chart
with the symbol/period specified for testing, and gets TesterPass events when a frame is received
during optimization. The function is used for dynamic handling of optimization results " on the spot"
without waiting for its completion. Frames are added using the FrameAdd() function, which can be
called after the end of a single pass in the OnTester() handler.
OnTesterDeinit
OnTesterDeinit() is the handler of the TesterDeinit event, which is automatically generated after the
end of Expert Advisor optimization in the strategy tester. The function must be defined with the void
type. It has no parameters :
void OnTesterDeinit();
An Expert Advisor with the TesterDeinit() handler is automatically loaded on a chart at the start of
optimization, and receives TesterDeinit after its completion. The function is used for final processing
of all optimization results.
OnBookEvent
The OnBookEvent() function is the BookEvent handler. BookEvent is generated for Expert Advisors and
indicators when Depth of Market changes. It must be of the void type and have one parameter of the
string type:
void OnBookEvent (const string& symbol);
To receive BookEvent events for any symbol, you just need to pre-subscribe to receive these events
for this symbol using the MarketBookAdd() function. In order to unsubscribe from receiving the
BookEvent events for a particular symbol, call Mark etBookR elease().
Unlik e other events, the BookEvent event is broadcast. This means that if one Expert Advisor
subscribes to receiving BookEvent events using MarketBookAdd, all the other Experts Advisors that
have the OnBookEvent() handler will receive this event. It is therefore necessary to analyze the name
of the symbol, which is passed to the handler as the const string& symbol parameter.
OnChartEvent
The function can be called only in Expert Advisors and indicators. The function should be of void type
with 4 parameters :
void OnChartEvent(const int id, // Event ID
const long& lparam, // Parameter of type long event
const double& dparam, // Parameter of type double event
const string& sparam // Parameter of type string events
);
For each type of event, the input parameters of the OnChartEvent() function have definite values that
are required for the processing of this event. The events and values passed through these parameters
are listed in the table below.
Mouse events (if CHARTEVENT_MO the X coordinate the Y coordinate The string value
property USE_MOVE of a bit mas k
CHART_EVENT_ describing the
MOUSE_MOVE=tr status of mouse
ue is set for the buttons
chart)
Event of CHARTEVENT_OB — — Name of the
graphical object JECT _CREAT E created graphical
creation (if object
CHART_EVENT_O
BJECT _CREAT E=t
rue is set for the
chart)
Event of change CHARTEVENT_OB — — Name of the
of an object JECT _CHANGE modified
property via the graphical object
properties dialog
Event of CHARTEVENT_OB — — Name of the
graphical object JECT _DEL ET E deleted graphical
deletion (if object
CHART_EVENT_O
BJECT _DEL ET E=t
rue is set for the
chart)
ID of the user CHARTEVENT_CU Value set by the Value set by the Value set by the
event under the S TOM+N EventChartCusto EventChartCusto EventChartCusto
N number m() function m() function m() function
OnCalculate
The OnCalculate() function is called only in custom indicators when it's necessary to calculate the
indicator values by the Calculate event. This usually happens when a new tick is received for the
symbol, for which the indicator is calculated. This indicator is not required to be attached to any price
chart of this symbol.
The OnCalculate() function must have a return type int. There are two possible definitions. W ithin one
indicator you cannot use both versions of the function.
The first form is intended for those indicators that can be calculated on a single data buffer. An
example of such an indicator is Custom Moving Average.
int OnCalculate (const int rates_total, // size of the price[] array
const int prev_calculated, // bars handled on a previous call
const int begin, // where the significant data start from
const double& price[] // array to calculate
);
As the price[] array, one of timeseries or a calculated buffer of some indicator can be passed. To
determine the direction of indexing in the price[] array, call ArrayGetAs S eries(). In order not to
depend on the default values, you must unconditionally call the ArrayS etAs S eries() function for those
arrays, that are expected to work with.
Necessary time series or an indicator to be used as the price[] array can be selected by the user in the
" Parameters " tab when starting the indicator. To do this, you should specify the necessary item in the
drop-down list of "Apply to" field.
To receive values of a custom indicator from other mql5 programs, the iCustom() function is used,
which returns the indicator handle for subsequent operations. You can also specify the appropriate
price[] array or the handle of another indicator. This parameter should be transmitted last in the list
of input variables of the custom indicator.
Example:
void OnStart()
{
//---
string terminal_path=TerminalInfoString(STATUS_TERMINAL_PATH);
int handle_customMA=iCustom(Symbol(),PERIOD_CURRENT, "Custom Moving Average",13,0, MODE_EMA,PRIC
if(handle_customMA>0)
Print("handle_customMA = ",handle_customMA);
else
Print("Cannot open or not EX5 file '"+terminal_path+"\\MQL5\\Indicators\\"+"Custom Moving Ave
}
In this example, the last parameter passed is the PRICE_TYPICAL value (from the
ENUM _APPLIED_PR ICE enumeration), which indicates that the custom indicator will be built on typical
prices obtained as (High+Low+Close)/3. If this parameter is not specified, the indicator is built based
on PRICE_CLOSE values, i.e. closing prices of each bar.
Another example that shows passing of the indicator handler as the last parameter to specify the
price[] array, is given in the description of the iCustom() function.
The second form is intended for all other indicators, in which more than one time series is used for
calculations.
int OnCalculate (const int rates_total, // size of input time series
const int prev_calculated, // bars handled in previous call
const datetime& time[], // Time
const double& open[], // Open
const double& high[], // High
const double& low[], // Low
const double& close[], // Close
const long& tick_volume[], // Tick Volume
const long& volume[], // Real Volume
const int& spread[] // Spread
);
Parameters of open[], high[], low[] and close[] contain arrays with open prices, high and low prices
and close prices of the current time frame. The time[] parameter contains an array with open time
values, the spread[] parameter has an array containing the history of spreads (if any spread is
provided for the traded security). The parameters of volume[] and tick_volume[] contain the history of
trade and tick volume, respectively.
To determine the indexing direction of time[], open[], high[], low[], close[], tick_volume[], volume[]
and spread[], call ArrayGetAs S eries(). In order not to depend on default values, you should
unconditionally call the ArrayS etAs S eries() function for those arrays, which are expected to work with.
The first rates _total parameter contains the number of bars, available to the indicator for calculation,
and corresponds to the number of bars available in the chart.
We should note the connection between the return value of OnCalculate() and the second input
parameter prev _calculated. During the function call, the prev _calculated parameter contains a value
returned by OnCalculate() during previous call. This allows for economical algorithms for calculating
the custom indicator in order to avoid repeated calculations for those bars that haven't changed since
the previous run of this function.
For this, it is usually enough to return the value of the rates _total parameter, which contains the
number of bars in the current function call. If since the last call of OnCalculate() price data has
changed (a deeper history downloaded or history blanks filled), the value of the input parameter
prev _calculated will be set to zero by the terminal.
Note: if OnCalculate returns zero, then the indicator values are not shown in the DataW indow of the
client terminal.
To understand it better, it would be useful to start the indicator, which code is attached below.
Indicator Example:
#property indicator_chart_window
#property indicator_buffers 1
#property indicator_plots 1
//---- plot Line
#property indicator_label1 "Line"
#property indicator_type1 DRAW_LINE
#property indicator_color1 clrDarkBlue
See also
R unning Programs, Client Terminal Events, W orking with Events
Variables
Declaring Variables
Variables must be declared before they are used. Unique names are used to identify variables. To
declare a variable, you must specify its type and a unique name. Declaration of variable is not an
operator.
S imple types are:
· char, short, int, long, uchar, ushort, uint, ulong – integers ;
· color – integer representing the RGB-color;
· datetime – the date and time, an unsigned integer containing the number of seconds since 0 hour
January 1, 1970;
· bool – boolean values true and false;
· double – double-precision floating point number;
· float – single-precision floating point number;
· string – character strings.
Examples:
string szInfoBox;
int nOrders;
double dSymbolPrice;
bool bLog;
datetime tBegin_Data = D'2004.01.01 00:00';
color cModify_Color = C'0x44,0xB9,0xE6';
You can't declare variables of the structure type until you declare the structure.
Arrays
Only an integer can be an array index. No more than four-dimensional arrays are allowed. Numbering
of array elements starts with 0. The last element of a one-dimensional array has the number which is 1
less than the array size. This means that call for the last element of an array consisting of 50 integers
will appear as a[49]. The same concerns multidimensional arrays : A dimension is indexed from 0 to
the dimension size-1. The last element of a two-dimensional array from the example will appear as
m[6][49].
S taticarrays can't be represented as timeseries, i.e., the ArrayS etAs S eries() function, which sets
access to array elements from the end to beginning, can't be applied to them. If you want to provide
access to an array the same as in timeseries, use the dynamic array object.
If there is an attempt to access out of the array range, the executing subsystem will generate a critical
error and the program will be stopped.
The functions from the Array Functions section, as well as the built-in methods can be used to handle
the arrays :
Access Specifiers
Access specifiers define how the compiler can access variables, members of structures or classes.
The const specifier declares a variable as a constant, and does not allow to change this variable during
runtime. A single initialization of a variable is allowed when declaring it.
Example:
There are three storage classes : static, input and extern. These modifiers of a storage class explicitly
indicate to the compiler that corresponding variables are distributed in a pre-allocated area of
memory, which is called the global pool. Besides, these modifiers indicate the special processing of
variable data. If a variable declared on a local level is not a static one, memory for such a variable is
allocated automatically at a program stack. Freeing of memory allocated for a non-static array is also
performed automatically when going beyond the visibility area of the block, in which the array is
declared.
See also
Data Types, Encapsulation and Extensibility of Types,Initialization of Variables, Visibility S cope and
Lifetime of Variables, Creating and Deleting Objects, S tatic Members of a Class
Local Variables
A variable declared inside a function is local. The scope of a local variable is limited to the function
range inside which it is declared. Local variable can be initialized by outcome of any expression. Every
call of the function initializes a local variable. Local variables are stored in memory area of the
corresponding function.
Example:
int somefunc()
{
int ret_code=0;
...
return(ret_code);
}
S cope of a variable is a program part, in which a variable can be referred to. Variables declared inside
a block (at the internal level), have the block as their scope. The block scope start with the variable
declaration and ends with the final right brace.
Local variables declared in the beginning of a function also have the scope of block, as well as function
parameters that are local variables. Any block can contain variable declarations. If blocks are nested
and the identifier in the external block has the same name as the identifier in the internal block, the
external block identifier is hidden, until the operation of the internal block is over.
Example:
void OnStart()
{
//---
int i=5; // local variable of the function
{
int i=10; // function variable
Print("Inside block i = ",i); // result is i=10;
}
Print("Outside block i = ",i); // result is i=5;
}
This means that while the internal block is running, it sees values of its own local identifiers, not the
values of identifiers with identical names in the external block.
Example:
void OnStart()
{
//---
int i=5; // local variable of the function
for(int i=0;i<3;i++)
Print("Inside for i = ",i);
Print("Outside the block i = ",i);
}
/* Execution result
Inside for i = 0
Inside for i = 1
Inside for i = 2
Outside block i = 5
*/
Local variables declared as static have the scope of the block, despite the fact that they exist since
the program start.
Stack
In every MQL5 program, a special memory area called stack is allocated for storing local function
variables that are created automatically. One stack is allocated for all functions, its default size for
indicators is equal to 1Mb. In Expert Advisors and scripts, stack size can be managed using the
#property stack size compiler directive (which sets the stack size in bytes), a memory of 8Mb is
allocated by default for the stack.
S tatic local variables
are stored in the same place where other static and global variables are stored -
in a special memory area, which exists separately from the stack. Dynamically created variables also
use a memory area separate from the stack.
W ith each function call,
a place on the stack is allocated for internal non-static variables. After exiting
the function, the memory is available for use again.
If from the first function the second one is called, then the second function occupies the required size
from the remaining stack memory for its variables. Thus, when using included functions, stack
memory will be sequentially occupied for each function. This may lead to a shortage of memory during
one of the function calls, such a situation is called stack overflow.
Therefore, for large local data you should better use dynamic memory - when entering a function,
allocate the memory, which is required for local needs, in the system (new, ArrayResize()), and when
exiting the function, release the memory (delete, ArrayFree()).
See also
Data Types, Encapsulation and Extensibility of Types,Initialization of Variables, Visibility S cope and
Lifetime of Variables, Creating and Deleting Objects
Formal Parameters
Parameters passed to the function are local. The scope is the function block. Formal parameters must
have names differing from those of external variables and local variables defined within one function.
S ome values can be assigned to formal parameters in the function block . If a formal parameter is
declared with the const modifier, its value can't be changed within the function.
Example:
Formal parameters can be initialized by constants. In this case, the initializing value is considered as
the default value. Parameters, next to the initialized one, must also be initialized.
Example:
W hen callingsuch a function, the initialized parameters can be omitted, the defaults being substituted
instead of them.
Example:
func(123, 0.5);
Parameters of simple types are passed by value, i.e., modifications of the corresponding local variable
of this type inside the called function will not be reflected in the calling function. Arrays of any type
and data of the structure type are always passed by reference. If it is necessary to prohibit modifying
the array or structure contents, the parameters of these types must be declared with the const
k eyword.
There is an opportunity to pass parameters of simple types by reference. In this case, modification of
such parameters inside the calling function will affect the corresponding variables passed by reference.
In order to indicate that a parameter is passed by reference, put the & modifier after the data type.
Example:
z[i]=OrderOpenPrice();
}
x=i;
y=calculated_tp;
}
Static Variables
The storage class of static defines a static variable. The static modifier is indicated before the data
type.
Example:
int somefunc()
{
static int flag=10;
...
return(flag);
}
A static variable can be initialized by a constant or constant expression corresponding to its type,
unlike a simple local variable, which can be initialized by any expression.
S tatic variables exist from the moment of program execution and are initialized only once before the
specialized functions OnInit() is called. If the initial values are not specified, variables of the static
storage class are taking zero initial values.
Local variables declared with the static keyword retain their values throughout the function lifetime.
W ith each next function call, such local variables contain the values that they had during the previous
call.
Any variables in a block, except formal parameters of a function, can be defined as static. If a
variable declared on a local level is not a static one, memory for such a variable is allocated
automatically at a program stack.
Example:
int Counter()
{
static int count;
count++;
if(count%100==0) Print("Function Counter has been called ",count," times");
return count;
}
void OnStart()
{
//---
int c=345;
for(int i=0;i<1000;i++)
{
int c=Counter();
}
Print("c =",c);
}
See also
Data Types, Encapsulation and Extensibility of Types, Initialization of Variables, Visibility S cope and
Lifetime of Variables, Creating and Deleting Objects, S tatic Class Members
Global Variables
Global variables are created by placing their declarations outside function descriptions. Global
variables are defined at the same level as functions, i.e., they are not local in any block.
Example:
The scope of global variables is the entire program. Global variables are accessible from all functions
defined in the program. They are initialized to zero unless another initial value is explicitly defined. A
global variable can be initialized only by a constant or constant expression that corresponds to its type.
Global variables are initialized only once after the program is loaded into the client terminal memory
and before the first handling of the Init event. For global variables representing class objects, during
their initialization the corresponding constructors are called. In scripts global variables are initialized
before handling the S tart event.
Note: Variables declared at global level must not be mixed up with the client terminal global variables
that can be accessed using the GlobalVariable...() functions.
See also
Data Types, Encapsulation and Extensibility of Types,Initialization of Variables, Visibility S cope and
Lifetime of Variables, Creating and Deleting Objects
Input Variables
The input storage class defines the external variable. The input modifier is indicated before the data
type. A variable with the input modifier can't be changed inside mql5-programs, such variables can be
accessed for reading only. Values of input variables can be changed only by a user from the program
properties window. External variables are always reinitialized immediately before the OnInit() is
called.
The maximum length of input variable names is 63 characters. For the input parameter of string type,
the maximum value length (string length) can be from 191 to 253 characters (see the Note). The
minimum length is 0 characters (the value is not set).
Example:
Input variables determine the input parameters of a program. They are available from the Properties
window of a program.
There is another way to set how your input parameter will look like in the Inputs tab. For this, place a
string comment after the description of an input parameter in the same line. In this way you can make
names of input parameters more understandable for users.
Example:
Note: Arrays and variables of complex types can't act as input variables.
Note: The length of a string comment for Input variables cannot exceed 63 characters.
Note: For input variables of string type, the limitation of the value length (string length) is set by the
following conditions :
· the parameter value is represented by the " parameter_name=parameter_value" string ('=' is
considered),
· maximum representation length of 255 characters (total_length_max=255 or 254 characters
excluding '='),
· maximum length of the parameter_name_length string parameter = 63 characters.
Thus, the maximum string size for a string parameter is calculated using the equation:
parameter_value_length=total_length_max-parameter_name_length=254-parameter_name_length
This provides the maximum string size from 191 (parameter_name_length=63) to 253 characters
(parameter_name_length=1).
Custom Indicators are called using the iCustom() function. After the name of the custom indicator,
parameters should go in a strict accordance with the declaration of input variables of this custom
indicator. If indicated parameters are less than input variables declared in the called custom indicator,
the missing parameters are filled with values specified during the declaration of variables.
If the custom indicator uses the OnCalculate function of the first type (i.e., the indicator is calculated
using the same array of data), then one of ENUM _APPLIED_PRICE values or handle of another indicator
should be used as the last parameter when calling such a custom indicator. All parameters
corresponding to input variables must be clearly indicated.
Not only built-in enumerationsprovided in MQL5, but also user defined variables can be used as input
variables (input parameters for mql5 programs). For example, we can create the dayOfW eek
enumeration, describing days of the week, and use the input variable to specify a particular day of the
week, not as a number, but in a more common way.
Example:
#property script_show_inputs
//--- day of week
enum dayOfWeek
{
S=0, // Sunday
M=1, // Monday
T=2, // Tuesday
W=3, // Wednesday
Th=4, // Thursday
Fr=5, // Friday,
St=6, // Saturday
};
//--- input parameters
input dayOfWeek swapday=W;
In order to enable a user to select a necessary value from the properties window during the script
startup, we use the preprocessor command #property script_show_inputs. W e start the script and can
choose one of values of the dayOfW eek enumeration from the list. W e start the EnumInInput script
and go to the Inputs tab. By default, the value of swapday (day of triple swap charge) is W ednesday (W
= 3), but we can specify any other value, and use this value to change the program operation.
Number of possible values of an enumeration is limited. In order to select an input value the drop-
down list is used. Mnemonic names of enumeration members are used for values displayed in the list.
If a comment is associated with a mnemonic name, as shown in this example, the comment content is
used instead of the mnemonic name.
Each value of the dayOfW eek enumeration has its value from 0 to 6, but in the list of parameters,
comments specified for each value will be shown. This provides additional flexibility for writing
programs with clear descriptions of input parameters.
The variable declared with sinput modifier is an input parameter of MQL5 program. The value of this
parameter can be changed when launching the program. However, this variable is not used in the
optimization of input parameters. In other words, its values are not enumerated when searching for
the best set of parameters fitting a specified condition.
The Expert Advisor shown above has 5 external parameters. "Number of layers " is declared to be
sinput and equal to 6. This parameter cannot be changed during a trading strategy optimization. W e
can specify the necessary value for it to be used further on. S tart, S tep and S top fields are not
available for such a variable.
Therefore, users will not be able to optimize this parameter after we specify sinput modifier for the
variable. In other words, the terminal users will not be able to set initial and final values for it in the
S trategy Tester for automatic enumeration in the specified range during optimization.
H owever, there is one exception to this rule: sinput variables can be varied in optimization tas ks
using ParameterS etRange() function. This function has been introduced specifically for the program
control of available values sets for any input variable including the ones declared as static input
(sinput). The ParameterGetRange() function allows to receive input variables values when
optimization is launched (in OnTesterInit() handler) and to reset a change step value and a range,
within which an optimized parameter values will be enumerated.
In this way, combining the sinput modifier and two functions that work with input parameters, allows
to create a flexible rules for setting optimization intervals of input parameters that depend on values
of another input parameters.
After such a declaration, all input parameters are visually joined into a specified group simplifying
parameters configuration for MQL5 users when launching on a chart or in the strategy tester.
S pecification of each group is valid till a new group declaration appears :
W hen launching such an EA in the strategy tester, you can double-click a group name to
collapse/expand the inputs block, as well as click the group checkbox to select all its parameters for
optimization.
See also
iCustom, Enumerations, Properties of Programs
Extern Variables
The extern keyword is used for declaring variable identifiers as identifiers of the static storage class
with global lifetime. These variables exist from the start of the program and memory for them is
allocated and initialized immediately after the start of the program.
You can create programs that consist of multiple source files ; in this case a directive to the
preprocessor #include is used. Variables declared as an extern with the same type and identifier can
exist in different source files of one project.
W hen compiling the whole project, all the extern variables with the same type and an identifier are
associated with one part of memory of the global variable pool. Extern variables are useful for
separate compilation of source files. Extern variables can be initialized, but only once - existence of
several initialized extern variables of the same type and with the same identifier is prohibited.
See also
Data Types, Encapsulation and Extensibility of Types,Initialization of Variables, Visibility S cope and
Lifetime of Variables, Creating and Deleting Objects
Initialization of Variables
Any variable can be initialized during definition. If a variable is not initialized explicitly, the value
stored in this variable can be any. Implicit initialization is not used.
Global and static variablescan be initialized only by a constant of the corresponding type or a constant
expression. Local variables can be initialized by any expression, not just a constant.
Initialization of global and static variables is performed only once. Initialization of local variables is
made every time you call the corresponding functions.
Examples:
int n = 1;
string s = "hello";
double f[] = { 0.0, 0.236, 0.382, 0.5, 0.618, 1.0 };
int a[4][4] = { {1, 1, 1, 1}, {2, 2, 2, 2}, {3, 3, 3, 3}, {4, 4, 4, 4 } };
//--- from tetris
int right[4]={WIDTH_IN_PIXELS+VERT_BORDER,WIDTH_IN_PIXELS+VERT_BORDER,
WIDTH_IN_PIXELS+VERT_BORDER,WIDTH_IN_PIXELS+VERT_BORDER};
//--- initialization of all fields of the structure with zero values
MqlTradeRequest request={};
List of values of the array elements must be enclosed in curly brackets. Missed initializing sequences
are considered equal to 0.
If the size of the initialized array is not specified, it is determined by a compiler, based on the size of
the initialization sequence.
Examples:
struct str3
{
int low_part;
int high_part;
};
struct str10
{
str3 s3;
double d1[10];
int i3;
};
void OnStart()
{
str10 s10_1={{1,0},{1.0,2.1,3.2,4.4,5.3,6.1,7.8,8.7,9.2,10.0},100};
str10 s10_2={{1,0},{},100};
str10 s10_3={{1,0},{1.0}};
//---
Print("1. s10_1.d1[5] = ",s10_1.d1[5]);
Print("2. s10_2.d1[5] = ",s10_2.d1[5]);
Print("3. s10_3.d1[5] = ",s10_3.d1[5]);
For structure type variable partial initialization is allowed, as well as for static arrays (with an
implicitly set size). You can initialize one or more first elements of a structure or array, the other
elements will be initialized with zeroes in this case.
See also
Data Types, Encapsulation and Extensibility of Types, Visibility S cope and Lifetime of Variables,
Creating and Deleting Objects
for(i=limit;i<rates_total;i++)
{
sum=0;
Its scope is only the for loop; outside of this loop there is another variable with the same name,
declared at the beginning of the function. In addition, the k variable is declared in the loop body, its
scope is the loop body.
Local variables can be declared with the access specifier static. In this case, the compiler has a
variable in the global pool of memory. Therefore, the lifetime of a static variable is equal to the
lifetime of the program. Here the scope of such a variable is limited to the block in which it is
declared.
See also
Data Types, Encapsulation and Extensibility of Types,Initialization of Variables, Creating and
Deleting Objects
pointer declared on a local level, the delete operator for this pointer must be performed before exiting
the level. Otherwise the pointer will be lost and the explicit deletion of the object will fail.
All objectscreated by the expression of object_pointer=new Class_name, must be then deleted by the
delete(object_pointer) operator. If for some reasons such a variable is not deleted by the delete
operator when the program is completed, the corresponding entry will appear in the "Experts " journal.
One can declare several variables and assign a pointer of one object to all of them.
If a dynamically created object has a constructor, this constructor will be called at the moment of the
new operator execution. If an object has a destructor, it will be called during the execution of the
delete operator.
Thus dynamically placed objects are created only at the moment when the corresponding new operator
is invoked, and are assuredly deleted either by the delete operator or automatically by the executing
system of MQL5 during the program unloading. The order of declaration of pointers of dynamically
created object doesn't influence the order of their initialization. The order of initialization and
deinitialization is fully controlled by the programmer.
Initialization right after a mql5 when the code line at the execution of
program is loaded where it is declared is the new operator
reached during
execution
Initialization order in the order of in the order of irrespective of the
declaration declaration order of declaration
Deinitialization before a mql5 when execution exits when the delete
program is unloaded the declaration block operator is executed
or before a mql5
program is unloaded
Deinitialization order in the order opposite in the order opposite irrespective of the
to the initialization to the initialization initialization order
order order
Constructor call at mql5 program at initialization at the execution of
loading the new operator
Destructor call at mql5 program when exiting the block at the execution of
unloading where the variable the delete operator
was initialized
Error logs log message in the log message in the log message in the
"Experts " journal "Experts " journal "Experts " journal
about the attempt to about the attempt to about undeleted
delete an delete an dynamically created
automatically created automatically created objects at the unload
object object of a mql5 program
See also
Data Types, Encapsulation and Extensibility of Types,Initialization of Variables, Visibility S cope and
Lifetime of Variables
Preprocessor
Preprocessor is a special subsystem of the MQL5 compiler that is intended for preparation of the
program source code immediately before the program is compiled.
Preprocessor allows enhancement of the source code readability. The code can be structured by
including of specific files containing source codes of mql5-programs. The possibility to assign
mnemonic names to specific constants contributes to enhancement of the code readability.
Preprocessor also allows determining specific parameters of mql5-programs :
· Declare constants
· S et program properties
· Include files in program text
· Import functions
· Conditional Compilation
The preprocessor directives are used by the compiler to preprocess the source code before compiling
it. The directive always begins with #, therefore the compiler prohibits using the symbol in names of
variables, functions etc.
Each directive is described by a separate entry and is valid until the line break. You cannot use several
directives in one entry. If the directive entry is too big, it can be broken into several lines using the '\'
symbol. In this case, the next line is considered a continuation of the directive entry.
//+------------------------------------------------------------------+
//| foreach pseudo-operator |
//+------------------------------------------------------------------+
#define ForEach(index, array) for (int index = 0, \
max_##index=ArraySize((array)); \
index<max_##index; index++)
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
string array[]={"12","23","34","45"};
//--- bypass the array using ForEach
ForEach(i,array)
{
PrintFormat("%d: array[%d]=%s",i,i,array[i]);
}
}
//+------------------------------------------------------------------+
/* Output result
0: array[0]=12
1: array[1]=23
2: array[2]=34
3: array[3]=45
*/
For the compiler, all these three #define directive lines look like a single long line. The example above
also applies ## character which is a merge operator used in the #define macros to merge the two
macro tokens into one. The tokens merge operator cannot be the first or last one in a macro
definition.
The #define directive substitutes expression for all further found entries of identifier in the source
text. The identifier is replaced only if it is a separate token. The identifier is not replaced if it is part
of a comment, part of a string, or part of another longer identifier.
The constant identifier is governed by the same rules as variable names. The value can be of any type:
#define ABC 100
#define PI 3.14
#define COMPANY_NAME "MetaQuotes Software Corp."
...
void ShowCopyright()
{
Print("Copyright 2001-2009, ",COMPANY_NAME);
Print("https://www.metaquotes.net");
}
expression can consist of several tokens, such as keywords, constants, constant and non-constant
expressions. expression ends with the end of the line and can't be transferred to the next line.
Example:
#define TWO 2
#define THREE 3
#define INCOMPLETE TWO+THREE
#define COMPLETE (TWO+THREE)
void OnStart()
{
Print("2 + 3*2 = ",INCOMPLETE*2);
Print("(2 + 3)*2 = ",COMPLETE*2);
}
// Result
// 2 + 3*2 = 8
// (2 + 3)*2 = 10
W ith the parametric form, all the subsequent found entries of identifier will be replaced by expression
taking into account the actual parameters. For example:
// example with two parameters a and b
#define A 2+3
#define B 5-1
#define MUL(a, b) ((a)*(b))
double c=MUL(A,B);
Print("c=",c);
/*
expression double c=MUL(A,B);
is equivalent to double c=((2+3)*(5-1));
*/
// Result
// c=20
Be sure to enclose parameters in parentheses when using the parameters in expression, as this will
help avoid non-obvious errors that are hard to find. If we rewrite the code without using the brackets,
the result will be different:
// example with two parameters a and b
#define A 2+3
#define B 5-1
#define MUL(a, b) a*b
double c=MUL(A,B);
Print("c=",c);
/*
expression double c=MUL(A,B);
is equivalent to double c=2+3*5-1;
*/
// Result
// c=16
The #undef directive cancels declaration of the macro substitution, defined before.
Example:
#define MACRO
void func1()
{
#ifdef MACRO
Print("MACRO is defined in ",__FUNCTION__);
#else
Print("MACRO is not defined in ",__FUNCTION__);
#endif
}
#undef MACRO
void func2()
{
#ifdef MACRO
Print("MACRO is defined in ",__FUNCTION__);
#else
Print("MACRO is not defined in ",__FUNCTION__);
#endif
}
void OnStart()
{
func1();
func2();
}
/* Result:
MACRO is defined in func1
MACRO is not defined in func2
*/
See also
Identifiers, Character Constants
The compiler will write declared values in the configuration of the module executed.
line feed.
stacksize int MQL5 program stack size. The stack of sufficient
size is necessary when executing function recursive
calls.
W hen launching a script or an Expert Advisor on the
chart, the stack of at least 8 M B is allocated. In
case of indicators, the stack size is always fixed
and equal to 1 M B.
W hen a program is launched in the strategy tester,
the stack of 16 M B is always allocated for it.
library A library; no start function is assigned, functions
with the export modifier can be imported in other
mql5-programs
indicator_applied_price int S pecifies the default value for the "Apply to" field.
You can specify one of the values of
ENUM _APPLIED_PR ICE. If the property is not
specified, the default value is PRICE_CLOSE
indicator_chart_window S how the indicator in the chart window
indicator_separate_window S how the indicator in a separate window
· "1d, input_parameter_name1,
input_parameter_name2" means a linear
chart, in which the results are sorted by the
specified parameter. Each pass is displayed
as a point. The chart is built based on one
parameter.
· "0d, input_parameter_name1,
input_parameter_name2" means a regular
chart with results sorted by the pass result
arrival time. Each pass is displayed as a
point in the chart. Parameter indication is
not required, but the specified parameters
can be used for the manual switch to other
chart types.
Optionally, you can indicate only the chart type,
without specifying one or two input parameters. In
this case, the terminal will select the required
parameters to show the optimization chart.
Examples of Specifying a Separate Label for Each Indicator Buffer ( " C open; C high; C low; C
close" )
#property indicator_chart_window
#property indicator_buffers 4
#property indicator_plots 1
#property indicator_type1 DRAW_CANDLES
#property indicator_width1 3
#property indicator_label1 "C open;C high;C low;C close"
Examples:
#include <WinUser32.mqh>
#include "mylib.mqh"
The preprocessor replaces the line #include <file_name> with the content of the file W inUser32.mqh.
Angle brack ets indicate that the W inUser32.mqh file will be tak en from the standard directory (usually
it is terminal_installation_directory\MQL5\Include). The current directory is not included in the
search.
If the file name is enclosed in quotation marks, the search is made in the current directory (which
contains the main source file). The standard directory is not included in the search.
See also
S tandard Library, Importing Functions
Imported functions can have any names. Functions having the same names but from different modules
can be imported at the same time. Imported functions can have names that coincide with the names
of built-in functions. Operation of scope resolution defines which of the functions should be called.
The order of searching for a file specified after the #import keyword is described in Call of Imported
Functions.
S ince the imported functionsare outside the compiled module, the compiler can not verify the validity
of passed parameters. Therefore, to avoid run-time errors, one must accurately describe the
composition and order of parameters passed to imported functions. Parameters passed to imported
functions (both from EX5, and from the DLL-module) can have default values.
The following can't be used for parameters in imported functions :
· pointers (*);
· link s to objects that contain dynamic arrays and/or pointers.
Classes, string arrays or complex objects that contain strings and/or dynamic arrays of any types
cannot be passed as a parameter to functions imported from DLL.
Examples:
#import "stdlib.ex5"
string ErrorDescription(int error_code);
int RGB(int red_value,int green_value,int blue_value);
bool CompareDoubles(double number1,double number2);
string DoubleToStrMorePrecision(double number,int precision);
string IntegerToHexString(int integer_number);
#import "ExpertSample.dll"
int GetIntValue(int);
double GetDoubleValue(double);
string GetStringValue(string);
double GetArrayItemValue(double &arr[],int,int);
bool SetArrayItemValue(double &arr[],int,int,double);
double GetRatesItemValue(double &rates[][6],int,int,int);
#import
To import functions during execution of a mql5 program, early binding is used. This means that the
library is loaded during the loading of a program using its ex5 program.
It's not recommended to use a fully qualified name of the loadable module of type Drive:
\Directory\FileName.Ext. MQL5 libraries are loaded from the terminal_dir\MQL5\Libraries folder.
If the imported function has different call versions for 32- and 64-bit W indows versions, both of them
should be imported, and the right function version should be called explicitly using the _Is X64
variable.
Example:
#import "user32.dll"
//--- For the 32-bit system
int MessageBoxW(uint hWnd,string lpText,string lpCaption,uint uType);
//--- For the 64-bit system
int MessageBoxW(ulong hWnd,string lpText,string lpCaption,uint uType);
#import
//+------------------------------------------------------------------+
//| MessageBox_32_64_bit uses the proper version of MessageBoxW() |
//+------------------------------------------------------------------+
int MessageBox_32_64_bit()
{
int res=-1;
//--- If we are using the 64-bit Windows
if(_IsX64)
{
ulong hwnd=0;
res=MessageBoxW(hwnd,"64-bit MessageBoxW call example","MessageBoxW 64 bit",MB_OK|MB_ICONINFO
}
else // We are using the 32-bit Windows
{
uint hwnd=0;
res=MessageBoxW(hwnd,"32-bit MessageBoxW call example","MessageBoxW 32 bit",MB_OK|MB_ICONINFO
}
return (res);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//---
int ans=MessageBox_32_64_bit();
PrintFormat("MessageBox_32_64_bit returned %d",ans);
}
To work with .NET library functions, simply import DLL itself without defining specific functions.
MetaEditor automatically imports all functions it is possible to work with:
· S imple structures (POD, plain old data) — structures that contain only simple data types.
· Public static functions having parameters, in which only simple types and POD structures or their
arrays are used
To call functions from the library, simply import it:
#import "TestLib.dll"
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
int x=41;
TestClass::Inc(x);
Print(x);
}
#ifndef identifier
// the code located here is compiled if the identifier is not currently defined by #define prepr
#endif
Any of the conditional compilation directives can be followed by any number of lines possibly
containing #else directive and ending with #endif. If the verified condition is true, the lines between
#else and #endif are ignored. If the verified condition is not fulfilled, all lines between check ing and
#else directive (or #endif directive if the former is absent) are ignored.
Example:
#ifndef TestMode
#define TestMode
#endif
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
#ifdef TestMode
Print("Test mode");
#else
Print("Normal mode");
#endif
}
Depending on the program type and compilation mode, the standard macros are defined the following
way:
__MQL5__ macro is defined when compiling *.mq5 file, __MQL 4__ macro is defined when compiling
*.mq4 one.
_DEBUG macro is defined when compiling in debug mode.
_REL EASE macro is defined when compiling in release mode.
Example:
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
#ifdef __MQL5__
#ifdef _DEBUG
Print("Hello from MQL5 compiler [DEBUG]");
#else
#ifdef _RELEASE
Print("Hello from MQL5 compiler [RELEASE]");
#endif
#endif
#else
#ifdef __MQL4__
#ifdef _DEBUG
Print("Hello from MQL4 compiler [DEBUG]");
#else
#ifdef _RELEASE
Print("Hello from MQL4 compiler [RELEASE]");
#endif
#endif
#endif
#endif
}
Object-Oriented Programming
Object-oriented programming (OOP) is programming primarily focused on data, while data and
behavior are being inseparably linked. Data and behavior together constitute a class, while objects are
class instances.
The components of the object-oriented approach are:
· Encapsulation and type extensibility
· Inheritance
· Polymorphism
· Overloading
· Virtual functions
OOP considers computation as modeling of behavior. The modeled item is the object represented by
computational abstractions. S uppose we want to write a well known game " Tetris " . To do this, we
must learn how to model the appearance of random shapes composed of four s quares joined together
by edges. Also we need to regulate the falling speed of shapes, define operations of rotation and shift
of shapes. Moving of shapes on the screen is limited by the well's boundaries, this requirement must
also be modeled. Besides that, filled rows of cubes must be destroyed and achieved points must be
counted.
Thus, this easy-to-understand game requires the creation of several models - shape model, well
model, shape movement model and so on. All these models are abstractions, represented by
calculations in the computer. To describe these models, the concept of Abstract Data Type, ADT (or
complex data type) is used. S trictly speaking, the model of the " shapes " motion in the DOM is not a
data type, but it is a set of operations on the " shape" data type, using the restrictions of the " well"
data type.
Objects are class variables. Object-oriented programming allows you to easily create and use ADT.
Object-oriented programming uses the inheritance mechanism. The benefit of inheritance is in the
fact that it allows obtaining derivative types from data types already defined by a user.
For example, to create Tetris shapes, it's convenient to create a base class S hape first. The other
classes representing all seven possible shape types can be derived on its basis. Behavior of shapes is
defined in the base class, while implementation of behavior of each separate shape is defined in
derivative classes.
In OOP objects are responsible for their behavior. ADT developer should include a code to describe any
behavior that would normally be expected from the corresponding objects. The fact that the object
itself is responsible for its behavior, greatly simplifies the tas k of programming for the user of this
object.
If we want to draw a shape on the screen, we need to know where the center will be and how to draw
it. If a separate shape knows how to draw itself, the programmer should send a " draw" message when
using such a shape.
The MQL5 Language is a C++ like, and it also has the encapsulation mechanism for the implementation
of ADT. On the one hand encapsulation combines the internal details of the implementation of a
particular type, and on the other hand it combines externally accessible functions that can influence
objects of this type. Implementation details may be inaccessible for a program that uses this type.
The concept of OOP has a set of related concepts, including the following:
· S imulation of actions from the real world
· User-defined data types
S ome of these concepts are rather vague, some are abstract, others are general.
Example:
class CPerson
{
protected:
string m_name; // name
public:
void SetName(string n){m_name=n;}// sets name
string GetName(){return (m_name);} // returns name
};
This approach offers several advantages. First, by function name we can understand what it does -
sets or gets the value of a class member. S econdly, perhaps in the future we will need to change the
type of the m_name variable in the CPerson class or in any of its derivative classes.
In this case, we'll need just to change the implementation of functions S etName() and GetName(),
while objects of the CPerson class will be available for using in a program without any code changes
because the user will not even know that the data type of m_name has changed.
Example:
struct Name
{
string first_name; // name
string last_name; // last name
};
class CPerson
{
protected:
Name m_name; // name
public:
void SetName(string n);
string GetName(){return(m_name.first_name+" "+m_name.last_name);}
private:
string GetFirstName(string full_name);
string GetLastName(string full_name);
};
void CPerson::SetName(string n)
{
m_name.first_name=GetFirstName(n);
m_name.last_name=GetLastName(n);
}
See also
Data Types
Inheritance
The characteristic feature of OOP is the encouragement of code reuse through inheritance. A new
class is made from the existing, which is called the base class. The derived class uses the members of
the base class, but can also modify and supplement them.
Many types are variations of the existing types. It is often tedious to develop a new code for each of
them. In addition, the new code implies new errors. The derived class inherits the description of the
base class, thus any re-development and re-testing of code is unnecessary. The inheritance
relationships are hierarchical.
H ierarchy is a method that allows to copy the elements in all their diversity and complexity. It
introduces the objects classification. For example, the periodic table of elements has gases. They
possess to properties inherent to all periodic elements.
Inert gases constitute the next important subclass. The hierarchy is that the inert gas, such as argon
is a gas, and gas, in its turn, is part of the system. S uch a hierarchy allows to interpret behaviour of
inert gases easily. W e know that their atoms contain protons and electrons, that is true for all other
elements.
W e k now that they are in a gaseous state at room temperature, like all the gases. W e know that no
gas from inert gas subclass enters usual chemical reaction with other elements, and it is a property of
all inert gases.
Consider an example of the inheritance of geometric shapes. To describe the whole variety of simple
shapes (circle, triangle, rectangle, s quare etc.), the best way is to create a base class (ADT), which is
the ancestor of all the derived classes.
Let's create a base class CS hape, which contains just the most common members describing the
shape. These members describe properties that are characteristic of any shape - the type of the shape
and main anchor point coordinates.
Example:
Next, create new classes derived from the base class, in which we will add necessary fields, each
specifying a certain class. For the Circle shape it is necessary to add a member that contains the
radius value. The Square shape is characterized by the side value. Therefore, derived classes,
inherited from the base class CS hape will be declared as follows :
public:
CCircle(){m_type=1;}// constructor, type 1
};
public:
CSquare(){m_type=2;} // constructor, type 2
};
It should be noted that while object is created the base class constructor is called first, and then the
constructor of the derived class is called. W hen an object is destroyed first the destructor of the
derived class is called, and then a base class destructor is called.
Thus, by declaring the most general members in the base class, we can add an additional members in
derived classes, which specify a particular class. Inheritance allows creating powerful code libraries
that can be reused many times.
The syntax for creating a derived class from an already existing one is as follows :
class class_name :
(public | protected | private) opt base_class_name
{
class members declaration
};
One of aspects of the derived class is the visibility (openness) of its members successors (heirs). The
public, protected and private keywords are used to indicate the extent, to which members of the base
class will be available for the derived one. The public keyword after a colon in the header of a derived
class indicates that the protected and public members of the base class CS hape should be inherited as
protected and public members of the derived class CCircle.
The private class members of the base class are not available for the derived class. The public
inheritance also means that derived classes (CCircle and CSquare) are CS hapes. That is, the Square
(CSquare) is a shape (CS hape), but the shape does not necessarily have to be a s quare.
The derived class is a modification of the base class, it inherits the protected and public members of
the base class. The constructors and destructors of the base class cannot be inherited. In addition to
members of the base class, new members are added in a derivative class.
The derived class may include the implementation of member functions, different from the base class.
It has nothing common with an overload, when the meaning of the same function name may be
different for different signatures.
In protected inheritance, public and protected members of base class become protected members of
derived class. In private inheritance, the public and protected members of base class become private
members of the derived class.
In protected and private inheritance, the relation that " the object of a derivative class is object of a
base class " is not true. The protected and private inheritance types are rare, and each of them needs
to be used carefully.
It should be understood that the type of inheritance (public, protected or private) does not affect the
ways of accessing the members of base classes in the hierarchy of inheritance from a derived
class. W ith any type of inheritance, only base class members declared with public and protected access
specifiers will be available out of the derived classes. Let's consider it in the following example:
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
//+------------------------------------------------------------------+
//| Example class with a few access types |
//+------------------------------------------------------------------+
class CBaseClass
{
private: //--- The private member is not available from derived classes
int m_member;
protected: //--- The protected method is available from the base class and its derived cl
int Member(){return(m_member);}
public: //--- Class constructor is available to all members of classes
CBaseClass(){m_member=5;return;};
private: //--- A private method for assigning a value to m_member
void Member(int value) { m_member=value;};
};
//+------------------------------------------------------------------+
//| Derived class with errors |
//+------------------------------------------------------------------+
class CDerived: public CBaseClass // specification of public inheritance can be omitted, since it i
{
public:
void Func() // In the derived class, define a function with calls to base class members
{
//--- An attempt to modify a private member of the base class
m_member=0; // Error, the private member of the base class is not available
Member(0); // Error, the private method of the base class is not available in derived
In the above example, CBaseClass has only a public method – the constructor. Constructors are called
automatically when creating a class object. Therefore, the private member m_member and the
protected methods Member() cannot be called from the outside. But in case of public inheritance, the
Member() method of the base class will be available from the derived classes.
In case of protected inheritance, all the members of the base class with public and protected access
become protected. It means that if public data members and methods of the base class were
accessible from the outside, with protected inheritance they are available only from the classes of the
derived class and its further derivatives.
//+------------------------------------------------------------------+
//| Example class with a few access types |
//+------------------------------------------------------------------+
class CBaseMathClass
{
private: //--- The private member is not available from derived classes
double m_Pi;
public: //--- Getting and setting a value for m_Pi
void SetPI(double v){m_Pi=v;return;};
double GetPI(){return m_Pi;};
public: // The class constructor is available to all members
CBaseMathClass() {SetPI(3.14); PrintFormat("%s",__FUNCTION__);};
};
//+------------------------------------------------------------------+
//| Derived class, in which m_Pi cannot be modified |
//+------------------------------------------------------------------+
class CProtectedChildClass: protected CBaseMathClass // Protected inheritance
{
private:
double m_radius;
public: //--- Public methods in the derived class
void SetRadius(double r){m_radius=r; return;};
double GetCircleLength(){return GetPI()*m_radius;};
};
//+------------------------------------------------------------------+
//| Script starting function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- When creating a derived class, the constructor of the base class will be called automatically
CProtectedChildClass pt;
//--- Specify radius
pt.SetRadius(10);
PrintFormat("Length=%G",pt.GetCircleLength());
//--- If we uncomment the line below, we will get an error at the stage of compilation, since SetPI
// pt.SetPI(3);
//--- Now declare a variable of the base class and try to set the Pi constant equal to 10
CBaseMathClass bc;
bc.SetPI(10);
//--- Here is the result
PrintFormat("bc.GetPI()=%G",bc.GetPI());
}
The example shows that methods S etPI() and GetPi() in the base class CBaseMathClass are open and
available for calling from any place of the program. But at the same time, for CProtectedChildClass
which is derived from it these methods can be called only from the methods of the
CProtectedChildClass class or its derived classes.
In case of private inheritance, all the members of the basic class with the public and protected access
become private, and calling them becomes impossible in further inheritance.
MQL5 has no multiple inheritance.
See also
S tructures and Classes
Polymorphism
Polymorphism is an opportunity for different classes of objects, related through inheritance, to
respond in various ways when calling the same function element. It helps to create a universal
mechanism describing the behavior of not only the base class, but also descendant classes.
Let's continue to develop a base class CS hape, and define a member function GetArea(), designed to
calculate the area of a shape. In all the descendant classes, produced by inheritance from the base
class, we redefine this function in accordance with rules of calculating the area of a particular shape.
For a s quare (class CSquare), the area is calculated through its sides, for a circle (class CCircle), area
is expressed through its radius etc. W e can create an array to store objects of CS hape type, in which
both objects of a base class and those of all descendant classes can be stored. Further we can call the
same function for each element of the array.
Example:
Now, all of the derived classes have a member function getArea(), which returns a zero value. The
implementation of this function in each descendant will vary.
//--- The derived class Circle
class CCircle : public CShape // After a colon we define the base class
{ // from which inheritance is made
private:
double m_radius; // circle radius
public:
void CCircle(){m_type=1;}; // constructor, type=1
void SetRadius(double r){m_radius=r;};
virtual double GetArea(){return (3.14*m_radius*m_radius);}// circle area
};
private:
double m_square_side; // square side
public:
void CSquare(){m_type=2;}; // constructor, type=1
void SetSide(double s){m_square_side=s;};
virtual double GetArea(){return (m_square_side*m_square_side);}// square area
};
For calculating thearea of the s quare and circle, we need the corresponding values of m_radius and
m_s quare_side, so we have added the functions S etRadius() and S etS ide() in the declaration of the
corresponding class.
It is assumed that object of different types (CCircle and CSquare) derived from one base type CS hape
are used in our program. Polymorphism allows creating an array of objects of the base CS hape class,
but when declaring this array, these objects are yet unknown and their type is undefined.
The decision on what type of object will be contained in each element of the array will be taken
directly during program execution. This involves the dynamic creation of objects of the appropriate
classes, and hence the necessity to use object pointers instead of objects.
The new operator is used for dynamic creation of objects. Each such object must be individually and
explicitly deleted using the delete operator. Therefore we will declare an array of pointers of CS hape
type, and create an object of a proper type for each element (new Class_Name), as shown in the
following script example:
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- Declare an array of object pointers of the base type
CShape *shapes[5]; // An array of pointers to CShape object
//--- Create another CCircle object and write down its pointer in shapes[1]
circle=new CCircle();
shapes[1]=circle;
circle.SetRadius(5);
//--- Create a CSquare object and write down its pointer to shapes[3]
CSquare *square=new CSquare();
square.SetSide(5);
shapes[3]=square;
//--- Create a CSquare object and write down its pointer to shapes[4]
square=new CSquare();
square.SetSide(10);
shapes[4]=square;
Please note that when deleting an object using the delete operator, the type of its pointer must be
checked. Only objects with the POINTER_DYNAMIC pointer can be deleted using delete. For pointers of
other type, an error will be returned.
But besides the redefining of functions during inheritance, polymorphism also includes the
implementation of one and the same functions with different sets of parameters within a class. This
means that the class may have several functions with the same name but with a different type and/or
set of parameters. In this case, polymorphism is implemented through the function overload.
See also
S tandard Library
Overload
W ithin one class it is possible to define two or more methods that use the same name, but have
different numbers of parameters. W hen this occurs, methods are called overloaded and such a process
is referred to as method overloading.
Method overloading is one of ways of polymorphism realization. Overloading of methods is performed
according to the same rules as the function overloading.
If the called function has no exact match, the compiler searches for a suitable function on three levels
sequentially:
1. search within class methods.
2. search within the base class methods, consistently from the nearest ancestor to the very first.
3. search among other functions.
If there is no exact correspondence at all levels, but several suitable functions at different levels have
been found, the function found at the least level is used. W ithin one level, there can't be more than
one suitable function.
See also
Function Overloading
Virtual Functions
The virtual keyword is the function specifier, which provides a mechanism to select dynamically at
runtime an appropriate function-member among the functions of basic and derived classes. S tructures
cannot have virtual functions. It can be used to change the declarations for function-members only.
The virtual function, like an ordinary function, must have an executable body. W hen called, its
semantic is the same as that of other functions.
A virtual function may be overridden in a derived class. The choice of what function definition should
be called for a virtual function is made dynamically (at runtime). A typical case is when a base class
contains a virtual function, and derived classes have their own versions of this function.
The pointer to the base class can indicate either a base class object or the object of a derived class.
The choice of the member-function to call will be performed at runtime and will depend on the type of
the object, not the type of the pointer. If there is no member of a derived type, the virtual function of
the base class is used by default.
Destructors are always virtual, regardless of whether they are declared with the virtual keyword or not.
Let's consider the use of virtual functions on the example of MT5_Tetris.mq5. The base class
CTetris S hape with the virtual function Draw is defined in the included file MT5_Tetris S hape.mqh.
//+------------------------------------------------------------------+
class CTetrisShape
{
protected:
int m_type;
int m_xpos;
int m_ypos;
int m_xsize;
int m_ysize;
int m_prev_turn;
int m_turn;
int m_right_border;
public:
void CTetrisShape();
void SetRightBorder(int border) { m_right_border=border; }
void SetYPos(int ypos) { m_ypos=ypos; }
void SetXPos(int xpos) { m_xpos=xpos; }
int GetYPos() { return(m_ypos); }
int GetXPos() { return(m_xpos); }
int GetYSize() { return(m_ysize); }
int GetXSize() { return(m_xsize); }
int GetType() { return(m_type); }
void Left() { m_xpos-=SHAPE_SIZE; }
void Right() { m_xpos+=SHAPE_SIZE; }
void Rotate() { m_prev_turn=m_turn; if(++m_turn>3) m_turn=0; }
virtual void Draw() { return; }
virtual bool CheckDown(int& pad_array[]);
virtual bool CheckLeft(int& side_row[]);
Further, for each derived class, this function is implemented in accordance with characteristics of a
descendant class. For example, the first shape CTetris S hape1 has its own implementation of the
Draw() function:
The Square shape is described by class CTetris S hape6 and has its own implementation of the Draw()
method:
class CTetrisShape6 : public CTetrisShape
{
public:
//--- Shape drawing
virtual void Draw()
{
int i;
string name;
//---
for(i=0; i<2; i++)
{
name=SHAPE_NAME+(string)i;
ObjectSetInteger(0,name,OBJPROP_XDISTANCE,m_xpos+i*SHAPE_SIZE);
ObjectSetInteger(0,name,OBJPROP_YDISTANCE,m_ypos);
}
for(i=2; i<4; i++)
{
name=SHAPE_NAME+(string)i;
ObjectSetInteger(0,name,OBJPROP_XDISTANCE,m_xpos+(i-2)*SHAPE_SIZE);
ObjectSetInteger(0,name,OBJPROP_YDISTANCE,m_ypos+SHAPE_SIZE);
}
}
};
Depending on the class, to which the created object belongs, it calls the virtual function of this or that
derived class.
void CTetrisField::NewShape()
{
//--- creating one of the 7 possible shapes randomly
int nshape=rand()%7;
switch(nshape)
{
case 0: m_shape=new CTetrisShape1; break;
case 1: m_shape=new CTetrisShape2; break;
case 2: m_shape=new CTetrisShape3; break;
case 3: m_shape=new CTetrisShape4; break;
case 4: m_shape=new CTetrisShape5; break;
case 5: m_shape=new CTetrisShape6; break;
case 6: m_shape=new CTetrisShape7; break;
}
//--- draw
m_shape.Draw();
//---
}
Modifier 'override'
The 'override' modifier means that the declared function must override the method of a parent class.
Use of this method allows you to avoid overriding errors, for example it allows you to avoid accidental
modification of the method signature. S uppose, the 'func' method is defined in the base class. The
method accepts an int variable as an argument:
class CFoo
{
void virtual func(int x) const { }
};
H owever, the argument type is mistakenly changed from int to short. In fact, this is not method
overriding, but it is method overloading. Acting in accordance with the overloaded function defining
algorithm, the compiler can in certain situations choose a method defined in the base class instead of
the overridden method.
In order to avoid such errors, you should explicitly add the 'override' modifier to the method you want
to override.
class CBar : public CFoo
{
void func(short x) override { }
};
If the method signature is changed during overriding, the compiler will not be able to find a method
with the same signature in the parent class, and it will return a compilation error:
'CBar::func' method is declared with 'override' specifier but does not override any base class meth
Modifier 'final'
The 'final' modifier does the opposite — it prohibits method overriding in child classes. If a method
implementation is sufficient and fully complete, declare this method with the 'final' modifier so as to
make sure that it will not be modified later.
class CFoo
{
void virtual func(int x) final { }
};
If you try to override a method with the 'final' modifier as shown in the above example, the compiler
will return an error:
'CFoo::func' method declared as 'final' cannot be overridden by 'CBar::func'
see declaration of 'CFoo::func'
See also
S tandard Library
where class_name is the name of the class, and variable is the name of the class member.
As you see, to access the static member of a class, context resolution operator :: is used. W hen you
access a static member within class methods, the context operator is optional.
S tatic member of a class has to be explicitly initialized with desired value. For this it must be declared
and initialized in global scope. The sequence of static members initialization will correspond to the
sequence of their declaration in global scope.
For example, we have a class CParser used for parsing the text, and we need to count the total
number of processed words and characters. W e only need to declare the necessary class members as
static and initialize them at the global level. Then all instances of the class will use common counters
of words and characters.
//+------------------------------------------------------------------+
//| Class "Text analyzer" |
//+------------------------------------------------------------------+
class CParser
{
public:
static int s_words;
static int s_symbols;
//--- Constructor and destructor
CParser(void);
~CParser(void){};
};
...
//--- Initialization of static members of the Parser class at the global level
int CParser::s_words=0;
int CParser::s_symbols=0;
A static class member can be declared with the const keyword. S uch static constants must be
initialized at the global level with the const keyword:
//+------------------------------------------------------------------+
//| Class "Stack" for storing processed data |
//+------------------------------------------------------------------+
class CStack
{
public:
CStack(void);
~CStack(void){};
...
private:
static const int s_max_length; // Maximum stack capacity
};
Pointer this
The keyword this denotes an implicitly declared pointer to itself – to a specific instance of the class, in
the context of which the method is executed. It can be used only in non-static methods of the class.
Pointer this is an implicit non-static member of any class.
In static functions you can access only static members /methods of a class.
Static Methods
In MQL5 member functions of type static can be used. The static modifier must precede the return
type of a function in the declaration inside a class.
class CStack
{
public:
//--- Constructor and destructor
CStack(void){};
~CStack(void){};
//--- Maximum stack capacity
static int Capacity();
private:
int m_length; // The number of elements in the stack
static const int s_max_length; // Maximum stack capacity
};
//+------------------------------------------------------------------+
//| Returns the maximum number of elements to store in the stack |
//+------------------------------------------------------------------+
int CStack::Capacity(void)
{
return(s_max_length);
}
//--- Initialization of the static constant of the CStack class
const int CStack::s_max_length=1000;
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- declare CStack type variable
CStack stack;
//--- call the object's static method
Print("CStack.s_max_length=",stack.Capacity());
//--- it can also be called the following way, as the method is static and does not require the pre
Print("CStack.s_max_length=",CStack::Capacity());
}
A method with the const modifier is called constant and cannot modify implicit members of its class.
Declaration of constant functions of a class and constant parameters is called const-correctness
control. Through this control you can be sure that the compiler will ensure the consistency of values of
objects and will return an error during compilation if there is something wrong.
The const modifier is placed after the list of arguments inside a class declaration. Definition outside a
class should also include the const modifier:
//+------------------------------------------------------------------+
//| Class "Rectangle" |
//+------------------------------------------------------------------+
class CRectangle
{
private:
double m_width; // Width
double m_height; // Height
public:
//--- Constructors and destructor
CRectangle(void):m_width(0),m_height(0){};
CRectangle(const double w,const double h):m_width(w),m_height(h){};
~CRectangle(void){};
//--- Calculating the area
double Square(void) const;
static double Square(const double w,const double h);// { return(w*h); }
};
//+------------------------------------------------------------------+
//| Returns the area of the "Rectangle" object |
//+------------------------------------------------------------------+
double CRectangle::Square(void) const
{
return(Square(m_width,m_height));
}
//+------------------------------------------------------------------+
//| Returns the product of two variables |
//+------------------------------------------------------------------+
static double CRectangle::Square(const double w,const double h)
{
return(w*h);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- Create a rectangle rect with the sides equal to 5 and 6
CRectangle rect(5,6);
//--- Find the rectangle area using a constant method
PrintFormat("rect.Square()=%.2f",rect.Square());
//--- Find the product of numbers using the static method of class CRectangle
PrintFormat("CRectangle::Square(2.0,1.5)=%f",CRectangle::Square(2.0,1.5));
}
An additional argument in favor of using the constancy control is the fact that in this case, the
compiler generates a special optimization, for example, places a constant object in read-only memory.
A static function cannot be determined with the const modifier, because this modifier ensures the
constancy of the instance members when calling this function. But, as mentioned above, the static
function cannot access non-static class members.
See also
S tatic Variables, Variables, R eferences. Modifier & and Keyword this
Function templates
Overloaded functions are commonly used to perform similar operations on various data types.
ArrayS ize() is a simple example of such function in MQL5. It returns size of any type of array. In fact,
this system function is overloaded and the entire implementation of such an overload is hidden from
MQL5 application developers :
int ArraySize(
void& array[] // checked array
);
It means that MQL5 language compiler inserts necessary implementation for each call of this function.
For example, that is how it can be done for integer type arrays :
int ArraySize(
int& array[] // array with int type elements
);
ArrayS ize() function can be displayed the following way for M qlRates type array for working with
quotations in historical data format:
int ArraySize(
MqlRates& array[] // array filled with MqlRates type values
);
Thus, it is very convenient to use the same function for working with different types. However, all
preliminary work should be carried out – the necessary function should be overloaded for all data types
it should correctly work with.
There is a convenient solution. If similar operations should be executed for each data type, it is
possible to use function templates. In this case, a programmer needs to write only one function
template description. W hen describing the template in such a way, we should specify only some formal
parameter instead of some definite data type the function should work with. The compiler will
automatically generate various functions for the appropriate handling of each type based on the types
of the arguments used when calling the function.
Function template definition starts with the template keyword followed by the list of formal
parameters in angle brackets. Each formal parameter is preceded by the typename keyword. Formal
parameter types are built-in or user-defined types. They are used:
· to specify the types of function arguments,
· to specify the types of function's return value,
· to declare the variables inside the function definition
Number of template parameters cannot exceed eight. Each formal parameter in the template
definition should appear in the list of function parameters at least once. Each name of the formal
parameter should be unique.
Below is an example of a function template for searching the highest value in the array of any numeric
type (integer and real numbers):
template<typename T>
T ArrayMax(T &arr[])
{
uint size=ArraySize(arr);
if(size==0) return(0);
T max=arr[0];
for(uint n=1;n<size;n++)
if(max<arr[n]) max=arr[n];
//---
return(max);
}
This template defines the function that finds the highest value in the passed array and returns this
value as a result. Keep in mind that the ArrayMaximum() function built in MQL5 returns only the
highest value index that can be used to find the value itself. For example:
//--- create an array
double array[];
int size=50;
ArrayResize(array,size);
//--- fill with random values
for(int i=0;i<size;i++)
{
array[i]=MathRand();
}
Thus, we have performed two steps to get the highest value in the array. W ith ArrayMax() function
template, we can get the result of the necessary type just by passing the array of an appropriate type
into this function. It means that instead of two last lines
//--- find position of the highest value in the array
int max_position=ArrayMaximum(array);
//--- now, get the highest value itself in the array
double max=array[max_position];
we now can use only one line, in which the returned result has the same type as the array passed into
function:
//--- find the highest value
double max=ArrayMax(array);
In this case, the type of result returned by the ArrayMax() function will automatically match the type of
array.
Use the typename keyword to get the argument type as a string in order to create general purpose
methods of working with various data types. Let's consider a specific example of the function that
returns data type as a string:
#include <Trade\Trade.mqh>
//+------------------------------------------------------------------+
//| |
//+------------------------------------------------------------------+
void OnStart()
{
//---
CTrade trade;
double d_value=M_PI;
int i_value=INT_MAX;
Print("d_value: type=",GetTypeName(d_value), ", value=", d_value);
Print("i_value: type=",GetTypeName(i_value), ", value=", i_value);
Print("trade: type=",GetTypeName(trade));
//---
}
//+------------------------------------------------------------------+
//| Type is returned as a line |
//+------------------------------------------------------------------+
template<typename T>
string GetTypeName(const T &t)
{
//--- return the type as a line
return(typename(T));
//---
}
Function templates can also be used for class methods, for example:
class CFile
{
...
public:
...
template<typename T>
uint WriteStruct(T &data);
};
template<typename T>
uint CFile::WriteStruct(T &data)
{
...
return(FileWriteStruct(m_handle,data));
}
Function templates should not be declared with export, virtual and #import keywords.
//+------------------------------------------------------------------+
//| Template function |
//+------------------------------------------------------------------+
template<typename T1,typename T2>
string Assign(T1 &var1,T2 var2)
{
var1=(T1)var2;
return(__FUNCSIG__);
}
//+------------------------------------------------------------------+
//| Special overload for bool+string |
//+------------------------------------------------------------------+
string Assign(bool &var1,string var2)
{
var1=(StringCompare(var2,"true",false) || StringToInteger(var2)!=0);
return(__FUNCSIG__);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
int i;
bool b;
Print(Assign(i,"test"));
Print(Assign(b,"test"));
}
As a result of the code execution, we can see that the Assign() template function has been used for
the int+string pair, while the overloaded version has already been used for the bool+string pair during
the second call.
string Assign<int,string>(int&,string)
string Assign(bool&,string)
See also
Overload
Template advantages
Function templates are used when you need to perform similar operations on various data types, for
example, searching for a maximum element in the array. The main advantage of applying the
templates is that you do not have to code a separate overload for each type. Instead of declaring
multiple overloads of each type
double ArrayMax(double array[])
{
...
}
int ArrayMax(int array[])
{
...
}
uint ArrayMax(uint array[])
{
...
}
long ArrayMax(long array[])
{
...
}
datetime ArrayMax(datetime array[])
{
...
}
H ere,the T formal parameter specifying a type of used data is replaced with an actually applied type
during compilation, i.e. the compiler automatically generates a separate function for each type –
double, datetime, etc. MQL5 also allows you to develop class templates using all the advantages of the
approach.
Class templates
A class template is declared using the template keyword followed by angle brackets <> enumerating the
list of formal parameters with the typename keyword. This entry informs the compiler that it deals
with a generic class with the T formal parameter defining a real variable type when implementing a
class. For example, let's create a vector class for storing an array with T type elements :
#define TOSTR(x) #x+" " // macro for displaying an object name
//+------------------------------------------------------------------+
//| Vector class for storing T-type elements |
//+------------------------------------------------------------------+
template <typename T>
class TArray
{
protected:
T m_array[];
public:
//--- constructor creates an array for 10 elements by default
void TArray(void){ArrayResize(m_array,10);}
//--- constructor for creating a vector with a specified array size
void TArray(int size){ArrayResize(m_array,size);}
//--- return a type and amount of data stored in the TArray type object
string Type(void){return(typename(m_array[0])+":"+(string)ArraySize(m_array));};
};
Next, let's apply different methods to create three TArray objects in the program for working with
various types
void OnStart()
{
TArray<double> double_array; // vector has a default size of 10
TArray<int> int_array(15); // vector has a size of 15
TArray<string> *string_array; // pointer to TArray<string> vector
//--- create a dynamic object
string_array=new TArray<string>(20);
//--- display an object name, data type and vector size in the Journal
PrintFormat("%s (%s)",TOSTR(double_array),double_array.Type());
PrintFormat("%s (%s)",TOSTR(int_array),int_array.Type());
PrintFormat("%s (%s)",TOSTR(string_array),string_array.Type());
//--- remove a dynamic object before completing the program
delete(string_array);
}
double_array (double:10)
int_array (int:15)
string_array (string:20)
Now, we have 3 vectors with different data types : double, int and string.
Class templates are well suited for developing containers – objects designed for encapsulating other
objects of any type. Container objects are collections already containing objects of one certain type.
Usually, work ing with stored data is instantly built into the container.
For example, you can create a class template that does not allow accessing an element outside the
array, thus avoiding the " out of range" critical error.
//+------------------------------------------------------------------+
//| Class for a free access to an array element |
//+------------------------------------------------------------------+
template<typename T>
class TSafeArray
{
protected:
T m_array[];
public:
//--- default constructor
void TSafeArray(void){}
//--- constructor for creating the array of a specified size
void TSafeArray(int size){ArrayResize(m_array,size);}
//--- array size
int Size(void){return(ArraySize(m_array));}
//--- change the array size
int Resize(int size,int reserve){return(ArrayResize(m_array,size,reserve));}
//--- release the array
void Erase(void){ZeroMemory(m_array);}
//--- operator for accessing the array element by index
T operator[](int index);
//--- assignment operator for receiving all elements from the array at once
void operator=(const T &array[]); // T type array
};
//+------------------------------------------------------------------+
//| Receiving an element by index |
//+------------------------------------------------------------------+
template<typename T>
T TSafeArray::operator[](int index)
{
static T invalid_value;
//---
int max=ArraySize(m_array)-1;
if(index<0 || index>=ArraySize(m_array))
{
PrintFormat("%s index %d is not in range (0-%d)!",__FUNCTION__,index,max);
return(invalid_value);
}
//---
return(m_array[index]);
}
//+------------------------------------------------------------------+
Please note that template declaration should also be used when describing methods outside the class
declaration:
template<typename T>
T TSafeArray::operator[](int index)
{
...
}
template<typename T>
void TSafeArray::operator=(const T &array[])
{
...
Class and function templates allow you to define multiple comma-separated formal parameters, for
example, Map collection for storing "key – value" pairs :
template<typename Key, template Value>
class TMap
{
...
}
See also
Function templates, Overload
H ere S ound() is a pure virtual function, because it is declared with the specifier of the pure virtual
function PURE (=0).
Pure virtual functions are only the virtual functions for which the PURE specifier is set: (=NULL) or
(=0). Example of abstract class declaration and use:
class CAnimal
{
public:
virtual void Sound()=NULL; // PURE method, should be overridden in the derived class, CA
};
//--- Derived from an abstract class
class CCat : public CAnimal
{
public:
virtual void Sound() { Print("Myau"); } // PURE is overridden, CCat is not abstract and ca
};
H owever, constructors and destructors for abstract classes can call other member functions.
Namespaces
A namespace is a specially declared area, within which various IDs are defined: variables, functions,
classes, etc. It is set using the namespace keyword:
namespace name of_space {
// list of function, class and variable definitions
}
Applying 'namespace' allows splitting the global namespace into subspaces. All IDs within the
namespace are available to each other without a specification. The :: operator (context resolution
operation) is used to access namespace members from the outside.
namespace ProjectData
{
class DataManager
{
public:
void LoadData() {}
};
void Func(DataManager& manager) {}
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- working with ProjectData namespace
ProjectData::DataManager mgr;
mgr.LoadData();
ProjectData::Func(mgr);
}
Namespaces are used to arrange a code in the form of logical groups and to avoid name conflicts that
may occur when several libraries are used in a program. In such cases, each library can be declared in
its namespace to explicitly access the necessary functions and classes of each library.
A namespace can be declared in several blocks in one or several files. The compiler combines all parts
together during a preprocessing and the resulting namespace contains all the members declared in all
parts. S uppose that we have A class implemented in the S ample.mqh include file:
//+------------------------------------------------------------------+
//| Sample.mqh |
//+------------------------------------------------------------------+
class A
{
public:
A() {Print(__FUNCTION__);}
};
W e want to use this class in our project, but we already have A class. To be able to use both classes
and avoid ID conflict, simply wrap the included file in a namespace:
//--- declare the first A class
class A
{
public:
A() {Print(__FUNCTION__);}
};
//--- wrap the A class from the Sample.mqh file in the Library namespace to avoid a conflict
namespace Library
{
#include "Sample.mqh"
}
//--- add yet another class to the Library namespace
namespace Library
{
class B
{
public:
B() {Print(__FUNCTION__);}
};
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- use the A class from the global namespace
A a1;
//--- use the A and B classes from the Library namespace
Library::A a2;
Library::B b;
}
//+------------------------------------------------------------------+
/*
Result:
A::A
Library::A::A
Library::B::B
*/
Namespaces can be nested. A nested namespace has unlimited access to members of its parent space,
but members of the parent space do not have unlimited access to the nested namespace.
namespace General
{
int Func();
namespace Details
{
int Counter;
int Refresh() {return Func(); }
}
Global namespace
If the ID is not explicitly declared in the namespace, it is considered to be an implicit part of the global
namespace. To set the global ID explicitly, use the scope resolution operator without a name. This will
allow you to distinguish this ID from any other element with the same name located in a different
namespace. For example, when importing a function:
#import "lib.dll"
int Func();
#import
//+------------------------------------------------------------------+
//| Some function |
//+------------------------------------------------------------------+
int Func()
{
return(0);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//+--- call the imported function
Print(lib::Func());
//+--- call our function
Print(::Func());
}
In this case, all the functions imported from the DLL function were included in the namespace of the
same name. This allowed the compiler to clearly determine the function to be called.
See also
Global Variables, Local Variables, Visibility S cope and Lifetime of Variables, Creating and Deleting
Objects
Chart Constants
Constants describing various properties of charts are divided into the following groups :
· Types of events – events that occur when working with charts ;
· Chart timeframes – standard built-in periods ;
· Properties of chart – identifiers that are used as parameters of chart functions ;
· Positioning constants - value of a parameter of the ChartNavigate() function;
· Displaying charts - setting the chart appearance.
ID Description
CHARTEVENT_KEYDOWN Keystrok es
For each type of event, the input parameters of the OnChartEvent() function have definite values that
are required for the processing of this event. The events and values passed through this parameters
are listed in the below table.
Mouse events (if CHARTEVENT_MO the X coordinate the Y coordinate The string value
CHART_EVENT_ USE_MOVE of a bit mas k
MOUSE_MOVE=tr describing the
ue is set for the status of mouse
chart) buttons
Mouse wheel CHARTEVENT_MO Flags of states of The Delta value —
event (if USE_WHEEL k eys and mouse of the mouse
CHART_EVENT_ buttons, the X wheel scroll
MOUSE_WHEEL= and Y
true for the coordinates of
chart) the mouse
pointer. S ee
description in
the example
below
event of CHARTEVENT_OB — — Name of the
graphical object JECT _CREAT E created graphical
creation (if object
CHART_EVENT_O
BJECT _CREAT E=t
rue is set for the
chart)
Event of change CHARTEVENT_OB — — Name of the
of an object JECT _CHANGE modified
property via the graphical object
properties dialog
Event of CHARTEVENT_OB — — Name of the
graphical object JECT _DEL ET E deleted graphical
deletion (if object
CHART_EVENT_O
BJECT _DEL ET E=t
rue is set for the
chart)
Event of a CHARTEVENT_C the X coordinate the Y coordinate —
mouse click on LICK
the chart
Event of a CHARTEVENT_OB the X coordinate the Y coordinate Name of the
mouse click in a JECT _CLICK graphical object,
graphical object on which the
belonging to the event occurred
chart
Event of a CHARTEVENT_OB — — Name of the
graphical object JECT _DRAG moved graphical
dragging using object
the mouse
Event of the CHARTEVENT_OB — — Name of the
finished text JECT _ENDEDIT LabelEdit
editing in the graphical object,
entry box of the in which text
LabelEdit editing has
graphical object completed
Event of change CHARTEVENT_C — — —
of the chart size HAR T _CHANGE
or modification
of chart
properties
through the
Properties dialog
ID of the user CHARTEVENT_CU Value set by the Value set by the Value set by the
event under the S TOM+N EventChartCusto EventChartCusto EventChartCusto
N number m() function m() function m() function
Example:
#define KEY_NUMPAD_5 12
#define KEY_LEFT 37
#define KEY_UP 38
#define KEY_RIGHT 39
#define KEY_DOWN 40
#define KEY_NUMLOCK_DOWN 98
#define KEY_NUMLOCK_LEFT 100
#define KEY_NUMLOCK_5 101
#define KEY_NUMLOCK_RIGHT 102
#define KEY_NUMLOCK_UP 104
//+------------------------------------------------------------------+
//| Expert initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//---
Print("The expert with name ",MQL5InfoString(MQL5_PROGRAM_NAME)," is running");
//--- enable object create events
ChartSetInteger(ChartID(),CHART_EVENT_OBJECT_CREATE,true);
//--- enable object delete events
ChartSetInteger(ChartID(),CHART_EVENT_OBJECT_DELETE,true);
//--- forced updating of chart properties ensures readiness for event processing
ChartRedraw();
//---
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| ChartEvent function |
//+------------------------------------------------------------------+
void OnChartEvent(const int id, // Event identifier
const long& lparam, // Event parameter of long type
const double& dparam, // Event parameter of double type
const string& sparam // Event parameter of string type
)
{
//--- the left mouse button has been pressed on the chart
if(id==CHARTEVENT_CLICK)
{
Print("The coordinates of the mouse click on the chart are: x = ",lparam," y = ",dparam);
}
//--- the mouse has been clicked on the graphic object
if(id==CHARTEVENT_OBJECT_CLICK)
{
Print("The mouse has been clicked on the object with name '"+sparam+"'");
}
//--- the key has been pressed
if(id==CHARTEVENT_KEYDOWN)
{
switch(lparam)
{
case KEY_NUMLOCK_LEFT: Print("The KEY_NUMLOCK_LEFT has been pressed"); break;
case KEY_LEFT: Print("The KEY_LEFT has been pressed"); break;
case KEY_NUMLOCK_UP: Print("The KEY_NUMLOCK_UP has been pressed"); break;
case KEY_UP: Print("The KEY_UP has been pressed"); break;
case KEY_NUMLOCK_RIGHT: Print("The KEY_NUMLOCK_RIGHT has been pressed"); break;
case KEY_RIGHT: Print("The KEY_RIGHT has been pressed"); break;
case KEY_NUMLOCK_DOWN: Print("The KEY_NUMLOCK_DOWN has been pressed"); break;
case KEY_DOWN: Print("The KEY_DOWN has been pressed"); break;
case KEY_NUMPAD_5: Print("The KEY_NUMPAD_5 has been pressed"); break;
case KEY_NUMLOCK_5: Print("The KEY_NUMLOCK_5 has been pressed"); break;
default: Print("Some not listed key has been pressed");
}
ChartRedraw();
}
//--- the object has been deleted
if(id==CHARTEVENT_OBJECT_DELETE)
{
Print("The object with name ",sparam," has been deleted");
}
//--- the object has been created
if(id==CHARTEVENT_OBJECT_CREATE)
{
Print("The object with name ",sparam," has been created");
}
//--- the object has been moved or its anchor point coordinates has been changed
if(id==CHARTEVENT_OBJECT_DRAG)
{
Print("The anchor point coordinates of the object with name ",sparam," has been changed");
}
//--- the text in the Edit of object has been changed
if(id==CHARTEVENT_OBJECT_ENDEDIT)
{
Print("The text in the Edit field of the object with name ",sparam," has been changed");
}
}
For CHAR T EVENT _MOUSE_MOVE event the sparam string parameter contains information about state
of the keyboard and mouse buttons :
Bit Description
Example:
//+------------------------------------------------------------------+
//| Expert initialization function |
//+------------------------------------------------------------------+
void OnInit()
{
//--- enable CHART_EVENT_MOUSE_MOVE messages
ChartSetInteger(0,CHART_EVENT_MOUSE_MOVE,1);
//--- disable the context menu of the chart (on the right)
ChartSetInteger(0,CHART_CONTEXT_MENU,0);
//--- disable the crosshair (by the middle button)
ChartSetInteger(0,CHART_CROSSHAIR_TOOL,0);
//--- forced updating of chart properties ensures readiness for event processing
ChartRedraw();
}
//+------------------------------------------------------------------+
//| MouseState |
//+------------------------------------------------------------------+
string MouseState(uint state)
{
string res;
res+="\nML: " +(((state& 1)== 1)?"DN":"UP"); // mouse left
res+="\nMR: " +(((state& 2)== 2)?"DN":"UP"); // mouse right
res+="\nMM: " +(((state&16)==16)?"DN":"UP"); // mouse middle
res+="\nMX: " +(((state&32)==32)?"DN":"UP"); // mouse first X key
res+="\nMY: " +(((state&64)==64)?"DN":"UP"); // mouse second X key
res+="\nSHIFT: "+(((state& 4)== 4)?"DN":"UP"); // shift key
res+="\nCTRL: " +(((state& 8)== 8)?"DN":"UP"); // control key
return(res);
}
//+------------------------------------------------------------------+
//| ChartEvent function |
//+------------------------------------------------------------------+
void OnChartEvent(const int id,const long &lparam,const double &dparam,const string &sparam)
{
if(id==CHARTEVENT_MOUSE_MOVE)
Comment("POINT: ",(int)lparam,",",(int)dparam,"\n",MouseState((uint)sparam));
}
For the CHARTEVENT_MOUSE_WHEEL event, parameters lparam and dparam contain information
about the states of the Ctrl and Shift keys, of mouse buttons, cursor coordinates and the mouse wheel
scroll value. For a better understanding, run this Expert Advisor on a chart and scroll the mouse wheel,
while pressing different buttons and holding down the keys described in the code.
Example of CHAR T EVENT _MOUSE_WHEEL event processing:
//+------------------------------------------------------------------+
//| Expert initialization function |
//+------------------------------------------------------------------+
init OnInit()
{
//--- Enabling mouse wheel scrolling messages
ChartSetInteger(0,CHART_EVENT_MOUSE_WHEEL,1);
//--- Forced updating of chart properties ensures readiness for event processing
ChartRedraw();
//---
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| ChartEvent function |
//+------------------------------------------------------------------+
void OnChartEvent(const int id,const long &lparam,const double &dparam,const string &sparam)
{
if(id==CHARTEVENT_MOUSE_WHEEL)
{
//--- Consider the state of mouse buttons and wheel for this event
int flg_keys = (int)(lparam>>32); // The flag of states of the Ctrl and Shift keys,
int x_cursor = (int)(short)lparam; // the X coordinate where the mousse wheel event o
int y_cursor = (int)(short)(lparam>>16); // the Y coordinate where the mousse wheel event o
int delta = (int)dparam; // the total value of mouse scroll, triggers when
//--- Processing the flag
string str_keys="";
if((flg_keys&0x0001)!=0) str_keys+="LMOUSE ";
if((flg_keys&0x0002)!=0) str_keys+="RMOUSE ";
if((flg_keys&0x0004)!=0) str_keys+="SHIFT ";
if((flg_keys&0x0008)!=0) str_keys+="CTRL ";
if((flg_keys&0x0010)!=0) str_keys+="MMOUSE ";
if((flg_keys&0x0020)!=0) str_keys+="X1MOUSE ";
if((flg_keys&0x0040)!=0) str_keys+="X2MOUSE ";
if(str_keys!="")
str_keys=", keys='"+StringSubstr(str_keys,0,StringLen(str_keys)-1) + "'";
PrintFormat("%s: X=%d, Y=%d, delta=%d%s",EnumToString(CHARTEVENT_MOUSE_WHEEL),x_cursor,y_curs
}
}
//+------------------------------------------------------------------+ /*
Example of the output
CHARTEVENT_MOUSE_WHEEL: Ctrl pressed: X=193, Y=445, delta=-120
CHARTEVENT_MOUSE_WHEEL: Shift pressed: X=186, Y=446, delta=120
CHARTEVENT_MOUSE_WHEEL: X=178, Y=447, delta=-120
CHARTEVENT_MOUSE_WHEEL: X=231, Y=449, delta=120
CHARTEVENT_MOUSE_WHEEL: MiddleButton pressed: X=231, Y=449, delta=120
CHARTEVENT_MOUSE_WHEEL: LeftButton pressed: X=279, Y=320, delta=-120
CHARTEVENT_MOUSE_WHEEL: RightButton pressed: X=253, Y=330, delta=120 */
See also
Event H andling Functions, W ork ing with events
Chart Timeframes
Allpredefined timeframes of charts have unique identifiers. The PERIOD_CURRENT identifier means
the current period of a chart, at which a mql5-program is running.
ENUM_TIMEFRAMES
ID Description
Example:
string chart_name="test_Object_Chart";
Print("Let's try to create a Chart object with the name ",chart_name);
//--- If such an object does not exist - create it
if(ObjectFind(0,chart_name)<0)ObjectCreate(0,chart_name,OBJ_CHART,0,0,0,0,0);
Timeseries identifiers
The identifiers of timeseries are used in the iHighest() and iLowest() functions. They can be equal to
a value the enumeration
ENUM_SERIESMODE
Identifier Description
See also
Chart Properties
Identifiers of ENUM _CHART_PROPERTY enumerations are used as parameters of functions for working
with charts. The abbreviation of r/o in the " Property Type" column means that this property is read-
only and cannot be changed. The w/o abbreviation in the " Property Type" column means that this
property is write-only and it cannot be received. W hen accessing certain properties, it's necessary to
specify an additional parameter-modifier (modifier), which serves to indicate the number of chart
subwindows. 0 means the main window.
The functions defining the chart properties are actually used for sending change commands to the
chart. If these functions are executed successfully, the command is included in the common queue of
the chart events. The changes are implemented to the chart when handling the queue of the chart
events.
Thus, do not expect an immediate visual update of the chart after calling these functions. Generally,
the chart is updated automatically by the terminal following the change events - a new quote arrival,
resizing the chart window, etc. Use ChartRedraw() function to forcefully update the chart.
For functions ChartS etInteger() and ChartGetInteger()
ENUM_CHART_PROPERTY _INTEGER
CHART_W INDOW_YDI The distance between the upper frame of int r/o modifier -
S T ANCE the indicator subwindow and the upper subwindow number
frame of the main chart window, along the
vertical Y axis, in pixels. In case of a
mouse event, the cursor coordinates are
passed in terms of the coordinates of the
main chart window, while the coordinates
of graphical objects in an indicator
subwindow are set relative to the upper
left corner of the subwindow.
The value is required for converting the
absolute coordinates of the main chart to
the local coordinates of a subwindow for
correct work with the graphical objects,
whose coordinates are set relative to the
upper left corner of the subwindow frame.
CHART_FIRS T_VIS IBLE Number of the first visible bar in the int r/o
_BAR chart. Indexing of bars is the same as for
timeseries.
CHART_W IDTH_IN_BA Chart width in bars int r/o
RS
CHART_COLOR_CHAR Color for the down bar, shadows and body color
T_DOWN borders of bear candlesticks
CHART_COLOR_CHAR Line chart color and color of "Doji" color
T_LINE Japanese candlestick s
int chartMode=ChartGetInteger(0,CHART_MODE);
switch(chartMode)
{
case(CHART_BARS): Print("CHART_BARS"); break;
case(CHART_CANDLES): Print("CHART_CANDLES");break;
default:Print("CHART_LINE");
}
bool shifted=ChartGetInteger(0,CHART_SHIFT);
if(shifted) Print("CHART_SHIFT = true");
else Print("CHART_SHIFT = false");
bool autoscroll=ChartGetInteger(0,CHART_AUTOSCROLL);
if(autoscroll) Print("CHART_AUTOSCROLL = true");
else Print("CHART_AUTOSCROLL = false");
int chartHandle=ChartGetInteger(0,CHART_WINDOW_HANDLE);
Print("CHART_WINDOW_HANDLE = ",chartHandle);
int windows=ChartGetInteger(0,CHART_WINDOWS_TOTAL);
Print("CHART_WINDOWS_TOTAL = ",windows);
if(windows>1)
{
for(int i=0;i<windows;i++)
{
int height=ChartGetInteger(0,CHART_HEIGHT_IN_PIXELS,i);
double priceMin=ChartGetDouble(0,CHART_PRICE_MIN,i);
double priceMax=ChartGetDouble(0,CHART_PRICE_MAX,i);
Print(i+": CHART_HEIGHT_IN_PIXELS = ",height," pixels");
Print(i+": CHART_PRICE_MIN = ",priceMin);
Print(i+": CHART_PRICE_MAX = ",priceMax);
}
See also
Positioning Constants
Three identifiers from the ENUM _CHART_POS ITION list are the possible values of the position
ID Description
Example:
long handle=ChartOpen("EURUSD",PERIOD_H12);
if(handle!=0)
{
ChartSetInteger(handle,CHART_AUTOSCROLL,false);
ChartSetInteger(handle,CHART_SHIFT,true);
ChartSetInteger(handle,CHART_MODE,CHART_LINE);
ResetLastError();
bool res=ChartNavigate(handle,CHART_END,150);
if(!res) Print("Navigate failed. Error = ",GetLastError());
ChartRedraw();
}
Chart Representation
Price charts can be displayed in three ways :
· as bars ;
· as candlesticks ;
· as a line.
The specific way of displaying the price chart is set by the function
ChartS etInteger(chart_handle,CHART_MODE, chart_mode), where chart_mode is one of the values of
the ENUM _CHART_MODE enumeration.
ENUM_CHART_MODE
ID Description
ENUM_CHART_VOLUME_MODE
ID Description
See also
ChartOpen, ChartID
//+------------------------------------------------------------------+
//| Checks if an object is a chart. If it is a graphic object, |
//| the result is true. If it is a real chart, the result variable |
//| has the value of false. |
//+------------------------------------------------------------------+
bool ChartIsObject(bool &result,const long chart_ID=0)
{
//--- prepare the variable to get the property value
long value;
//--- reset the error value
ResetLastError();
//--- get the chart property
if(!ChartGetInteger(chart_ID,CHART_IS_OBJECT,0,value))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
//--- return false
return(false);
}
//--- store the value of the chart property in memory
result=value;
//--- successful execution
return(true);
}
· CHART_MOUSE_SCROLL is a property for scrolling the chart using left mouse button.
//+--------------------------------------------------------------------------+
//| Checks if scrolling of chart using left mouse button is enabled |
//+--------------------------------------------------------------------------+
bool ChartMouseScrollGet(bool &result,const long chart_ID=0)
{
//--- prepare the variable to get the property value
long value;
//--- reset the error value
ResetLastError();
//--- receive the property value
if(!ChartGetInteger(chart_ID,CHART_MOUSE_SCROLL,0,value))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
return(false);
}
//--- store the value of the chart property in memory
result=value;
//--- successful execution
return(true);
}
//+--------------------------------------------------------------------+
//| Enables/disables scrolling of chart using left mouse button |
//+--------------------------------------------------------------------+
bool ChartMouseScrollSet(const bool value,const long chart_ID=0)
{
//--- reset the error value
ResetLastError();
//--- set property value
if(!ChartSetInteger(chart_ID,CHART_MOUSE_SCROLL,0,value))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
return(false);
}
//--- store the value of the chart property in memory
result=value;
//--- successful execution
return(true);
}
//+--------------------------------------------------------------------------+
//| Enables/disables the mode of sending messages concerning the event of a |
//| graphic object deletion to all mql5 applications on the chart |
//+--------------------------------------------------------------------------+
bool ChartEventObjectDeleteSet(const bool value,const long chart_ID=0)
{
//--- reset the error value
ResetLastError();
//--- set property value
if(!ChartSetInteger(chart_ID,CHART_EVENT_OBJECT_DELETE,0,value))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
}
//+------------------------------------------------------------------+
//| Sets chart display type (candlesticks, bars or line) |
//+------------------------------------------------------------------+
bool ChartModeSet(const long value,const long chart_ID=0)
{
//--- reset the error value
ResetLastError();
//--- set property value
if(!ChartSetInteger(chart_ID,CHART_MODE,value))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
ResetLastError();
//--- set property value
if(!ChartSetInteger(chart_ID,CHART_FOREGROUND,0,value))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
· CHART_SHIFT – mode of shift of the price chart from the right border.
//+-------------------------------------------------------------------+
//| Checks if shifting a price chart from the right border is enabled |
//+-------------------------------------------------------------------+
bool ChartShiftGet(bool &result,const long chart_ID=0)
{
//--- prepare the variable to get the property value
long value;
//--- reset the error value
ResetLastError();
//--- receive the property value
if(!ChartGetInteger(chart_ID,CHART_SHIFT,0,value))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
return(false);
}
//--- store the value of the chart property in memory
result=value;
//--- successful execution
return(true);
}
//+---------------------------------------------------------------------------------+
//| Enables/disables displaying of a price chart with a shift from the right border |
//+---------------------------------------------------------------------------------+
bool ChartShiftSet(const bool value,const long chart_ID=0)
{
//--- reset the error value
ResetLastError();
//--- set property value
if(!ChartSetInteger(chart_ID,CHART_SHIFT,0,value))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
· CHART_AUTOSCROLL – the mode of automatic shift to the right border of the chart.
//+------------------------------------------------------------------+
//| Checks if automatic scrolling of a chart to the right |
//| on new ticks arrival is enabled |
//+------------------------------------------------------------------+
bool ChartAutoscrollGet(bool &result,const long chart_ID=0)
{
//--- prepare the variable to get the property value
long value;
//--- reset the error value
ResetLastError();
//--- receive the property value
if(!ChartGetInteger(chart_ID,CHART_AUTOSCROLL,0,value))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
return(false);
}
//--- store the value of the chart property in memory
result=value;
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Enables/disables automatic scrolling of a chart to the right |
//| on new ticks arrival |
//+------------------------------------------------------------------+
bool ChartAutoscrollSet(const bool value,const long chart_ID=0)
{
//--- reset the error value
ResetLastError();
//--- set property value
if(!ChartSetInteger(chart_ID,CHART_AUTOSCROLL,0,value))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
if(!ChartGetInteger(chart_ID,CHART_SCALEFIX_11,0,value))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
return(false);
}
//--- store the value of the chart property in memory
result=value;
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Enables/disables the "1:1" scale mode |
//+------------------------------------------------------------------+
bool ChartScaleFix11Set(const bool value,const long chart_ID=0)
{
//--- reset the error value
ResetLastError();
//--- set property value
if(!ChartSetInteger(chart_ID,CHART_SCALEFIX_11,0,value))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
· CHART_SCALE_PT_PER_BAR – the mode of specifying the chart scale in points per bar.
//+------------------------------------------------------------------+
//| Checks if the "points per bar" chart scaling mode is enabled |
//+------------------------------------------------------------------+
bool ChartScalePerBarGet(bool &result,const long chart_ID=0)
{
//--- prepare the variable to get the property value
long value;
//--- reset the error value
ResetLastError();
//--- receive the property value
if(!ChartGetInteger(chart_ID,CHART_SCALE_PT_PER_BAR,0,value))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
return(false);
}
//--- store the value of the chart property in memory
result=value;
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Enables/disables the "points per bar" chart scaling mode |
//+------------------------------------------------------------------+
bool ChartScalePerBarSet(const bool value,const long chart_ID=0)
{
//--- reset the error value
ResetLastError();
//--- set property value
if(!ChartSetInteger(chart_ID,CHART_SCALE_PT_PER_BAR,0,value))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
· CHART_SHOW_BID_LINE – the property of displaying Bid value as a horizontal line on the chart.
//+------------------------------------------------------------------+
//| Checks if displaying of Bid line on chart is enabled |
//+------------------------------------------------------------------+
bool ChartShowBidLineGet(bool &result,const long chart_ID=0)
{
//--- prepare the variable to get the property value
long value;
//--- reset the error value
ResetLastError();
//--- receive the property value
if(!ChartGetInteger(chart_ID,CHART_SHOW_BID_LINE,0,value))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
return(false);
}
//--- store the value of the chart property in memory
result=value;
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Enables/disables displaying of Bid line on chart |
//+------------------------------------------------------------------+
bool ChartShowBidLineSet(const bool value,const long chart_ID=0)
{
//--- reset the error value
ResetLastError();
//--- set property value
if(!ChartSetInteger(chart_ID,CHART_SHOW_BID_LINE,0,value))
{
//+---------------------------------------------------------------------------------+
bool ChartShowPeriodSeparatorGet(bool &result,const long chart_ID=0)
{
//--- prepare the variable to get the property value
long value;
//--- reset the error value
ResetLastError();
//--- receive the property value
if(!ChartGetInteger(chart_ID,CHART_SHOW_PERIOD_SEP,0,value))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
return(false);
}
//--- store the value of the chart property in memory
result=value;
//--- successful execution
return(true);
}
//+-----------------------------------------------------------------------------+
//| Enables/disables displaying of vertical separators between adjacent periods |
//+-----------------------------------------------------------------------------+
bool ChartShowPeriodSepapatorSet(const bool value,const long chart_ID=0)
{
//--- reset the error value
ResetLastError();
//--- set property value
if(!ChartSetInteger(chart_ID,CHART_SHOW_PERIOD_SEP,0,value))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
· CHART_VISIBLE_BARS defines the number of bars on a chart that are available for display.
//+----------------------------------------------------------------------+
//| Gets the number of bars that are displayed (visible) in chart window |
//+----------------------------------------------------------------------+
int ChartVisibleBars(const long chart_ID=0)
{
//--- prepare the variable to get the property value
long result=-1;
//--- reset the error value
ResetLastError();
//--- receive the property value
if(!ChartGetInteger(chart_ID,CHART_VISIBLE_BARS,0,result))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
}
//--- return the value of the chart property
return((int)result);
}
· CHART_WINDOW_ Y DISTANCE defines the distance in pixels between the upper frame of the
indicator subwindow and the upper frame of the chart's main window.
//+------------------------------------------------------------------+
//| Gets the distance in pixels between the upper border of |
//| subwindow and the upper border of chart's main window |
//+------------------------------------------------------------------+
int ChartWindowsYDistance(const long chart_ID=0,const int sub_window=0)
{
//--- prepare the variable to get the property value
long result=-1;
//--- reset the error value
ResetLastError();
//--- receive the property value
if(!ChartGetInteger(chart_ID,CHART_WINDOW_YDISTANCE,sub_window,result))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
}
//--- return the value of the chart property
return((int)result);
}
· CHART_FIRST_VISIBLE_BAR returns the number of the first visible bar on the chart (bar indexing
corresponds to the time series).
//+------------------------------------------------------------------------------+
//| Gets the index of the first visible bar on chart. |
//| Indexing is performed like in timeseries: latest bars have smallest indices. |
//+------------------------------------------------------------------------------+
int ChartFirstVisibleBar(const long chart_ID=0)
{
//--- prepare the variable to get the property value
long result=-1;
//--- reset the error value
ResetLastError();
//--- receive the property value
if(!ChartGetInteger(chart_ID,CHART_FIRST_VISIBLE_BAR,0,result))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
}
//--- return the value of the chart property
return((int)result);
}
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
}
//--- return the value of the chart property
return((color)result);
}
//+------------------------------------------------------------------+
//| Sets the color of axes, scale and OHLC line |
//+------------------------------------------------------------------+
bool ChartForeColorSet(const color clr,const long chart_ID=0)
{
//--- reset the error value
ResetLastError();
//--- set the color of axes, scale and OHLC line
if(!ChartSetInteger(chart_ID,CHART_COLOR_FOREGROUND,clr))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
}
//--- successful execution
return(true);
}
· CHART_COLOR_CHART_UP – color of up bar, its shadow and border of a bullish candlestick's body.
//+-----------------------------------------------------------------------------+
//| Gets the color of up bar, shadow and border of a bullish candlestick's body |
//+-----------------------------------------------------------------------------+
color ChartUpColorGet(const long chart_ID=0)
{
//--- prepare the variable to receive the color
long result=clrNONE;
//--- reset the error value
ResetLastError();
//--- receive the color of up bar, its shadow and border of bullish candlestick's body
if(!ChartGetInteger(chart_ID,CHART_COLOR_CHART_UP,0,result))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
}
//--- return the value of the chart property
return((color)result);
}
//+------------------------------------------------------------------+
//| Sets the color of up bar, shadow and border of a bullish candlestick's body |
//+------------------------------------------------------------------+
bool ChartUpColorSet(const color clr,const long chart_ID=0)
{
//--- reset the error value
ResetLastError();
//--- set the color of up bar, its shadow and border of body of a bullish candlestick
if(!ChartSetInteger(chart_ID,CHART_COLOR_CHART_UP,clr))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
· CHART_COLOR_CHART_DOWN – color of down bar, its shadow and border of bearish candlestick's
body.
//+-------------------------------------------------------------------------------+
//| Gets the color of down bar, shadow and border of a bearish candlestick's body |
//+-------------------------------------------------------------------------------+
color ChartDownColorGet(const long chart_ID=0)
{
//--- prepare the variable to receive the color
long result=clrNONE;
//--- reset the error value
ResetLastError();
//--- receive the color of down bar, its shadow and border of bearish candlestick's body
if(!ChartGetInteger(chart_ID,CHART_COLOR_CHART_DOWN,0,result))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
}
//--- return the value of the chart property
return((color)result);
}
//+-------------------------------------------------------------------------------+
//| Sets the color of down bar, shadow and border of a bearish candlestick's body |
//+-------------------------------------------------------------------------------+
bool ChartDownColorSet(const color clr,const long chart_ID=0)
{
//--- reset the error value
ResetLastError();
//--- set the color of down bar, its shadow and border of bearish candlestick's body
if(!ChartSetInteger(chart_ID,CHART_COLOR_CHART_DOWN,clr))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
}
//--- return the value of the chart property
return((color)result);
}
//+------------------------------------------------------------------+
//| Sets the color of chart line and Doji candlesticks |
//+------------------------------------------------------------------+
bool ChartLineColorSet(const color clr,const long chart_ID=0)
{
//--- reset the error value
ResetLastError();
//--- set color of the chart line and Doji candlesticks
if(!ChartSetInteger(chart_ID,CHART_COLOR_CHART_LINE,clr))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
color ChartAskColorGet(const long chart_ID=0)
{
//--- prepare the variable to receive the color
long result=clrNONE;
//--- reset the error value
ResetLastError();
//--- receive the color of Ask price line
if(!ChartGetInteger(chart_ID,CHART_COLOR_ASK,0,result))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
}
//--- return the value of the chart property
return((color)result);
}
//+------------------------------------------------------------------+
//| Sets the color of Ask line |
//+------------------------------------------------------------------+
bool ChartAskColorSet(const color clr,const long chart_ID=0)
{
//--- reset the error value
ResetLastError();
//--- set the color of Ask price line
if(!ChartSetInteger(chart_ID,CHART_COLOR_ASK,clr))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
· CHART_COLOR_STOP_LEVEL – stop order level color (S top Loss and Take Profit).
//+------------------------------------------------------------------+
//| Gets the color of Stop Loss and Take Profit levels |
//+------------------------------------------------------------------+
color ChartStopLevelColorGet(const long chart_ID=0)
{
//--- prepare the variable to receive the color
long result=clrNONE;
//--- reset the error value
ResetLastError();
//--- receive the color of stop order levels (Stop Loss and Take Profit)
if(!ChartGetInteger(chart_ID,CHART_COLOR_STOP_LEVEL,0,result))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
}
//--- return the value of the chart property
return((color)result);
}
//+------------------------------------------------------------------+
//| Sets the color of Stop Loss and Take Profit levels |
//+------------------------------------------------------------------+
bool ChartStopLevelColorSet(const color clr,const long chart_ID=0)
{
//--- reset the error value
ResetLastError();
//--- set the color of stop order levels (Stop Loss and Take Profit)
if(!ChartSetInteger(chart_ID,CHART_COLOR_STOP_LEVEL,clr))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
bool ChartShowPriceScaleGet(bool &result,const long chart_ID=0)
{
//--- prepare the variable to get the property value
long value;
//--- reset the error value
ResetLastError();
//--- receive the property value
if(!ChartGetInteger(chart_ID,CHART_SHOW_PRICE_SCALE,0,value))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
return(false);
}
//--- store the value of the chart property in memory
result=value;
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Enables/disables displaying of the price scale on chart |
//+------------------------------------------------------------------+
bool ChartShowPriceScaleSet(const bool value,const long chart_ID=0)
{
//--- reset the error value
ResetLastError();
//--- set property value
if(!ChartSetInteger(chart_ID,CHART_SHOW_PRICE_SCALE,0,value))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
· CHART_SHOW_ONE_CLICK – property of displaying the " One click trading " panel on a chart.
//+------------------------------------------------------------------+
//| Checks if the "One click trading" panel is displayed on chart |
//+------------------------------------------------------------------+
bool ChartShowOneClickPanelGet(bool &result,const long chart_ID=0)
{
//--- prepare the variable to get the property value
long value;
//--- reset the error value
ResetLastError();
· CHART_SHIFT_SI ZE – shift size of the zero bar from the right border in percentage values.
//+-----------------------------------------------------------------+
//| Gets the size of shifting of the zero bar from the right border |
//| of the chart in percentage values (from 10% up to 50%) |
//+-----------------------------------------------------------------+
double ChartShiftSizeGet(const long chart_ID=0)
{
//--- prepare the variable to get the result
double result=EMPTY_VALUE;
//--- reset the error value
ResetLastError();
//--- receive the property value
if(!ChartGetDouble(chart_ID,CHART_SHIFT_SIZE,0,result))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
}
//--- return the value of the chart property
return(result);
}
//+-----------------------------------------------------------------------------+
//| Gets the size of shifting of the zero bar from the right border |
//| of the chart in percentage values (from 10% up to 50%). |
//| To enable the shift mode, CHART_SHIFT property value should be set to true. |
//+-----------------------------------------------------------------------------+
bool ChartShiftSizeSet(const double value,const long chart_ID=0)
{
//--- reset the error value
ResetLastError();
//--- set property value
if(!ChartSetDouble(chart_ID,CHART_SHIFT_SIZE,value))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
· CHART_FI X ED_POSITION – chart fixed position from the left border in percentage value.
//+----------------------------------------------------------------------------------------+
//| Gets the location of chart's fixed position from the left border (in percentage value) |
//+----------------------------------------------------------------------------------------+
double ChartFixedPositionGet(const long chart_ID=0)
{
//--- prepare the variable to get the result
double result=EMPTY_VALUE;
//--- reset the error value
ResetLastError();
//--- receive the property value
if(!ChartGetDouble(chart_ID,CHART_FIXED_POSITION,0,result))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
}
//--- return the value of the chart property
return(result);
}
//+-----------------------------------------------------------------------------------------+
//| Gets the location of chart's fixed position from the left border (in percentage value). |
//| To view the location of chart's fixed position, the value of CHART_AUTOSCROLL property |
//| should be set to false. |
//+-----------------------------------------------------------------------------------------+
bool ChartFixedPositionSet(const double value,const long chart_ID=0)
{
//--- reset the error value
ResetLastError();
//--- set property value
if(!ChartSetDouble(chart_ID,CHART_FIXED_POSITION,value))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
{
//--- prepare the variable to get the result
double result=EMPTY_VALUE;
//--- reset the error value
ResetLastError();
//--- receive the property value
if(!ChartGetDouble(chart_ID,CHART_PRICE_MIN,sub_window,result))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
}
//--- return the value of the chart property
return(result);
}
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Gets comment in the upper left corner of chart |
//+------------------------------------------------------------------+
bool ChartCommentSet(const string str,const long chart_ID=0)
{
//--- reset the error value
ResetLastError();
//--- set property value
if(!ChartSetString(chart_ID,CHART_COMMENT,str))
{
//--- display the error message in Experts journal
Print(__FUNCTION__+", Error Code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
double ExtMaxValue[]; // maximum property values that are possible when working with
double ExtMinValue[]; // minimum property values that are possible when working with
double ExtStep[]; // steps for changing properties
int ExtCount; // total number of all properties
color ExtColors[2]; // array of colors for displaying lines
string ExtComments[2]; // array of comments (for CHART_COMMENT property)
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- display a comment on the chart
Comment("SomeComment");
//--- store colors in the array to be able to switch between them later
ExtColors[0]=InpFirstColor;
ExtColors[1]=InpSecondColor;
//--- store comments in the array to be able to switch between them later
ExtComments[0]="FirstComment";
ExtComments[1]="SecondComment";
//--- prepare and display the control panel for managing chart properties
if(!PrepareControls())
return(INIT_FAILED);
//--- successful execution
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Deinitialization function of the expert |
//+------------------------------------------------------------------+
void OnDeinit(const int reason)
{
//--- remove the comment on the chart
Comment("");
}
//+------------------------------------------------------------------+
//| Handler of a chart event |
//+------------------------------------------------------------------+
void OnChartEvent(const int id,
const long &lparam,
const double &dparam,
const string &sparam)
{
//--- check the event of clicking the chart object
if(id==CHARTEVENT_OBJECT_CLICK)
{
//--- divide the object name by separator
string obj_name[];
StringSplit(sparam,'_',obj_name);
//--- check if the object is a button
if(obj_name[0]=="Button")
{
//--- receive button index
int index=(int)StringToInteger(obj_name[1]);
//--- unpress the button
ExtButtons[index].State(false);
//--- set the new value of the property depending on its type
if(ExtDataTypes[index]=='I')
ChangeIntegerProperty(index);
if(ExtDataTypes[index]=='D')
ChangeDoubleProperty(index);
if(ExtDataTypes[index]=='S')
ChangeStringProperty(index);
}
}
//--- re-draw property values
RedrawProperties();
ChartRedraw();
}
//+------------------------------------------------------------------+
//| Changes an integer property of chart |
//+------------------------------------------------------------------+
void ChangeIntegerProperty(const int index)
{
//--- receive the current property value
long value=ChartGetInteger(0,(ENUM_CHART_PROPERTY_INTEGER)ExtNumbers[index]);
//--- define the following property value
switch(ExtDrawTypes[index])
{
case 'C':
value=GetNextColor((color)value);
break;
default:
value=(long)GetNextValue((double)value,index);
break;
}
//--- set the new property value
ChartSetInteger(0,(ENUM_CHART_PROPERTY_INTEGER)ExtNumbers[index],0,value);
}
//+------------------------------------------------------------------+
//| Changes a double property of chart |
//+------------------------------------------------------------------+
void ChangeDoubleProperty(const int index)
{
//--- receive the current property value
double value=ChartGetDouble(0,(ENUM_CHART_PROPERTY_DOUBLE)ExtNumbers[index]);
//--- define the following property value
value=GetNextValue(value,index);
//--- set the new property value
ChartSetDouble(0,(ENUM_CHART_PROPERTY_DOUBLE)ExtNumbers[index],value);
}
//+------------------------------------------------------------------+
//| Changes a string property of chart |
//+------------------------------------------------------------------+
void ChangeStringProperty(const int index)
{
//--- static variable for switching inside ExtComments array
static uint comment_index=1;
//--- change index for receiving another comment
comment_index=1-comment_index;
//--- set the new property value
ChartSetString(0,(ENUM_CHART_PROPERTY_STRING)ExtNumbers[index],ExtComments[comment_index]);
}
//+------------------------------------------------------------------+
//| Gets the next property value |
//+------------------------------------------------------------------+
double GetNextValue(const double value,const int index)
{
if(value+ExtStep[index]<=ExtMaxValue[index])
return(value+ExtStep[index]);
else
return(ExtMinValue[index]);
}
//+------------------------------------------------------------------+
//| Gets the next color for color type property |
//+------------------------------------------------------------------+
color GetNextColor(const color clr)
{
//--- return the following color value
switch(clr)
{
case clrWhite: return(clrRed);
case clrRed: return(clrGreen);
case clrGreen: return(clrBlue);
case clrBlue: return(clrBlack);
default: return(clrWhite);
}
}
//+------------------------------------------------------------------+
//| Re-draws property values |
//+------------------------------------------------------------------+
void RedrawProperties(void)
{
//--- property value text
string text;
long value;
//--- loop of the number of properties
for(int i=0;i<ExtCount;i++)
{
text="";
switch(ExtDataTypes[i])
{
case 'I':
//--- receive the current property value
if(!ChartGetInteger(0,(ENUM_CHART_PROPERTY_INTEGER)ExtNumbers[i],0,value))
break;
//--- integer property text
switch(ExtDrawTypes[i])
{
//--- color property
case 'C':
text=(string)((color)value);
break;
//--- boolean property
case 'B':
text=(string)((bool)value);
break;
//--- ENUM_CHART_MODE enumeration property
case 'M':
text=EnumToString((ENUM_CHART_MODE)value);
break;
//--- ENUM_CHART_VOLUME_MODE enumeration property
case 'V':
text=EnumToString((ENUM_CHART_VOLUME_MODE)value);
break;
//--- int type number
default:
text=IntegerToString(value);
break;
}
break;
case 'D':
//--- double property text
text=DoubleToString(ChartGetDouble(0,(ENUM_CHART_PROPERTY_DOUBLE)ExtNumbers[i]),4);
break;
case 'S':
//--- string property text
text=ChartGetString(0,(ENUM_CHART_PROPERTY_STRING)ExtNumbers[i]);
break;
}
//--- display property value
ExtLabelsValue[i].Description(text);
}
}
//+------------------------------------------------------------------+
//| Creates panel for managing chart properties |
//+------------------------------------------------------------------+
bool PrepareControls(void)
{
//--- allocate memory for arrays with a reserve
MemoryAllocation(LAST_PROPERTY_NUMBER+1);
//--- variables
int i=0; // loop variable
int col_1=0; // number of properties in the first column
int col_2=0; // number of properties in the second column
int col_3=0; // number of properties in the third column
//--- current number of properties - 0
ExtCount=0;
//--- looking for properties in the loop
while(i<=LAST_PROPERTY_NUMBER)
{
//--- store the current number of the property
ExtNumbers[ExtCount]=i;
//--- increase the value of the loop variable
i++;
//--- check if there is a property with such a number
if(CheckNumber(ExtNumbers[ExtCount],ExtNames[ExtCount],ExtDataTypes[ExtCount],ExtGroupTypes[E
{
//--- create control elements for the property
switch(ExtGroupTypes[ExtCount])
{
case 1:
//--- create labels and a button for the property
if(!ShowProperty(ExtCount,0,X_PROPERTY_NAME_1,X_PROPERTY_VALUE_1,X_BUTTON_1,Y_PROPER
return(false);
//--- number of the elements in the first column has increased
col_1++;
break;
case 2:
//--- create labels and a button for the property
if(!ShowProperty(ExtCount,1,X_PROPERTY_NAME_2,X_PROPERTY_VALUE_2,X_BUTTON_2,Y_PROPER
return(false);
//--- number of the elements in the second column has increased
col_2++;
break;
case 3:
//--- create only labels for the property
if(!ShowProperty(ExtCount,2,X_PROPERTY_NAME_2,X_PROPERTY_VALUE_2,0,Y_PROPERTY_2+col_
return(false);
//--- number of the elements in the third column has increased
col_3++;
break;
}
//--- define maximum and minimum property value and step
GetMaxMinStep(ExtNumbers[ExtCount],ExtMaxValue[ExtCount],ExtMinValue[ExtCount],ExtStep[Ext
//--- increase the number of properties
ExtCount++;
}
}
//--- free the memory not used by arrays
MemoryAllocation(ExtCount);
//--- re-draw property values
RedrawProperties();
ChartRedraw();
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Allocates memory for arrays |
//+------------------------------------------------------------------+
void MemoryAllocation(const int size)
{
ArrayResize(ExtLabelsName,size);
ArrayResize(ExtLabelsValue,size);
ArrayResize(ExtButtons,size);
ArrayResize(ExtNumbers,size);
ArrayResize(ExtNames,size);
ArrayResize(ExtDataTypes,size);
ArrayResize(ExtGroupTypes,size);
ArrayResize(ExtDrawTypes,size);
ArrayResize(ExtMaxValue,size);
ArrayResize(ExtMinValue,size);
ArrayResize(ExtStep,size);
}
//+------------------------------------------------------------------+
//| Checks if the property index belongs to the one of |
//| ENUM_CHART_PROPERTIES enumerations |
//+------------------------------------------------------------------+
bool CheckNumber(const int ind,string &name,uchar &data_type,uint &group_type,uchar &draw_type)
{
//--- check if the property is of integer type
ResetLastError();
name=EnumToString((ENUM_CHART_PROPERTY_INTEGER)ind);
if(_LastError==0)
{
data_type='I'; // property from ENUM_CHART_PROPERTY_INTEGER enumeration
GetTypes(ind,group_type,draw_type); // define property display parameters
return(true);
}
//--- check if the property is of double type
ResetLastError();
name=EnumToString((ENUM_CHART_PROPERTY_DOUBLE)ind);
if(_LastError==0)
{
data_type='D'; // property from ENUM_CHART_PROPERTY_DOUBLE enumeration
GetTypes(ind,group_type,draw_type); // define property display parameters
return(true);
}
//--- check if the property is of string type
ResetLastError();
name=EnumToString((ENUM_CHART_PROPERTY_STRING)ind);
if(_LastError==0)
{
data_type='S'; // property from ENUM_CHART_PROPERTY_STRING enumeration
GetTypes(ind,group_type,draw_type); // define property display parameters
return(true);
}
//--- property does not belong to any enumeration
return(false);
}
//+------------------------------------------------------------------+
//| Defines the group in which property should be stored, |
//| as well as its display type |
//+------------------------------------------------------------------+
void GetTypes(const int property_number,uint &group_type,uchar &draw_type)
{
//--- check if the property belongs to the third group
//--- third group properties are displayed in the second column starting from CHART_BRING_TO_TOP
if(CheckThirdGroup(property_number,group_type,draw_type))
return;
//--- check if the property belongs to the second group
//--- second group properties are displayed at the beginning of the second column
if(CheckSecondGroup(property_number,group_type,draw_type))
return;
//--- if you find yourself here, the property belongs to the first group (first column)
CheckFirstGroup(property_number,group_type,draw_type);
}
//+----------------------------------------------------------------------+
//| Checks if property belongs to the third group and |
//| defines its display type in case of a positive answer |
//+----------------------------------------------------------------------+
bool CheckThirdGroup(const int property_number,uint &group_type,uchar &draw_type)
{
//--- check if the property belongs to the third group
switch(property_number)
{
//--- boolean properties
case CHART_IS_OBJECT:
case CHART_WINDOW_IS_VISIBLE:
draw_type='B';
break;
//--- integer properties
case CHART_VISIBLE_BARS:
case CHART_WINDOWS_TOTAL:
case CHART_WINDOW_HANDLE:
case CHART_WINDOW_YDISTANCE:
case CHART_FIRST_VISIBLE_BAR:
case CHART_WIDTH_IN_BARS:
case CHART_WIDTH_IN_PIXELS:
draw_type='I';
break;
//--- double properties
case CHART_PRICE_MIN:
case CHART_PRICE_MAX:
draw_type='D';
break;
//--- in fact, this property is a command of displaying the chart on top of all the others
//--- there is no need to apply this panel, as the window will always be
//--- on top of other ones before we use it
case CHART_BRING_TO_TOP:
draw_type=' ';
break;
//--- property does not belong to the third group
default:
return(false);
}
//--- property belongs to the third group
group_type=3;
return(true);
}
//+----------------------------------------------------------------------+
//| Checks if property belongs to the second group and |
//| defines its display type in case of a positive answer |
//+----------------------------------------------------------------------+
bool CheckSecondGroup(const int property_number,uint &group_type,uchar &draw_type)
{
//--- check if the property belongs to the second group
switch(property_number)
{
//--- ENUM_CHART_MODE type property
case CHART_MODE:
draw_type='M';
break;
//--- ENUM_CHART_VOLUME_MODE type property
case CHART_SHOW_VOLUMES:
draw_type='V';
break;
//--- string property
case CHART_COMMENT:
draw_type='S';
break;
//--- color property
case CHART_COLOR_BACKGROUND:
case CHART_COLOR_FOREGROUND:
case CHART_COLOR_GRID:
case CHART_COLOR_VOLUME:
case CHART_COLOR_CHART_UP:
case CHART_COLOR_CHART_DOWN:
case CHART_COLOR_CHART_LINE:
case CHART_COLOR_CANDLE_BULL:
case CHART_COLOR_CANDLE_BEAR:
case CHART_COLOR_BID:
case CHART_COLOR_ASK:
case CHART_COLOR_LAST:
case CHART_COLOR_STOP_LEVEL:
draw_type='C';
break;
//--- property does not belong to the second group
default:
return(false);
}
//--- property belongs to the second group
group_type=2;
return(true);
}
//+-----------------------------------------------------------------------+
//| Called only if it is already known that property does not belong |
//| to the second and third property groups |
//+-----------------------------------------------------------------------+
void CheckFirstGroup(const int property_number,uint &group_type,uchar &draw_type)
{
//--- the property belongs to the first group
group_type=1;
//--- define property display type
switch(property_number)
{
//--- integer properties
case CHART_SCALE:
case CHART_HEIGHT_IN_PIXELS:
draw_type='I';
return;
//--- double properties
case CHART_SHIFT_SIZE:
case CHART_FIXED_POSITION:
case CHART_FIXED_MAX:
case CHART_FIXED_MIN:
case CHART_POINTS_PER_BAR:
draw_type='D';
return;
//--- only boolean properties have remained
default:
draw_type='B';
return;
}
}
//+------------------------------------------------------------------+
//| Creates label and button for property |
//+------------------------------------------------------------------+
bool ShowProperty(const int ind,const int type,const int x1,const int x2,
const int xb,const int y,const bool btn)
{
//--- static array for switching inside ExtColors color array
static uint color_index[3]={1,1,1};
//--- change index for receiving another color
color_index[type]=1-color_index[type];
//--- display labels and a button (if btn=true) for the property
if(!LabelCreate(ExtLabelsName[ind],"name_"+(string)ind,ExtNames[ind],ExtColors[color_index[type]
return(false);
if(!LabelCreate(ExtLabelsValue[ind],"value_"+(string)ind,"",ExtColors[color_index[type]],x2,y))
return(false);
if(btn && !ButtonCreate(ExtButtons[ind],(string)ind,xb,y+1))
return(false);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Creates label |
//+------------------------------------------------------------------+
bool LabelCreate(CChartObjectLabel &lbl,const string name,const string text,
const color clr,const int x,const int y)
{
if(!lbl.Create(0,"Label_"+name,0,x,y)) return(false);
if(!lbl.Description(text)) return(false);
if(!lbl.FontSize(10)) return(false);
if(!lbl.Color(clr)) return(false);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Creates button |
//+------------------------------------------------------------------+
bool ButtonCreate(CChartObjectButton &btn,const string name,
const int x,const int y)
{
if(!btn.Create(0,"Button_"+name,0,x,y,50,15)) return(false);
if(!btn.Description("Next")) return(false);
if(!btn.FontSize(10)) return(false);
if(!btn.Color(clrBlack)) return(false);
if(!btn.BackColor(clrWhite)) return(false);
if(!btn.BorderColor(clrBlack)) return(false);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Defines maximum and minimum property value and step |
//+------------------------------------------------------------------+
void GetMaxMinStep(const int property_number,double &max,double &min,double &step)
{
double value;
//--- set values depending on the property type
switch(property_number)
{
case CHART_SCALE:
max=5;
min=0;
step=1;
break;
case CHART_MODE:
case CHART_SHOW_VOLUMES:
max=2;
min=0;
step=1;
break;
case CHART_SHIFT_SIZE:
max=50;
min=10;
step=2.5;
break;
case CHART_FIXED_POSITION:
max=90;
min=0;
step=15;
break;
case CHART_POINTS_PER_BAR:
max=19;
min=1;
step=3;
break;
case CHART_FIXED_MAX:
value=ChartGetDouble(0,CHART_FIXED_MAX);
max=value*1.25;
min=value;
step=value/32;
break;
case CHART_FIXED_MIN:
value=ChartGetDouble(0,CHART_FIXED_MIN);
max=value;
min=value*0.75;
step=value/32;
break;
case CHART_HEIGHT_IN_PIXELS:
max=700;
min=520;
step=30;
break;
//--- default values
default:
max=1;
min=0;
step=1;
}
}
Object Constants
There are 44 graphical objects that can be created and displayed in the price chart. All constants for
working with objects are divided into 9 groups :
· Object types – Identifiers of graphical objects ;
· Object properties – setting and getting properties of graphical objects ;
· Methods of object binding – constants of object positioning in the chart;
· Binding corner – setting the corner relative to which an object is positioned on chart;
· Visibility of objects – setting timeframes in which an object is visible;
· Levels of Elliott W aves – gradation of waves ;
· Gann objects – trend constants for Gann fan and Gann grid;
· W eb colors – constants of predefined web colors ;
· W ingdings – codes of characters of the W ingdings font.
Object Types
W hen a graphical object is created using the ObjectCreate() function, it's necessary to specify the type
of object being created, which can be one of the values of the ENUM _OBJECT enumeration. Further
specifications of object properties are possible using functions for working with graphical objects.
ENUM_OBJECT
ID Description
OBJ_RECTANGLE R ectangle
OBJ_TRIANGLE Triangle
OBJ_ELLIPSE Ellipse
ID Description
OBJ_ARROW_UP Arrow Up
OBJ_ARROW Arrow
OBJ_TEXT Text
OBJ_LABEL Label
OBJ_BUTTON Button
OBJ_CHART Chart
OBJ_BITM AP Bitmap
OBJ_EDIT Edit
OBJ_VLINE
Vertical Line.
Note
W hen drawing a vertical line, it is possible to set the line display mode for all chart windows
(property OBJPROP_RAY).
Example
The following script creates and moves the vertical line on the chart. S pecial functions have been
developed to create and change graphical object's properties. You can use these functions " as is " in
your own applications.
//--- description
#property description "Script draws \"Vertical Line\" graphical object."
#property description "Anchor point date is set in percentage of"
#property description "the chart window width in bars."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="VLine"; // Line name
input int InpDate=25; // Event date, %
input color InpColor=clrRed; // Line color
input ENUM_LINE_STYLE InpStyle=STYLE_DASH; // Line style
input int InpWidth=3; // Line width
input bool InpBack=false; // Background line
input bool InpSelection=true; // Highlight to move
input bool InpRay=true; // Line's continuation down
ObjectSetInteger(chart_ID,name,OBJPROP_ZORDER,z_order);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Move the vertical line |
//+------------------------------------------------------------------+
bool VLineMove(const long chart_ID=0, // chart's ID
const string name="VLine", // line name
datetime time=0) // line time
{
//--- if line time is not set, move the line to the last bar
if(!time)
time=TimeCurrent();
//--- reset the error value
ResetLastError();
//--- move the vertical line
if(!ObjectMove(chart_ID,name,0,time,0))
{
Print(__FUNCTION__,
": failed to move the vertical line! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Delete the vertical line |
//+------------------------------------------------------------------+
bool VLineDelete(const long chart_ID=0, // chart's ID
const string name="VLine") // line name
{
//--- reset the error value
ResetLastError();
//--- delete the vertical line
if(!ObjectDelete(chart_ID,name))
{
Print(__FUNCTION__,
": failed to delete the vertical line! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
OBJ_HLINE
H orizontal Line.
Example
The following script creates and moves the horizontal line on the chart. S pecial functions have been
developed to create and change graphical object's properties. You can use these functions " as is " in
your own applications.
//--- description
#property description "Script draws \"Horizontal Line\" graphical object."
#property description "Anchor point price is set in percentage of the height of"
#property description "the chart window."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="HLine"; // Line name
input int InpPrice=25; // Line price, %
input color InpColor=clrRed; // Line color
input ENUM_LINE_STYLE InpStyle=STYLE_DASH; // Line style
input int InpWidth=3; // Line width
input bool InpBack=false; // Background line
input bool InpSelection=true; // Highlight to move
input bool InpHidden=true; // Hidden in the object list
input long InpZOrder=0; // Priority for mouse click
//+------------------------------------------------------------------+
//| Create the horizontal line |
//+------------------------------------------------------------------+
//---
}
OBJ_TREND
Trend Line.
Note
For Trend Line, it is possible to specify the mode of continuation of its display to the right and/or
left (OBJPROP_RAY_RIGHT and OBJPROP_RAY_LEFT properties accordingly).
Example
The following script creates and moves the trend line on the chart. S pecial functions have been
developed to create and change graphical object's properties. You can use these functions " as is " in
your own applications.
//--- description
#property description "Script draws \"Trend Line\" graphical object."
#property description "Anchor point coordinates are set in percentage of"
#property description "the chart window size."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="Trend"; // Line name
input int InpDate1=35; // 1 st point's date, %
input int InpPrice1=60; // 1 st point's price, %
input int InpDate2=65; // 2 nd point's date, %
input int InpPrice2=40; // 2 nd point's price, %
input color InpColor=clrRed; // Line color
input ENUM_LINE_STYLE InpStyle=STYLE_DASH; // Line style
//--- is true by default making it possible to highlight and move the object
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTABLE,selection);
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTED,selection);
//--- enable (true) or disable (false) the mode of continuation of the line's display to the left
ObjectSetInteger(chart_ID,name,OBJPROP_RAY_LEFT,ray_left);
//--- enable (true) or disable (false) the mode of continuation of the line's display to the right
ObjectSetInteger(chart_ID,name,OBJPROP_RAY_RIGHT,ray_right);
//--- hide (true) or display (false) graphical object name in the object list
ObjectSetInteger(chart_ID,name,OBJPROP_HIDDEN,hidden);
//--- set the priority for receiving the event of a mouse click in the chart
ObjectSetInteger(chart_ID,name,OBJPROP_ZORDER,z_order);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Move trend line anchor point |
//+------------------------------------------------------------------+
bool TrendPointChange(const long chart_ID=0, // chart's ID
const string name="TrendLine", // line name
const int point_index=0, // anchor point index
datetime time=0, // anchor point time coordinate
double price=0) // anchor point price coordinate
{
//--- if point position is not set, move it to the current bar having Bid price
if(!time)
time=TimeCurrent();
if(!price)
price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
//--- reset the error value
ResetLastError();
//--- move trend line's anchor point
if(!ObjectMove(chart_ID,name,point_index,time,price))
{
Print(__FUNCTION__,
": failed to move the anchor point! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| The function deletes the trend line from the chart. |
//+------------------------------------------------------------------+
bool TrendDelete(const long chart_ID=0, // chart's ID
const string name="TrendLine") // line name
{
//--- reset the error value
ResetLastError();
//--- delete a trend line
if(!ObjectDelete(chart_ID,name))
{
Print(__FUNCTION__,
": failed to delete a trend line! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Check the values of trend line's anchor points and set default |
//| values for empty ones |
//+------------------------------------------------------------------+
void ChangeTrendEmptyPoints(datetime &time1,double &price1,
datetime &time2,double &price2)
{
//--- if the first point's time is not set, it will be on the current bar
if(!time1)
time1=TimeCurrent();
//--- if the first point's price is not set, it will have Bid value
if(!price1)
price1=SymbolInfoDouble(Symbol(),SYMBOL_BID);
//--- if the second point's time is not set, it is located 9 bars left from the second one
if(!time2)
{
//--- array for receiving the open time of the last 10 bars
datetime temp[10];
CopyTime(Symbol(),Period(),time1,10,temp);
//--- set the second point 9 bars left from the first one
time2=temp[0];
}
//--- if the second point's price is not set, it is equal to the first point's one
if(!price2)
price2=price1;
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- check correctness of the input parameters
if(InpDate1<0 || InpDate1>100 || InpPrice1<0 || InpPrice1>100 ||
InpDate2<0 || InpDate2>100 || InpPrice2<0 || InpPrice2>100)
{
Print("Error! Incorrect values of input parameters!");
return;
}
//--- number of visible bars in the chart window
int bars=(int)ChartGetInteger(0,CHART_VISIBLE_BARS);
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
}
//--- move the second anchor point vertically
for(int i=0;i<v_steps;i++)
{
//--- use the following value
if(p2<accuracy-1)
p2+=1;
//--- move the point
if(!TrendPointChange(0,InpName,1,date[d2],price[p2]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
}
//--- half a second of delay
Sleep(500);
//--- loop counter
int h_steps=bars/2;
//--- move both anchor points horizontally at the same time
for(int i=0;i<h_steps;i++)
{
//--- use the following values
if(d1<bars-1)
d1+=1;
if(d2>1)
d2-=1;
//--- shift the points
if(!TrendPointChange(0,InpName,0,date[d1],price[p1]))
return;
if(!TrendPointChange(0,InpName,1,date[d2],price[p2]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
// 0.03 seconds of delay
Sleep(30);
}
//--- 1 second of delay
Sleep(1000);
OBJ_TRENDBYANGLE
Trend Line By Angle.
Note
ForTrend Line By Angle, it is possible to specify the mode of continuation of its display to the right
and/or left (OBJPROP_RAY_RIGHT and OBJPROP_RAY_LEFT properties accordingly).
Both angle and the second anchor point's coordinates can be used to set the slope of the line.
Example
The following script creates and moves the trend line on the chart. S pecial functions have been
developed to create and change graphical object's properties. You can use these functions " as is " in
your own applications.
//--- description
#property description "Script draws \"Trend Line By Angle\" graphical object."
#property description "Anchor point coordinates are set in percentage of the size of"
#property description "the chart window."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="Trend"; // Line name
input int InpDate1=50; // 1 st point's date, %
input int InpPrice1=75; // 1 st point's price, %
input int InpAngle=0; // Line's slope angle
input color InpColor=clrRed; // Line color
input ENUM_LINE_STYLE InpStyle=STYLE_DASH; // Line style
time2=second_point_time[0];
price2=price1;
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- check correctness of the input parameters
if(InpDate1<0 || InpDate1>100 || InpPrice1<0 || InpPrice1>100)
{
Print("Error! Incorrect values of input parameters!");
return;
}
//--- number of visible bars in the chart window
int bars=(int)ChartGetInteger(0,CHART_VISIBLE_BARS);
//--- price array size
int accuracy=1000;
//--- arrays for storing the date and price values to be used
//--- for setting and changing line anchor points' coordinates
datetime date[];
double price[];
//--- memory allocation
ArrayResize(date,bars);
ArrayResize(price,accuracy);
//--- fill the array of dates
ResetLastError();
if(CopyTime(Symbol(),Period(),0,bars,date)==-1)
{
Print("Failed to copy time values! Error code = ",GetLastError());
return;
}
//--- fill the array of prices
//--- find the highest and lowest values of the chart
double max_price=ChartGetDouble(0,CHART_PRICE_MAX);
double min_price=ChartGetDouble(0,CHART_PRICE_MIN);
//--- define a change step of a price and fill the array
double step=(max_price-min_price)/accuracy;
for(int i=0;i<accuracy;i++)
price[i]=min_price+i*step;
//--- define points for drawing the line
int d1=InpDate1*(bars-1)/100;
int p1=InpPrice1*(accuracy-1)/100;
//--- create a trend line
if(!TrendByAngleCreate(0,InpName,0,date[d1],price[p1],InpAngle,InpColor,InpStyle,
InpWidth,InpBack,InpSelection,InpRayLeft,InpRayRight,InpHidden,InpZOrder))
{
return;
}
OBJ_CYCLES
Cycle Lines.
Note
The distance between the lines is set by time coordinates of two anchor points of the object.
Example
The following script creates and moves cycle lines on the chart. S pecial functions have been
developed to create and change graphical object's properties. You can use these functions " as is " in
your own applications.
//--- description
#property description "Script creates cycle lines on the chart."
#property description "Anchor point coordinates are set in percentage"
#property description "percentage of the chart window size."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="Cycles"; // Object name
input int InpDate1=10; // 1 st point's date, %
input int InpPrice1=45; // 1 st point's price, %
input int InpDate2=20; // 2 nd point's date, %
input int InpPrice2=55; // 2 nd point's price, %
input color InpColor=clrRed; // Color of cycle lines
input ENUM_LINE_STYLE InpStyle=STYLE_DOT; // Style of cycle lines
input int InpWidth=1; // Width of cycle lines
//--- set the priority for receiving the event of a mouse click in the chart
ObjectSetInteger(chart_ID,name,OBJPROP_ZORDER,z_order);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Move the anchor point |
//+------------------------------------------------------------------+
bool CyclesPointChange(const long chart_ID=0, // chart's ID
const string name="Cycles", // object name
const int point_index=0, // anchor point index
datetime time=0, // anchor point time coordinate
double price=0) // anchor point price coordinate
{
//--- if point position is not set, move it to the current bar having Bid price
if(!time)
time=TimeCurrent();
if(!price)
price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
//--- reset the error value
ResetLastError();
//--- move the anchor point
if(!ObjectMove(chart_ID,name,point_index,time,price))
{
Print(__FUNCTION__,
": failed to move the anchor point! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Delete the cycle lines |
//+------------------------------------------------------------------+
bool CyclesDelete(const long chart_ID=0, // chart's ID
const string name="Cycles") // object name
{
//--- reset the error value
ResetLastError();
//--- delete cycle lines
if(!ObjectDelete(chart_ID,name))
{
Print(__FUNCTION__,
": failed to delete cycle lines! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Check the values of cycle lines' anchor points and set default |
//| values for empty ones |
//+------------------------------------------------------------------+
void ChangeCyclesEmptyPoints(datetime &time1,double &price1,
datetime &time2,double &price2)
{
//--- if the first point's time is not set, it will be on the current bar
if(!time1)
time1=TimeCurrent();
//--- if the first point's price is not set, it will have Bid value
if(!price1)
price1=SymbolInfoDouble(Symbol(),SYMBOL_BID);
//--- if the second point's time is not set, it is located 9 bars left from the second one
if(!time2)
{
//--- array for receiving the open time of the last 10 bars
datetime temp[10];
CopyTime(Symbol(),Period(),time1,10,temp);
//--- set the second point 9 bars left from the first one
time2=temp[0];
}
//--- if the second point's price is not set, it is equal to the first point's one
if(!price2)
price2=price1;
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- check correctness of the input parameters
if(InpDate1<0 || InpDate1>100 || InpPrice1<0 || InpPrice1>100 ||
InpDate2<0 || InpDate2>100 || InpPrice2<0 || InpPrice2>100)
{
Print("Error! Incorrect values of input parameters!");
return;
}
//--- number of visible bars in the chart window
int bars=(int)ChartGetInteger(0,CHART_VISIBLE_BARS);
//--- price array size
int accuracy=1000;
//--- arrays for storing the date and price values to be used
//--- for setting and changing the coordinates of cycle lines' anchor points
datetime date[];
double price[];
//--- memory allocation
ArrayResize(date,bars);
ArrayResize(price,accuracy);
OBJ_ARROWED_LINE
Arrowed line.
Example
The following script creates and moves an arrow line on the chart. S pecial functions have been
developed to create and change graphical object's properties. You can use these functions " as is " in
your own applications.
//--- description
#property description "Script draws \"Arrowed line\" graphical object."
#property description "Anchor point coordinates are set in percentage of"
#property description "the chart window size."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="ArrowedLine"; // Line name
input int InpDate1=35; // 1 st point's date, %
input int InpPrice1=60; // 1 st point's price, %
input int InpDate2=65; // 2 nd point's date, %
input int InpPrice2=40; // 2 nd point's price, %
input color InpColor=clrRed; // Line color
input ENUM_LINE_STYLE InpStyle=STYLE_DASH; // Line style
input int InpWidth=2; // Line width
input bool InpBack=false; // Background line
input bool InpSelection=true; // Highlight to move
input bool InpHidden=true; // Hidden in the object list
input long InpZOrder=0; // Priority for mouse click
//+------------------------------------------------------------------+
//| Create an arrowed line by the given coordinates |
//+------------------------------------------------------------------+
bool ArrowedLineCreate(const long chart_ID=0, // chart's ID
const string name="ArrowedLine", // line name
const int sub_window=0, // subwindow index
datetime time1=0, // first point time
double price1=0, // first point price
datetime time2=0, // second point time
double price2=0, // second point price
const color clr=clrRed, // line color
const ENUM_LINE_STYLE style=STYLE_SOLID, // line style
const int width=1, // line width
const bool back=false, // in the background
const bool selection=true, // highlight to move
const bool hidden=true, // hidden in the object list
const long z_order=0) // priority for mouse click
{
//--- set anchor points' coordinates if they are not set
ChangeArrowedLineEmptyPoints(time1,price1,time2,price2);
//--- reset the error value
ResetLastError();
//--- create an arrowed line by the given coordinates
if(!ObjectCreate(chart_ID,name,OBJ_ARROWED_LINE,sub_window,time1,price1,time2,price2))
{
Print(__FUNCTION__,
": failed to create an arrowed line! Error code = ",GetLastError());
return(false);
}
//--- set line color
ObjectSetInteger(chart_ID,name,OBJPROP_COLOR,clr);
//--- set line display style
ObjectSetInteger(chart_ID,name,OBJPROP_STYLE,style);
//--- set line width
ObjectSetInteger(chart_ID,name,OBJPROP_WIDTH,width);
//--- display in the foreground (false) or background (true)
ObjectSetInteger(chart_ID,name,OBJPROP_BACK,back);
//--- enable (true) or disable (false) the mode of moving the line by mouse
//--- when creating a graphical object using ObjectCreate function, the object cannot be
//--- highlighted and moved by default. Inside this method, selection parameter
//--- is true by default making it possible to highlight and move the object
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTABLE,selection);
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTED,selection);
//--- hide (true) or display (false) graphical object name in the object list
ObjectSetInteger(chart_ID,name,OBJPROP_HIDDEN,hidden);
//--- set the priority for receiving the event of a mouse click in the chart
ObjectSetInteger(chart_ID,name,OBJPROP_ZORDER,z_order);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Move arrowed line's anchor point |
//+------------------------------------------------------------------+
bool ArrowedLinePointChange(const long chart_ID=0, // chart's ID
const string name="ArrowedLine", // line name
const int point_index=0, // anchor point index
datetime time=0, // anchor point time coordinate
double price=0) // anchor point price coordinate
{
//--- if point position is not set, move it to the current bar having Bid price
if(!time)
time=TimeCurrent();
if(!price)
price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
//--- reset the error value
ResetLastError();
//--- move the line's anchor point
if(!ObjectMove(chart_ID,name,point_index,time,price))
{
Print(__FUNCTION__,
": failed to move the anchor point! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| The function removes the arrowed line from the chart |
//+------------------------------------------------------------------+
bool ArrowedLineDelete(const long chart_ID=0, // chart's ID
const string name="ArrowedLine") // line name
{
//--- reset the error value
ResetLastError();
//--- delete an arrowed line
if(!ObjectDelete(chart_ID,name))
{
Print(__FUNCTION__,
": failed to create an arrowed line! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Check anchor points' values and set default values |
//| for empty ones |
//+------------------------------------------------------------------+
OBJ_CHANNEL
Equidistant Channel
Note
For an equidistant channel, it is possible to specify the mode of its continuation to the right and/or
to the left (OBJPROP_RAY_RIGHT and OBJPROP_RAY_LEFT properties accordingly). The mode of
filling the channel with color can also be set.
Example
The following script creates and moves an equidistant channel on the chart. S pecial functions have
been developed to create and change graphical object's properties. You can use these functions " as
is " in your own applications.
//--- description
#property description "Script draws \"Equidistant Channel\" graphical object."
#property description "Anchor point coordinates are set in percentage of the size of"
#property description "the chart window."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="Channel"; // Channel name
input int InpDate1=25; // 1 st point's date, %
input int InpPrice1=60; // 1 st point's price, %
input int InpDate2=65; // 2 nd point's date, %
input int InpPrice2=80; // 2 nd point's price, %
input int InpDate3=30; // 3 rd point's date, %
//+------------------------------------------------------------------+
//| Delete the channel |
//+------------------------------------------------------------------+
bool ChannelDelete(const long chart_ID=0, // chart's ID
const string name="Channel") // channel name
{
//--- reset the error value
ResetLastError();
//--- delete the channel
if(!ObjectDelete(chart_ID,name))
{
Print(__FUNCTION__,
": failed to delete the channel! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+-------------------------------------------------------------------------+
//| Check the values of the channel's anchor points and set default values |
//| for empty ones |
//+-------------------------------------------------------------------------+
void ChangeChannelEmptyPoints(datetime &time1,double &price1,datetime &time2,
double &price2,datetime &time3,double &price3)
{
//--- if the second (right) point's time is not set, it will be on the current bar
if(!time2)
time2=TimeCurrent();
//--- if the second point's price is not set, it will have Bid value
if(!price2)
price2=SymbolInfoDouble(Symbol(),SYMBOL_BID);
//--- if the first (left) point's time is not set, it is located 9 bars left from the second one
if(!time1)
{
//--- array for receiving the open time of the last 10 bars
datetime temp[10];
CopyTime(Symbol(),Period(),time2,10,temp);
//--- set the first point 9 bars left from the second one
time1=temp[0];
}
//--- if the first point's price is not set, move it 300 points higher than the second one
if(!price1)
price1=price2+300*SymbolInfoDouble(Symbol(),SYMBOL_POINT);
//--- if the third point's time is not set, it coincides with the first point's one
if(!time3)
time3=time1;
//--- if the third point's price is not set, it is equal to the second point's one
if(!price3)
price3=price2;
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- check correctness of the input parameters
if(InpDate1<0 || InpDate1>100 || InpPrice1<0 || InpPrice1>100 ||
InpDate2<0 || InpDate2>100 || InpPrice2<0 || InpPrice2>100 ||
InpDate3<0 || InpDate3>100 || InpPrice3<0 || InpPrice3>100)
{
Print("Error! Incorrect values of input parameters!");
return;
}
//--- number of visible bars in the chart window
int bars=(int)ChartGetInteger(0,CHART_VISIBLE_BARS);
//--- price array size
int accuracy=1000;
//--- arrays for storing the date and price values to be used
//--- for setting and changing channel anchor points' coordinates
datetime date[];
double price[];
//--- memory allocation
ArrayResize(date,bars);
ArrayResize(price,accuracy);
//--- fill the array of dates
ResetLastError();
if(CopyTime(Symbol(),Period(),0,bars,date)==-1)
{
Print("Failed to copy time values! Error code = ",GetLastError());
return;
}
//--- fill the array of prices
//--- find the highest and lowest values of the chart
double max_price=ChartGetDouble(0,CHART_PRICE_MAX);
double min_price=ChartGetDouble(0,CHART_PRICE_MIN);
//--- define a change step of a price and fill the array
double step=(max_price-min_price)/accuracy;
for(int i=0;i<accuracy;i++)
price[i]=min_price+i*step;
//--- define points for drawing the channel
int d1=InpDate1*(bars-1)/100;
int d2=InpDate2*(bars-1)/100;
int d3=InpDate3*(bars-1)/100;
int p1=InpPrice1*(accuracy-1)/100;
int p2=InpPrice2*(accuracy-1)/100;
int p3=InpPrice3*(accuracy-1)/100;
//--- create the equidistant channel
if(!ChannelCreate(0,InpName,0,date[d1],price[p1],date[d2],price[p2],date[d3],price[p3],InpColor,
InpStyle,InpWidth,InpFill,InpBack,InpSelection,InpRayLeft,InpRayRight,InpHidden,InpZOrder))
{
return;
}
//--- redraw the chart and wait for 1 second
ChartRedraw();
Sleep(1000);
//--- now, move the channel's anchor points
//--- loop counter
int h_steps=bars/6;
//--- move the second anchor point
for(int i=0;i<h_steps;i++)
{
//--- use the following value
if(d2<bars-1)
d2+=1;
//--- move the point
if(!ChannelPointChange(0,InpName,1,date[d2],price[p2]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
// 0.05 seconds of delay
Sleep(50);
}
//--- 1 second of delay
Sleep(1000);
//--- move the first anchor point
for(int i=0;i<h_steps;i++)
{
//--- use the following value
if(d1>1)
d1-=1;
//--- move the point
if(!ChannelPointChange(0,InpName,0,date[d1],price[p1]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
// 0.05 seconds of delay
Sleep(50);
}
//--- 1 second of delay
Sleep(1000);
//--- loop counter
int v_steps=accuracy/10;
//--- move the third anchor point
for(int i=0;i<v_steps;i++)
{
//--- use the following value
if(p3>1)
p3-=1;
//--- move the point
if(!ChannelPointChange(0,InpName,2,date[d3],price[p3]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
}
//--- 1 second of delay
Sleep(1000);
//--- delete the channel from the chart
ChannelDelete(0,InpName);
ChartRedraw();
//--- 1 second of delay
Sleep(1000);
//---
}
OBJ_STDDEVCHANNEL
S tandard Deviation Channel.
Note
For S tandard Deviation Channel, it is possible to specify the mode of continuation of its display to
the right and/or left (OBJPROP_RAY_RIGHT and OBJPROP_RAY_LEFT properties accordingly). The
mode of filling the channel with color can also be set.
OBJPROP_DEVIATION property is used to change the value of the channel deviation.
Example
The following script creates and moves S tandard Deviation Channel on the chart. S pecial functions
have been developed to create and change graphical object's properties. You can use these functions
" as is " in your own applications.
//--- description
#property description "Script draws \"Standard Deviation Channel\" graphical object."
#property description "Anchor point coordinates are set in percentage of the size of"
#property description "the chart window."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="StdDevChannel"; // Channel name
input int InpDate1=10; // 1 st point's date, %
input int InpDate2=40; // 2 nd point's date, %
input double InpDeviation=1.0; // Deviation
input color InpColor=clrRed; // Channel color
ObjectSetInteger(chart_ID,name,OBJPROP_FILL,fill);
//--- display in the foreground (false) or background (true)
ObjectSetInteger(chart_ID,name,OBJPROP_BACK,back);
//--- enable (true) or disable (false) the mode of highlighting the channel for moving
//--- when creating a graphical object using ObjectCreate function, the object cannot be
//--- highlighted and moved by default. Inside this method, selection parameter
//--- is true by default making it possible to highlight and move the object
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTABLE,selection);
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTED,selection);
//--- enable (true) or disable (false) the mode of continuation of the channel's display to the lef
ObjectSetInteger(chart_ID,name,OBJPROP_RAY_LEFT,ray_left);
//--- enable (true) or disable (false) the mode of continuation of the channel's display to the rig
ObjectSetInteger(chart_ID,name,OBJPROP_RAY_RIGHT,ray_right);
//--- hide (true) or display (false) graphical object name in the object list
ObjectSetInteger(chart_ID,name,OBJPROP_HIDDEN,hidden);
//--- set the priority for receiving the event of a mouse click in the chart
ObjectSetInteger(chart_ID,name,OBJPROP_ZORDER,z_order);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Move the channel's anchor point |
//+------------------------------------------------------------------+
bool StdDevChannelPointChange(const long chart_ID=0, // chart's ID
const string name="Channel", // channel name
const int point_index=0, // anchor point index
datetime time=0) // anchor point time coordinate
{
//--- if point time is not set, move the point to the current bar
if(!time)
time=TimeCurrent();
//--- reset the error value
ResetLastError();
//--- move the anchor point
if(!ObjectMove(chart_ID,name,point_index,time,0))
{
Print(__FUNCTION__,
": failed to move the anchor point! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Change the channel's deviation |
//+------------------------------------------------------------------+
bool StdDevChannelDeviationChange(const long chart_ID=0, // chart's ID
const string name="Channel", // channel name
const double deviation=1.0) // deviation
{
//--- reset the error value
ResetLastError();
//--- change trend line's slope angle
if(!ObjectSetDouble(chart_ID,name,OBJPROP_DEVIATION,deviation))
{
Print(__FUNCTION__,
": failed to change channel deviation! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Delete the channel |
//+------------------------------------------------------------------+
bool StdDevChannelDelete(const long chart_ID=0, // chart's ID
const string name="Channel") // channel name
{
//--- reset the error value
ResetLastError();
//--- delete the channel
if(!ObjectDelete(chart_ID,name))
{
Print(__FUNCTION__,
": failed to delete the channel! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+-------------------------------------------------------------------------+
//| Check the values of the channel's anchor points and set default values |
//| for empty ones |
//+-------------------------------------------------------------------------+
void ChangeChannelEmptyPoints(datetime &time1,datetime &time2)
{
//--- if the second point's time is not set, it will be on the current bar
if(!time2)
time2=TimeCurrent();
//--- if the first point's time is not set, it is located 9 bars left from the second one
if(!time1)
{
//--- array for receiving the open time of the last 10 bars
datetime temp[10];
CopyTime(Symbol(),Period(),time2,10,temp);
//--- set the first point 9 bars left from the second one
time1=temp[0];
}
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- check correctness of the input parameters
if(InpDate1<0 || InpDate1>100 ||
InpDate2<0 || InpDate2>100)
{
Print("Error! Incorrect values of input parameters!");
return;
}
//--- number of visible bars in the chart window
int bars=(int)ChartGetInteger(0,CHART_VISIBLE_BARS);
//--- price array size
int accuracy=1000;
//--- arrays for storing the date and price values to be used
//--- for setting and changing channel anchor points' coordinates
datetime date[];
double price[];
//--- memory allocation
ArrayResize(date,bars);
ArrayResize(price,accuracy);
//--- fill the array of dates
ResetLastError();
if(CopyTime(Symbol(),Period(),0,bars,date)==-1)
{
Print("Failed to copy time values! Error code = ",GetLastError());
return;
}
//--- fill the array of prices
//--- find the highest and lowest values of the chart
double max_price=ChartGetDouble(0,CHART_PRICE_MAX);
double min_price=ChartGetDouble(0,CHART_PRICE_MIN);
//--- define a change step of a price and fill the array
double step=(max_price-min_price)/accuracy;
for(int i=0;i<accuracy;i++)
price[i]=min_price+i*step;
//--- define points for drawing the channel
int d1=InpDate1*(bars-1)/100;
int d2=InpDate2*(bars-1)/100;
//--- create standard deviation channel
if(!StdDevChannelCreate(0,InpName,0,date[d1],date[d2],InpDeviation,InpColor,InpStyle,
InpWidth,InpFill,InpBack,InpSelection,InpRayLeft,InpRayRight,InpHidden,InpZOrder))
{
return;
}
//--- redraw the chart and wait for 1 second
ChartRedraw();
Sleep(1000);
//--- now, move the channel horizontally to the right and expand it
//--- loop counter
int h_steps=bars/2;
//--- move the channel
for(int i=0;i<h_steps;i++)
{
//--- use the following values
if(d1<bars-1)
d1+=1;
if(d2<bars-1)
d2+=1;
//--- move the anchor points
if(!StdDevChannelPointChange(0,InpName,0,date[d1]))
return;
if(!StdDevChannelPointChange(0,InpName,1,date[d2]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
// 0.05 seconds of delay
Sleep(50);
}
//--- 1 second of delay
Sleep(1000);
//--- loop counter
double v_steps=InpDeviation*2;
//--- expand the channel
for(double i=InpDeviation;i<v_steps;i+=10.0/accuracy)
{
if(!StdDevChannelDeviationChange(0,InpName,i))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
}
//--- 1 second of delay
Sleep(1000);
//--- delete the channel from the chart
StdDevChannelDelete(0,InpName);
ChartRedraw();
//--- 1 second of delay
Sleep(1000);
//---
OBJ_REGRESSION
Linear Regression Channel.
Note
For Linear Regression Channel, it is possible to specify the mode of continuation of its display to the
right and/or left (OBJPROP_RAY_RIGHT and OBJPROP_RAY_LEFT properties accordingly). The mode
of filling the channel with color can also be set.
Example
The following script creates and moves Linear Regression Channel on the chart. S pecial functions
have been developed to create and change graphical object's properties. You can use these functions
" as is " in your own applications.
//--- description
#property description "Script draws \"Linear Regression Channel\" graphical object."
#property description "Anchor point coordinates are set in percentage of the size of"
#property description "the chart window."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="Regression"; // Channel name
input int InpDate1=10; // 1 st point's date, %
input int InpDate2=40; // 2 nd point's date, %
input color InpColor=clrRed; // Channel color
input ENUM_LINE_STYLE InpStyle=STYLE_DASH; // Style of channel lines
input int InpWidth=2; // Width of channel lines
//--- highlighted and moved by default. Inside this method, selection parameter
//--- is true by default making it possible to highlight and move the object
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTABLE,selection);
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTED,selection);
//--- enable (true) or disable (false) the mode of continuation of the channel's display to the lef
ObjectSetInteger(chart_ID,name,OBJPROP_RAY_LEFT,ray_left);
//--- enable (true) or disable (false) the mode of continuation of the channel's display to the rig
ObjectSetInteger(chart_ID,name,OBJPROP_RAY_RIGHT,ray_right);
//--- hide (true) or display (false) graphical object name in the object list
ObjectSetInteger(chart_ID,name,OBJPROP_HIDDEN,hidden);
//--- set the priority for receiving the event of a mouse click in the chart
ObjectSetInteger(chart_ID,name,OBJPROP_ZORDER,z_order);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Move the channel's anchor point |
//+------------------------------------------------------------------+
bool RegressionPointChange(const long chart_ID=0, // chart's ID
const string name="Channel", // channel name
const int point_index=0, // anchor point index
datetime time=0) // anchor point time coordinate
{
//--- if point time is not set, move the point to the current bar
if(!time)
time=TimeCurrent();
//--- reset the error value
ResetLastError();
//--- move the anchor point
if(!ObjectMove(chart_ID,name,point_index,time,0))
{
Print(__FUNCTION__,
": failed to move the anchor point! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Delete the channel |
//+------------------------------------------------------------------+
bool RegressionDelete(const long chart_ID=0, // chart's ID
const string name="Channel") // channel name
{
//--- reset the error value
ResetLastError();
//--- delete the channel
if(!ObjectDelete(chart_ID,name))
{
Print(__FUNCTION__,
": failed to delete the channel! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+-------------------------------------------------------------------------+
//| Check the values of the channel's anchor points and set default values |
//| for empty ones |
//+-------------------------------------------------------------------------+
void ChangeRegressionEmptyPoints(datetime &time1,datetime &time2)
{
//--- if the second point's time is not set, it will be on the current bar
if(!time2)
time2=TimeCurrent();
//--- if the first point's time is not set, it is located 9 bars left from the second one
if(!time1)
{
//--- array for receiving the open time of the last 10 bars
datetime temp[10];
CopyTime(Symbol(),Period(),time2,10,temp);
//--- set the first point 9 bars left from the second one
time1=temp[0];
}
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- check correctness of the input parameters
if(InpDate1<0 || InpDate1>100 ||
InpDate2<0 || InpDate2>100)
{
Print("Error! Incorrect values of input parameters!");
return;
}
//--- number of visible bars in the chart window
int bars=(int)ChartGetInteger(0,CHART_VISIBLE_BARS);
//--- price array size
int accuracy=1000;
//--- arrays for storing the date and price values to be used
//--- for setting and changing channel anchor points' coordinates
datetime date[];
double price[];
//--- memory allocation
ArrayResize(date,bars);
ArrayResize(price,accuracy);
Sleep(50);
}
//--- 1 second of delay
Sleep(1000);
//--- delete the channel from the chart
RegressionDelete(0,InpName);
ChartRedraw();
//--- 1 second of delay
Sleep(1000);
//---
}
OBJ_PITCHFORK
Andrews ’ Pitchfork.
Note
For Andrews ’ Pitchfork , it is possible to specify the mode of continuation of its display to the right
and/or left (OBJPROP_RAY_RIGHT and OBJPROP_RAY_LEFT properties accordingly).
You can also specify the number of line-levels, their values and color.
Example
The following script creates and moves Andrews ’ Pitchfork on the chart. S pecial functions have been
developed to create and change graphical object's properties. You can use these functions " as is " in
your own applications.
//--- description
#property description "Script draws \"Andrews’ Pitchfork\" graphical object."
#property description "Anchor point coordinates are set in percentage of"
#property description "the chart window size."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="Pitchfork"; // Pitchfork name
input int InpDate1=14; // 1 st point's date, %
input int InpPrice1=40; // 1 st point's price, %
input int InpDate2=18; // 2 nd point's date, %
input int InpPrice2=50; // 2 nd point's price, %
input int InpDate3=18; // 3 rd point's date, %
input int InpPrice3=30; // 3 rd point's price, %
ObjectSetInteger(chart_ID,name,OBJPROP_BACK,back);
//--- enable (true) or disable (false) the mode of highlighting the pitchfork for moving
//--- when creating a graphical object using ObjectCreate function, the object cannot be
//--- highlighted and moved by default. Inside this method, selection parameter
//--- is true by default making it possible to highlight and move the object
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTABLE,selection);
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTED,selection);
//--- enable (true) or disable (false) the mode of continuation of the pitchfork's display to the l
ObjectSetInteger(chart_ID,name,OBJPROP_RAY_LEFT,ray_left);
//--- enable (true) or disable (false) the mode of continuation of the pitchfork's display to the r
ObjectSetInteger(chart_ID,name,OBJPROP_RAY_RIGHT,ray_right);
//--- hide (true) or display (false) graphical object name in the object list
ObjectSetInteger(chart_ID,name,OBJPROP_HIDDEN,hidden);
//--- set the priority for receiving the event of a mouse click in the chart
ObjectSetInteger(chart_ID,name,OBJPROP_ZORDER,z_order);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Set number of Andrews' Pitchfork levels and their parameters |
//+------------------------------------------------------------------+
bool PitchforkLevelsSet(int levels, // number of level lines
double &values[], // values of level lines
color &colors[], // color of level lines
ENUM_LINE_STYLE &styles[], // style of level lines
int &widths[], // width of level lines
const long chart_ID=0, // chart's ID
const string name="Pitchfork") // pitchfork name
{
//--- check array sizes
if(levels!=ArraySize(colors) || levels!=ArraySize(styles) ||
levels!=ArraySize(widths) || levels!=ArraySize(widths))
{
Print(__FUNCTION__,": array length does not correspond to the number of levels, error!");
return(false);
}
//--- set the number of levels
ObjectSetInteger(chart_ID,name,OBJPROP_LEVELS,levels);
//--- set the properties of levels in the loop
for(int i=0;i<levels;i++)
{
//--- level value
ObjectSetDouble(chart_ID,name,OBJPROP_LEVELVALUE,i,values[i]);
//--- level color
ObjectSetInteger(chart_ID,name,OBJPROP_LEVELCOLOR,i,colors[i]);
//--- level style
ObjectSetInteger(chart_ID,name,OBJPROP_LEVELSTYLE,i,styles[i]);
//--- level width
ObjectSetInteger(chart_ID,name,OBJPROP_LEVELWIDTH,i,widths[i]);
}
//+----------------------------------------------------------------------+
//| Check the values of Andrews' Pitchfork anchor points and set default |
//| values for empty ones |
//+----------------------------------------------------------------------+
void ChangeChannelEmptyPoints(datetime &time1,double &price1,datetime &time2,
double &price2,datetime &time3,double &price3)
{
//--- if the second (upper right) point's time is not set, it will be on the current bar
if(!time2)
time2=TimeCurrent();
//--- if the second point's price is not set, it will have Bid value
if(!price2)
price2=SymbolInfoDouble(Symbol(),SYMBOL_BID);
//--- if the first (left) point's time is not set, it is located 9 bars left from the second one
if(!time1)
{
//--- array for receiving the open time of the last 10 bars
datetime temp[10];
CopyTime(Symbol(),Period(),time2,10,temp);
//--- set the first point 9 bars left from the second one
time1=temp[0];
}
//--- if the first point's price is not set, move it 200 points below the second one
if(!price1)
price1=price2-200*SymbolInfoDouble(Symbol(),SYMBOL_POINT);
//--- if the third point's time is not set, it coincides with the second point's one
if(!time3)
time3=time2;
//--- if the third point's price is not set, move it 200 points lower than the first one
if(!price3)
price3=price1-200*SymbolInfoDouble(Symbol(),SYMBOL_POINT);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- check correctness of the input parameters
if(InpDate1<0 || InpDate1>100 || InpPrice1<0 || InpPrice1>100 ||
InpDate2<0 || InpDate2>100 || InpPrice2<0 || InpPrice2>100 ||
InpDate3<0 || InpDate3>100 || InpPrice3<0 || InpPrice3>100)
{
Print("Error! Incorrect values of input parameters!");
return;
}
//--- number of visible bars in the chart window
int bars=(int)ChartGetInteger(0,CHART_VISIBLE_BARS);
//--- price array size
int accuracy=1000;
//--- arrays for storing the date and price values to be used
//--- for setting and changing the coordinates of Andrews' Pitchfork anchor points
datetime date[];
double price[];
//--- memory allocation
ArrayResize(date,bars);
ArrayResize(price,accuracy);
//--- fill the array of dates
ResetLastError();
if(CopyTime(Symbol(),Period(),0,bars,date)==-1)
{
Print("Failed to copy time values! Error code = ",GetLastError());
return;
}
//--- fill the array of prices
//--- find the highest and lowest values of the chart
double max_price=ChartGetDouble(0,CHART_PRICE_MAX);
double min_price=ChartGetDouble(0,CHART_PRICE_MIN);
//--- define a change step of a price and fill the array
double step=(max_price-min_price)/accuracy;
for(int i=0;i<accuracy;i++)
price[i]=min_price+i*step;
//--- define points for drawing Andrews' Pitchfork
int d1=InpDate1*(bars-1)/100;
int d2=InpDate2*(bars-1)/100;
int d3=InpDate3*(bars-1)/100;
int p1=InpPrice1*(accuracy-1)/100;
int p2=InpPrice2*(accuracy-1)/100;
int p3=InpPrice3*(accuracy-1)/100;
//--- create the pitchfork
if(!PitchforkCreate(0,InpName,0,date[d1],price[p1],date[d2],price[p2],date[d3],price[p3],
InpColor,InpStyle,InpWidth,InpBack,InpSelection,InpRayLeft,InpRayRight,InpHidden,InpZOrder))
{
return;
}
//--- redraw the chart and wait for 1 second
ChartRedraw();
Sleep(1000);
//--- now, move the pitchfork's anchor points
//--- loop counter
int v_steps=accuracy/10;
//--- move the first anchor point
for(int i=0;i<v_steps;i++)
{
//--- use the following value
if(p1>1)
p1-=1;
//--- move the point
if(!PitchforkPointChange(0,InpName,0,date[d1],price[p1]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
}
//--- 1 second of delay
Sleep(1000);
//--- loop counter
int h_steps=bars/8;
//--- move the third anchor point
for(int i=0;i<h_steps;i++)
{
//--- use the following value
if(d3<bars-1)
d3+=1;
//--- move the point
if(!PitchforkPointChange(0,InpName,2,date[d3],price[p3]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
//--- redraw the chart
ChartRedraw();
// 0.05 seconds of delay
Sleep(50);
}
//--- 1 second of delay
Sleep(1000);
//--- loop counter
v_steps=accuracy/10;
//--- move the second anchor point
for(int i=0;i<v_steps;i++)
{
//--- use the following value
if(p2>1)
p2-=1;
//--- move the point
if(!PitchforkPointChange(0,InpName,1,date[d2],price[p2]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
}
//--- 1 second of delay
Sleep(1000);
//--- delete the pitchfork from the chart
PitchforkDelete(0,InpName);
ChartRedraw();
//--- 1 second of delay
Sleep(1000);
//---
}
OBJ_GANNLINE
Gann Line.
Note
For Gann Line, it is possible to specify the mode of continuation of its display to the right and/or
left (OBJPROP_RAY_RIGHT and OBJPROP_RAY_LEFT properties accordingly).
Both Gann angle with a scale and coordinates of the second anchor point can be used to set the slope
of the line.
Example
The following script creates and moves Gann Line on the chart. S pecial functions have been
developed to create and change graphical object's properties. You can use these functions " as is " in
your own applications.
//--- description
#property description "Script draws \"Gann Line\" graphical object."
#property description "Anchor point coordinates are set in percentage of"
#property description "the chart window size."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="GannLine"; // Line name
input int InpDate1=20; // 1 st point's date, %
input int InpPrice1=75; // 1 st point's price, %
input int InpDate2=80; // 2 nd point's date, %
input double InpAngle=0.0; // Gann Angle
ObjectSetInteger(chart_ID,name,OBJPROP_COLOR,clr);
//--- set line display style
ObjectSetInteger(chart_ID,name,OBJPROP_STYLE,style);
//--- set line width
ObjectSetInteger(chart_ID,name,OBJPROP_WIDTH,width);
//--- display in the foreground (false) or background (true)
ObjectSetInteger(chart_ID,name,OBJPROP_BACK,back);
//--- enable (true) or disable (false) the mode of highlighting the lines for moving
//--- when creating a graphical object using ObjectCreate function, the object cannot be
//--- highlighted and moved by default. Inside this method, selection parameter
//--- is true by default making it possible to highlight and move the object
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTABLE,selection);
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTED,selection);
//--- enable (true) or disable (false) the mode of continuation of the line's display to the left
ObjectSetInteger(chart_ID,name,OBJPROP_RAY_LEFT,ray_left);
//--- enable (true) or disable (false) the mode of continuation of the line's display to the right
ObjectSetInteger(chart_ID,name,OBJPROP_RAY_RIGHT,ray_right);
//--- hide (true) or display (false) graphical object name in the object list
ObjectSetInteger(chart_ID,name,OBJPROP_HIDDEN,hidden);
//--- set the priority for receiving the event of a mouse click in the chart
ObjectSetInteger(chart_ID,name,OBJPROP_ZORDER,z_order);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Move Gann Line anchor point |
//+------------------------------------------------------------------+
bool GannLinePointChange(const long chart_ID=0, // chart's ID
const string name="GannLine", // line name
const int point_index=0, // anchor point index
datetime time=0, // anchor point time coordinate
double price=0) // anchor point price coordinate
{
//--- if point position is not set, move it to the current bar having Bid price
if(!time)
time=TimeCurrent();
if(!price)
price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
//--- reset the error value
ResetLastError();
//--- move the line's anchor point
if(!ObjectMove(chart_ID,name,point_index,time,price))
{
Print(__FUNCTION__,
": failed to move the anchor point! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Change Gann angle |
//+------------------------------------------------------------------+
bool GannLineAngleChange(const long chart_ID=0, // chart's ID
const string name="GannLine", // line name
const double angle=1.0) // Gann angle
{
//--- reset the error value
ResetLastError();
//--- change Gann angle
if(!ObjectSetDouble(chart_ID,name,OBJPROP_ANGLE,angle))
{
Print(__FUNCTION__,
": failed to change Gann angle! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Change Gann Line's scale |
//+------------------------------------------------------------------+
bool GannLineScaleChange(const long chart_ID=0, // chart's ID
const string name="GannLine", // line name
const double scale=1.0) // scale
{
//--- reset the error value
ResetLastError();
//--- change the scale (number of pips per bar)
if(!ObjectSetDouble(chart_ID,name,OBJPROP_SCALE,scale))
{
Print(__FUNCTION__,
": failed to change the scale! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| The function removes Gann Line from the chart |
//+------------------------------------------------------------------+
bool GannLineDelete(const long chart_ID=0, // chart's ID
const string name="GannLine") // line name
{
//--- reset the error value
ResetLastError();
//--- delete Gann line
if(!ObjectDelete(chart_ID,name))
{
Print(__FUNCTION__,
": failed to delete \"Gann Line\"! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Check the values of Gann Line anchor points and set default |
//| values for empty ones |
//+------------------------------------------------------------------+
void ChangeGannLineEmptyPoints(datetime &time1,double &price1,datetime &time2)
{
//--- if the second point's time is not set, it will be on the current bar
if(!time2)
time2=TimeCurrent();
//--- if the first point's time is not set, it is located 9 bars left from the second one
if(!time1)
{
//--- array for receiving the open time of the last 10 bars
datetime temp[10];
CopyTime(Symbol(),Period(),time2,10,temp);
//--- set the first point 9 bars left from the second one
time1=temp[0];
}
//--- if the first point's price is not set, it will have Bid value
if(!price1)
price1=SymbolInfoDouble(Symbol(),SYMBOL_BID);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- check correctness of the input parameters
if(InpDate1<0 || InpDate1>100 || InpPrice1<0 || InpPrice1>100 ||
InpDate2<0 || InpDate2>100)
{
Print("Error! Incorrect values of input parameters!");
return;
}
//--- number of visible bars in the chart window
int bars=(int)ChartGetInteger(0,CHART_VISIBLE_BARS);
//--- price array size
int accuracy=1000;
//--- arrays for storing the date and price values to be used
//--- for setting and changing line anchor points' coordinates
datetime date[];
double price[];
//--- memory allocation
ArrayResize(date,bars);
ArrayResize(price,accuracy);
//--- fill the array of dates
ResetLastError();
if(CopyTime(Symbol(),Period(),0,bars,date)==-1)
{
Print("Failed to copy time values! Error code = ",GetLastError());
return;
}
//--- fill the array of prices
//--- find the highest and lowest values of the chart
double max_price=ChartGetDouble(0,CHART_PRICE_MAX);
double min_price=ChartGetDouble(0,CHART_PRICE_MIN);
//--- define a change step of a price and fill the array
double step=(max_price-min_price)/accuracy;
for(int i=0;i<accuracy;i++)
price[i]=min_price+i*step;
//--- define points for drawing Gann Line
int d1=InpDate1*(bars-1)/100;
int d2=InpDate2*(bars-1)/100;
int p1=InpPrice1*(accuracy-1)/100;
//--- create Gann Line
if(!GannLineCreate(0,InpName,0,date[d1],price[p1],date[d2],InpAngle,InpScale,InpColor,
InpStyle,InpWidth,InpBack,InpSelection,InpRayLeft,InpRayRight,InpHidden,InpZOrder))
{
return;
}
//--- redraw the chart and wait for 1 second
ChartRedraw();
Sleep(1000);
//--- now, move the line's anchor point and change the angle
//--- loop counter
int v_steps=accuracy/2;
//--- move the first anchor point vertically
for(int i=0;i<v_steps;i++)
{
//--- use the following value
if(p1>1)
p1-=1;
//--- move the point
if(!GannLinePointChange(0,InpName,0,date[d1],price[p1]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
}
//--- half a second of delay
Sleep(500);
//--- define the current value of Gann angle (changed
//--- after moving the first anchor point)
double curr_angle;
if(!ObjectGetDouble(0,InpName,OBJPROP_ANGLE,0,curr_angle))
return;
//--- loop counter
v_steps=accuracy/8;
//--- change Gann angle
for(int i=0;i<v_steps;i++)
{
if(!GannLineAngleChange(0,InpName,curr_angle-0.05*i))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
}
//--- 1 second of delay
Sleep(1000);
//--- delete the line from the chart
GannLineDelete(0,InpName);
ChartRedraw();
//--- 1 second of delay
Sleep(1000);
//---
}
OBJ_GANNFAN
Gann Fan.
Note
For Gann Fan, it is possible to specify trend type from ENUM _GANN_DIRECTION enumeration. By
adjusting the scale value (OBJPROP_S CALE), it is possible to change slope angle of the fan lines.
Example
The following script creates and moves Gann Fan on the chart. S pecial functions have been
developed to create and change graphical object's properties. You can use these functions " as is " in
your own applications.
//--- description
#property description "Script draws \"Gann Fan\" graphical object."
#property description "Anchor point coordinates are set in percentage of"
#property description "the chart window size."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="GannFan"; // Fan name
input int InpDate1=15; // 1 st point's date, %
input int InpPrice1=25; // 1 st point's price, %
input int InpDate2=85; // 2 nd point's date, %
input double InpScale=2.0; // Scale
input bool InpDirection=false; // Trend direction
input color InpColor=clrRed; // Fan color
//--- when creating a graphical object using ObjectCreate function, the object cannot be
//--- highlighted and moved by default. Inside this method, selection parameter
//--- is true by default making it possible to highlight and move the object
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTABLE,selection);
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTED,selection);
//--- hide (true) or display (false) graphical object name in the object list
ObjectSetInteger(chart_ID,name,OBJPROP_HIDDEN,hidden);
//--- set the priority for receiving the event of a mouse click in the chart
ObjectSetInteger(chart_ID,name,OBJPROP_ZORDER,z_order);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Move Gann Fan anchor point |
//+------------------------------------------------------------------+
bool GannFanPointChange(const long chart_ID=0, // chart's ID
const string name="GannFan", // fan name
const int point_index=0, // anchor point index
datetime time=0, // anchor point time coordinate
double price=0) // anchor point price coordinate
{
//--- if point position is not set, move it to the current bar having Bid price
if(!time)
time=TimeCurrent();
if(!price)
price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
//--- reset the error value
ResetLastError();
//--- move the fan's anchor point
if(!ObjectMove(chart_ID,name,point_index,time,price))
{
Print(__FUNCTION__,
": failed to move the anchor point! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Change Gann Fan's scale |
//+------------------------------------------------------------------+
bool GannFanScaleChange(const long chart_ID=0, // chart's ID
const string name="GannFan", // fan name
const double scale=1.0) // scale
{
//--- reset the error value
ResetLastError();
//--- change the scale (number of pips per bar)
if(!ObjectSetDouble(chart_ID,name,OBJPROP_SCALE,scale))
{
Print(__FUNCTION__,
": failed to change the scale! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Change Gann Fan's trend direction |
//+------------------------------------------------------------------+
bool GannFanDirectionChange(const long chart_ID=0, // chart's ID
const string name="GannFan", // fan name
const bool direction=true) // trend direction
{
//--- reset the error value
ResetLastError();
//--- change Gann Fan's trend direction
if(!ObjectSetInteger(chart_ID,name,OBJPROP_DIRECTION,direction))
{
Print(__FUNCTION__,
": failed to change trend direction! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| The function removes Gann Fan from the chart |
//+------------------------------------------------------------------+
bool GannFanDelete(const long chart_ID=0, // chart's ID
const string name="GannFan") // fan name
{
//--- reset the error value
ResetLastError();
//--- delete Gann Fan
if(!ObjectDelete(chart_ID,name))
{
Print(__FUNCTION__,
": failed to delete \"Gann Fan\"! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
// | Check the values of Gann Fan anchor points and set default |
//| values for empty ones |
//+------------------------------------------------------------------+
OBJ_GANNGRID
Gann Grid.
Note
For Gann Grid, it is possible to specify trend type from ENUM _GANN_DIRECTION. By adjusting the
scale value (OBJPROP_S CALE), it is possible to change slope angle of the grid lines.
Example
The following script creates and moves Gann Grid on the chart. S pecial functions have been
developed to create and change graphical object's properties. You can use these functions " as is " in
your own applications.
//--- description
#property description "Script draws \"Gann Grid\" graphical object."
#property description "Anchor point coordinates of the grid are set in percentage of"
#property description "the chart window size."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="GannGrid"; // Grid name
input int InpDate1=15; // 1 st point's date, %
input int InpPrice1=25; // 1 st point's price, %
input int InpDate2=35; // 2 nd point's date, %
input double InpScale=3.0; // Scale
input bool InpDirection=false; // Trend direction
input color InpColor=clrRed; // Grid color
//--- when creating a graphical object using ObjectCreate function, the object cannot be
//--- highlighted and moved by default. Inside this method, selection parameter
//--- is true by default making it possible to highlight and move the object
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTABLE,selection);
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTED,selection);
//--- hide (true) or display (false) graphical object name in the object list
ObjectSetInteger(chart_ID,name,OBJPROP_HIDDEN,hidden);
//--- set the priority for receiving the event of a mouse click in the chart
ObjectSetInteger(chart_ID,name,OBJPROP_ZORDER,z_order);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Move Gann Grid anchor point |
//+------------------------------------------------------------------+
bool GannGridPointChange(const long chart_ID=0, // chart's ID
const string name="GannGrid", // grid name
const int point_index=0, // anchor point index
datetime time=0, // anchor point time coordinate
double price=0) // anchor point price coordinate
{
//--- if point position is not set, move it to the current bar having Bid price
if(!time)
time=TimeCurrent();
if(!price)
price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
//--- reset the error value
ResetLastError();
//--- move the grid's anchor point
if(!ObjectMove(chart_ID,name,point_index,time,price))
{
Print(__FUNCTION__,
": failed to move the anchor point! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Change Gann Grid's scale |
//+------------------------------------------------------------------+
bool GannGridScaleChange(const long chart_ID=0, // chart's ID
const string name="GannGrid", // grids
const double scale=1.0) // scale
{
//--- reset the error value
ResetLastError();
//--- change the scale (number of pips per bar)
if(!ObjectSetDouble(chart_ID,name,OBJPROP_SCALE,scale))
{
Print(__FUNCTION__,
": failed to change the scale! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Change Gann Grid's trend direction |
//+------------------------------------------------------------------+
bool GannGridDirectionChange(const long chart_ID=0, // chart's ID
const string name="GannGrid", // grid name
const bool direction=true) // trend direction
{
//--- reset the error value
ResetLastError();
//--- change Gann Grid's trend direction
if(!ObjectSetInteger(chart_ID,name,OBJPROP_DIRECTION,direction))
{
Print(__FUNCTION__,
": failed to change trend direction! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| The function removes Gann Fan from the chart |
//+------------------------------------------------------------------+
bool GannGridDelete(const long chart_ID=0, // chart's ID
const string name="GannGrid") // grid name
{
//--- reset the error value
ResetLastError();
//--- delete Gann Grid
if(!ObjectDelete(chart_ID,name))
{
Print(__FUNCTION__,
": failed to delete \"Gann Grid\"! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Check the values of Gann Grid anchor points and set default |
//| values for empty ones |
//+------------------------------------------------------------------+
OBJ_FIBO
Fibonacci R etracement.
Note
For Fibonacci R etracement, it is possible to specify the mode of continuation of its display to the
right and/or left (OBJPROP_RAY_RIGHT and OBJPROP_RAY_LEFT properties accordingly).
You can also specify the number of line-levels, their values and color.
Example
The following script creates and moves Fibonacci Retracement on the chart. S pecial functions have
been developed to create and change graphical object's properties. You can use these functions " as
is " in your own applications.
//--- description
#property description "Script draws \"Fibonacci Retracement\" graphical object."
#property description "Anchor point coordinates are set in percentage of"
#property description "the chart window size."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="FiboLevels"; // Object name
input int InpDate1=10; // 1 st point's date, %
input int InpPrice1=65; // 1 st point's price, %
input int InpDate2=90; // 2 nd point's date, %
input int InpPrice2=85; // 2 nd point's price, %
input color InpColor=clrRed; // Object color
//--- highlighted and moved by default. Inside this method, selection parameter
//--- is true by default making it possible to highlight and move the object
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTABLE,selection);
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTED,selection);
//--- enable (true) or disable (false) the mode of continuation of the object's display to the left
ObjectSetInteger(chart_ID,name,OBJPROP_RAY_LEFT,ray_left);
//--- enable (true) or disable (false) the mode of continuation of the object's display to the righ
ObjectSetInteger(chart_ID,name,OBJPROP_RAY_RIGHT,ray_right);
//--- hide (true) or display (false) graphical object name in the object list
ObjectSetInteger(chart_ID,name,OBJPROP_HIDDEN,hidden);
//--- set the priority for receiving the event of a mouse click in the chart
ObjectSetInteger(chart_ID,name,OBJPROP_ZORDER,z_order);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Set number of levels and their parameters |
//+------------------------------------------------------------------+
bool FiboLevelsSet(int levels, // number of level lines
double &values[], // values of level lines
color &colors[], // color of level lines
ENUM_LINE_STYLE &styles[], // style of level lines
int &widths[], // width of level lines
const long chart_ID=0, // chart's ID
const string name="FiboLevels") // object name
{
//--- check array sizes
if(levels!=ArraySize(colors) || levels!=ArraySize(styles) || levels!=ArraySize(widths))
{
Print(__FUNCTION__,": array length does not correspond to the number of levels, error!");
return(false);
}
//--- set the number of levels
ObjectSetInteger(chart_ID,name,OBJPROP_LEVELS,levels);
//--- set the properties of levels in the loop
for(int i=0;i<levels;i++)
{
//--- level value
ObjectSetDouble(chart_ID,name,OBJPROP_LEVELVALUE,i,values[i]);
//--- level color
ObjectSetInteger(chart_ID,name,OBJPROP_LEVELCOLOR,i,colors[i]);
//--- level style
ObjectSetInteger(chart_ID,name,OBJPROP_LEVELSTYLE,i,styles[i]);
//--- level width
ObjectSetInteger(chart_ID,name,OBJPROP_LEVELWIDTH,i,widths[i]);
//--- level description
ObjectSetString(chart_ID,name,OBJPROP_LEVELTEXT,i,DoubleToString(100*values[i],1));
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Move Fibonacci Retracement anchor point |
//+------------------------------------------------------------------+
bool FiboLevelsPointChange(const long chart_ID=0, // chart's ID
const string name="FiboLevels", // object name
const int point_index=0, // anchor point index
datetime time=0, // anchor point time coordinate
double price=0) // anchor point price coordinate
{
//--- if point position is not set, move it to the current bar having Bid price
if(!time)
time=TimeCurrent();
if(!price)
price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
//--- reset the error value
ResetLastError();
//--- move the anchor point
if(!ObjectMove(chart_ID,name,point_index,time,price))
{
Print(__FUNCTION__,
": failed to move the anchor point! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Delete Fibonacci Retracement |
//+------------------------------------------------------------------+
bool FiboLevelsDelete(const long chart_ID=0, // chart's ID
const string name="FiboLevels") // object name
{
//--- reset the error value
ResetLastError();
//--- delete the object
if(!ObjectDelete(chart_ID,name))
{
Print(__FUNCTION__,
": failed to delete \"Fibonacci Retracement\"! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Check the values of Fibonacci Retracement anchor points and set |
//| default values for empty ones |
//+------------------------------------------------------------------+
void ChangeFiboLevelsEmptyPoints(datetime &time1,double &price1,
datetime &time2,double &price2)
{
//--- if the second point's time is not set, it will be on the current bar
if(!time2)
time2=TimeCurrent();
//--- if the second point's price is not set, it will have Bid value
if(!price2)
price2=SymbolInfoDouble(Symbol(),SYMBOL_BID);
//--- if the first point's time is not set, it is located 9 bars left from the second one
if(!time1)
{
//--- array for receiving the open time of the last 10 bars
datetime temp[10];
CopyTime(Symbol(),Period(),time2,10,temp);
//--- set the first point 9 bars left from the second one
time1=temp[0];
}
//--- if the first point's price is not set, move it 200 points below the second one
if(!price1)
price1=price2-200*SymbolInfoDouble(Symbol(),SYMBOL_POINT);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- check correctness of the input parameters
if(InpDate1<0 || InpDate1>100 || InpPrice1<0 || InpPrice1>100 ||
InpDate2<0 || InpDate2>100 || InpPrice2<0 || InpPrice2>100)
{
Print("Error! Incorrect values of input parameters!");
return;
}
//--- number of visible bars in the chart window
int bars=(int)ChartGetInteger(0,CHART_VISIBLE_BARS);
//--- price array size
int accuracy=1000;
//--- arrays for storing the date and price values to be used
//--- for setting and changing the coordinates of Fibonacci Retracement anchor points
datetime date[];
double price[];
//--- memory allocation
ArrayResize(date,bars);
ArrayResize(price,accuracy);
//--- fill the array of dates
ResetLastError();
if(CopyTime(Symbol(),Period(),0,bars,date)==-1)
{
Print("Failed to copy time values! Error code = ",GetLastError());
return;
}
//--- fill the array of prices
//--- find the highest and lowest values of the chart
double max_price=ChartGetDouble(0,CHART_PRICE_MAX);
double min_price=ChartGetDouble(0,CHART_PRICE_MIN);
//--- define a change step of a price and fill the array
double step=(max_price-min_price)/accuracy;
for(int i=0;i<accuracy;i++)
price[i]=min_price+i*step;
//--- define points for drawing Fibonacci Retracement
int d1=InpDate1*(bars-1)/100;
int d2=InpDate2*(bars-1)/100;
int p1=InpPrice1*(accuracy-1)/100;
int p2=InpPrice2*(accuracy-1)/100;
//--- create an object
if(!FiboLevelsCreate(0,InpName,0,date[d1],price[p1],date[d2],price[p2],InpColor,
InpStyle,InpWidth,InpBack,InpSelection,InpRayLeft,InpRayRight,InpHidden,InpZOrder))
{
return;
}
//--- redraw the chart and wait for 1 second
ChartRedraw();
Sleep(1000);
//--- now, move the anchor points
//--- loop counter
int v_steps=accuracy*2/5;
//--- move the first anchor point
for(int i=0;i<v_steps;i++)
{
//--- use the following value
if(p1>1)
p1-=1;
//--- move the point
if(!FiboLevelsPointChange(0,InpName,0,date[d1],price[p1]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
}
//--- 1 second of delay
Sleep(1000);
//--- loop counter
v_steps=accuracy*4/5;
//--- move the second anchor point
for(int i=0;i<v_steps;i++)
{
//--- use the following value
if(p2>1)
p2-=1;
//--- move the point
if(!FiboLevelsPointChange(0,InpName,1,date[d2],price[p2]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
}
//--- 1 second of delay
Sleep(1000);
//--- delete the object from the chart
FiboLevelsDelete(0,InpName);
ChartRedraw();
//--- 1 second of delay
Sleep(1000);
//---
}
OBJ_FIBOTIMES
Fibonacci Time Zones.
Note
For "Fibonacci Time Zones " , it is possible to specify the number of line-levels, their values and
color.
Example
The following script creates and moves Fibonacci Time Zones on the chart. S pecial functions have
been developed to create and change graphical object's properties. You can use these functions " as
is " in your own applications.
//--- description
#property description "Script draws \"Fibonacci Time Zones\" graphical object."
#property description "Anchor point coordinates are set in percentage of the size of"
#property description "the chart window."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="FiboTimes"; // Object name
input int InpDate1=10; // 1 st point's date, %
input int InpPrice1=45; // 1 st point's price, %
input int InpDate2=20; // 2 nd point's date, %
input int InpPrice2=55; // 2 nd point's price, %
input color InpColor=clrRed; // Object color
input ENUM_LINE_STYLE InpStyle=STYLE_DASHDOTDOT; // Line style
input int InpWidth=2; // Line width
//--- set the priority for receiving the event of a mouse click in the chart
ObjectSetInteger(chart_ID,name,OBJPROP_ZORDER,z_order);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Set number of levels and their parameters |
//+------------------------------------------------------------------+
bool FiboTimesLevelsSet(int levels, // number of level lines
double &values[], // values of level lines
color &colors[], // color of level lines
ENUM_LINE_STYLE &styles[], // style of level lines
int &widths[], // width of level lines
const long chart_ID=0, // chart's ID
const string name="FiboTimes") // object name
{
//--- check array sizes
if(levels!=ArraySize(colors) || levels!=ArraySize(styles) ||
levels!=ArraySize(widths) || levels!=ArraySize(widths))
{
Print(__FUNCTION__,": array length does not correspond to the number of levels, error!");
return(false);
}
//--- set the number of levels
ObjectSetInteger(chart_ID,name,OBJPROP_LEVELS,levels);
//--- set the properties of levels in the loop
for(int i=0;i<levels;i++)
{
//--- level value
ObjectSetDouble(chart_ID,name,OBJPROP_LEVELVALUE,i,values[i]);
//--- level color
ObjectSetInteger(chart_ID,name,OBJPROP_LEVELCOLOR,i,colors[i]);
//--- level style
ObjectSetInteger(chart_ID,name,OBJPROP_LEVELSTYLE,i,styles[i]);
//--- level width
ObjectSetInteger(chart_ID,name,OBJPROP_LEVELWIDTH,i,widths[i]);
//--- level description
ObjectSetString(chart_ID,name,OBJPROP_LEVELTEXT,i,DoubleToString(values[i],1));
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Move Fibonacci Time Zones anchor point |
//+------------------------------------------------------------------+
bool FiboTimesPointChange(const long chart_ID=0, // chart's ID
const string name="FiboTimes", // object name
const int point_index=0, // anchor point index
datetime time=0, // anchor point time coordinate
price1=SymbolInfoDouble(Symbol(),SYMBOL_BID);
//--- if the second point's time is not set, it is located 2 bars left from the second one
if(!time2)
{
//--- array for receiving the open time of the last 3 bars
datetime temp[3];
CopyTime(Symbol(),Period(),time1,3,temp);
//--- set the first point 2 bars left from the second one
time2=temp[0];
}
//--- if the second point's price is not set, it is equal to the first point's one
if(!price2)
price2=price1;
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- check correctness of the input parameters
if(InpDate1<0 || InpDate1>100 || InpPrice1<0 || InpPrice1>100 ||
InpDate2<0 || InpDate2>100 || InpPrice2<0 || InpPrice2>100)
{
Print("Error! Incorrect values of input parameters!");
return;
}
//--- number of visible bars in the chart window
int bars=(int)ChartGetInteger(0,CHART_VISIBLE_BARS);
//--- price array size
int accuracy=1000;
//--- arrays for storing the date and price values to be used
//--- for setting and changing the coordinates of Fibonacci Time Zones anchor points
datetime date[];
double price[];
//--- memory allocation
ArrayResize(date,bars);
ArrayResize(price,accuracy);
//--- fill the array of dates
ResetLastError();
if(CopyTime(Symbol(),Period(),0,bars,date)==-1)
{
Print("Failed to copy time values! Error code = ",GetLastError());
return;
}
//--- fill the array of prices
//--- find the highest and lowest values of the chart
double max_price=ChartGetDouble(0,CHART_PRICE_MAX);
double min_price=ChartGetDouble(0,CHART_PRICE_MIN);
//--- define a change step of a price and fill the array
double step=(max_price-min_price)/accuracy;
for(int i=0;i<accuracy;i++)
price[i]=min_price+i*step;
//--- define points for drawing Fibonacci Time Zones
int d1=InpDate1*(bars-1)/100;
int d2=InpDate2*(bars-1)/100;
int p1=InpPrice1*(accuracy-1)/100;
int p2=InpPrice2*(accuracy-1)/100;
//--- create an object
if(!FiboTimesCreate(0,InpName,0,date[d1],price[p1],date[d2],price[p2],
InpColor,InpStyle,InpWidth,InpBack,InpSelection,InpHidden,InpZOrder))
{
return;
}
//--- redraw the chart and wait for 1 second
ChartRedraw();
Sleep(1000);
//--- now, move the anchor points
//--- loop counter
int h_steps=bars*2/5;
//--- move the second anchor point
for(int i=0;i<h_steps;i++)
{
//--- use the following value
if(d2<bars-1)
d2+=1;
//--- move the point
if(!FiboTimesPointChange(0,InpName,1,date[d2],price[p2]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
// 0.05 seconds of delay
Sleep(50);
}
//--- 1 second of delay
Sleep(1000);
//--- loop counter
h_steps=bars*3/5;
//--- move the first anchor point
for(int i=0;i<h_steps;i++)
{
//--- use the following value
if(d1<bars-1)
d1+=1;
//--- move the point
if(!FiboTimesPointChange(0,InpName,0,date[d1],price[p1]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
// 0.05 seconds of delay
Sleep(50);
}
//--- 1 second of delay
Sleep(1000);
//--- delete the object from the chart
FiboTimesDelete(0,InpName);
ChartRedraw();
//--- 1 second of delay
Sleep(1000);
//---
}
OBJ_FIBOFAN
Fibonacci Fan.
Note
For "Fibonacci Fan" , it is possible to specify the number of line-levels, their values and color.
Example
The following script creates and moves Fibonacci Fan on the chart. S pecial functions have been
developed to create and change graphical object's properties. You can use these functions " as is " in
your own applications.
//--- description
#property description "Script draws \"Fibonacci Fan\" graphical object."
#property description "Anchor point coordinates are set in percentage of"
#property description "the chart window size."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="FiboFan"; // Fan name
input int InpDate1=10; // 1 st point's date, %
input int InpPrice1=25; // 1 st point's price, %
input int InpDate2=30; // 2 nd point's date, %
input int InpPrice2=50; // 2 nd point's price, %
input color InpColor=clrRed; // Fan line color
input ENUM_LINE_STYLE InpStyle=STYLE_DASHDOTDOT; // Line style
input int InpWidth=2; // Line width
//--- set the priority for receiving the event of a mouse click in the chart
ObjectSetInteger(chart_ID,name,OBJPROP_ZORDER,z_order);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Set number of levels and their parameters |
//+------------------------------------------------------------------+
bool FiboFanLevelsSet(int levels, // number of level lines
double &values[], // values of level lines
color &colors[], // color of level lines
ENUM_LINE_STYLE &styles[], // style of level lines
int &widths[], // width of level lines
const long chart_ID=0, // chart's ID
const string name="FiboFan") // fan name
{
//--- check array sizes
if(levels!=ArraySize(colors) || levels!=ArraySize(styles) ||
levels!=ArraySize(widths) || levels!=ArraySize(widths))
{
Print(__FUNCTION__,": array length does not correspond to the number of levels, error!");
return(false);
}
//--- set the number of levels
ObjectSetInteger(chart_ID,name,OBJPROP_LEVELS,levels);
//--- set the properties of levels in the loop
for(int i=0;i<levels;i++)
{
//--- level value
ObjectSetDouble(chart_ID,name,OBJPROP_LEVELVALUE,i,values[i]);
//--- level color
ObjectSetInteger(chart_ID,name,OBJPROP_LEVELCOLOR,i,colors[i]);
//--- level style
ObjectSetInteger(chart_ID,name,OBJPROP_LEVELSTYLE,i,styles[i]);
//--- level width
ObjectSetInteger(chart_ID,name,OBJPROP_LEVELWIDTH,i,widths[i]);
//--- level description
ObjectSetString(chart_ID,name,OBJPROP_LEVELTEXT,i,DoubleToString(100*values[i],1));
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Move Fibonacci Fan anchor point |
//+------------------------------------------------------------------+
bool FiboFanPointChange(const long chart_ID=0, // chart's ID
const string name="FiboFan", // fan name
const int point_index=0, // anchor point index
datetime time=0, // anchor point time coordinate
price2=SymbolInfoDouble(Symbol(),SYMBOL_BID);
//--- if the first point's time is not set, it is located 9 bars left from the second one
if(!time1)
{
//--- array for receiving the open time of the last 10 bars
datetime temp[10];
CopyTime(Symbol(),Period(),time2,10,temp);
//--- set the first point 9 bars left from the second one
time1=temp[0];
}
//--- if the first point's price is not set, move it 200 points below the second one
if(!price1)
price1=price2-200*SymbolInfoDouble(Symbol(),SYMBOL_POINT);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- check correctness of the input parameters
if(InpDate1<0 || InpDate1>100 || InpPrice1<0 || InpPrice1>100 ||
InpDate2<0 || InpDate2>100 || InpPrice2<0 || InpPrice2>100)
{
Print("Error! Incorrect values of input parameters!");
return;
}
//--- number of visible bars in the chart window
int bars=(int)ChartGetInteger(0,CHART_VISIBLE_BARS);
//--- price array size
int accuracy=1000;
//--- arrays for storing the date and price values to be used
//--- for setting and changing the coordinates of Fibonacci Fan anchor points
datetime date[];
double price[];
//--- memory allocation
ArrayResize(date,bars);
ArrayResize(price,accuracy);
//--- fill the array of dates
ResetLastError();
if(CopyTime(Symbol(),Period(),0,bars,date)==-1)
{
Print("Failed to copy time values! Error code = ",GetLastError());
return;
}
//--- fill the array of prices
//--- find the highest and lowest values of the chart
double max_price=ChartGetDouble(0,CHART_PRICE_MAX);
double min_price=ChartGetDouble(0,CHART_PRICE_MIN);
//--- define a change step of a price and fill the array
double step=(max_price-min_price)/accuracy;
for(int i=0;i<accuracy;i++)
price[i]=min_price+i*step;
//--- define points for drawing Fibonacci Fan
int d1=InpDate1*(bars-1)/100;
int d2=InpDate2*(bars-1)/100;
int p1=InpPrice1*(accuracy-1)/100;
int p2=InpPrice2*(accuracy-1)/100;
//--- create an object
if(!FiboFanCreate(0,InpName,0,date[d1],price[p1],date[d2],price[p2],
InpColor,InpStyle,InpWidth,InpBack,InpSelection,InpHidden,InpZOrder))
{
return;
}
//--- redraw the chart and wait for 1 second
ChartRedraw();
Sleep(1000);
//--- now, move the fan's anchor points
//--- loop counter
int v_steps=accuracy/2;
//--- move the first anchor point
for(int i=0;i<v_steps;i++)
{
//--- use the following value
if(p1<accuracy-1)
p1+=1;
//--- move the point
if(!FiboFanPointChange(0,InpName,0,date[d1],price[p1]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
}
//--- 1 second of delay
Sleep(1000);
//--- loop counter
int h_steps=bars/4;
//--- move the second anchor point
for(int i=0;i<h_steps;i++)
{
//--- use the following value
if(d2<bars-1)
d2+=1;
//--- move the point
if(!FiboFanPointChange(0,InpName,1,date[d2],price[p2]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
// 0.05 seconds of delay
Sleep(50);
}
//--- 1 second of delay
Sleep(1000);
//--- delete the object from the chart
FiboFanDelete(0,InpName);
ChartRedraw();
//--- 1 second of delay
Sleep(1000);
//---
}
OBJ_FIBOARC
Fibonacci Arcs.
Note
The following script creates and moves Fibonacci Arcs on the chart. S pecial functions have been
developed to create and change graphical object's properties. You can use these functions " as is " in
your own applications.
//--- description
#property description "Script draws \"Fibonacci Arcs\" graphical object."
#property description "Anchor point coordinates are set in percentage of"
#property description "the chart window size."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="FiboArc"; // Object name
input int InpDate1=25; // 1 st point's date, %
input int InpPrice1=25; // 1 st point's price, %
input int InpDate2=35; // 2 nd point's date, %
input int InpPrice2=55; // 2 nd point's price, %
input double InpScale=3.0; // Scale
if(CopyTime(Symbol(),Period(),0,bars,date)==-1)
{
Print("Failed to copy time values! Error code = ",GetLastError());
return;
}
//--- fill the array of prices
//--- find the highest and lowest values of the chart
double max_price=ChartGetDouble(0,CHART_PRICE_MAX);
double min_price=ChartGetDouble(0,CHART_PRICE_MIN);
//--- define a change step of a price and fill the array
double step=(max_price-min_price)/accuracy;
for(int i=0;i<accuracy;i++)
price[i]=min_price+i*step;
//--- define points for drawing Fibonacci Arcs
int d1=InpDate1*(bars-1)/100;
int d2=InpDate2*(bars-1)/100;
int p1=InpPrice1*(accuracy-1)/100;
int p2=InpPrice2*(accuracy-1)/100;
//--- create an object
if(!FiboArcCreate(0,InpName,0,date[d1],price[p1],date[d2],price[p2],InpScale,
InpFullEllipse,InpColor,InpStyle,InpWidth,InpBack,InpSelection,InpHidden,InpZOrder))
{
return;
}
//--- redraw the chart and wait for 1 second
ChartRedraw();
Sleep(1000);
//--- now, move the anchor points
//--- loop counter
int v_steps=accuracy/5;
//--- move the first anchor point
for(int i=0;i<v_steps;i++)
{
//--- use the following value
if(p1<accuracy-1)
p1+=1;
//--- move the point
if(!FiboArcPointChange(0,InpName,0,date[d1],price[p1]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
}
//--- 1 second of delay
Sleep(1000);
//--- loop counter
int h_steps=bars/5;
OBJ_FIBOCHANNEL
Fibonacci Channel.
Note
For Fibonacci Channel, it is possible to specify the mode of continuation of its display to the right
and/or left (OBJPROP_RAY_RIGHT and OBJPROP_RAY_LEFT properties accordingly).
You can also specify the number of line-levels, their values and color.
Example
The following script creates and moves Fibonacci Channel on the chart. S pecial functions have been
developed to create and change graphical object's properties. You can use these functions " as is " in
your own applications.
//--- description
#property description "Script draws \"Fibonacci Channel\" graphical object."
#property description "Anchor point coordinates are set in percentage of"
#property description "the chart window size."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="FiboChannel"; // Channel name
input int InpDate1=20; // 1 st point's date, %
input int InpPrice1=10; // 1 st point's price, %
input int InpDate2=60; // 2 nd point's date, %
input int InpPrice2=30; // 2 nd point's price, %
input int InpDate3=20; // 3 rd point's date, %
ObjectSetInteger(chart_ID,name,OBJPROP_LEVELWIDTH,i,widths[i]);
//--- level description
ObjectSetString(chart_ID,name,OBJPROP_LEVELTEXT,i,DoubleToString(100*values[i],1));
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Move Fibonacci Channel anchor point |
//+------------------------------------------------------------------+
bool FiboChannelPointChange(const long chart_ID=0, // chart's ID
const string name="FiboChannel", // channel name
const int point_index=0, // anchor point index
datetime time=0, // anchor point time coordinate
double price=0) // anchor point price coordinate
{
//--- if point position is not set, move it to the current bar having Bid price
if(!time)
time=TimeCurrent();
if(!price)
price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
//--- reset the error value
ResetLastError();
//--- move the anchor point
if(!ObjectMove(chart_ID,name,point_index,time,price))
{
Print(__FUNCTION__,
": failed to move the anchor point! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Delete the channel |
//+------------------------------------------------------------------+
bool FiboChannelDelete(const long chart_ID=0, // chart's ID
const string name="FiboChannel") // channel name
{
//--- reset the error value
ResetLastError();
//--- delete the channel
if(!ObjectDelete(chart_ID,name))
{
Print(__FUNCTION__,
": failed to delete \"Fibonacci Channel\"! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Check the values of Fibonacci Channel anchor points and set |
//| default values for empty ones |
//+------------------------------------------------------------------+
void ChangeFiboChannelEmptyPoints(datetime &time1,double &price1,datetime &time2,
double &price2,datetime &time3,double &price3)
{
//--- if the second (right) point's time is not set, it will be on the current bar
if(!time2)
time2=TimeCurrent();
//--- if the second point's price is not set, it will have Bid value
if(!price2)
price2=SymbolInfoDouble(Symbol(),SYMBOL_BID);
//--- if the first (left) point's time is not set, it is located 9 bars left from the second one
if(!time1)
{
//--- array for receiving the open time of the last 10 bars
datetime temp[10];
CopyTime(Symbol(),Period(),time2,10,temp);
//--- set the first point 9 bars left from the second one
time1=temp[0];
}
//--- if the first point's price is not set, move it 300 points higher than the second one
if(!price1)
price1=price2+300*SymbolInfoDouble(Symbol(),SYMBOL_POINT);
//--- if the third point's time is not set, it coincides with the first point's one
if(!time3)
time3=time1;
//--- if the third point's price is not set, it is equal to the second point's one
if(!price3)
price3=price2;
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- check correctness of the input parameters
if(InpDate1<0 || InpDate1>100 || InpPrice1<0 || InpPrice1>100 ||
InpDate2<0 || InpDate2>100 || InpPrice2<0 || InpPrice2>100 ||
InpDate3<0 || InpDate3>100 || InpPrice3<0 || InpPrice3>100)
{
Print("Error! Incorrect values of input parameters!");
return;
}
//--- number of visible bars in the chart window
int bars=(int)ChartGetInteger(0,CHART_VISIBLE_BARS);
OBJ_EXPANSION
Fibonacci Expansion.
Note
For "Fibonacci Expansion" , it is possible to specify the mode of continuation of its display to the
right and/or left (OBJPROP_RAY_RIGHT and OBJPROP_RAY_LEFT properties accordingly).
You can also specify the number of line-levels, their values and color.
Example
The following script creates and moves Fibonacci Expansion on the chart. S pecial functions have
been developed to create and change graphical object's properties. You can use these functions " as
is " in your own applications.
//--- description
#property description "Script draws \"Fibonacci Expansion\"graphical object."
#property description "Anchor point coordinates are set in percentage of"
#property description "the chart window size."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="FiboExpansion"; // Object name
input int InpDate1=10; // 1 st point's date, %
input int InpPrice1=55; // 1 st point's price, %
input int InpDate2=30; // 2 nd point's date, %
input int InpPrice2=10; // 2 nd point's price, %
input int InpDate3=80; // 3 rd point's date, %
ObjectSetInteger(chart_ID,name,OBJPROP_LEVELWIDTH,i,widths[i]);
//--- level description
ObjectSetString(chart_ID,name,OBJPROP_LEVELTEXT,i,"FE "+DoubleToString(100*values[i],1));
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Move Fibonacci Expansion anchor point |
//+------------------------------------------------------------------+
bool FiboExpansionPointChange(const long chart_ID=0, // chart's ID
const string name="FiboExpansion", // object name
const int point_index=0, // anchor point index
datetime time=0, // anchor point time coordinate
double price=0) // anchor point price coordinate
{
//--- if point position is not set, move it to the current bar having Bid price
if(!time)
time=TimeCurrent();
if(!price)
price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
//--- reset the error value
ResetLastError();
//--- move the anchor point
if(!ObjectMove(chart_ID,name,point_index,time,price))
{
Print(__FUNCTION__,
": failed to move the anchor point! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Delete Fibonacci Expansion |
//+------------------------------------------------------------------+
bool FiboExpansionDelete(const long chart_ID=0, // chart's ID
const string name="FiboExpansion") // object name
{
//--- reset the error value
ResetLastError();
//--- delete the object
if(!ObjectDelete(chart_ID,name))
{
Print(__FUNCTION__,
": failed to delete \"Fibonacci Expansion\"! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Check the values of Fibonacci Expansion anchor points and set |
//| default values for empty ones |
//+------------------------------------------------------------------+
void ChangeFiboExpansionEmptyPoints(datetime &time1,double &price1,datetime &time2,
double &price2,datetime &time3,double &price3)
{
//--- if the third (right) point's time is not set, it will be on the current bar
if(!time3)
time3=TimeCurrent();
//--- if the third point's price is not set, it will have Bid value
if(!price3)
price3=SymbolInfoDouble(Symbol(),SYMBOL_BID);
//--- if the first (left) point's time is not set, it is located 9 bars left from the third one
//--- array for receiving the open time of the last 10 bars
datetime temp[];
ArrayResize(temp,10);
if(!time1)
{
CopyTime(Symbol(),Period(),time3,10,temp);
//--- set the first point 9 bars left from the second one
time1=temp[0];
}
//--- if the first point's price is not set, it is equal to the third point's one
if(!price1)
price1=price3;
//--- if the second point's time is not set, it is located 7 bars left from the third one
if(!time2)
time2=temp[2];
//--- if the second point's price is not set, move it 250 points lower than the first one
if(!price2)
price2=price1-250*SymbolInfoDouble(Symbol(),SYMBOL_POINT);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- check correctness of the input parameters
if(InpDate1<0 || InpDate1>100 || InpPrice1<0 || InpPrice1>100 ||
InpDate2<0 || InpDate2>100 || InpPrice2<0 || InpPrice2>100 ||
InpDate3<0 || InpDate3>100 || InpPrice3<0 || InpPrice3>100)
{
Print("Error! Incorrect values of input parameters!");
return;
}
//--- number of visible bars in the chart window
int bars=(int)ChartGetInteger(0,CHART_VISIBLE_BARS);
//--- price array size
int accuracy=1000;
//--- arrays for storing the date and price values to be used
//--- for setting and changing object anchor points' coordinates
datetime date[];
double price[];
//--- memory allocation
ArrayResize(date,bars);
ArrayResize(price,accuracy);
//--- fill the array of dates
ResetLastError();
if(CopyTime(Symbol(),Period(),0,bars,date)==-1)
{
Print("Failed to copy time values! Error code = ",GetLastError());
return;
}
//--- fill the array of prices
//--- find the highest and lowest values of the chart
double max_price=ChartGetDouble(0,CHART_PRICE_MAX);
double min_price=ChartGetDouble(0,CHART_PRICE_MIN);
//--- define a change step of a price and fill the array
double step=(max_price-min_price)/accuracy;
for(int i=0;i<accuracy;i++)
price[i]=min_price+i*step;
//--- define points for drawing Fibonacci Expansion
int d1=InpDate1*(bars-1)/100;
int d2=InpDate2*(bars-1)/100;
int d3=InpDate3*(bars-1)/100;
int p1=InpPrice1*(accuracy-1)/100;
int p2=InpPrice2*(accuracy-1)/100;
int p3=InpPrice3*(accuracy-1)/100;
//--- create Fibonacci Expansion
if(!FiboExpansionCreate(0,InpName,0,date[d1],price[p1],date[d2],price[p2],date[d3],price[p3],
InpColor,InpStyle,InpWidth,InpBack,InpSelection,InpRayLeft,InpRayRight,InpHidden,InpZOrder))
{
return;
}
//--- redraw the chart and wait for 1 second
ChartRedraw();
Sleep(1000);
//--- now, move the anchor points
//--- loop counter
int v_steps=accuracy/10;
//--- move the first anchor point
for(int i=0;i<v_steps;i++)
{
//--- use the following value
if(p1>1)
p1-=1;
//--- move the point
if(!FiboExpansionPointChange(0,InpName,0,date[d1],price[p1]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
}
//--- 1 second of delay
Sleep(1000);
//--- loop counter
v_steps=accuracy/2;
//--- move the third anchor point
for(int i=0;i<v_steps;i++)
{
//--- use the following value
if(p3>1)
p3-=1;
//--- move the point
if(!FiboExpansionPointChange(0,InpName,2,date[d3],price[p3]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
}
//--- 1 second of delay
Sleep(1000);
//--- loop counter
v_steps=accuracy*4/5;
//--- move the second anchor point
for(int i=0;i<v_steps;i++)
{
//--- use the following value
if(p2<accuracy-1)
p2+=1;
//--- move the point
if(!FiboExpansionPointChange(0,InpName,1,date[d2],price[p2]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
}
//--- 1 second of delay
Sleep(1000);
//--- delete the object from the chart
FiboExpansionDelete(0,InpName);
ChartRedraw();
//--- 1 second of delay
Sleep(1000);
//---
}
OBJ_ELLIOTWAVE5
Elliott Motive W ave.
Note
For "Elliott Motive W ave" , it is possible to enable/disable the mode of connecting points by lines
(OBJPROP_DRAW LINES property), as well as set the level of wave positioning (from
ENUM _ELLIOT _WAVE_DEGREE enumeration).
Example
The following script creates and moves Elliott motive wave on the chart. S pecial functions have been
developed to create and change graphical object's properties. You can use these functions " as is " in
your own applications.
//--- description
#property description "Script draws \"Elliott Motive Wave\"."
#property description "Anchor point coordinates are set in percentage of the size of"
#property description "the chart window."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="ElliotWave5"; // Object name
input int InpDate1=10; // 1 st point's date, %
input int InpPrice1=90; // 1 st point's price, %
input int InpDate2=20; // 2 nd point's date, %
input int InpPrice2=40; // 2 nd point's price, %
input int InpDate3=30; // 3 rd point's date, %
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Delete Elliott Motive Wave |
//+------------------------------------------------------------------+
bool ElliotWave5Delete(const long chart_ID=0, // chart's ID
const string name="ElliotWave5") // object name
{
//--- reset the error value
ResetLastError();
//--- delete the object
if(!ObjectDelete(chart_ID,name))
{
Print(__FUNCTION__,
": failed to delete \"Elliott Motive Wave\"! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Check the values of Elliott Motive Wave's anchor points and |
//| set default values for empty ones |
//+------------------------------------------------------------------+
void ChangeElliotWave5EmptyPoints(datetime &time1,double &price1,
datetime &time2,double &price2,
datetime &time3,double &price3,
datetime &time4,double &price4,
datetime &time5,double &price5)
{
//--- array for receiving the open time of the last 10 bars
datetime temp[];
ArrayResize(temp,10);
//--- receive data
CopyTime(Symbol(),Period(),TimeCurrent(),10,temp);
//--- receive the value of one point on the current chart
double point=SymbolInfoDouble(Symbol(),SYMBOL_POINT);
//--- if the first point's time is not set, it will be 9 bars left from the last bar
if(!time1)
time1=temp[0];
//--- if the first point's price is not set, it will have Bid value
if(!price1)
price1=SymbolInfoDouble(Symbol(),SYMBOL_BID);
//--- if the second point's time is not set, it will be 7 bars left from the last bar
if(!time2)
time2=temp[2];
//--- if the second point's price is not set, move it 300 points lower than the first one
if(!price2)
price2=price1-300*point;
//--- if the third point's time is not set, it will be 5 bars left from the last bar
if(!time3)
time3=temp[4];
//--- if the third point's price is not set, move it 250 points lower than the first one
if(!price3)
price3=price1-250*point;
//--- if the fourth point's time is not set, it will be 3 bars left from the last bar
if(!time4)
time4=temp[6];
//--- if the fourth point's price is not set, move it 550 points lower than the first one
if(!price4)
price4=price1-550*point;
//--- if the fifth point's time is not set, it will be on the last bar
if(!time5)
time5=temp[9];
//--- if the fifth point's price is not set, move it 450 points lower than the first one
if(!price5)
price5=price1-450*point;
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- check correctness of the input parameters
if(InpDate1<0 || InpDate1>100 || InpPrice1<0 || InpPrice1>100 ||
InpDate2<0 || InpDate2>100 || InpPrice2<0 || InpPrice2>100 ||
InpDate3<0 || InpDate3>100 || InpPrice3<0 || InpPrice3>100 ||
InpDate4<0 || InpDate4>100 || InpPrice4<0 || InpPrice4>100 ||
InpDate5<0 || InpDate5>100 || InpPrice5<0 || InpPrice5>100)
{
Print("Error! Incorrect values of input parameters!");
return;
}
//--- number of visible bars in the chart window
int bars=(int)ChartGetInteger(0,CHART_VISIBLE_BARS);
//--- price array size
int accuracy=1000;
//--- arrays for storing the date and price values to be used
//--- for setting and changing object anchor points' coordinates
datetime date[];
double price[];
//--- memory allocation
ArrayResize(date,bars);
ArrayResize(price,accuracy);
//--- fill the array of dates
ResetLastError();
if(CopyTime(Symbol(),Period(),0,bars,date)==-1)
{
Print("Failed to copy time values! Error code = ",GetLastError());
return;
}
//--- fill the array of prices
//--- find the highest and lowest values of the chart
double max_price=ChartGetDouble(0,CHART_PRICE_MAX);
double min_price=ChartGetDouble(0,CHART_PRICE_MIN);
//--- define a change step of a price and fill the array
double step=(max_price-min_price)/accuracy;
for(int i=0;i<accuracy;i++)
price[i]=min_price+i*step;
//--- define points for drawing Elliott Motive Wave
int d1=InpDate1*(bars-1)/100;
int d2=InpDate2*(bars-1)/100;
int d3=InpDate3*(bars-1)/100;
int d4=InpDate4*(bars-1)/100;
int d5=InpDate5*(bars-1)/100;
int p1=InpPrice1*(accuracy-1)/100;
int p2=InpPrice2*(accuracy-1)/100;
int p3=InpPrice3*(accuracy-1)/100;
int p4=InpPrice4*(accuracy-1)/100;
int p5=InpPrice5*(accuracy-1)/100;
//--- Create Elliott Motive Wave
if(!ElliotWave5Create(0,InpName,0,date[d1],price[p1],date[d2],price[p2],date[d3],price[p3],
date[d4],price[p4],date[d5],price[p5],InpDegree,InpDrawLines,InpColor,InpStyle,InpWidth,
InpBack,InpSelection,InpHidden,InpZOrder))
{
return;
}
//--- redraw the chart and wait for 1 second
ChartRedraw();
Sleep(1000);
//--- now, move the anchor points
//--- loop counter
int v_steps=accuracy/5;
//--- move the fifth anchor point
for(int i=0;i<v_steps;i++)
{
//--- use the following value
if(p5<accuracy-1)
p5+=1;
//--- move the point
if(!ElliotWave5PointChange(0,InpName,4,date[d5],price[p5]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
}
//--- 1 second of delay
Sleep(1000);
//--- loop counter
v_steps=accuracy/5;
//--- move the second and third anchor points
for(int i=0;i<v_steps;i++)
{
//--- use the following values
if(p2<accuracy-1)
p2+=1;
if(p3>1)
p3-=1;
//--- shift the points
if(!ElliotWave5PointChange(0,InpName,1,date[d2],price[p2]))
return;
if(!ElliotWave5PointChange(0,InpName,2,date[d3],price[p3]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
}
//--- 1 second of delay
Sleep(1000);
//--- loop counter
v_steps=accuracy*4/5;
//--- move the first and fourth anchor points
for(int i=0;i<v_steps;i++)
{
//--- use the following values
if(p1>1)
p1-=1;
if(p4<accuracy-1)
p4+=1;
//--- shift the points
if(!ElliotWave5PointChange(0,InpName,0,date[d1],price[p1]))
return;
if(!ElliotWave5PointChange(0,InpName,3,date[d4],price[p4]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
}
//--- 1 second of delay
Sleep(1000);
//--- delete the object from the chart
ElliotWave5Delete(0,InpName);
ChartRedraw();
//--- 1 second of delay
Sleep(1000);
//---
}
OBJ_ELLIOTWAVE3
Elliott Correction W ave.
Note
For "Elliott Correction W ave" , it is possible to enable/disable the mode of connecting points by lines
(OBJPROP_DRAW LINES property), as well as set the level of wave positioning (from
ENUM _ELLIOT _WAVE_DEGREE enumeration).
Example
The following script creates and moves Elliott correction wave on the chart. S pecial functions have
been developed to create and change graphical object's properties. You can use these functions " as
is " in your own applications.
//--- description
#property description "Script draws \"Elliott Correction Wave\" graphical object."
#property description "Anchor point coordinates are set in percentage of the chart's window"
#property description "size."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="ElliotWave3"; // Object name
input int InpDate1=10; // 1 st point's date, %
input int InpPrice1=90; // 1 st point's price, %
input int InpDate2=30; // 2 nd point's date, %
input int InpPrice2=10; // 2 nd point's price, %
input int InpDate3=50; // 3 rd point's date, %
return;
}
//--- redraw the chart and wait for 1 second
ChartRedraw();
Sleep(1000);
//--- now, move the anchor points
//--- loop counter
int v_steps=accuracy/5;
//--- move the third anchor point
for(int i=0;i<v_steps;i++)
{
//--- use the following value
if(p3<accuracy-1)
p3+=1;
//--- move the point
if(!ElliotWave3PointChange(0,InpName,2,date[d3],price[p3]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
}
//--- 1 second of delay
Sleep(1000);
//--- loop counter
v_steps=accuracy*4/5;
//--- move the first and second anchor points
for(int i=0;i<v_steps;i++)
{
//--- use the following values
if(p1>1)
p1-=1;
if(p2<accuracy-1)
p2+=1;
//--- shift the points
if(!ElliotWave3PointChange(0,InpName,0,date[d1],price[p1]))
return;
if(!ElliotWave3PointChange(0,InpName,1,date[d2],price[p2]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
}
//--- 1 second of delay
Sleep(1000);
//--- delete the object from the chart
ElliotWave3Delete(0,InpName);
ChartRedraw();
//--- 1 second of delay
Sleep(1000);
//---
}
OBJ_RECTANGLE
R ectangle.
Note
For rectangle, the mode of filling with color can be set using OBJPROP_FILL property.
Example
The following script creates and moves the rectangle on the chart. S pecial functions have been
developed to create and change graphical object's properties. You can use these functions " as is " in
your own applications.
//--- description
#property description "Script creates rectangle on the chart."
#property description "Anchor point coordinates are set in"
#property description "percentage of the chart window size."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="Rectangle"; // Rectangle name
input int InpDate1=40; // 1 st point's date, %
input int InpPrice1=40; // 1 st point's price, %
input int InpDate2=60; // 2 nd point's date, %
input int InpPrice2=60; // 2 nd point's price, %
input color InpColor=clrRed; // Rectangle color
input ENUM_LINE_STYLE InpStyle=STYLE_DASH; // Style of rectangle lines
input int InpWidth=2; // Width of rectangle lines
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTABLE,selection);
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTED,selection);
//--- hide (true) or display (false) graphical object name in the object list
ObjectSetInteger(chart_ID,name,OBJPROP_HIDDEN,hidden);
//--- set the priority for receiving the event of a mouse click in the chart
ObjectSetInteger(chart_ID,name,OBJPROP_ZORDER,z_order);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Move the rectangle anchor point |
//+------------------------------------------------------------------+
bool RectanglePointChange(const long chart_ID=0, // chart's ID
const string name="Rectangle", // rectangle name
const int point_index=0, // anchor point index
datetime time=0, // anchor point time coordinate
double price=0) // anchor point price coordinate
{
//--- if point position is not set, move it to the current bar having Bid price
if(!time)
time=TimeCurrent();
if(!price)
price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
//--- reset the error value
ResetLastError();
//--- move the anchor point
if(!ObjectMove(chart_ID,name,point_index,time,price))
{
Print(__FUNCTION__,
": failed to move the anchor point! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Delete the rectangle |
//+------------------------------------------------------------------+
bool RectangleDelete(const long chart_ID=0, // chart's ID
const string name="Rectangle") // rectangle name
{
//--- reset the error value
ResetLastError();
//--- delete rectangle
if(!ObjectDelete(chart_ID,name))
{
Print(__FUNCTION__,
": failed to delete rectangle! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Check the values of rectangle's anchor points and set default |
//| values for empty ones |
//+------------------------------------------------------------------+
void ChangeRectangleEmptyPoints(datetime &time1,double &price1,
datetime &time2,double &price2)
{
//--- if the first point's time is not set, it will be on the current bar
if(!time1)
time1=TimeCurrent();
//--- if the first point's price is not set, it will have Bid value
if(!price1)
price1=SymbolInfoDouble(Symbol(),SYMBOL_BID);
//--- if the second point's time is not set, it is located 9 bars left from the second one
if(!time2)
{
//--- array for receiving the open time of the last 10 bars
datetime temp[10];
CopyTime(Symbol(),Period(),time1,10,temp);
//--- set the second point 9 bars left from the first one
time2=temp[0];
}
//--- if the second point's price is not set, move it 300 points lower than the first one
if(!price2)
price2=price1-300*SymbolInfoDouble(Symbol(),SYMBOL_POINT);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- check correctness of the input parameters
if(InpDate1<0 || InpDate1>100 || InpPrice1<0 || InpPrice1>100 ||
InpDate2<0 || InpDate2>100 || InpPrice2<0 || InpPrice2>100)
{
Print("Error! Incorrect values of input parameters!");
return;
}
//--- number of visible bars in the chart window
int bars=(int)ChartGetInteger(0,CHART_VISIBLE_BARS);
//--- price array size
int accuracy=1000;
//--- arrays for storing the date and price values to be used
//--- for setting and changing rectangle anchor points' coordinates
datetime date[];
double price[];
//--- memory allocation
ArrayResize(date,bars);
ArrayResize(price,accuracy);
//--- fill the array of dates
ResetLastError();
if(CopyTime(Symbol(),Period(),0,bars,date)==-1)
{
Print("Failed to copy time values! Error code = ",GetLastError());
return;
}
//--- fill the array of prices
//--- find the highest and lowest values of the chart
double max_price=ChartGetDouble(0,CHART_PRICE_MAX);
double min_price=ChartGetDouble(0,CHART_PRICE_MIN);
//--- define a change step of a price and fill the array
double step=(max_price-min_price)/accuracy;
for(int i=0;i<accuracy;i++)
price[i]=min_price+i*step;
//--- define points for drawing the rectangle
int d1=InpDate1*(bars-1)/100;
int d2=InpDate2*(bars-1)/100;
int p1=InpPrice1*(accuracy-1)/100;
int p2=InpPrice2*(accuracy-1)/100;
//--- create a rectangle
if(!RectangleCreate(0,InpName,0,date[d1],price[p1],date[d2],price[p2],InpColor,
InpStyle,InpWidth,InpFill,InpBack,InpSelection,InpHidden,InpZOrder))
{
return;
}
//--- redraw the chart and wait for 1 second
ChartRedraw();
Sleep(1000);
//--- now, move the rectangle's anchor points
//--- loop counter
int h_steps=bars/2;
//--- move the anchor points
for(int i=0;i<h_steps;i++)
{
//--- use the following values
if(d1<bars-1)
d1+=1;
if(d2>1)
d2-=1;
//--- shift the points
if(!RectanglePointChange(0,InpName,0,date[d1],price[p1]))
return;
if(!RectanglePointChange(0,InpName,1,date[d2],price[p2]))
return;
OBJ_TRIANGLE
Triangle.
Note
For triangle, the mode of filling with color can be set using OBJPROP_FILL property.
Example
The following script creates and moves the triangle on the chart. S pecial functions have been
developed to create and change graphical object's properties. You can use these functions " as is " in
your own applications.
//--- description
#property description "Script creates triangle on the chart."
#property description "Anchor point coordinates are set in"
#property description "percentage of the chart window size."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="Triangle"; // Triangle name
input int InpDate1=25; // 1 st point's date, %
input int InpPrice1=50; // 1 st point's price, %
input int InpDate2=70; // 2 nd point's date, %
input int InpPrice2=70; // 2 nd point's price, %
input int InpDate3=65; // 3 rd point's date, %
input int InpPrice3=20; // 3 rd point's price, %
input color InpColor=clrRed; // Triangle color
//--- enable (true) or disable (false) the mode of highlighting the triangle for moving
//--- when creating a graphical object using ObjectCreate function, the object cannot be
//--- highlighted and moved by default. Inside this method, selection parameter
//--- is true by default making it possible to highlight and move the object
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTABLE,selection);
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTED,selection);
//--- hide (true) or display (false) graphical object name in the object list
ObjectSetInteger(chart_ID,name,OBJPROP_HIDDEN,hidden);
//--- set the priority for receiving the event of a mouse click in the chart
ObjectSetInteger(chart_ID,name,OBJPROP_ZORDER,z_order);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Move the triangle anchor point |
//+------------------------------------------------------------------+
bool TrianglePointChange(const long chart_ID=0, // chart's ID
const string name="Triangle", // triangle name
const int point_index=0, // anchor point index
datetime time=0, // anchor point time coordinate
double price=0) // anchor point price coordinate
{
//--- if point position is not set, move it to the current bar having Bid price
if(!time)
time=TimeCurrent();
if(!price)
price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
//--- reset the error value
ResetLastError();
//--- move the anchor point
if(!ObjectMove(chart_ID,name,point_index,time,price))
{
Print(__FUNCTION__,
": failed to move the anchor point! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Delete the triangle |
//+------------------------------------------------------------------+
bool TriangleDelete(const long chart_ID=0, // chart's ID
const string name="Triangle") // triangle name
{
//--- reset the error value
ResetLastError();
//--- delete the triangle
if(!ObjectDelete(chart_ID,name))
{
Print(__FUNCTION__,
": failed to delete the ellipse! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Check the values of triangle's anchor points and set default |
//| values for empty ones |
//+------------------------------------------------------------------+
void ChangeTriangleEmptyPoints(datetime &time1,double &price1,
datetime &time2,double &price2,
datetime &time3,double &price3)
{
//--- if the first point's time is not set, it will be on the current bar
if(!time1)
time1=TimeCurrent();
//--- if the first point's price is not set, it will have Bid value
if(!price1)
price1=SymbolInfoDouble(Symbol(),SYMBOL_BID);
//--- if the second point's time is not set, it is located 9 bars left from the second one
if(!time2)
{
//--- array for receiving the open time of the last 10 bars
datetime temp[10];
CopyTime(Symbol(),Period(),time1,10,temp);
//--- set the second point 9 bars left from the first one
time2=temp[0];
}
//--- if the second point's price is not set, move it 300 points lower than the first one
if(!price2)
price2=price1-300*SymbolInfoDouble(Symbol(),SYMBOL_POINT);
//--- if the third point's time is not set, it coincides with the second point's date
if(!time3)
time3=time2;
//--- if the third point's price is not set, it is equal to the first point's one
if(!price3)
price3=price1;
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- check correctness of the input parameters
if(InpDate1<0 || InpDate1>100 || InpPrice1<0 || InpPrice1>100 ||
InpDate2<0 || InpDate2>100 || InpPrice2<0 || InpPrice2>100 ||
int v_steps=accuracy*3/10;
//--- move the first anchor point
for(int i=0;i<v_steps;i++)
{
//--- use the following value
if(p1>1)
p1-=1;
//--- move the point
if(!TrianglePointChange(0,InpName,0,date[d1],price[p1]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
}
//--- 1 second of delay
Sleep(1000);
//--- loop counter
int h_steps=bars*9/20-1;
//--- move the second anchor point
for(int i=0;i<h_steps;i++)
{
//--- use the following value
if(d2>1)
d2-=1;
//--- move the point
if(!TrianglePointChange(0,InpName,1,date[d2],price[p2]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
// 0.05 seconds of delay
Sleep(50);
}
//--- 1 second of delay
Sleep(1000);
//--- loop counter
v_steps=accuracy/4;
//--- move the third anchor point
for(int i=0;i<v_steps;i++)
{
//--- use the following value
if(p3<accuracy-1)
p3+=1;
//--- move the point
if(!TrianglePointChange(0,InpName,2,date[d3],price[p3]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
}
//--- 1 second of delay
Sleep(1000);
//--- delete triangle from the chart
TriangleDelete(0,InpName);
ChartRedraw();
//--- 1 second of delay
Sleep(1000);
//---
}
OBJ_ELLIPSE
Ellipse.
Note
For ellipse, the mode of filling with color can be set using OBJPROP_FILL property.
Example
The following script creates and moves the ellipse on the chart. S pecial functions have been
developed to create and change graphical object's properties. You can use these functions " as is " in
your own applications.
//--- description
#property description "Script creates ellipse on the chart."
#property description "Anchor point coordinates are set"
#property description "in percentage of the chart window size."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="Ellipse"; // Ellipse name
input int InpDate1=30; // 1 st point's date, %
input int InpPrice1=20; // 1 st point's price, %
input int InpDate2=70; // 2 nd point's date, %
input int InpPrice2=80; // 2 nd point's price, %
input int InpDate3=50; // 3 rd point's date, %
input int InpPrice3=60; // 3 rd point's price, %
input color InpColor=clrRed; // Ellipse color
input ENUM_LINE_STYLE InpStyle=STYLE_DASHDOTDOT; // Style of ellipse lines
//--- when creating a graphical object using ObjectCreate function, the object cannot be
//--- highlighted and moved by default. Inside this method, selection parameter
//--- is true by default making it possible to highlight and move the object
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTABLE,selection);
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTED,selection);
//--- hide (true) or display (false) graphical object name in the object list
ObjectSetInteger(chart_ID,name,OBJPROP_HIDDEN,hidden);
//--- set the priority for receiving the event of a mouse click in the chart
ObjectSetInteger(chart_ID,name,OBJPROP_ZORDER,z_order);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Move the ellipse anchor point |
//+------------------------------------------------------------------+
bool EllipsePointChange(const long chart_ID=0, // chart's ID
const string name="Ellipse", // ellipse name
const int point_index=0, // anchor point index
datetime time=0, // anchor point time coordinate
double price=0) // anchor point price coordinate
{
//--- if point position is not set, move it to the current bar having Bid price
if(!time)
time=TimeCurrent();
if(!price)
price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
//--- reset the error value
ResetLastError();
//--- move the anchor point
if(!ObjectMove(chart_ID,name,point_index,time,price))
{
Print(__FUNCTION__,
": failed to move the anchor point! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Delete ellipse |
//+------------------------------------------------------------------+
bool EllipseDelete(const long chart_ID=0, // chart's ID
const string name="Ellipse") // ellipse name
{
//--- reset the error value
ResetLastError();
//--- delete an ellipse
if(!ObjectDelete(chart_ID,name))
{
Print(__FUNCTION__,
": failed to delete an ellipse! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Check the values of ellipse anchor points and set default values |
//| for empty ones |
//+------------------------------------------------------------------+
void ChangeEllipseEmptyPoints(datetime &time1,double &price1,
datetime &time2,double &price2,
datetime &time3,double &price3)
{
//--- if the first point's time is not set, it will be on the current bar
if(!time1)
time1=TimeCurrent();
//--- if the first point's price is not set, it will have Bid value
if(!price1)
price1=SymbolInfoDouble(Symbol(),SYMBOL_BID);
//--- if the second point's time is not set, it is located 9 bars left from the second one
if(!time2)
{
//--- array for receiving the open time of the last 10 bars
datetime temp[10];
CopyTime(Symbol(),Period(),time1,10,temp);
//--- set the second point 9 bars left from the first one
time2=temp[0];
}
//--- if the second point's price is not set, move it 300 points lower than the first one
if(!price2)
price2=price1-300*SymbolInfoDouble(Symbol(),SYMBOL_POINT);
//--- if the third point's time is not set, it coincides with the second point's date
if(!time3)
time3=time2;
//--- if the third point's price is not set, it is equal to the first point's one
if(!price3)
price3=price1;
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- check correctness of the input parameters
if(InpDate1<0 || InpDate1>100 || InpPrice1<0 || InpPrice1>100 ||
InpDate2<0 || InpDate2>100 || InpPrice2<0 || InpPrice2>100 ||
InpDate3<0 || InpDate3>100 || InpPrice3<0 || InpPrice3>100)
{
Print("Error! Incorrect values of input parameters!");
return;
}
//--- number of visible bars in the chart window
int bars=(int)ChartGetInteger(0,CHART_VISIBLE_BARS);
//--- price array size
int accuracy=1000;
//--- arrays for storing the date and price values to be used
//--- for setting and changing ellipse anchor points' coordinates
datetime date[];
double price[];
//--- memory allocation
ArrayResize(date,bars);
ArrayResize(price,accuracy);
//--- fill the array of dates
ResetLastError();
if(CopyTime(Symbol(),Period(),0,bars,date)==-1)
{
Print("Failed to copy time values! Error code = ",GetLastError());
return;
}
//--- fill the array of prices
//--- find the highest and lowest values of the chart
double max_price=ChartGetDouble(0,CHART_PRICE_MAX);
double min_price=ChartGetDouble(0,CHART_PRICE_MIN);
//--- define a change step of a price and fill the array
double step=(max_price-min_price)/accuracy;
for(int i=0;i<accuracy;i++)
price[i]=min_price+i*step;
//--- define points for drawing the ellipse
int d1=InpDate1*(bars-1)/100;
int d2=InpDate2*(bars-1)/100;
int d3=InpDate3*(bars-1)/100;
int p1=InpPrice1*(accuracy-1)/100;
int p2=InpPrice2*(accuracy-1)/100;
int p3=InpPrice3*(accuracy-1)/100;
//--- create an ellipse
if(!EllipseCreate(0,InpName,0,date[d1],price[p1],date[d2],price[p2],date[d3],price[p3],
InpColor,InpStyle,InpWidth,InpFill,InpBack,InpSelection,InpHidden,InpZOrder))
{
return;
}
//--- redraw the chart and wait for 1 second
ChartRedraw();
Sleep(1000);
//--- now, move the ellipse anchor points
//--- loop counter
int v_steps=accuracy/5;
OBJ_ARROW_THUMB_UP
Thumbs Up sign.
Note
Anchor point position relative to the sign can be selected from ENUM _ARR OW_ANCH OR
enumeration.
Large signs (more than 5) can only be created by setting the appropriate OBJPROP_W IDTH property
value when writing a code in MetaEditor.
Example
The following script creates and moves Thumbs Up sign on the chart. S pecial functions have been
developed to create and change graphical object's properties. You can use these functions " as is " in
your own applications.
//--- description
#property description "Script draws \"Thumbs Up\" sign."
#property description "Anchor point coordinate is set in percentage of"
#property description "the chart window size."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="ThumbUp"; // Sign name
input int InpDate=75; // Anchor point date in %
input int InpPrice=25; // Anchor point price in %
input ENUM_ARROW_ANCHOR InpAnchor=ANCHOR_TOP; // Anchor type
input color InpColor=clrRed; // Sign color
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTED,selection);
//--- hide (true) or display (false) graphical object name in the object list
ObjectSetInteger(chart_ID,name,OBJPROP_HIDDEN,hidden);
//--- set the priority for receiving the event of a mouse click in the chart
ObjectSetInteger(chart_ID,name,OBJPROP_ZORDER,z_order);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Move the anchor point |
//+------------------------------------------------------------------+
bool ArrowThumbUpMove(const long chart_ID=0, // chart's ID
const string name="ThumbUp", // object name
datetime time=0, // anchor point time coordinate
double price=0) // anchor point price coordinate
{
//--- if point position is not set, move it to the current bar having Bid price
if(!time)
time=TimeCurrent();
if(!price)
price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
//--- reset the error value
ResetLastError();
//--- move the anchor point
if(!ObjectMove(chart_ID,name,0,time,price))
{
Print(__FUNCTION__,
": failed to move the anchor point! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Change Thumbs Up sign anchor type |
//+------------------------------------------------------------------+
bool ArrowThumbUpAnchorChange(const long chart_ID=0, // chart's ID
const string name="ThumbUp", // object name
const ENUM_ARROW_ANCHOR anchor=ANCHOR_TOP) // anchor type
{
//--- reset the error value
ResetLastError();
//--- change anchor type
if(!ObjectSetInteger(chart_ID,name,OBJPROP_ANCHOR,anchor))
{
Print(__FUNCTION__,
": failed to change anchor type! Error code = ",GetLastError());
return(false);
}
//--- arrays for storing the date and price values to be used
//--- for setting and changing sign anchor point coordinates
datetime date[];
double price[];
//--- memory allocation
ArrayResize(date,bars);
ArrayResize(price,accuracy);
//--- fill the array of dates
ResetLastError();
if(CopyTime(Symbol(),Period(),0,bars,date)==-1)
{
Print("Failed to copy time values! Error code = ",GetLastError());
return;
}
//--- fill the array of prices
//--- find the highest and lowest values of the chart
double max_price=ChartGetDouble(0,CHART_PRICE_MAX);
double min_price=ChartGetDouble(0,CHART_PRICE_MIN);
//--- define a change step of a price and fill the array
double step=(max_price-min_price)/accuracy;
for(int i=0;i<accuracy;i++)
price[i]=min_price+i*step;
//--- define points for drawing the sign
int d=InpDate*(bars-1)/100;
int p=InpPrice*(accuracy-1)/100;
//--- create Thumbs Up sign on the chart
if(!ArrowThumbUpCreate(0,InpName,0,date[d],price[p],InpAnchor,InpColor,
InpStyle,InpWidth,InpBack,InpSelection,InpHidden,InpZOrder))
{
return;
}
//--- redraw the chart and wait for 1 second
ChartRedraw();
Sleep(1000);
//--- now, move the anchor point and change its position relative to the sign
//--- loop counter
int h_steps=bars/4;
//--- move the anchor point
for(int i=0;i<h_steps;i++)
{
//--- use the following value
if(d>1)
d-=1;
//--- move the point
if(!ArrowThumbUpMove(0,InpName,date[d],price[p]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
OBJ_ARROW_THUMB_DOWN
Thumbs Down sign.
Note
Anchor point position relative to the sign can be selected from ENUM _ARR OW_ANCH OR
enumeration.
Large signs (more than 5) can only be created by setting the appropriate OBJPROP_W IDTH property
value when writing a code in MetaEditor.
Example
The following script creates and moves Thumbs Down sign on the chart. S pecial functions have been
developed to create and change graphical object's properties. You can use these functions " as is " in
your own applications.
//--- description
#property description "Script draws \"Thumbs Down\" sign."
#property description "Anchor point coordinate is set in percentage of"
#property description "the chart window size."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="ThumbDown"; // Sign name
input int InpDate=25; // Anchor point date in %
input int InpPrice=75; // Anchor point price in %
input ENUM_ARROW_ANCHOR InpAnchor=ANCHOR_BOTTOM; // Anchor type
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTABLE,selection);
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTED,selection);
//--- hide (true) or display (false) graphical object name in the object list
ObjectSetInteger(chart_ID,name,OBJPROP_HIDDEN,hidden);
//--- set the priority for receiving the event of a mouse click in the chart
ObjectSetInteger(chart_ID,name,OBJPROP_ZORDER,z_order);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Move the anchor point |
//+------------------------------------------------------------------+
bool ArrowThumbDownMove(const long chart_ID=0, // chart's ID
const string name="ThumbDown", // object name
datetime time=0, // anchor point time coordinate
double price=0) // anchor point price coordinate
{
//--- if point position is not set, move it to the current bar having Bid price
if(!time)
time=TimeCurrent();
if(!price)
price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
//--- reset the error value
ResetLastError();
//--- move the anchor point
if(!ObjectMove(chart_ID,name,0,time,price))
{
Print(__FUNCTION__,
": failed to move the anchor point! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Change Thumbs Down sign anchor type |
//+------------------------------------------------------------------+
bool ArrowThumbDownAnchorChange(const long chart_ID=0, // chart's ID
const string name="ThumbDown", // object name
const ENUM_ARROW_ANCHOR anchor=ANCHOR_TOP) // anchor type
{
//--- reset the error value
ResetLastError();
//--- change anchor type
if(!ObjectSetInteger(chart_ID,name,OBJPROP_ANCHOR,anchor))
{
Print(__FUNCTION__,
": failed to change anchor type! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Delete Thumbs Down sign |
//+------------------------------------------------------------------+
bool ArrowThumbDownDelete(const long chart_ID=0, // chart's ID
const string name="ThumbDown") // sign name
{
//--- reset the error value
ResetLastError();
//--- delete the sign
if(!ObjectDelete(chart_ID,name))
{
Print(__FUNCTION__,
": failed to delete \"Thumbs Down\" sign! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Check anchor point values and set default values |
//| for empty ones |
//+------------------------------------------------------------------+
void ChangeArrowEmptyPoint(datetime &time,double &price)
{
//--- if the point's time is not set, it will be on the current bar
if(!time)
time=TimeCurrent();
//--- if the point's price is not set, it will have Bid value
if(!price)
price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- check correctness of the input parameters
if(InpDate<0 || InpDate>100 || InpPrice<0 || InpPrice>100)
{
Print("Error! Incorrect values of input parameters!");
return;
}
//--- number of visible bars in the chart window
int bars=(int)ChartGetInteger(0,CHART_VISIBLE_BARS);
//--- price array size
int accuracy=1000;
//--- arrays for storing the date and price values to be used
//--- for setting and changing sign anchor point coordinates
datetime date[];
double price[];
//--- memory allocation
ArrayResize(date,bars);
ArrayResize(price,accuracy);
//--- fill the array of dates
ResetLastError();
if(CopyTime(Symbol(),Period(),0,bars,date)==-1)
{
Print("Failed to copy time values! Error code = ",GetLastError());
return;
}
//--- fill the array of prices
//--- find the highest and lowest values of the chart
double max_price=ChartGetDouble(0,CHART_PRICE_MAX);
double min_price=ChartGetDouble(0,CHART_PRICE_MIN);
//--- define a change step of a price and fill the array
double step=(max_price-min_price)/accuracy;
for(int i=0;i<accuracy;i++)
price[i]=min_price+i*step;
//--- define points for drawing the sign
int d=InpDate*(bars-1)/100;
int p=InpPrice*(accuracy-1)/100;
//--- create Thumbs Down sign on the chart
if(!ArrowThumbDownCreate(0,InpName,0,date[d],price[p],InpAnchor,InpColor,
InpStyle,InpWidth,InpBack,InpSelection,InpHidden,InpZOrder))
{
return;
}
//--- redraw the chart and wait for 1 second
ChartRedraw();
Sleep(1000);
//--- now, move the anchor point and change its position relative to the sign
//--- loop counter
int h_steps=bars/4;
//--- move the anchor point
for(int i=0;i<h_steps;i++)
{
//--- use the following value
if(d<bars-1)
d+=1;
//--- move the point
if(!ArrowThumbDownMove(0,InpName,date[d],price[p]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
// 0.05 seconds of delay
Sleep(50);
}
//--- 1 second of delay
Sleep(1000);
//--- loop counter
int v_steps=accuracy/4;
//--- move the anchor point
for(int i=0;i<v_steps;i++)
{
//--- use the following value
if(p>1)
p-=1;
//--- move the point
if(!ArrowThumbDownMove(0,InpName,date[d],price[p]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
}
//--- change anchor point location relative to the sign
ArrowThumbDownAnchorChange(0,InpName,ANCHOR_TOP);
//--- redraw the chart
ChartRedraw();
//--- 1 second of delay
Sleep(1000);
//--- delete the sign from the chart
ArrowThumbDownDelete(0,InpName);
ChartRedraw();
//--- 1 second of delay
Sleep(1000);
//---
}
OBJ_ARROW_UP
Arrow Up sign.
Note
Anchor point position relative to the sign can be selected from ENUM _ARR OW_ANCH OR
enumeration.
Large signs (more than 5) can only be created by setting the appropriate OBJPROP_W IDTH property
value when writing a code in MetaEditor.
Example
The following script creates and moves Arrow Up sign on the chart. S pecial functions have been
developed to create and change graphical object's properties. You can use these functions " as is " in
your own applications.
//--- description
#property description "Script draws \"Arrow Up\" sign."
#property description "Anchor point coordinate is set in"
#property description "percentage of the chart window size."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="ArrowUp"; // Sign name
input int InpDate=25; // Anchor point date in %
input int InpPrice=25; // Anchor point price in %
input ENUM_ARROW_ANCHOR InpAnchor=ANCHOR_TOP; // Anchor type
input color InpColor=clrRed; // Sign color
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTED,selection);
//--- hide (true) or display (false) graphical object name in the object list
ObjectSetInteger(chart_ID,name,OBJPROP_HIDDEN,hidden);
//--- set the priority for receiving the event of a mouse click in the chart
ObjectSetInteger(chart_ID,name,OBJPROP_ZORDER,z_order);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Move the anchor point |
//+------------------------------------------------------------------+
bool ArrowUpMove(const long chart_ID=0, // chart's ID
const string name="ArrowUp", // object name
datetime time=0, // anchor point time coordinate
double price=0) // anchor point price coordinate
{
//--- if point position is not set, move it to the current bar having Bid price
if(!time)
time=TimeCurrent();
if(!price)
price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
//--- reset the error value
ResetLastError();
//--- move the anchor point
if(!ObjectMove(chart_ID,name,0,time,price))
{
Print(__FUNCTION__,
": failed to move the anchor point! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Change Arrow Down sign anchor type |
//+------------------------------------------------------------------+
bool ArrowUpAnchorChange(const long chart_ID=0, // chart's ID
const string name="ArrowUp", // object name
const ENUM_ARROW_ANCHOR anchor=ANCHOR_TOP) // anchor type
{
//--- reset the error value
ResetLastError();
//--- change anchor point location
if(!ObjectSetInteger(chart_ID,name,OBJPROP_ANCHOR,anchor))
{
Print(__FUNCTION__,
": failed to change anchor type! Error code = ",GetLastError());
return(false);
}
//--- arrays for storing the date and price values to be used
//--- for setting and changing sign anchor point coordinates
datetime date[];
double price[];
//--- memory allocation
ArrayResize(date,bars);
ArrayResize(price,accuracy);
//--- fill the array of dates
ResetLastError();
if(CopyTime(Symbol(),Period(),0,bars,date)==-1)
{
Print("Failed to copy time values! Error code = ",GetLastError());
return;
}
//--- fill the array of prices
//--- find the highest and lowest values of the chart
double max_price=ChartGetDouble(0,CHART_PRICE_MAX);
double min_price=ChartGetDouble(0,CHART_PRICE_MIN);
//--- define a change step of a price and fill the array
double step=(max_price-min_price)/accuracy;
for(int i=0;i<accuracy;i++)
price[i]=min_price+i*step;
//--- define points for drawing the sign
int d=InpDate*(bars-1)/100;
int p=InpPrice*(accuracy-1)/100;
//--- create Arrow Up sign on the chart
if(!ArrowUpCreate(0,InpName,0,date[d],price[p],InpAnchor,InpColor,
InpStyle,InpWidth,InpBack,InpSelection,InpHidden,InpZOrder))
{
return;
}
//--- redraw the chart and wait for 1 second
ChartRedraw();
Sleep(1000);
//--- now, move the anchor point and change its position relative to the sign
//--- loop counter
int v_steps=accuracy/2;
//--- move the anchor point
for(int i=0;i<v_steps;i++)
{
//--- use the following value
if(p<accuracy-1)
p+=1;
//--- move the point
if(!ArrowUpMove(0,InpName,date[d],price[p]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
OBJ_ARROW_DOWN
Arrow Down sign.
Note
Anchor point position relative to the sign can be selected from ENUM _ARR OW_ANCH OR
enumeration.
Large signs (more than 5) can only be created by setting the appropriate OBJPROP_W IDTH property
value when writing a code in MetaEditor.
Example
The following script creates and moves Arrow Down sign on the chart. S pecial functions have been
developed to create and change graphical object's properties. You can use these functions " as is " in
your own applications.
//--- description
#property description "Script draws \"Arrow Down\" sign."
#property description "Anchor point coordinate is set in"
#property description "percentage of the chart window size."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="ArrowDown"; // Sign name
input int InpDate=75; // Anchor point date in %
input int InpPrice=75; // Anchor point price in %
input ENUM_ARROW_ANCHOR InpAnchor=ANCHOR_BOTTOM; // Anchor type
input color InpColor=clrRed; // Sign color
input ENUM_LINE_STYLE InpStyle=STYLE_DOT; // Border line style
//--- hide (true) or display (false) graphical object name in the object list
ObjectSetInteger(chart_ID,name,OBJPROP_HIDDEN,hidden);
//--- set the priority for receiving the event of a mouse click in the chart
ObjectSetInteger(chart_ID,name,OBJPROP_ZORDER,z_order);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Move the anchor point |
//+------------------------------------------------------------------+
bool ArrowDownMove(const long chart_ID=0, // chart's ID
const string name="ArrowDown", // object name
datetime time=0, // anchor point time coordinate
double price=0) // anchor point price coordinate
{
//--- if point position is not set, move it to the current bar having Bid price
if(!time)
time=TimeCurrent();
if(!price)
price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
//--- reset the error value
ResetLastError();
//--- move the anchor point
if(!ObjectMove(chart_ID,name,0,time,price))
{
Print(__FUNCTION__,
": failed to move the anchor point! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Change Arrow Down sign anchor type |
//+------------------------------------------------------------------+
bool ArrowDownAnchorChange(const long chart_ID=0, // chart's ID
const string name="ArrowDown", // object name
const ENUM_ARROW_ANCHOR anchor=ANCHOR_TOP) // anchor type
{
//--- reset the error value
ResetLastError();
//--- change anchor point location
if(!ObjectSetInteger(chart_ID,name,OBJPROP_ANCHOR,anchor))
{
Print(__FUNCTION__,
": failed to change anchor type! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Delete Arrow Down sign |
//+------------------------------------------------------------------+
bool ArrowDownDelete(const long chart_ID=0, // chart's ID
const string name="ArrowDown") // sign name
{
//--- reset the error value
ResetLastError();
//--- delete the sign
if(!ObjectDelete(chart_ID,name))
{
Print(__FUNCTION__,
": failed to delete \"Arrow Down\" sign! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Check anchor point values and set default values |
//| for empty ones |
//+------------------------------------------------------------------+
void ChangeArrowEmptyPoint(datetime &time,double &price)
{
//--- if the point's time is not set, it will be on the current bar
if(!time)
time=TimeCurrent();
//--- if the point's price is not set, it will have Bid value
if(!price)
price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- check correctness of the input parameters
if(InpDate<0 || InpDate>100 || InpPrice<0 || InpPrice>100)
{
Print("Error! Incorrect values of input parameters!");
return;
}
//--- number of visible bars in the chart window
int bars=(int)ChartGetInteger(0,CHART_VISIBLE_BARS);
//--- price array size
int accuracy=1000;
//--- arrays for storing the date and price values to be used
ChartRedraw();
}
//--- 1 second of delay
Sleep(1000);
//--- change anchor point location relative to the sign
ArrowDownAnchorChange(0,InpName,ANCHOR_TOP);
//--- redraw the chart
ChartRedraw();
//--- 1 second of delay
Sleep(1000);
//--- delete the sign from the chart
ArrowDownDelete(0,InpName);
ChartRedraw();
//--- 1 second of delay
Sleep(1000);
//---
}
OBJ_ARROW_STOP
S top sign.
Note
Anchor point position relative to the sign can be selected from ENUM _ARR OW_ANCH OR
enumeration.
Large signs (more than 5) can only be created by setting the appropriate OBJPROP_W IDTH property
value when writing a code in MetaEditor.
Example
The following script creates and moves S top sign on the chart. S pecial functions have been
developed to create and change graphical object's properties. You can use these functions " as is " in
your own applications.
//--- description
#property description "Script draws \"Stop\" sign."
#property description "Anchor point coordinate is set in"
#property description "percentage of the chart window size."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="ArrowStop"; // Sign name
input int InpDate=10; // Anchor point date in %
input int InpPrice=50; // Anchor point price in %
input ENUM_ARROW_ANCHOR InpAnchor=ANCHOR_BOTTOM; // Anchor type
input color InpColor=clrRed; // Sign color
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTED,selection);
//--- hide (true) or display (false) graphical object name in the object list
ObjectSetInteger(chart_ID,name,OBJPROP_HIDDEN,hidden);
//--- set the priority for receiving the event of a mouse click in the chart
ObjectSetInteger(chart_ID,name,OBJPROP_ZORDER,z_order);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Move the anchor point |
//+------------------------------------------------------------------+
bool ArrowStopMove(const long chart_ID=0, // chart's ID
const string name="ArrowStop", // object name
datetime time=0, // anchor point time coordinate
double price=0) // anchor point price coordinate
{
//--- if point position is not set, move it to the current bar having Bid price
if(!time)
time=TimeCurrent();
if(!price)
price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
//--- reset the error value
ResetLastError();
//--- move the anchor point
if(!ObjectMove(chart_ID,name,0,time,price))
{
Print(__FUNCTION__,
": failed to move the anchor point! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Change Stop sign anchor type |
//+------------------------------------------------------------------+
bool ArrowStopAnchorChange(const long chart_ID=0, // chart's ID
const string name="ArrowStop", // object name
const ENUM_ARROW_ANCHOR anchor=ANCHOR_TOP) // anchor point position
{
//--- reset the error value
ResetLastError();
//--- change anchor type
if(!ObjectSetInteger(chart_ID,name,OBJPROP_ANCHOR,anchor))
{
Print(__FUNCTION__,
": failed to change anchor type! Error code = ",GetLastError());
return(false);
}
//--- arrays for storing the date and price values to be used
//--- for setting and changing sign anchor point coordinates
datetime date[];
double price[];
//--- memory allocation
ArrayResize(date,bars);
ArrayResize(price,accuracy);
//--- fill the array of dates
ResetLastError();
if(CopyTime(Symbol(),Period(),0,bars,date)==-1)
{
Print("Failed to copy time values! Error code = ",GetLastError());
return;
}
//--- fill the array of prices
//--- find the highest and lowest values of the chart
double max_price=ChartGetDouble(0,CHART_PRICE_MAX);
double min_price=ChartGetDouble(0,CHART_PRICE_MIN);
//--- define a change step of a price and fill the array
double step=(max_price-min_price)/accuracy;
for(int i=0;i<accuracy;i++)
price[i]=min_price+i*step;
//--- define points for drawing the sign
int d=InpDate*(bars-1)/100;
int p=InpPrice*(accuracy-1)/100;
//--- create Stop sign on the chart
if(!ArrowStopCreate(0,InpName,0,date[d],price[p],InpAnchor,InpColor,
InpStyle,InpWidth,InpBack,InpSelection,InpHidden,InpZOrder))
{
return;
}
//--- redraw the chart and wait for 1 second
ChartRedraw();
Sleep(1000);
//--- now, move the anchor point and change its position relative to the sign
//--- loop counter
int h_steps=bars*2/5;
//--- move the anchor point
for(int i=0;i<h_steps;i++)
{
//--- use the following value
if(d<bars-1)
d+=1;
//--- move the point
if(!ArrowStopMove(0,InpName,date[d],price[p]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
OBJ_ARROW_CHECK
Check sign.
Note
Anchor point position relative to the sign can be selected from ENUM _ARR OW_ANCH OR
enumeration.
Large signs (more than 5) can only be created by setting the appropriate OBJPROP_W IDTH property
value when writing a code in MetaEditor.
Example
The following script creates and moves Check sign on the chart. S pecial functions have been
developed to create and change graphical object's properties. You can use these functions " as is " in
your own applications.
//--- description
#property description "Script draws \"Check\" sign."
#property description "Anchor point coordinate is set in"
#property description "percentage of the chart window size."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="ArrowCheck"; // Sign name
input int InpDate=10; // Anchor point date in %
input int InpPrice=50; // Anchor point price in %
input ENUM_ARROW_ANCHOR InpAnchor=ANCHOR_TOP; // Anchor type
input color InpColor=clrRed; // Sign color
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTED,selection);
//--- hide (true) or display (false) graphical object name in the object list
ObjectSetInteger(chart_ID,name,OBJPROP_HIDDEN,hidden);
//--- set the priority for receiving the event of a mouse click in the chart
ObjectSetInteger(chart_ID,name,OBJPROP_ZORDER,z_order);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Move the anchor point |
//+------------------------------------------------------------------+
bool ArrowCheckMove(const long chart_ID=0, // chart's ID
const string name="ArrowCheck", // object name
datetime time=0, // anchor point time coordinate
double price=0) // anchor point price coordinate
{
//--- if point position is not set, move it to the current bar having Bid price
if(!time)
time=TimeCurrent();
if(!price)
price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
//--- reset the error value
ResetLastError();
//--- move the anchor point
if(!ObjectMove(chart_ID,name,0,time,price))
{
Print(__FUNCTION__,
": failed to move the anchor point! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Change Check anchor type |
//+------------------------------------------------------------------+
bool ArrowCheckAnchorChange(const long chart_ID=0, // chart's ID
const string name="ArrowCheck", // object name
const ENUM_ARROW_ANCHOR anchor=ANCHOR_TOP) // anchor type
{
//--- reset the error value
ResetLastError();
//--- change anchor type
if(!ObjectSetInteger(chart_ID,name,OBJPROP_ANCHOR,anchor))
{
Print(__FUNCTION__,
": failed to change anchor type! Error code = ",GetLastError());
return(false);
}
//--- arrays for storing the date and price values to be used
//--- for setting and changing sign anchor point coordinates
datetime date[];
double price[];
//--- memory allocation
ArrayResize(date,bars);
ArrayResize(price,accuracy);
//--- fill the array of dates
ResetLastError();
if(CopyTime(Symbol(),Period(),0,bars,date)==-1)
{
Print("Failed to copy time values! Error code = ",GetLastError());
return;
}
//--- fill the array of prices
//--- find the highest and lowest values of the chart
double max_price=ChartGetDouble(0,CHART_PRICE_MAX);
double min_price=ChartGetDouble(0,CHART_PRICE_MIN);
//--- define a change step of a price and fill the array
double step=(max_price-min_price)/accuracy;
for(int i=0;i<accuracy;i++)
price[i]=min_price+i*step;
//--- define points for drawing the sign
int d=InpDate*(bars-1)/100;
int p=InpPrice*(accuracy-1)/100;
//--- create Check sign on the chart
if(!ArrowCheckCreate(0,InpName,0,date[d],price[p],InpAnchor,InpColor,
InpStyle,InpWidth,InpBack,InpSelection,InpHidden,InpZOrder))
{
return;
}
//--- redraw the chart and wait for 1 second
ChartRedraw();
Sleep(1000);
//--- now, move the anchor point and change its position relative to the sign
//--- loop counter
int h_steps=bars*2/5;
//--- move the anchor point
for(int i=0;i<h_steps;i++)
{
//--- use the following value
if(d<bars-1)
d+=1;
//--- move the point
if(!ArrowCheckMove(0,InpName,date[d],price[p]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
OBJ_ARROW_LEFT_PRICE
Left Price Label
Example
The following script creates and moves left price label on the chart. S pecial functions have been
developed to create and change graphical object's properties. You can use these functions " as is " in
your own applications.
//--- description
#property description "Script creates the left price label on the chart."
#property description "Anchor point coordinate is set in"
#property description "percentage of the chart window size."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="LeftPrice"; // Price label name
input int InpDate=100; // Anchor point date in %
input int InpPrice=10; // Anchor point price in %
input color InpColor=clrRed; // Price label color
input ENUM_LINE_STYLE InpStyle=STYLE_SOLID; // Border line style
input int InpWidth=2; // Price label size
input bool InpBack=false; // Background label
input bool InpSelection=true; // Highlight to move
input bool InpHidden=true; // Hidden in the object list
input long InpZOrder=0; // Priority for mouse click
//+------------------------------------------------------------------+
//| Create the left price label |
//+------------------------------------------------------------------+
bool ArrowLeftPriceCreate(const long chart_ID=0, // chart's ID
const string name="LeftPrice", // price label name
const int sub_window=0, // subwindow index
datetime time=0, // anchor point time
double price=0, // anchor point price
const color clr=clrRed, // price label color
const ENUM_LINE_STYLE style=STYLE_SOLID, // border line style
const int width=1, // price label size
const bool back=false, // in the background
const bool selection=true, // highlight to move
const bool hidden=true, // hidden in the object list
const long z_order=0) // priority for mouse click
{
//--- set anchor point coordinates if they are not set
ChangeArrowEmptyPoint(time,price);
//--- reset the error value
ResetLastError();
//--- create a price label
if(!ObjectCreate(chart_ID,name,OBJ_ARROW_LEFT_PRICE,sub_window,time,price))
{
Print(__FUNCTION__,
": failed to create the left price label! Error code = ",GetLastError());
return(false);
}
//--- set the label color
ObjectSetInteger(chart_ID,name,OBJPROP_COLOR,clr);
//--- set the border line style
ObjectSetInteger(chart_ID,name,OBJPROP_STYLE,style);
//--- set the label size
ObjectSetInteger(chart_ID,name,OBJPROP_WIDTH,width);
//--- display in the foreground (false) or background (true)
ObjectSetInteger(chart_ID,name,OBJPROP_BACK,back);
//--- enable (true) or disable (false) the mode of moving the label by mouse
//--- when creating a graphical object using ObjectCreate function, the object cannot be
//--- highlighted and moved by default. Inside this method, selection parameter
//--- is true by default making it possible to highlight and move the object
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTABLE,selection);
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTED,selection);
//--- hide (true) or display (false) graphical object name in the object list
ObjectSetInteger(chart_ID,name,OBJPROP_HIDDEN,hidden);
//--- set the priority for receiving the event of a mouse click in the chart
ObjectSetInteger(chart_ID,name,OBJPROP_ZORDER,z_order);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Move the anchor point |
//+------------------------------------------------------------------+
//--- if the point's price is not set, it will have Bid value
if(!price)
price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- check correctness of the input parameters
if(InpDate<0 || InpDate>100 || InpPrice<0 || InpPrice>100)
{
Print("Error! Incorrect values of input parameters!");
return;
}
//--- number of visible bars in the chart window
int bars=(int)ChartGetInteger(0,CHART_VISIBLE_BARS);
//--- price array size
int accuracy=1000;
//--- arrays for storing the date and price values to be used
//--- for setting and changing label anchor point coordinates
datetime date[];
double price[];
//--- memory allocation
ArrayResize(date,bars);
ArrayResize(price,accuracy);
//--- fill the array of dates
ResetLastError();
if(CopyTime(Symbol(),Period(),0,bars,date)==-1)
{
Print("Failed to copy time values! Error code = ",GetLastError());
return;
}
//--- fill the array of prices
//--- find the highest and lowest values of the chart
double max_price=ChartGetDouble(0,CHART_PRICE_MAX);
double min_price=ChartGetDouble(0,CHART_PRICE_MIN);
//--- define a change step of a price and fill the array
double step=(max_price-min_price)/accuracy;
for(int i=0;i<accuracy;i++)
price[i]=min_price+i*step;
//--- define points for drawing the label
int d=InpDate*(bars-1)/100;
int p=InpPrice*(accuracy-1)/100;
//--- create the left price label on the chart
if(!ArrowLeftPriceCreate(0,InpName,0,date[d],price[p],InpColor,
InpStyle,InpWidth,InpBack,InpSelection,InpHidden,InpZOrder))
{
return;
}
//--- redraw the chart and wait for 1 second
ChartRedraw();
Sleep(1000);
//--- now, move the anchor point
//--- loop counter
int v_steps=accuracy*4/5;
//--- move the anchor point
for(int i=0;i<v_steps;i++)
{
//--- use the following value
if(p<accuracy-1)
p+=1;
//--- move the point
if(!ArrowLeftPriceMove(0,InpName,date[d],price[p]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
}
//--- 1 second of delay
Sleep(1000);
//--- delete the label from the chart
ArrowLeftPriceDelete(0,InpName);
ChartRedraw();
//--- 1 second of delay
Sleep(1000);
//---
}
OBJ_ARROW_RIGHT_PRICE
R ight Price Label.
Example
The following script creates and moves right price label on the chart. S pecial functions have been
developed to create and change graphical object's properties. You can use these functions " as is " in
your own applications.
//--- description
#property description "Script creates the right price label on the chart."
#property description "Anchor point coordinate is set in"
#property description "percentage of the chart window size."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="RightPrice"; // Price label name
input int InpDate=0; // Anchor point date in %
input int InpPrice=90; // Anchor point price in %
input color InpColor=clrRed; // Price label color
input ENUM_LINE_STYLE InpStyle=STYLE_SOLID; // Border line style
input int InpWidth=2; // Price label size
input bool InpBack=false; // Background label
input bool InpSelection=true; // Highlight to move
input bool InpHidden=true; // Hidden in the object list
input long InpZOrder=0; // Priority for mouse click
//+------------------------------------------------------------------+
//| Create the right price label |
//+------------------------------------------------------------------+
bool ArrowRightPriceCreate(const long chart_ID=0, // chart's ID
const string name="RightPrice", // price label name
const int sub_window=0, // subwindow index
datetime time=0, // anchor point time
double price=0, // anchor point price
const color clr=clrRed, // price label color
const ENUM_LINE_STYLE style=STYLE_SOLID, // border line style
const int width=1, // price label size
const bool back=false, // in the background
const bool selection=true, // highlight to move
const bool hidden=true, // hidden in the object list
const long z_order=0) // priority for mouse click
{
//--- set anchor point coordinates if they are not set
ChangeArrowEmptyPoint(time,price);
//--- reset the error value
ResetLastError();
//--- create a price label
if(!ObjectCreate(chart_ID,name,OBJ_ARROW_RIGHT_PRICE,sub_window,time,price))
{
Print(__FUNCTION__,
": failed to create the right price label! Error code = ",GetLastError());
return(false);
}
//--- set the label color
ObjectSetInteger(chart_ID,name,OBJPROP_COLOR,clr);
//--- set the border line style
ObjectSetInteger(chart_ID,name,OBJPROP_STYLE,style);
//--- set the label size
ObjectSetInteger(chart_ID,name,OBJPROP_WIDTH,width);
//--- display in the foreground (false) or background (true)
ObjectSetInteger(chart_ID,name,OBJPROP_BACK,back);
//--- enable (true) or disable (false) the mode of moving the label by mouse
//--- when creating a graphical object using ObjectCreate function, the object cannot be
//--- highlighted and moved by default. Inside this method, selection parameter
//--- is true by default making it possible to highlight and move the object
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTABLE,selection);
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTED,selection);
//--- hide (true) or display (false) graphical object name in the object list
ObjectSetInteger(chart_ID,name,OBJPROP_HIDDEN,hidden);
//--- set the priority for receiving the event of a mouse click in the chart
ObjectSetInteger(chart_ID,name,OBJPROP_ZORDER,z_order);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Move the anchor point |
//+------------------------------------------------------------------+
//--- if the point's price is not set, it will have Bid value
if(!price)
price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- check correctness of the input parameters
if(InpDate<0 || InpDate>100 || InpPrice<0 || InpPrice>100)
{
Print("Error! Incorrect values of input parameters!");
return;
}
//--- number of visible bars in the chart window
int bars=(int)ChartGetInteger(0,CHART_VISIBLE_BARS);
//--- price array size
int accuracy=1000;
//--- arrays for storing the date and price values to be used
//--- for setting and changing label anchor point coordinates
datetime date[];
double price[];
//--- memory allocation
ArrayResize(date,bars);
ArrayResize(price,accuracy);
//--- fill the array of dates
ResetLastError();
if(CopyTime(Symbol(),Period(),0,bars,date)==-1)
{
Print("Failed to copy time values! Error code = ",GetLastError());
return;
}
//--- fill the array of prices
//--- find the highest and lowest values of the chart
double max_price=ChartGetDouble(0,CHART_PRICE_MAX);
double min_price=ChartGetDouble(0,CHART_PRICE_MIN);
//--- define a change step of a price and fill the array
double step=(max_price-min_price)/accuracy;
for(int i=0;i<accuracy;i++)
price[i]=min_price+i*step;
//--- define points for drawing the label
int d=InpDate*(bars-1)/100;
int p=InpPrice*(accuracy-1)/100;
//--- create the right price label on the chart
if(!ArrowRightPriceCreate(0,InpName,0,date[d],price[p],InpColor,
InpStyle,InpWidth,InpBack,InpSelection,InpHidden,InpZOrder))
{
return;
}
//--- redraw the chart and wait for 1 second
ChartRedraw();
Sleep(1000);
//--- now, move the anchor point
//--- loop counter
int v_steps=accuracy*4/5;
//--- move the anchor point
for(int i=0;i<v_steps;i++)
{
//--- use the following value
if(p>1)
p-=1;
//--- move the point
if(!ArrowRightPriceMove(0,InpName,date[d],price[p]))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
}
//--- 1 second of delay
Sleep(1000);
//--- delete the label from the chart
ArrowRightPriceDelete(0,InpName);
ChartRedraw();
//--- 1 second of delay
Sleep(1000);
//---
}
OBJ_ARROW_BUY
Buy sign.
Example
The following script creates and moves Buy sign on the chart. S pecial functions have been developed
to create and change graphical object's properties. You can use these functions " as is " in your own
applications.
//--- description
#property description "Script draws \"Buy\" signs in the chart window."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input color InpColor=C'3,95,172'; // Color of signs
//+------------------------------------------------------------------+
//| Create Buy sign |
//+------------------------------------------------------------------+
bool ArrowBuyCreate(const long chart_ID=0, // chart's ID
const string name="ArrowBuy", // sign name
const int sub_window=0, // subwindow index
datetime time=0, // anchor point time
double price=0, // anchor point price
const color clr=C'3,95,172', // sign color
const ENUM_LINE_STYLE style=STYLE_SOLID, // line style (when highlighted)
const int width=1, // line size (when highlighted)
const bool back=false, // in the background
const bool selection=false, // highlight to move
{
Print(__FUNCTION__,
": failed to move the anchor point! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Delete Buy sign |
//+------------------------------------------------------------------+
bool ArrowBuyDelete(const long chart_ID=0, // chart's ID
const string name="ArrowBuy") // sign name
{
//--- reset the error value
ResetLastError();
//--- delete the sign
if(!ObjectDelete(chart_ID,name))
{
Print(__FUNCTION__,
": failed to delete \"Buy\" sign! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Check anchor point values and set default values |
//| for empty ones |
//+------------------------------------------------------------------+
void ChangeArrowEmptyPoint(datetime &time,double &price)
{
//--- if the point's time is not set, it will be on the current bar
if(!time)
time=TimeCurrent();
//--- if the point's price is not set, it will have Bid value
if(!price)
price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
datetime date[]; // array for storing dates of visible bars
double low[]; // array for storing Low prices of visible bars
double high[]; // array for storing High prices of visible bars
//--- number of visible bars in the chart window
int bars=(int)ChartGetInteger(0,CHART_VISIBLE_BARS);
OBJ_ARROW_SELL
S ell sign.
Example
The following script creates and moves S ell sign on the chart. S pecial functions have been developed
to create and change graphical object's properties. You can use these functions " as is " in your own
applications.
//--- description
#property description "Script draws \"Sell\" signs in the chart window."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input color InpColor=C'225,68,29'; // Color of signs
//+------------------------------------------------------------------+
//| Create Sell sign |
//+------------------------------------------------------------------+
bool ArrowSellCreate(const long chart_ID=0, // chart's ID
const string name="ArrowSell", // sign name
const int sub_window=0, // subwindow index
datetime time=0, // anchor point time
double price=0, // anchor point price
const color clr=C'225,68,29', // sign color
const ENUM_LINE_STYLE style=STYLE_SOLID, // line style (when highlighted)
const int width=1, // line size (when highlighted)
const bool back=false, // in the background
const bool selection=false, // highlight to move
{
Print(__FUNCTION__,
": failed to move the anchor point! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Delete Sell sign |
//+------------------------------------------------------------------+
bool ArrowSellDelete(const long chart_ID=0, // chart's ID
const string name="ArrowSell") // sign name
{
//--- reset the error value
ResetLastError();
//--- delete the sign
if(!ObjectDelete(chart_ID,name))
{
Print(__FUNCTION__,
": failed to delete \"Sell\" sign! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Check anchor point values and set default values |
//| for empty ones |
//+------------------------------------------------------------------+
void ChangeArrowEmptyPoint(datetime &time,double &price)
{
//--- if the point's time is not set, it will be on the current bar
if(!time)
time=TimeCurrent();
//--- if the point's price is not set, it will have Bid value
if(!price)
price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
datetime date[]; // array for storing dates of visible bars
double low[]; // array for storing Low prices of visible bars
double high[]; // array for storing High prices of visible bars
//--- number of visible bars in the chart window
int bars=(int)ChartGetInteger(0,CHART_VISIBLE_BARS);
OBJ_ARROW
Arrow object.
Note
Anchor point position relative to the object can be selected from ENUM _ARROW_ANCHOR.
Large arrows (more than 5) can only be created by setting the appropriate OBJPROP_W IDTH property
value when writing a code in MetaEditor.
The necessary arrow type can be selected by setting one of the W ingdings font's symbol codes.
Example
The following script creates Arrow object on the chart and changes its type. S pecial functions have
been developed to create and change graphical object's properties. You can use these functions " as
is " in your own applications.
//--- description
#property description "Script creates a random arrow in the chart window."
#property description "Anchor point coordinate is set in"
#property description "percentage of the chart window size."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="Arrow"; // Arrow name
input int InpDate=50; // Anchor point date in %
input int InpPrice=50; // Anchor point price in %
input ENUM_ARROW_ANCHOR InpAnchor=ANCHOR_TOP; // Anchor type
//--- when creating a graphical object using ObjectCreate function, the object cannot be
//--- highlighted and moved by default. Inside this method, selection parameter
//--- is true by default making it possible to highlight and move the object
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTABLE,selection);
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTED,selection);
//--- hide (true) or display (false) graphical object name in the object list
ObjectSetInteger(chart_ID,name,OBJPROP_HIDDEN,hidden);
//--- set the priority for receiving the event of a mouse click in the chart
ObjectSetInteger(chart_ID,name,OBJPROP_ZORDER,z_order);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Move the anchor point |
//+------------------------------------------------------------------+
bool ArrowMove(const long chart_ID=0, // chart's ID
const string name="Arrow", // object name
datetime time=0, // anchor point time coordinate
double price=0) // anchor point price coordinate
{
//--- if point position is not set, move it to the current bar having Bid price
if(!time)
time=TimeCurrent();
if(!price)
price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
//--- reset the error value
ResetLastError();
//--- move the anchor point
if(!ObjectMove(chart_ID,name,0,time,price))
{
Print(__FUNCTION__,
": failed to move the anchor point! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Change the arrow code |
//+------------------------------------------------------------------+
bool ArrowCodeChange(const long chart_ID=0, // chart's ID
const string name="Arrow", // object name
const uchar code=252) // arrow code
{
//--- reset the error value
ResetLastError();
//--- change the arrow code
if(!ObjectSetInteger(chart_ID,name,OBJPROP_ARROWCODE,code))
{
Print(__FUNCTION__,
": failed to change the arrow code! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Change anchor type |
//+------------------------------------------------------------------+
bool ArrowAnchorChange(const long chart_ID=0, // chart's ID
const string name="Arrow", // object name
const ENUM_ARROW_ANCHOR anchor=ANCHOR_TOP) // anchor type
{
//--- reset the error value
ResetLastError();
//--- change anchor type
if(!ObjectSetInteger(chart_ID,name,OBJPROP_ANCHOR,anchor))
{
Print(__FUNCTION__,
": failed to change anchor type! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Delete an arrow |
//+------------------------------------------------------------------+
bool ArrowDelete(const long chart_ID=0, // chart's ID
const string name="Arrow") // arrow name
{
//--- reset the error value
ResetLastError();
//--- delete an arrow
if(!ObjectDelete(chart_ID,name))
{
Print(__FUNCTION__,
": failed to delete an arrow! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Check anchor point values and set default values |
//| for empty ones |
//+------------------------------------------------------------------+
void ChangeArrowEmptyPoint(datetime &time,double &price)
{
//--- if the point's time is not set, it will be on the current bar
if(!time)
time=TimeCurrent();
//--- if the point's price is not set, it will have Bid value
if(!price)
price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- check correctness of the input parameters
if(InpDate<0 || InpDate>100 || InpPrice<0 || InpPrice>100)
{
Print("Error! Incorrect values of input parameters!");
return;
}
//--- number of visible bars in the chart window
int bars=(int)ChartGetInteger(0,CHART_VISIBLE_BARS);
//--- price array size
int accuracy=1000;
//--- arrays for storing the date and price values to be used
//--- for setting and changing sign anchor point coordinates
datetime date[];
double price[];
//--- memory allocation
ArrayResize(date,bars);
ArrayResize(price,accuracy);
//--- fill the array of dates
ResetLastError();
if(CopyTime(Symbol(),Period(),0,bars,date)==-1)
{
Print("Failed to copy time values! Error code = ",GetLastError());
return;
}
//--- fill the array of prices
//--- find the highest and lowest values of the chart
double max_price=ChartGetDouble(0,CHART_PRICE_MAX);
double min_price=ChartGetDouble(0,CHART_PRICE_MIN);
//--- define a change step of a price and fill the array
double step=(max_price-min_price)/accuracy;
for(int i=0;i<accuracy;i++)
price[i]=min_price+i*step;
//--- define points for drawing the arrow
int d=InpDate*(bars-1)/100;
int p=InpPrice*(accuracy-1)/100;
//--- create an arrow on the chart
if(!ArrowCreate(0,InpName,0,date[d],price[p],32,InpAnchor,InpColor,
InpStyle,InpWidth,InpBack,InpSelection,InpHidden,InpZOrder))
{
return;
}
//--- redraw the chart
ChartRedraw();
//--- consider all cases of creating arrows in the loop
for(int i=33;i<256;i++)
{
if(!ArrowCodeChange(0,InpName,(uchar)i))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
// half a second of delay
Sleep(500);
}
//--- 1 second of delay
Sleep(1000);
//--- delete the arrow from the chart
ArrowDelete(0,InpName);
ChartRedraw();
//--- 1 second of delay
Sleep(1000);
//---
}
OBJ_TEXT
Text object.
Note
Anchor point position relative to the text can be selected from ENUM _ANCH OR_POINT enumeration.
You can also change text slope angle using OBJPR OP_ANGL E property.
Example
The following script creates several Text objects on the chart. S pecial functions have been
developed to create and change graphical object's properties. You can use these functions " as is " in
your own applications.
//--- description
#property description "Script creates \"Text\" graphical object."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpFont="Arial"; // Font
input int InpFontSize=10; // Font size
input color InpColor=clrRed; // Color
input double InpAngle=90.0; // Slope angle in degrees
input ENUM_ANCHOR_POINT InpAnchor=ANCHOR_LEFT; // Anchor type
input bool InpBack=false; // Background object
input bool InpSelection=false; // Highlight to move
input bool InpHidden=true; // Hidden in the object list
input long InpZOrder=0; // Priority for mouse click
//+------------------------------------------------------------------+
//| Creating Text object |
//+------------------------------------------------------------------+
bool TextCreate(const long chart_ID=0, // chart's ID
const string name="Text", // object name
const int sub_window=0, // subwindow index
datetime time=0, // anchor point time
double price=0, // anchor point price
const string text="Text", // the text itself
const string font="Arial", // font
const int font_size=10, // font size
const color clr=clrRed, // color
const double angle=0.0, // text slope
const ENUM_ANCHOR_POINT anchor=ANCHOR_LEFT_UPPER, // anchor type
const bool back=false, // in the background
const bool selection=false, // highlight to move
const bool hidden=true, // hidden in the object list
const long z_order=0) // priority for mouse click
{
//--- set anchor point coordinates if they are not set
ChangeTextEmptyPoint(time,price);
//--- reset the error value
ResetLastError();
//--- create Text object
if(!ObjectCreate(chart_ID,name,OBJ_TEXT,sub_window,time,price))
{
Print(__FUNCTION__,
": failed to create \"Text\" object! Error code = ",GetLastError());
return(false);
}
//--- set the text
ObjectSetString(chart_ID,name,OBJPROP_TEXT,text);
//--- set text font
ObjectSetString(chart_ID,name,OBJPROP_FONT,font);
//--- set font size
ObjectSetInteger(chart_ID,name,OBJPROP_FONTSIZE,font_size);
//--- set the slope angle of the text
ObjectSetDouble(chart_ID,name,OBJPROP_ANGLE,angle);
//--- set anchor type
ObjectSetInteger(chart_ID,name,OBJPROP_ANCHOR,anchor);
//--- set color
ObjectSetInteger(chart_ID,name,OBJPROP_COLOR,clr);
//--- display in the foreground (false) or background (true)
ObjectSetInteger(chart_ID,name,OBJPROP_BACK,back);
//--- enable (true) or disable (false) the mode of moving the object by mouse
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTABLE,selection);
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTED,selection);
//--- hide (true) or display (false) graphical object name in the object list
ObjectSetInteger(chart_ID,name,OBJPROP_HIDDEN,hidden);
//--- set the priority for receiving the event of a mouse click in the chart
ObjectSetInteger(chart_ID,name,OBJPROP_ZORDER,z_order);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Move the anchor point |
//+------------------------------------------------------------------+
bool TextMove(const long chart_ID=0, // chart's ID
const string name="Text", // object name
datetime time=0, // anchor point time coordinate
double price=0) // anchor point price coordinate
{
//--- if point position is not set, move it to the current bar having Bid price
if(!time)
time=TimeCurrent();
if(!price)
price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
//--- reset the error value
ResetLastError();
//--- move the anchor point
if(!ObjectMove(chart_ID,name,0,time,price))
{
Print(__FUNCTION__,
": failed to move the anchor point! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Change the object text |
//+------------------------------------------------------------------+
bool TextChange(const long chart_ID=0, // chart's ID
const string name="Text", // object name
const string text="Text") // text
{
//--- reset the error value
ResetLastError();
//--- change object text
if(!ObjectSetString(chart_ID,name,OBJPROP_TEXT,text))
{
Print(__FUNCTION__,
": failed to change the text! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Delete Text object |
//+------------------------------------------------------------------+
bool TextDelete(const long chart_ID=0, // chart's ID
const string name="Text") // object name
{
//--- reset the error value
ResetLastError();
//--- delete the object
if(!ObjectDelete(chart_ID,name))
{
Print(__FUNCTION__,
": failed to delete \"Text\" object! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Check anchor point values and set default values |
//| for empty ones |
//+------------------------------------------------------------------+
void ChangeTextEmptyPoint(datetime &time,double &price)
{
//--- if the point's time is not set, it will be on the current bar
if(!time)
time=TimeCurrent();
//--- if the point's price is not set, it will have Bid value
if(!price)
price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
datetime date[]; // array for storing dates of visible bars
double low[]; // array for storing Low prices of visible bars
double high[]; // array for storing High prices of visible bars
//--- number of visible bars in the chart window
int bars=(int)ChartGetInteger(0,CHART_VISIBLE_BARS);
//--- memory allocation
ArrayResize(date,bars);
ArrayResize(low,bars);
ArrayResize(high,bars);
//--- fill the array of dates
ResetLastError();
if(CopyTime(Symbol(),Period(),0,bars,date)==-1)
{
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
// 0.05 seconds of delay
Sleep(50);
}
//--- half a second of delay
Sleep(500);
//--- delete the texts
for(int i=0;i<bars;i+=step)
{
if(!TextDelete(0,"TextHigh_"+(string)i))
return;
if(!TextDelete(0,"TextLow_"+(string)i))
return;
//--- redraw the chart
ChartRedraw();
// 0.05 seconds of delay
Sleep(50);
}
//---
}
OBJ_LABEL
Label object.
Note
Anchor point position relative to the label can be selected from ENUM _ANCHOR_POINT enumeration.
Anchor point coordinates are set in pixels.
You can also select text label anchoring corner from ENUM _BASE_CORNER enumeration.
Example
The following script creates and moves Edit object on the chart. S pecial functions have been
developed to create and change graphical object's properties. You can use these functions " as is " in
your own applications.
//--- description
#property description "Script creates \"Label\" graphical object."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="Label"; // Label name
input int InpX=150; // X-axis distance
input int InpY=150; // Y-axis distance
input string InpFont="Arial"; // Font
input int InpFontSize=14; // Font size
input color InpColor=clrRed; // Color
input double InpAngle=0.0; // Slope angle in degrees
input ENUM_ANCHOR_POINT InpAnchor=ANCHOR_CENTER; // Anchor type
ObjectSetInteger(chart_ID,name,OBJPROP_COLOR,clr);
//--- display in the foreground (false) or background (true)
ObjectSetInteger(chart_ID,name,OBJPROP_BACK,back);
//--- enable (true) or disable (false) the mode of moving the label by mouse
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTABLE,selection);
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTED,selection);
//--- hide (true) or display (false) graphical object name in the object list
ObjectSetInteger(chart_ID,name,OBJPROP_HIDDEN,hidden);
//--- set the priority for receiving the event of a mouse click in the chart
ObjectSetInteger(chart_ID,name,OBJPROP_ZORDER,z_order);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Move the text label |
//+------------------------------------------------------------------+
bool LabelMove(const long chart_ID=0, // chart's ID
const string name="Label", // label name
const int x=0, // X coordinate
const int y=0) // Y coordinate
{
//--- reset the error value
ResetLastError();
//--- move the text label
if(!ObjectSetInteger(chart_ID,name,OBJPROP_XDISTANCE,x))
{
Print(__FUNCTION__,
": failed to move X coordinate of the label! Error code = ",GetLastError());
return(false);
}
if(!ObjectSetInteger(chart_ID,name,OBJPROP_YDISTANCE,y))
{
Print(__FUNCTION__,
": failed to move Y coordinate of the label! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Change corner of the chart for binding the label |
//+------------------------------------------------------------------+
bool LabelChangeCorner(const long chart_ID=0, // chart's ID
const string name="Label", // label name
const ENUM_BASE_CORNER corner=CORNER_LEFT_UPPER) // chart corner for anchori
{
//--- reset the error value
ResetLastError();
//--- change anchor corner
if(!ObjectSetInteger(chart_ID,name,OBJPROP_CORNER,corner))
{
Print(__FUNCTION__,
": failed to change the anchor corner! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Change the label text |
//+------------------------------------------------------------------+
bool LabelTextChange(const long chart_ID=0, // chart's ID
const string name="Label", // object name
const string text="Text") // text
{
//--- reset the error value
ResetLastError();
//--- change object text
if(!ObjectSetString(chart_ID,name,OBJPROP_TEXT,text))
{
Print(__FUNCTION__,
": failed to change the text! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Delete a text label |
//+------------------------------------------------------------------+
bool LabelDelete(const long chart_ID=0, // chart's ID
const string name="Label") // label name
{
//--- reset the error value
ResetLastError();
//--- delete the label
if(!ObjectDelete(chart_ID,name))
{
Print(__FUNCTION__,
": failed to delete a text label! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- store the label's coordinates in the local variables
int x=InpX;
int y=InpY;
//--- chart window size
long x_distance;
long y_distance;
//--- set window size
if(!ChartGetInteger(0,CHART_WIDTH_IN_PIXELS,0,x_distance))
{
Print("Failed to get the chart width! Error code = ",GetLastError());
return;
}
if(!ChartGetInteger(0,CHART_HEIGHT_IN_PIXELS,0,y_distance))
{
Print("Failed to get the chart height! Error code = ",GetLastError());
return;
}
//--- check correctness of the input parameters
if(InpX<0 || InpX>x_distance-1 || InpY<0 || InpY>y_distance-1)
{
Print("Error! Incorrect values of input parameters!");
return;
}
//--- prepare initial text for the label
string text;
StringConcatenate(text,"Upper left corner: ",x,",",y);
//--- create a text label on the chart
if(!LabelCreate(0,InpName,0,InpX,InpY,CORNER_LEFT_UPPER,text,InpFont,InpFontSize,
InpColor,InpAngle,InpAnchor,InpBack,InpSelection,InpHidden,InpZOrder))
{
return;
}
//--- redraw the chart and wait for half a second
ChartRedraw();
Sleep(500);
//--- move the label and change its text simultaneously
//--- number of iterations by axes
int h_steps=(int)(x_distance/2-InpX);
int v_steps=(int)(y_distance/2-InpY);
//--- move the label down
for(int i=0;i<v_steps;i++)
{
//--- change the coordinate
y+=2;
//--- move the label and change its text
MoveAndTextChange(x,y,"Upper left corner: ");
}
return;
//--- redraw the chart and wait for two seconds
ChartRedraw();
Sleep(2000);
//--- move to the upper right corner
if(!LabelChangeCorner(0,InpName,CORNER_RIGHT_UPPER))
return;
//--- change the label text
StringConcatenate(text,"Upper right corner: ",x,",",y);
if(!LabelTextChange(0,InpName,text))
return;
//--- redraw the chart and wait for two seconds
ChartRedraw();
Sleep(2000);
//--- move to the upper left corner
if(!LabelChangeCorner(0,InpName,CORNER_LEFT_UPPER))
return;
//--- change the label text
StringConcatenate(text,"Upper left corner: ",x,",",y);
if(!LabelTextChange(0,InpName,text))
return;
//--- redraw the chart and wait for two seconds
ChartRedraw();
Sleep(2000);
//--- delete the label
LabelDelete(0,InpName);
//--- redraw the chart and wait for half a second
ChartRedraw();
Sleep(500);
//---
}
//+------------------------------------------------------------------+
//| The function moves the object and changes its text |
//+------------------------------------------------------------------+
bool MoveAndTextChange(const int x,const int y,string text)
{
//--- move the label
if(!LabelMove(0,InpName,x,y))
return(false);
//--- change the label text
StringConcatenate(text,text,x,",",y);
if(!LabelTextChange(0,InpName,text))
return(false);
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return(false);
//--- redraw the chart
ChartRedraw();
// 0.01 seconds of delay
Sleep(10);
//--- exit the function
return(true);
}
OBJ_BUTTON
Button object.
Note
Anchor point coordinates are set in pixels. You can select button anchoring corner from
ENUM _BASE_CORNER .
Example
The following script creates and moves Button object on the chart. S pecial functions have been
developed to create and change graphical object's properties. You can use these functions " as is " in
your own applications.
//--- description
#property description "Script creates the button on the chart."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="Button"; // Button name
input ENUM_BASE_CORNER InpCorner=CORNER_LEFT_UPPER; // Chart corner for anchoring
input string InpFont="Arial"; // Font
input int InpFontSize=14; // Font size
input color InpColor=clrBlack; // Text color
input color InpBackColor=C'236,233,216'; // Background color
input color InpBorderColor=clrNONE; // Border color
input bool InpState=false; // Pressed/Released
input bool InpBack=false; // Background object
input bool InpSelection=false; // Highlight to move
ObjectSetInteger(chart_ID,name,OBJPROP_COLOR,clr);
//--- set background color
ObjectSetInteger(chart_ID,name,OBJPROP_BGCOLOR,back_clr);
//--- set border color
ObjectSetInteger(chart_ID,name,OBJPROP_BORDER_COLOR,border_clr);
//--- display in the foreground (false) or background (true)
ObjectSetInteger(chart_ID,name,OBJPROP_BACK,back);
//--- set button state
ObjectSetInteger(chart_ID,name,OBJPROP_STATE,state);
//--- enable (true) or disable (false) the mode of moving the button by mouse
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTABLE,selection);
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTED,selection);
//--- hide (true) or display (false) graphical object name in the object list
ObjectSetInteger(chart_ID,name,OBJPROP_HIDDEN,hidden);
//--- set the priority for receiving the event of a mouse click in the chart
ObjectSetInteger(chart_ID,name,OBJPROP_ZORDER,z_order);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Move the button |
//+------------------------------------------------------------------+
bool ButtonMove(const long chart_ID=0, // chart's ID
const string name="Button", // button name
const int x=0, // X coordinate
const int y=0) // Y coordinate
{
//--- reset the error value
ResetLastError();
//--- move the button
if(!ObjectSetInteger(chart_ID,name,OBJPROP_XDISTANCE,x))
{
Print(__FUNCTION__,
": failed to move X coordinate of the button! Error code = ",GetLastError());
return(false);
}
if(!ObjectSetInteger(chart_ID,name,OBJPROP_YDISTANCE,y))
{
Print(__FUNCTION__,
": failed to move Y coordinate of the button! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Change button size |
//+------------------------------------------------------------------+
bool ButtonChangeSize(const long chart_ID=0, // chart's ID
ResetLastError();
//--- change object text
if(!ObjectSetString(chart_ID,name,OBJPROP_TEXT,text))
{
Print(__FUNCTION__,
": failed to change the text! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Delete the button |
//+------------------------------------------------------------------+
bool ButtonDelete(const long chart_ID=0, // chart's ID
const string name="Button") // button name
{
//--- reset the error value
ResetLastError();
//--- delete the button
if(!ObjectDelete(chart_ID,name))
{
Print(__FUNCTION__,
": failed to delete the button! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- chart window size
long x_distance;
long y_distance;
//--- set window size
if(!ChartGetInteger(0,CHART_WIDTH_IN_PIXELS,0,x_distance))
{
Print("Failed to get the chart width! Error code = ",GetLastError());
return;
}
if(!ChartGetInteger(0,CHART_HEIGHT_IN_PIXELS,0,y_distance))
{
Print("Failed to get the chart height! Error code = ",GetLastError());
return;
}
//--- define the step for changing the button size
int x_step=(int)x_distance/32;
int y_step=(int)y_distance/32;
//--- set the button coordinates and its size
int x=(int)x_distance/32;
int y=(int)y_distance/32;
int x_size=(int)x_distance*15/16;
int y_size=(int)y_distance*15/16;
//--- create the button
if(!ButtonCreate(0,InpName,0,x,y,x_size,y_size,InpCorner,"Press",InpFont,InpFontSize,
InpColor,InpBackColor,InpBorderColor,InpState,InpBack,InpSelection,InpHidden,InpZOrder))
{
return;
}
//--- redraw the chart
ChartRedraw();
//--- reduce the button in the loop
int i=0;
while(i<13)
{
//--- half a second of delay
Sleep(500);
//--- switch the button to the pressed state
ObjectSetInteger(0,InpName,OBJPROP_STATE,true);
//--- redraw the chart and wait for 0.2 second
ChartRedraw();
Sleep(200);
//--- redefine coordinates and button size
x+=x_step;
y+=y_step;
x_size-=x_step*2;
y_size-=y_step*2;
//--- reduce the button
ButtonMove(0,InpName,x,y);
ButtonChangeSize(0,InpName,x_size,y_size);
//--- bring the button back to the released state
ObjectSetInteger(0,InpName,OBJPROP_STATE,false);
//--- redraw the chart
ChartRedraw();
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- increase the loop counter
i++;
}
//--- half a second of delay
Sleep(500);
//--- delete the button
ButtonDelete(0,InpName);
ChartRedraw();
OBJ_CHART
Chart object.
Note
" OBJ_CHART" type object is not supported (not displayed) during a visual test.
Anchor point coordinates are set in pixels. You can select anchoring corner from
ENUM _BASE_CORNER enumeration.
S ymbol, period and scale can be selected for Chart object. Price scale and date display mode can
also be enabled/disabled.
Example
The following script creates and moves Chart object on the chart. S pecial functions have been
developed to create and change graphical object's properties. You can use these functions " as is " in
your own applications.
//--- description
#property description "Script creates \"Chart\" object."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="Chart"; // Object name
input string InpSymbol="EURUSD"; // Symbol
input ENUM_TIMEFRAMES InpPeriod=PERIOD_H1; // Period
input ENUM_BASE_CORNER InpCorner=CORNER_LEFT_UPPER; // Anchoring corner
input int InpScale=2; // Scale
ObjectSetInteger(chart_ID,name,OBJPROP_CORNER,corner);
//--- set the symbol
ObjectSetString(chart_ID,name,OBJPROP_SYMBOL,symbol);
//--- set the period
ObjectSetInteger(chart_ID,name,OBJPROP_PERIOD,period);
//--- set the scale
ObjectSetInteger(chart_ID,name,OBJPROP_CHART_SCALE,scale);
//--- display (true) or hide (false) the time scale
ObjectSetInteger(chart_ID,name,OBJPROP_DATE_SCALE,date_scale);
//--- display (true) or hide (false) the price scale
ObjectSetInteger(chart_ID,name,OBJPROP_PRICE_SCALE,price_scale);
//--- set the border color when object highlighting mode is enabled
ObjectSetInteger(chart_ID,name,OBJPROP_COLOR,clr);
//--- set the border line style when object highlighting mode is enabled
ObjectSetInteger(chart_ID,name,OBJPROP_STYLE,style);
//--- set a size of the anchor point for moving an object
ObjectSetInteger(chart_ID,name,OBJPROP_WIDTH,point_width);
//--- display in the foreground (false) or background (true)
ObjectSetInteger(chart_ID,name,OBJPROP_BACK,back);
//--- enable (true) or disable (false) the mode of moving the label by mouse
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTABLE,selection);
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTED,selection);
//--- hide (true) or display (false) graphical object name in the object list
ObjectSetInteger(chart_ID,name,OBJPROP_HIDDEN,hidden);
//--- set the priority for receiving the event of a mouse click in the chart
ObjectSetInteger(chart_ID,name,OBJPROP_ZORDER,z_order);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Sets the symbol and time frame of the Chart object |
//+------------------------------------------------------------------+
bool ObjectChartSetSymbolAndPeriod(const long chart_ID=0, // chart's ID (not Chart
const string name="Chart", // object name
const string symbol="EURUSD", // symbol
const ENUM_TIMEFRAMES period=PERIOD_H1) // time frame
{
//--- reset the error value
ResetLastError();
//--- set Chart object's symbol and time frame
if(!ObjectSetString(chart_ID,name,OBJPROP_SYMBOL,symbol))
{
Print(__FUNCTION__,
": failed to set a symbol for \"Chart\" object! Error code = ",GetLastError());
return(false);
}
if(!ObjectSetInteger(chart_ID,name,OBJPROP_PERIOD,period))
{
Print(__FUNCTION__,
": failed to set a period for \"Chart\" object! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Move Chart object |
//+------------------------------------------------------------------+
bool ObjectChartMove(const long chart_ID=0, // chart's ID (not Chart object's one)
const string name="Chart", // object name
const int x=0, // X coordinate
const int y=0) // Y coordinate
{
//--- reset the error value
ResetLastError();
//--- move the object
if(!ObjectSetInteger(chart_ID,name,OBJPROP_XDISTANCE,x))
{
Print(__FUNCTION__,
": failed to move X coordinate of \"Chart\" object! Error code = ",GetLastError());
return(false);
}
if(!ObjectSetInteger(chart_ID,name,OBJPROP_YDISTANCE,y))
{
Print(__FUNCTION__,
": failed to move Y coordinate of \"Chart\" object! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Change Chart object size |
//+------------------------------------------------------------------+
bool ObjectChartChangeSize(const long chart_ID=0, // chart's ID (not Chart object's one)
const string name="Chart", // object name
const int width=300, // width
const int height=200) // height
{
//--- reset the error value
ResetLastError();
//--- change the object size
if(!ObjectSetInteger(chart_ID,name,OBJPROP_XSIZE,width))
{
Print(__FUNCTION__,
": failed to change the width of \"Chart\" object! Error code = ",GetLastError());
return(false);
}
if(!ObjectSetInteger(chart_ID,name,OBJPROP_YSIZE,height))
{
Print(__FUNCTION__,
": failed to change the height of \"Chart\" object! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Return Chart object's ID |
//+------------------------------------------------------------------+
long ObjectChartGetID(const long chart_ID=0, // chart's ID (not Chart object's one)
const string name="Chart") // object name
{
//--- prepare the variable to get Chart object's ID
long id=-1;
//--- reset the error value
ResetLastError();
//--- get ID
if(!ObjectGetInteger(chart_ID,name,OBJPROP_CHART_ID,0,id))
{
Print(__FUNCTION__,
": failed to get \"Chart\" object's ID! Error code = ",GetLastError());
}
//--- return the result
return(id);
}
//+------------------------------------------------------------------+
//| Delete Chart object |
//+------------------------------------------------------------------+
bool ObjectChartDelete(const long chart_ID=0, // chart's ID (not Chart object's one)
const string name="Chart") // object name
{
//--- reset the error value
ResetLastError();
//--- delete the button
if(!ObjectDelete(chart_ID,name))
{
Print(__FUNCTION__,
": failed to delete \"Chart\" object! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- get the number of symbols in Market Watch
int symbols=SymbolsTotal(true);
//--- check if the symbol with a specified name is present in the symbol list
bool exist=false;
for(int i=0;i<symbols;i++)
if(InpSymbol==SymbolName(i,true))
{
exist=true;
break;
}
if(!exist)
{
Print("Error! ",InpSymbol," symbol is not present in \"Market Watch\"!");
return;
}
//--- check validity of input parameters
if(InpScale<0 || InpScale>5)
{
Print("Error! Incorrect values of input parameters!");
return;
}
OBJ_BITMAP
Bitmap object.
Note
The following script creates several bitmaps on the chart. S pecial functions have been developed to
create and change graphical object's properties. You can use these functions " as is " in your own
applications.
//--- description
#property description "Script creates a bitmap in the chart window."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpFile="\\Images\\dollar.bmp"; // Bitmap file name
input int InpWidth=24; // Visibility scope X coordinate
input int InpHeight=24; // Visibility scope Y coordinate
input int InpXOffset=4; // Visibility scope shift by X axis
input int InpYOffset=4; // Visibility scope shift by Y axis
input color InpColor=clrRed; // Border color when highlighted
input ENUM_LINE_STYLE InpStyle=STYLE_SOLID; // Line style when highlighted
input int InpPointWidth=1; // Point size to move
input bool InpBack=false; // Background object
input bool InpSelection=false; // Highlight to move
//--- performing a shift from this area displaying another part of the image
ObjectSetInteger(chart_ID,name,OBJPROP_XOFFSET,x_offset);
ObjectSetInteger(chart_ID,name,OBJPROP_YOFFSET,y_offset);
//--- set the border color when object highlighting mode is enabled
ObjectSetInteger(chart_ID,name,OBJPROP_COLOR,clr);
//--- set the border line style when object highlighting mode is enabled
ObjectSetInteger(chart_ID,name,OBJPROP_STYLE,style);
//--- set a size of the anchor point for moving an object
ObjectSetInteger(chart_ID,name,OBJPROP_WIDTH,point_width);
//--- display in the foreground (false) or background (true)
ObjectSetInteger(chart_ID,name,OBJPROP_BACK,back);
//--- enable (true) or disable (false) the mode of moving the label by mouse
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTABLE,selection);
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTED,selection);
//--- hide (true) or display (false) graphical object name in the object list
ObjectSetInteger(chart_ID,name,OBJPROP_HIDDEN,hidden);
//--- set the priority for receiving the event of a mouse click in the chart
ObjectSetInteger(chart_ID,name,OBJPROP_ZORDER,z_order);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Set a new image for the bitmap |
//+------------------------------------------------------------------+
bool BitmapSetImage(const long chart_ID=0, // chart's ID
const string name="Bitmap", // bitmap name
const string file="") // path to the file
{
//--- reset the error value
ResetLastError();
//--- set the path to the image file
if(!ObjectSetString(chart_ID,name,OBJPROP_BMPFILE,file))
{
Print(__FUNCTION__,
": failed to load the image! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Move a bitmap in the chart window |
//+------------------------------------------------------------------+
bool BitmapMove(const long chart_ID=0, // chart's ID
const string name="Bitmap", // bitmap name
datetime time=0, // anchor point time
double price=0) // anchor point price
{
//--- if point position is not set, move it to the current bar having Bid price
if(!time)
time=TimeCurrent();
if(!price)
price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
//--- reset the error value
ResetLastError();
//--- move the anchor point
if(!ObjectMove(chart_ID,name,0,time,price))
{
Print(__FUNCTION__,
": failed to move the anchor point! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Change visibility scope (bitmap) size |
//+------------------------------------------------------------------+
bool BitmapChangeSize(const long chart_ID=0, // chart's ID
const string name="Bitmap", // bitmap name
const int width=0, // bitmap width
const int height=0) // bitmap height
{
//--- reset the error value
ResetLastError();
//--- change bitmap size
if(!ObjectSetInteger(chart_ID,name,OBJPROP_XSIZE,width))
{
Print(__FUNCTION__,
": failed to change the bitmap width! Error code = ",GetLastError());
return(false);
}
if(!ObjectSetInteger(chart_ID,name,OBJPROP_YSIZE,height))
{
Print(__FUNCTION__,
": failed to change the bitmap height! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+--------------------------------------------------------------------+
//| Change coordinate of the upper left corner of the visibility scope |
//+--------------------------------------------------------------------+
bool BitmapMoveVisibleArea(const long chart_ID=0, // chart's ID
const string name="Bitmap", // bitmap name
const int x_offset=0, // visibility scope X coordinate
const int y_offset=0) // visibility scope Y coordinate
{
//--- reset the error value
ResetLastError();
//--- change the bitmap's visibility scope coordinates
if(!ObjectSetInteger(chart_ID,name,OBJPROP_XOFFSET,x_offset))
{
Print(__FUNCTION__,
": failed to change X coordinate of the visibility scope! Error code = ",GetLastError()
return(false);
}
if(!ObjectSetInteger(chart_ID,name,OBJPROP_YOFFSET,y_offset))
{
Print(__FUNCTION__,
": failed to change Y coordinate of the visibility scope! Error code = ",GetLastError()
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Delete a bitmap |
//+------------------------------------------------------------------+
bool BitmapDelete(const long chart_ID=0, // chart's ID
const string name="Bitmap") // bitmap name
{
//--- reset the error value
ResetLastError();
//--- delete the label
if(!ObjectDelete(chart_ID,name))
{
Print(__FUNCTION__,
": failed to delete a bitmap! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Check anchor point values and set default values |
//| for empty ones |
//+------------------------------------------------------------------+
void ChangeBitmapEmptyPoint(datetime &time,double &price)
{
//--- if the point's time is not set, it will be on the current bar
if(!time)
time=TimeCurrent();
//--- if the point's price is not set, it will have Bid value
if(!price)
price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
datetime date[]; // array for storing dates of visible bars
double close[]; // array for storing Close prices
//--- bitmap file name
string file="\\Images\\dollar.bmp";
//--- number of visible bars in the chart window
int bars=(int)ChartGetInteger(0,CHART_VISIBLE_BARS);
//--- memory allocation
ArrayResize(date,bars);
ArrayResize(close,bars);
//--- fill the array of dates
ResetLastError();
if(CopyTime(Symbol(),Period(),0,bars,date)==-1)
{
Print("Failed to copy time values! Error code = ",GetLastError());
return;
}
//--- fill the array of Close prices
if(CopyClose(Symbol(),Period(),0,bars,close)==-1)
{
Print("Failed to copy the values of Close prices! Error code = ",GetLastError());
return;
}
//--- define how often the images should be displayed
int scale=(int)ChartGetInteger(0,CHART_SCALE);
//--- define the step
int step=1;
switch(scale)
{
case 0:
step=27;
break;
case 1:
step=14;
break;
case 2:
step=7;
break;
case 3:
step=4;
break;
case 4:
step=2;
break;
}
//--- create bitmaps for High and Low bars' values (with gaps)
for(int i=0;i<bars;i+=step)
{
//--- create the bitmaps
if(!BitmapCreate(0,"Bitmap_"+(string)i,0,date[i],close[i],InpFile,InpWidth,InpHeight,InpXOffs
InpYOffset,InpColor,InpStyle,InpPointWidth,InpBack,InpSelection,InpHidden,InpZOrder))
{
return;
}
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
// 0.05 seconds of delay
Sleep(50);
}
//--- half a second of delay
Sleep(500);
//--- delete Sell signs
for(int i=0;i<bars;i+=step)
{
if(!BitmapDelete(0,"Bitmap_"+(string)i))
return;
if(!BitmapDelete(0,"Bitmap_"+(string)i))
return;
//--- redraw the chart
ChartRedraw();
// 0.05 seconds of delay
Sleep(50);
}
//---
}
OBJ_BITMAP_LABEL
Bitmap Label object.
Note
Anchor point position relative to the label can be selected from ENUM _ANCHOR_POINT enumeration.
Anchor point coordinates are set in pixels.
You can also select bitmap anchoring corner from ENUM _BASE_CORNER enumeration.
For bitmap label, you can select visibility scope of an image.
Example
The following script creates several bitmaps on the chart. S pecial functions have been developed to
create and change graphical object's properties. You can use these functions " as is " in your own
applications.
//--- description
#property description "Script creates \"Bitmap Label\" object."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="BmpLabel"; // Label name
input string InpFileOn="\\Images\\dollar.bmp"; // File name for On mode
input string InpFileOff="\\Images\\euro.bmp"; // File name for Off mode
input bool InpState=false; // Label pressed/released
input ENUM_BASE_CORNER InpCorner=CORNER_LEFT_UPPER; // Chart corner for anchoring
input ENUM_ANCHOR_POINT InpAnchor=ANCHOR_CENTER; // Anchor type
input color InpColor=clrRed; // Border color when highlighted
Print(__FUNCTION__,
": failed to load the image for Off mode! Error code = ",GetLastError());
return(false);
}
//--- set label coordinates
ObjectSetInteger(chart_ID,name,OBJPROP_XDISTANCE,x);
ObjectSetInteger(chart_ID,name,OBJPROP_YDISTANCE,y);
//--- set visibility scope for the image; if width or height values
//--- exceed the width and height (respectively) of a source image,
//--- it is not drawn; in the opposite case,
//--- only the part corresponding to these values is drawn
ObjectSetInteger(chart_ID,name,OBJPROP_XSIZE,width);
ObjectSetInteger(chart_ID,name,OBJPROP_YSIZE,height);
//--- set the part of an image that is to be displayed in the visibility scope
//--- the default part is the upper left area of an image; the values allow
//--- performing a shift from this area displaying another part of the image
ObjectSetInteger(chart_ID,name,OBJPROP_XOFFSET,x_offset);
ObjectSetInteger(chart_ID,name,OBJPROP_YOFFSET,y_offset);
//--- define the label's status (pressed or released)
ObjectSetInteger(chart_ID,name,OBJPROP_STATE,state);
//--- set the chart's corner, relative to which point coordinates are defined
ObjectSetInteger(chart_ID,name,OBJPROP_CORNER,corner);
//--- set anchor type
ObjectSetInteger(chart_ID,name,OBJPROP_ANCHOR,anchor);
//--- set the border color when object highlighting mode is enabled
ObjectSetInteger(chart_ID,name,OBJPROP_COLOR,clr);
//--- set the border line style when object highlighting mode is enabled
ObjectSetInteger(chart_ID,name,OBJPROP_STYLE,style);
//--- set a size of the anchor point for moving an object
ObjectSetInteger(chart_ID,name,OBJPROP_WIDTH,point_width);
//--- display in the foreground (false) or background (true)
ObjectSetInteger(chart_ID,name,OBJPROP_BACK,back);
//--- enable (true) or disable (false) the mode of moving the label by mouse
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTABLE,selection);
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTED,selection);
//--- hide (true) or display (false) graphical object name in the object list
ObjectSetInteger(chart_ID,name,OBJPROP_HIDDEN,hidden);
//--- set the priority for receiving the event of a mouse click in the chart
ObjectSetInteger(chart_ID,name,OBJPROP_ZORDER,z_order);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Set a new image for Bitmap label object |
//+------------------------------------------------------------------+
bool BitmapLabelSetImage(const long chart_ID=0, // chart's ID
const string name="BmpLabel", // label name
const int on_off=0, // modifier (On or Off)
const string file="") // path to the file
{
//--- reset the error value
ResetLastError();
//--- set the path to the image file
if(!ObjectSetString(chart_ID,name,OBJPROP_BMPFILE,on_off,file))
{
Print(__FUNCTION__,
": failed to load the image! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Move Bitmap Label object |
//+------------------------------------------------------------------+
bool BitmapLabelMove(const long chart_ID=0, // chart's ID
const string name="BmpLabel", // label name
const int x=0, // X coordinate
const int y=0) // Y coordinate
{
//--- reset the error value
ResetLastError();
//--- move the object
if(!ObjectSetInteger(chart_ID,name,OBJPROP_XDISTANCE,x))
{
Print(__FUNCTION__,
": failed to move X coordinate of the object! Error code = ",GetLastError());
return(false);
}
if(!ObjectSetInteger(chart_ID,name,OBJPROP_YDISTANCE,y))
{
Print(__FUNCTION__,
": failed to move Y coordinate of the object! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Change visibility scope (object) size |
//+------------------------------------------------------------------+
bool BitmapLabelChangeSize(const long chart_ID=0, // chart's ID
const string name="BmpLabel", // label name
const int width=0, // label width
const int height=0) // label height
{
//--- reset the error value
ResetLastError();
ResetLastError();
//--- delete the label
if(!ObjectDelete(chart_ID,name))
{
Print(__FUNCTION__,
": failed to delete \"Bitmap label\" object! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- chart window size
long x_distance;
long y_distance;
//--- set window size
if(!ChartGetInteger(0,CHART_WIDTH_IN_PIXELS,0,x_distance))
{
Print("Failed to get the chart width! Error code = ",GetLastError());
return;
}
if(!ChartGetInteger(0,CHART_HEIGHT_IN_PIXELS,0,y_distance))
{
Print("Failed to get the chart height! Error code = ",GetLastError());
return;
}
//--- define bitmap label coordinates
int x=(int)x_distance/2;
int y=(int)y_distance/2;
//--- set label size and visibility scope coordinates
int width=32;
int height=32;
int x_offset=0;
int y_offset=0;
//--- place bitmap label at the center of the window
if(!BitmapLabelCreate(0,InpName,0,x,y,InpFileOn,InpFileOff,width,height,x_offset,y_offset,InpSta
InpCorner,InpAnchor,InpColor,InpStyle,InpPointWidth,InpBack,InpSelection,InpHidden,InpZOrder)
{
return;
}
//--- redraw the chart and wait one second
ChartRedraw();
Sleep(1000);
//--- change label's visibility scope size in the loop
for(int i=0;i<6;i++)
{
//--- change visibility scope size
width--;
height--;
if(!BitmapLabelChangeSize(0,InpName,width,height))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
// 0.3 seconds of delay
Sleep(300);
}
//--- 1 second of delay
Sleep(1000);
//--- change label's visibility scope coordinates in the loop
for(int i=0;i<2;i++)
{
//--- change visibility scope coordinates
x_offset++;
y_offset++;
if(!BitmapLabelMoveVisibleArea(0,InpName,x_offset,y_offset))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart
ChartRedraw();
// 0.3 seconds of delay
Sleep(300);
}
//--- 1 second of delay
Sleep(1000);
//--- delete the label
BitmapLabelDelete(0,InpName);
ChartRedraw();
//--- 1 second of delay
Sleep(1000);
//---
}
OBJ_EDIT
Edit object.
Note
Anchor point coordinates are set in pixels. You can select Edit anchoring corner from
ENUM _BASE_CORNER enumeration.
You can also select one of the text alignment types inside Edit from ENUM _ALIGN_MODE
enumeration.
Example
The following script creates and moves Edit object on the chart. S pecial functions have been
developed to create and change graphical object's properties. You can use these functions " as is " in
your own applications.
//--- description
#property description "Script creates \"Edit\" object."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="Edit"; // Object name
input string InpText="Text"; // Object text
input string InpFont="Arial"; // Font
input int InpFontSize=14; // Font size
input ENUM_ALIGN_MODE InpAlign=ALIGN_CENTER; // Text alignment type
input bool InpReadOnly=false; // Permission to edit
input ENUM_BASE_CORNER InpCorner=CORNER_LEFT_UPPER; // Chart corner for anchoring
input color InpColor=clrBlack; // Text color
}
if(!ChartGetInteger(0,CHART_HEIGHT_IN_PIXELS,0,y_distance))
{
Print("Failed to get the chart height! Error code = ",GetLastError());
return;
}
//--- define the step for changing the edit field
int x_step=(int)x_distance/64;
//--- set edit field coordinates and its size
int x=(int)x_distance/8;
int y=(int)y_distance/2;
int x_size=(int)x_distance/8;
int y_size=InpFontSize*2;
//--- store the text in the local variable
string text=InpText;
//--- create edit field
if(!EditCreate(0,InpName,0,x,y,x_size,y_size,InpText,InpFont,InpFontSize,InpAlign,InpReadOnly,
InpCorner,InpColor,InpBackColor,InpBorderColor,InpBack,InpSelection,InpHidden,InpZOrder))
{
return;
}
//--- redraw the chart and wait for 1 second
ChartRedraw();
Sleep(1000);
//--- stretch the edit field
while(x_size-x<x_distance*5/8)
{
//--- increase edit field's width
x_size+=x_step;
if(!EditChangeSize(0,InpName,x_size,y_size))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart and wait for 0.05 seconds
ChartRedraw();
Sleep(50);
}
//--- half a second of delay
Sleep(500);
//--- change the text
for(int i=0;i<20;i++)
{
//--- add "+" at the beginning and at the end
text="+"+text+"+";
if(!EditTextChange(0,InpName,text))
return;
//--- check if the script's operation has been forcefully disabled
if(IsStopped())
return;
//--- redraw the chart and wait for 0.1 seconds
ChartRedraw();
Sleep(100);
}
//--- half a second of delay
Sleep(500);
//--- delete edit field
EditDelete(0,InpName);
ChartRedraw();
//--- wait for 1 second
Sleep(1000);
//---
}
OBJ_EVENT
Event object.
Note
The following script creates and moves Event object on the chart. S pecial functions have been
developed to create and change graphical object's properties. You can use these functions " as is " in
your own applications.
//--- description
#property description "Script draws \"Event\" graphical object."
#property description "Anchor point date is set in percentage of"
#property description "the chart window width in bars."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="Event"; // Event name
input int InpDate=25; // Event date, %
input string InpText="Text"; // Event text
input color InpColor=clrRed; // Event color
input int InpWidth=1; // Point size when highlighted
input bool InpBack=false; // Background event
input bool InpSelection=false; // Highlight to move
input bool InpHidden=true; // Hidden in the object list
Print(__FUNCTION__,
": failed to delete \"Event\" object! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- check correctness of the input parameters
if(InpDate<0 || InpDate>100)
{
Print("Error! Incorrect values of input parameters!");
return;
}
//--- number of visible bars in the chart window
int bars=(int)ChartGetInteger(0,CHART_VISIBLE_BARS);
//--- array for storing the date values to be used
//--- for setting and changing Event object anchor point's coordinates
datetime date[];
//--- memory allocation
ArrayResize(date,bars);
//--- fill the array of dates
ResetLastError();
if(CopyTime(Symbol(),Period(),0,bars,date)==-1)
{
Print("Failed to copy time values! Error code = ",GetLastError());
return;
}
//--- define the points to create an object
int d=InpDate*(bars-1)/100;
//--- create Event object
if(!EventCreate(0,InpName,0,InpText,date[d],InpColor,InpWidth,
InpBack,InpSelection,InpHidden,InpZOrder))
{
return;
}
//--- redraw the chart and wait for 1 second
ChartRedraw();
Sleep(1000);
//--- now, move the object
//--- loop counter
int h_steps=bars/2;
//--- move the object
for(int i=0;i<h_steps;i++)
{
OBJ_RECTANGLE_LABEL
R ectangle Label object.
Note
Anchor point coordinates are set in pixels. You can select rectangle label's anchoring corner from
ENUM _BASE_CORNER enumeration. R ectangle label's border type can be selected from
ENUM _BORDER_T YPE enumeration.
The object is used to create and design the custom graphical interface.
Example
The following script creates and moves Rectangle Label object on the chart. S pecial functions have
been developed to create and change graphical object's properties. You can use these functions " as
is " in your own applications.
//--- description
#property description "Script creates \"Rectangle Label\" graphical object."
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- input parameters of the script
input string InpName="RectLabel"; // Label name
input color InpBackColor=clrSkyBlue; // Background color
input ENUM_BORDER_TYPE InpBorder=BORDER_FLAT; // Border type
input ENUM_BASE_CORNER InpCorner=CORNER_LEFT_UPPER; // Chart corner for anchoring
input color InpColor=clrDarkBlue; // Flat border color (Flat)
input ENUM_LINE_STYLE InpStyle=STYLE_SOLID; // Flat border style (Flat)
input int InpLineWidth=3; // Flat border width (Flat)
ObjectSetInteger(chart_ID,name,OBJPROP_STYLE,style);
//--- set flat border width
ObjectSetInteger(chart_ID,name,OBJPROP_WIDTH,line_width);
//--- display in the foreground (false) or background (true)
ObjectSetInteger(chart_ID,name,OBJPROP_BACK,back);
//--- enable (true) or disable (false) the mode of moving the label by mouse
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTABLE,selection);
ObjectSetInteger(chart_ID,name,OBJPROP_SELECTED,selection);
//--- hide (true) or display (false) graphical object name in the object list
ObjectSetInteger(chart_ID,name,OBJPROP_HIDDEN,hidden);
//--- set the priority for receiving the event of a mouse click in the chart
ObjectSetInteger(chart_ID,name,OBJPROP_ZORDER,z_order);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Move rectangle label |
//+------------------------------------------------------------------+
bool RectLabelMove(const long chart_ID=0, // chart's ID
const string name="RectLabel", // label name
const int x=0, // X coordinate
const int y=0) // Y coordinate
{
//--- reset the error value
ResetLastError();
//--- move the rectangle label
if(!ObjectSetInteger(chart_ID,name,OBJPROP_XDISTANCE,x))
{
Print(__FUNCTION__,
": failed to move X coordinate of the label! Error code = ",GetLastError());
return(false);
}
if(!ObjectSetInteger(chart_ID,name,OBJPROP_YDISTANCE,y))
{
Print(__FUNCTION__,
": failed to move Y coordinate of the label! Error code = ",GetLastError());
return(false);
}
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Change the size of the rectangle label |
//+------------------------------------------------------------------+
bool RectLabelChangeSize(const long chart_ID=0, // chart's ID
const string name="RectLabel", // label name
const int width=50, // label width
const int height=18) // label height
{
Object Properties
Graphical objects can have various properties depending on the object type. Values of object
properties are set up and received by corresponding functions for working with graphical objects.
All objects used in technical analysis are bound to the time and price coordinates : trendline, channels,
Fibonacci tools, etc. But there is a number of auxiliary objects intended to improve the user interface
that are bound to the always visible part of a chart (main chart windows or indicator subwindows):
The functions defining the properties of graphical objects, as well as ObjectCreate() and ObjectMove()
operations for creating and moving objects along the chart are actually used for sending commands to
the chart. If these functions are executed successfully, the command is included in the common queue
of the chart events. Visual changes in the properties of graphical objects are implemented when
handling the queue of the chart events.
Thus, do not expect an immediate visual update of graphical objects after calling these functions.
Generally, the graphical objects on the chart are updated automatically by the terminal following the
change events - a new quote arrival, resizing the chart window, etc. Use ChartRedraw() function to
forcefully update the graphical objects.
For functions ObjectS etInteger() and ObjectGetInteger()
ENUM_OBJECT_PROPERTY _INTEGER
char
t
(CH
AR T
EVE
NT _
CLI
CK).
The
defa
ult
zero
valu
e is
set
whe
n
crea
ting
an
obje
ct;
the
prio
rity
can
be
incr
eas
ed
if
nec
essa
ry.
W he
n
obje
cts
are
plac
ed
one
atop
anot
her,
only
one
of
the
m
with
the
high
est
prio
rity
will
rece
ive
the
CHA
RTE
VEN
T _C
LICK
eve
nt.
OBJPROP_FILL Fill bool
an
obje
ct
with
colo
r
(for
OBJ
_RE
CTA
NGL
E,
OBJ
_T R
IAN
GL E
,
OBJ
_EL
LIPS
E,
OBJ
_CH
ANN
EL,
OBJ
_S T
DDE
VCH
ANN
EL,
OBJ
_RE
GRE
SS I
ON)
OBJPROP_HIDDEN Proh bool
ibit
sho
win
g of
the
nam
e of
a
grap
hica
l
obje
ct in
the
list
of
obje
cts
fro
m
the
ter
min
al
men
u
" Ch
arts
" -
" Obj
ects
" -
" Lis
t of
obje
cts "
.
The
true
valu
e
allo
ws
to
hide
an
obje
ct
fro
m
the
list.
By
defa
ult,
true
is
set
to
the
obje
cts
that
disp
lay
cale
ndar
eve
nts,
trad
ing
hist
ory
and
to
the
obje
cts
crea
ted
fro
m
MQL
5
prog
ram
s.
To
see
such
grap
hica
l
obje
cts
and
acce
ss
thei
r
prop
erti
es,
click
on
the
"All"
butt
on
in
the
" Lis
t of
obje
cts "
win
dow
.
OBJPROP_SELECTED Obj bool
ect
is
sele
cted
OBJPROP_READONLY Abili bool
ty
to
edit
text
in
the
Edit
obje
ct
OBJPROP_TYPE Obj ENUM _OBJECT r/o
ect
type
OBJPROP_TIM E Tim datetime modifier=number of anchor point
e
coor
dina
te
OBJPROP_SELECTABLE Obj bool
ect
avai
labil
ity
OBJPROP_CREATETIM E Tim datetime r/o
e of
obje
ct
crea
tion
OBJPROP_LEVELS Num int
ber
of
leve
ls
OBJPROP_LEVELCOLOR Colo color modifier=level number
r of
the
line-
leve
l
OBJPROP_LEVELS TYLE S tyl ENUM _LINE_S T YL E modifier=level number
e of
the
line-
leve
l
OBJPROP_LEVELW IDTH Thic int modifier=level number
k nes
s of
the
line-
level
OBJPROP_ALIGN H ori ENUM _ALIGN_MODE
zont
al
text
alig
nme
nt
in
the
"Edi
t"
obje
ct
(OB
J_E
DIT)
dow
s of
a
char
t
OBJPROP_ELLIPSE S ho bool
win
g
the
full
ellip
se
of
the
Fibo
nacc
i
Arc
obje
ct
(OB
J_FI
BOA
R C)
fro
m
the
bind
ing
corn
er
(see
note
)
OBJPROP_DIRECTION Tre ENUM _GANN_DIRECTION
nd
of
the
Gan
n
obje
ct
OBJPROP_DEGREE Lev ENUM _ELLIOT _WAVE_DEGREE
el of
the
Ellio
tt
W av
e
Mar
k ing
ssed
/
depr
esse
d)
OBJPROP_CHART_ID ID long r/o
of
the
" Ch
art"
obje
ct
(OB
J_C
HAR
T).
It
allo
ws
wor
k ing
with
the
prop
erti
es
of
this
obje
ct
like
with
a
nor
mal
char
t
usin
g
the
func
tion
s
desc
ribe
d in
Cha
rt
Ope
rati
ons,
but
ther
e
som
e
exc
epti
ons.
OBJPROP_XS IZE The int
obje
ct's
widt
h
alon
g
the
X
axis
in
pixe
ls.
S pe
cifie
d
for
OBJ
_L A
BEL
(rea
d
only
),
OBJ
_BU
TTO
N,
OBJ
_CH
AR T
,
OBJ
_BIT
M AP
,
OBJ
_BIT
M AP
_L A
BEL,
OBJ
_EDI
T,
OBJ
_RE
CTA
NGL
E_L
ABE
L
obje
cts.
OBJPROP_YS IZE The int
obje
ct's
heig
ht
alon
g
the
Y
axis
in
pixe
ls.
S pe
cifie
d
for
OBJ
_L A
BEL
(rea
d
only
),
OBJ
_BU
TTO
N,
OBJ
_CH
AR T
,
OBJ
_BIT
M AP
,
OBJ
_BIT
M AP
_L A
BEL,
OBJ
_EDI
T,
OBJ
_RE
CTA
NGL
E_L
ABE
L
obje
cts.
OBJPROP_XOFFSET The int
X
coor
dina
te
of
the
upp
er
left
corn
er
of
the
rect
ang
ular
visi
ble
area
in
the
grap
hica
l
obje
cts
"Bit
map
Lab
el"
and
"Bit
map
" (O
BJ_
BIT
M AP
_L A
BEL
and
OBJ
_BIT
M AP
).
The
valu
e is
set
in
pixe
ls
rela
tive
to
the
upp
er
left
corn
er
of
the
orig
inal
ima
ge.
OBJPROP_YOFFSET The int
Y
coor
dina
te
of
the
upp
er
left
corn
er
of
the
rect
ang
ular
visi
ble
area
in
the
grap
hica
l
obje
cts
"Bit
map
Lab
el"
and
"Bit
map
" (O
BJ_
BIT
M AP
_L A
BEL
and
OBJ
_BIT
M AP
).
The
valu
e is
set
in
pixe
ls
rela
tive
to
the
upp
er
left
corn
er
of
the
orig
inal
ima
ge.
OBJPROP_PERIOD Tim ENUM _TIM EFRAM ES
efra
me
for
the
Cha
rt
obje
ct
OBJPROP_DATE_S CALE Disp bool
layi
ng
the
tim
e
scal
e
for
the
Cha
rt
obje
ct
OBJPROP_PRICE_S CALE Disp bool
layi
ng
the
pric
e
scal
e
for
the
Cha
rt
obje
ct
OBJPROP_CHART_S CALE The int value in the range 0–5
scal
e
for
the
Cha
rt
obje
ct
OBJPROP_BGCOLOR The color
bac
k gro
und
colo
r for
OBJ
_EDI
T,
OBJ
_BU
TTO
N,
OBJ
_RE
CTA
NGL
E_L
ABE
L
OBJPROP_CORNER The ENUM _BASE_CORNER
corn
er
of
the
char
t to
link
a
grap
hica
l
obje
ct
OBJPROP_BORDER_TYPE Bord ENUM _BORDER_T YPE
er
type
for
the
"R ec
tang
le
labe
l"
obje
ct
OBJPROP_BORDER_COLOR Bord color
er
colo
r for
the
OBJ
_EDI
T
and
OBJ
_BU
TTO
N
obje
cts
W hen using chart operations for the " Chart" object (OBJ_CHART), the following limitations are
imposed:
· It cannot be closed using ChartClose();
· S ymbol/period cannot be changed using the ChartS etS ymbolPeriod() function;
· The following properties are ineffective CHART_S CALE, CHART_BRING_TO_TOP,
CHART_SHOW_DATE_S CALE and CHART_SHOW_PRICE_S CALE (ENUM _CHART_PROPERTY_INTEGER).
You can set a special mode of image display for OBJ_BITM AP_LABEL and OBJ_BITM AP objects. In this
mode, only part of an original image (at which a rectangular visible area is applied) is displayed, while
the rest of the image becomes invisible. The size of this area should be set using the properties
OBJPROP_XS IZE and OBJPROP_YS IZE. The visible area can be " moved" only within the original image
using the properties OBJPROP_XOFFSET and OBJPROP_YOFFSET.
For
the
obje
cts
with
no
angl
e
spec
ifie
d,
crea
ted
fro
m a
prog
ram
,
the
valu
e is
equ
al to
EMP
TY_
VAL
UE
sho
wn.
A
tool
tip
can
be
disa
bled
by
sett
ing
the
"\n"
(line
feed
)
valu
e to
it
OBJPROP_LEVELTEXT Lev string modifier=level number
el
desc
ripti
on
OBJPROP_FONT Font string
OBJPROP_BMPFILE The string modifier: 0-state ON, 1-state OFF
nam
e of
BMP
-file
for
Bit
map
Lab
el.
S ee
also
R es
ourc
es
OBJPROP_SYM BOL S ym string
bol
for
the
Cha
rt
obje
ct
For the OBJ_RECTANGLE_LABEL object ("Rectangle label" ) one of the three design modes can be set,
to which the following values of ENUM _BORDER_TYPE correspond.
ENUM_BORDER_TY PE
Identifier Description
For the OBJ_EDIT object ("Edit" ) and for the ChartS creenS hot() function, you can specify the horizontal
alignment type using the values of the ENUM _ALIGN_MODE enumeration.
ENUM_ALIGN_MODE
Identifier Description
Example:
#define UP "\x0431"
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//---
string label_name="my_OBJ_LABEL_object";
if(ObjectFind(0,label_name)<0)
{
Print("Object ",label_name," not found. Error code = ",GetLastError());
//--- create Label object
ObjectCreate(0,label_name,OBJ_LABEL,0,0,0);
The necessary variant can be specified using the function ObjectS etInteger(chart_handle,
object_name, OBJPROP_ANCHOR, anchor_point_mode), where anchor_point_mode is one of the
values of ENUM _ANCHOR_POINT.
ENUM_ANCHOR_POINT
ID Description
ANCH OR_L EFT _UPPER Anchor point at the upper left corner
ID Description
string text_name="my_OBJ_TEXT_object";
if(ObjectFind(0,text_name)<0)
{
Print("Object ",text_name," not found. Error code = ",GetLastError());
//--- Get the maximal price of the chart
double chart_max_price=ChartGetDouble(0,CHART_PRICE_MAX,0);
//--- Create object Label
ObjectCreate(0,text_name,OBJ_TEXT,0,TimeCurrent(),chart_max_price);
//--- Set color of the text
ObjectSetInteger(0,text_name,OBJPROP_COLOR,clrWhite);
//--- Set background color
ObjectSetInteger(0,text_name,OBJPROP_BGCOLOR,clrGreen);
//--- Set text for the Label object
ObjectSetString(0,text_name,OBJPROP_TEXT,TimeToString(TimeCurrent()));
//--- Set text font
ObjectSetString(0,text_name,OBJPROP_FONT,"Trebuchet MS");
//--- Set font size
ObjectSetInteger(0,text_name,OBJPROP_FONTSIZE,10);
//--- Bind to the upper right corner
ObjectSetInteger(0,text_name,OBJPROP_ANCHOR,ANCHOR_RIGHT_UPPER);
//--- Rotate 90 degrees counter-clockwise
ObjectSetDouble(0,text_name,OBJPROP_ANGLE,90);
//--- Forbid the selection of the object by mouse
ObjectSetInteger(0,text_name,OBJPROP_SELECTABLE,false);
//--- redraw object
ChartRedraw(0);
}
Graphical objects Arrow (OBJ_ARR OW ) have only 2 ways of linking their coordinates. Identifiers are
listed in ENUM _ARROW_ANCHOR.
ENUM_ARROW_ANCHOR
ID Description
void OnStart()
{
//--- Auxiliary arrays
double Ups[],Downs[];
datetime Time[];
//--- Set the arrays as timeseries
ArraySetAsSeries(Ups,true);
ArraySetAsSeries(Downs,true);
ArraySetAsSeries(Time,true);
//--- Create handle of the Indicator Fractals
int FractalsHandle=iFractals(NULL,0);
Print("FractalsHandle = ",FractalsHandle);
//--- Set Last error value to Zero
ResetLastError();
//--- Try to copy the values of the indicator
int copied=CopyBuffer(FractalsHandle,0,0,1000,Ups);
if(copied<=0)
{
Print("Unable to copy the upper fractals. Error = ",GetLastError());
return;
}
ResetLastError();
//--- Try to copy the values of the indicator
copied=CopyBuffer(FractalsHandle,1,0,1000,Downs);
if(copied<=0)
{
Print("Unable to copy the bottom fractals. Error = ",GetLastError());
return;
}
ResetLastError();
//--- Copy timeseries containing the opening bars of the last 1000 ones
copied=CopyTime(NULL,0,0,1000,Time);
if(copied<=0)
{
Print("Unable to copy the Opening Time of the last 1000 bars");
return;
}
After the script execution the chart will look like in this figure.
In order to specify the chart corner, from which X and Y coordinates will be measured in pixels, use
ObjectS etInteger(chartID, name, OBJPROP_CORNER, chart_corner), where:
ID Description
int width=(int)ChartGetInteger(0,CHART_WIDTH_IN_PIXELS,0);
string arrows[4]={"LEFT_UPPER","RIGHT_UPPER","RIGHT_LOWER","LEFT_LOWER"};
CreateLabel(0,arrows[0],CORNER_LEFT_UPPER,ANCHOR_LEFT_UPPER,arrows[0],50,50);
CreateLabel(0,arrows[1],CORNER_RIGHT_UPPER,ANCHOR_RIGHT_UPPER,arrows[1],50,50);
CreateLabel(0,arrows[2],CORNER_RIGHT_LOWER,ANCHOR_RIGHT_LOWER,arrows[2],50,50);
CreateLabel(0,arrows[3],CORNER_LEFT_LOWER,ANCHOR_LEFT_LOWER,arrows[3],50,50);
}
Visibility of Objects
The combination of object visibility flags determines chart timeframes, where the object is visible. To
set/get the value of the OBJPROP_TIM EFRAM ES property, you can use functions
ObjectS etInteger()/ObjectGetInteger().
ID Value Description
ID Value Description
void OnStart()
{
//---
string highlevel="PreviousDayHigh";
string lowlevel="PreviousDayLow";
double prevHigh; // The previous day High
double prevLow; // The previous day Low
double highs[],lows[]; // Arrays for High and Low
See also
ID Description
Example:
for(int i=0;i<ObjectsTotal(0);i++)
{
string currobj=ObjectName(0,i);
if((ObjectGetInteger(0,currobj,OBJPROP_TYPE)==OBJ_ELLIOTWAVE3) ||
((ObjectGetInteger(0,currobj,OBJPROP_TYPE)==OBJ_ELLIOTWAVE5)))
{
//--- set the marking level in INTERMEDIATE
ObjectSetInteger(0,currobj,OBJPROP_DEGREE,ELLIOTT_INTERMEDIATE);
//--- show lines between tops of waves
ObjectSetInteger(0,currobj,OBJPROP_DRAWLINES,true);
//--- set line color
ObjectSetInteger(0,currobj,OBJPROP_COLOR,clrBlue);
//--- set line width
ObjectSetInteger(0,currobj,OBJPROP_WIDTH,5);
//--- set description
ObjectSetString(0,currobj,OBJPROP_TEXT,"test script");
}
}
Gann Objects
For Gann Fan (OBJ_GANNFAN) and Gann Grid (OBJ_GANNGR ID) objects you can specify two values of
the ENUM _GANN_DIRECTION enumeration that sets the trend direction.
ENUM_GANN_DIRECTION
ID Description
void OnStart()
{
//---
string my_gann="OBJ_GANNFAN object";
if(ObjectFind(0,my_gann)<0)// Object not found
{
//--- Inform about the failure
Print("Object ",my_gann," not found. Error code = ",GetLastError());
//--- Get the maximal price of the chart
double chart_max_price=ChartGetDouble(0,CHART_PRICE_MAX,0);
//--- Get the minimal price of the chart
double chart_min_price=ChartGetDouble(0,CHART_PRICE_MIN,0);
//--- How many bars are shown in the chart?
int bars_on_chart=ChartGetInteger(0,CHART_VISIBLE_BARS);
//--- Create an array, to write the opening time of each bar to
datetime Time[];
//--- Arrange access to the array as that of timeseries
ArraySetAsSeries(Time,true);
//--- Now copy data of bars visible in the chart into this array
int times=CopyTime(NULL,0,0,bars_on_chart,Time);
if(times<=0)
{
Print("Could not copy the array with the open time!");
return;
}
//--- Preliminary preparations completed
Web Colors
The following color constants are defined for the color type:
Color can be set to an object using the ObjectS etInteger() function. For setting color to custom
indicators the PlotIndexS etInteger() function is used. For getting color values there are similar
functions ObjectGetInteger() and PlotIndexGetInteger().
Example:
Wingdings
Characters of W ingdings used with the OBJ_ARROW object:
void OnStart()
{
//---
string up_arrow="up_arrow";
datetime time=TimeCurrent();
double lastClose[1];
int close=CopyClose(Symbol(),Period(),0,1,lastClose); // Get the Close price
//--- If the price was obtained
if(close>0)
{
ObjectCreate(0,up_arrow,OBJ_ARROW,0,0,0,0,0); // Create an arrow
ObjectSetInteger(0,up_arrow,OBJPROP_ARROWCODE,241); // Set the arrow code
ObjectSetInteger(0,up_arrow,OBJPROP_TIME,time); // Set time
ObjectSetDouble(0,up_arrow,OBJPROP_PRICE,lastClose[0]);// Set price
ChartRedraw(0); // Draw arrow now
}
else
Print("Unable to get the latest Close price!");
}
Indicators Constants
There are 37 predefined technical indicators, which can be used in programs written in the MQL5
language. In addition, there is an opportunity to create custom indicators using the iCustom()
function. All constants required for that are divided into 5 groups :
· Price constants – for selecting the type of price or volume, on which an indicator is calculated;
· S moothing methods – built-in smoothing methods used in indicators ;
· Indicator lines – identifiers of indicator buffers when accessing indicator values using CopyBuffer();
· Drawing styles – for indicating one of 18 types of drawing and setting the line drawing style;
· Custom indicators properties are used in functions for working with custom indicators ;
· Types of indicators are used for specifying the type of technical indicator when creating a handle
using IndicatorCreate();
· Identifiers of data types are used for specifying the type of data passed in an array of the M qlParam
type into the IndicatorCreate() function.
Price Constants
Calculations of technical indicators require price values and/or values of volumes, on which
calculations will be performed. There are 7 predefined identifiers from the ENUM _APPLIED_PRICE
enumeration, used to specify the desired price base for calculations.
ENUM_APPLIED_PRICE
ID Description
ENUM_APPLIED_VOLUME
ID Description
To select a necessary variant for calculation, specify one of the values of the ENUM _S TO_PR ICE
enumeration.
ENUM_STO_PRICE
ID Description
Example:
#property indicator_separate_window
#property indicator_buffers 2
#property indicator_plots 2
//--- input parameters
input int RSIperiod=14; // Period for calculating the RSI
input int Smooth=8; // Smoothing period RSI
input ENUM_MA_METHOD meth=MODE_SMMA; // Method of smoothing
//---- plot RSI
#property indicator_label1 "RSI"
#property indicator_type1 DRAW_LINE
#property indicator_color1 clrRed
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
//---- plot RSI_Smoothed
#property indicator_label2 "RSI_Smoothed"
#property indicator_type2 DRAW_LINE
#property indicator_color2 clrNavy
#property indicator_style2 STYLE_SOLID
#property indicator_width2 1
//--- indicator buffers
double RSIBuffer[]; // Here we store the values of RSI
double RSI_SmoothedBuffer[]; // Here will be smoothed values of RSI
int RSIhandle; // Handle to the RSI indicator
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
void OnInit()
{
//--- indicator buffers mapping
SetIndexBuffer(0,RSIBuffer,INDICATOR_DATA);
SetIndexBuffer(1,RSI_SmoothedBuffer,INDICATOR_DATA);
IndicatorSetString(INDICATOR_SHORTNAME,"iRSI");
IndicatorSetInteger(INDICATOR_DIGITS,2);
//---
RSIhandle=iRSI(NULL,0,RSIperiod,PRICE_CLOSE);
//---
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const int begin,
const double &price[]
)
Smoothing Methods
Many technical indicators are based on various methods of the price series smoothing. S ome standard
technical indicators require specification of the smoothing type as an input parameter. For specifying
the desired type of smoothing, identifiers listed in the ENUM _M A_M ETHOD enumeration are used.
ENUM_MA_METHOD
ID Description
double ExtJaws[];
double ExtTeeth[];
double ExtLips[];
//---- handles for moving averages
int ExtJawsHandle;
int ExtTeethHandle;
int ExtLipsHandle;
//--- get MA's handles
ExtJawsHandle=iMA(NULL,0,JawsPeriod,0,MODE_SMMA,PRICE_MEDIAN);
ExtTeethHandle=iMA(NULL,0,TeethPeriod,0,MODE_SMMA,PRICE_MEDIAN);
ExtLipsHandle=iMA(NULL,0,LipsPeriod,0,MODE_SMMA,PRICE_MEDIAN);
Indicators Lines
S ome technical indicators have several buffers drawn in the chart. Numbering of indicator buffers
starts with 0. W hen copying indicator values using the CopyBuffer() function into an array of the
double type, for some indicators one may indicate the identifier of a copied buffer instead of its
number.
Identifiers of indicator lines permissible when copying values of iM ACD(), iRVI() and iS tochastic().
Constant Value Description
Identifiers of indicator lines permissible when copying values of ADX() and ADXW ().
Constant Value Description
Drawing Styles
W hen creating a custom indicator, you can specify one of 18 types of graphical plotting (as displayed
in the main chart window or a chart subwindow), whose values are specified in the ENUM _DRAW_TYPE
enumeration.
In one custom indicator, it is permissible to use any indicator building/drawing types. Each
construction type requires specification of one to five global arrays for storing data necessary for
drawing. These data arrays must be bound with indicator buffers using the S etIndexBuffer() function.
The type of data from ENUM _INDEXBUFFER_TYPE should be specified for each buffer.
Depending on the drawing style, you may need one to four value buffers (mark ed as
INDICATOR_DATA). If a style admits dynamic alternation of colors (all styles contain COLOR in their
names), then you'll need one more buffer of color (indicated type INDICATOR_COLOR_INDEX). The
color buffers are always bound after value buffers corresponding to the style.
ENUM_DRAW_TY PE
DRAW_NONE Not
1 0
drawn
DRAW_LINE Line 1 0
DRAW_SECTION S ection 1 0
DRAW_BARS Display
as a
4 0
sequence
of bars
DRAW_CANDL ES Display
as a
sequence
4 0
of
candlesti
cks
DRAW_COLOR_LINE Multicolo
1 1
red line
DRAW_COLOR_SECTION Multicolo
red 1 1
section
DRAW_COLOR_H IS TOGRAM Multicolo
red
histogra
1 1
m from
the zero
line
DRAW_COLOR_H IS TOGRAM 2 Multicolo
red
histogra
m of the 2 1
two
indicator
buffers
DRAW_COLOR_ARR OW Drawing
multicolo
1 1
red
arrows
DRAW_COLOR_ZIGZAG Multicolo
red 2 1
Zig Zag
DRAW_COLOR_BARS Multicolo
4 1
red bars
DRAW_COLOR_CANDL ES Multicolo
red
4 1
candlesti
cks
To refine the display of the selected drawing type identifiers listed in ENUM _PLOT _PR OPER T Y are
used.
For functions PlotIndexS etInteger() and PlotIndexGetInteger()
ENUM_PLOT_PROPERTY _INTEGER
which there is no
drawing
For the function PlotIndexS etS tring()
ENUM_PLOT_PROPERTY _STRING
5 styles can be used for drawing lines in custom indicators. They are valid only for the line thickness 0
or 1.
ENUM_LINE_STY LE
ID Description
To set the line drawing style and the type of drawing, the PlotIndexS etInteger() function is used. For
the Fibonacci extensions the thickness and drawing style of levels can be indicated using the
ObjectS etInteger() function.
Example:
#property indicator_chart_window
#property indicator_buffers 1
#property indicator_plots 1
//--- indicator buffers
double MABuffer[];
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
void OnInit()
{
//--- Bind the Array to the indicator buffer with index 0
SetIndexBuffer(0,MABuffer,INDICATOR_DATA);
//--- Set the line drawing
PlotIndexSetInteger(0,PLOT_DRAW_TYPE,DRAW_LINE);
//--- Set the style line
PlotIndexSetInteger(0,PLOT_LINE_STYLE,STYLE_DOT);
//--- Set line color
PlotIndexSetInteger(0,PLOT_LINE_COLOR,clrRed);
//--- Set line thickness
PlotIndexSetInteger(0,PLOT_LINE_WIDTH,1);
//--- Set labels for the line
PlotIndexSetString(0,PLOT_LABEL,"Moving Average");
//---
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
//---
for(int i=prev_calculated;i<rates_total;i++)
{
MABuffer[i]=close[i];
}
//--- return value of prev_calculated for next call
return(rates_total);
}
ID Description
ENUM_CUSTOMIND_PROPERTY _INTEGER
roce
ssor
com
man
d
#pro
pert
y
indi
cato
r_he
ight
)
INDICATOR_LEVELS Num int
ber
of
leve
ls in
the
indi
cato
r
win
dow
INDICATOR_LEVELCOLOR Colo color modifier = level number
r of
the
leve
l
line
INDICATOR_LEVELS TYLE S tyl ENUM _LINE_S T YL E modifier = level number
e of
the
leve
l
line
INDICATOR_LEVELW IDTH Thic int modifier = level number
k ne
ss
of
the
leve
l
line
can
only
be
writ
ten
by
the
Indi
cato
rS et
Inte
ger(
)
func
tion
ENUM_CUSTOMIND_PROPERTY _DOUBLE
ENUM_CUSTOMIND_PROPERTY _STRING
Identifier Indicator
IND_ALLIGATOR Alligator
IND_ENVELOPES Envelopes
IND_FRACTALS Fractals
Identifier Indicator
IND_VOLUM ES Volumes
TYPE_BOOL bool
TYPE_CHAR char
TYPE_UCHAR uchar
TYPE_SHORT short
TYPE_USHORT ushort
TYPE_COLOR color
TYPE_INT int
TYPE_UINT uint
TYPE_DATETIM E datetime
TYPE_LONG long
TYPE_ULONG ulong
TYPE_FLOAT float
TYPE_DOUBLE double
TYPE_S TRING string
Each element of the array describes the corresponding input parameter of a created technical
indicator, so the type and order of elements in the array must be strictly maintained in accordance
with the description.
Environment State
Constants describing the current runtime environment of an mql5-program are divided into groups :
· Client terminal properties – information about the client terminal;
· Executed MQL5-program properties – mql5 program properties, which help to control its execution;
· S ymbol properties – obtaining information about a symbol;
· Account properties – information about the current account;
· Testing S tatistics – results of Expert Advisor testing.
ENUM_TERMINAL_INFO_INTEGER
Call to TerminalInfoInteger(TERMINAL_KEYS TATE_XXX) returns the same state code of a key as the
GetKeyS tate() function in M SDN.
In the above example, the graphical resource looks the same on monitors with different resolution
characteristics. The size of control elements (buttons, dialog windows, etc.) corresponds to
personalization settings.
ENUM_TERMINAL_INFO_DOUBLE
File operations can be performed only in two directories ; corresponding paths can be obtained using
the request for TERMINAL_DATA_PATH and TERMINAL_COMMONDATA_PATH properties.
ENUM_TERMINAL_INFO_STRING
//+------------------------------------------------------------------+
//| Check_TerminalPaths.mq5 |
//| Copyright 2009, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "2009, MetaQuotes Software Corp."
#property link "https://www.mql5.com"
#property version "1.00"
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//---
Print("TERMINAL_PATH = ",TerminalInfoString(TERMINAL_PATH));
Print("TERMINAL_DATA_PATH = ",TerminalInfoString(TERMINAL_DATA_PATH));
Print("TERMINAL_COMMONDATA_PATH = ",TerminalInfoString(TERMINAL_COMMONDATA_PATH));
}
As result of the script execution in the Experts Journal you will see a messages, like the following:
given running
program
MQLInfoInteger(M
QL_LICENSE_TYP
E).
For information about the type of the running program, values of ENUM _PROGRAM _TYPE are used.
ENUM_PROGRAM_TY PE
Identifier Description
ENUM_LICENSE_TY PE
Identifier Description
ENUM_PROGRAM_TYPE mql_program=(ENUM_PROGRAM_TYPE)MQLInfoInteger(MQL_PROGRAM_TYPE);
switch(mql_program)
{
case PROGRAM_SCRIPT:
{
Print(__FILE__+" is script");
break;
}
case PROGRAM_EXPERT:
{
Print(__FILE__+" is Expert Advisor");
break;
}
case PROGRAM_INDICATOR:
{
Print(__FILE__+" is custom indicator");
break;
}
default:Print("MQL5 type value is ",mql_program);
//---
Print("MQLInfoInteger(MQL_MEMORY_LIMIT)=", MQLInfoInteger(MQL_MEMORY_LIMIT), " MB");
Print("MQLInfoInteger(MQL_MEMORY_USED)=", MQLInfoInteger(MQL_MEMORY_USED), " MB");
Print("MQLInfoInteger(MQL_HANDLES_USED)=", MQLInfoInteger(MQL_HANDLES_USED), " handles");
Symbol Properties
To obtain the current market information there are several functions : S ymbolInfoInteger(),
S ymbolInfoDouble() and S ymbolInfoS tring(). The first parameter is the symbol name, the values of the
second function parameter can be one of the identifiers of ENUM _SYM BOL_INFO_INTEGER,
ENUM _SYM BOL _INFO_DOUBL E and ENUM _SYM BOL _INFO_S T R ING.
The
ERR
_M A
RKE
T_N
OT_
SEL
ECT
ED
(430
2)
erro
r is
gen
erat
ed
for
othe
r
sym
bols
SYM BOL _SECTOR The ENUM _SYM BOL _SECTOR
sect
or
of
the
eco
nom
y to
whic
h
the
asse
t
belo
ngs
SYM BOL _INDUS T RY The ENUM _SYM BOL _INDUS T RY
indu
stry
or
the
eco
nom
y
bran
ch
to
whic
h
the
sym
bol
belo
ngs
SYM BOL _CUS TOM It is bool
a
cust
om
sym
bol –
the
sym
bol
has
bee
n
crea
ted
synt
heti
cally
bas
ed
on
othe
r
sym
bols
fro
m
the
Mar
k et
W at
ch
and
/or
exte
rnal
data
sour
ces
SYM BOL _BACKGR OUND_COLOR The color
colo
r of
the
bac
k gro
und
use
d
for
the
sym
bol
in
Mar
k et
W at
ch
SYM BOL _CHAR T _MODE The ENUM _SYM BOL _CHAR T _MODE
pric
e
type
use
d
for
gen
erat
ing
sym
bols
bars
,
i.e.
Bid
or
Last
SYM BOL _EXIS T S ym bool
bol
with
this
nam
e
exis
ts
SYM BOL _SEL ECT S ym bool
bol
is
sele
cted
in
Mar
k et
W at
ch
SYM BOL _VIS IBL E S ym bool
bol
is
visi
ble
in
Mar
k et
W at
ch.
S om
e
sym
bols
(mo
stly,
thes
e
are
cros
s
rate
s
requ
ired
for
calc
ulati
on
of
mar
gin
requ
ire
men
ts
or
prof
its
in
dep
osit
curr
ency
)
are
sele
cted
auto
mat
icall
y,
but
may
not
be
visi
ble
in
Mar
k et
W at
ch.
To
be
disp
laye
d
such
sym
bols
hav
e to
be
expl
icitl
y
sele
cted
.
SYM BOL _SESS ION_DEAL S Num long
ber
of
deal
s in
the
curr
ent
sess
ion
SYM BOL _SESS ION_BUY_ORDERS Num long
ber
of
Buy
orde
rs
at
the
mo
men
t
SYM BOL _SESS ION_SELL _ORDERS Num long
ber
of
S ell
orde
rs
at
the
mo
men
t
SYM BOL _VOL UM E Volu long
me
of
the
last
deal
SYM BOL _VOL UM EH IGH Max long
imal
day
volu
me
SYM BOL _VOL UM ELOW Mini long
mal
day
volu
me
SYM BOL _TIM E Tim datetime
e of
the
last
quot
e
SYM BOL _TIM E_M S C Tim long
e of
the
last
quot
e in
milli
seco
nds
sinc
e
197
0.01
.01
SYM BOL _DIGIT S Digi int
ts
afte
r a
deci
mal
poin
t
SYM BOL _S PREAD_FLOAT Indi bool
cati
on
of a
floa
ting
spre
ad
calc
ulati
on
mod
e
SYM BOL _T RADE_MODE Ord ENUM _SYM BOL _T RADE_MODE
er
exe
cuti
on
type
SYM BOL _S T AR T _TIM E Dat datetime
e of
the
sym
bol
trad
e
begi
nnin
g
(usu
ally
use
d
for
futu
res)
SYM BOL _EXPIRATION_TIM E Dat datetime
e of
the
sym
bol
trad
e
end
(usu
ally
use
d
for
futu
res)
on
mod
el
SYM BOL _SWAP_R OLLOVER3DAYS The ENUM _DAY_OF_WEEK
day
of
wee
k to
char
ge
3-
day
swa
p
rollo
ver
SYM BOL _M ARGIN_HEDGED_USE_L EG Calc bool
ulati
ng
hed
ging
mar
gin
usin
g
the
larg
er
leg
(Buy
or
S ell)
ON_
GTC
(Go
od
till
canc
eled
)
SYM BOL _OPTION_MODE Opti ENUM _SYM BOL _OPTION_MODE
on
type
SYM BOL _OPTION_R IGH T Opti ENUM _SYM BOL _OPTION_R IGH T
on
righ
t
(Call
/Put
)
For function S ymbolInfoDouble()
ENUM_SY MBOL_INFO_DOUBLE
option)
the
underlyi
ng
asset,
and the
option
seller is
obliged
to sell
or buy
the
appropr
iate
amount
of the
underlyi
ng
asset.
SYM BOL _POINT S ymbol double
point
value
SYM BOL _T RADE_TICK_VAL UE Value of double
SYM BOL
_T RADE
_TICK_V
AL UE_P
R OFIT
asset
that can
be used
for the
margin.
SYM BOL _VOL UM E_MIN Minimal double
volume
for a
deal
SYM BOL _VOL UM E_M AX Maxima double
l
volume
for a
deal
SYM BOL _VOL UM E_S T EP Minimal double
volume
change
step for
deal
executi
on
SYM BOL _VOL UM E_LIMIT Maximu double
m
allowed
aggrega
te
volume
of an
open
position
and
pending
orders
in one
directio
n (buy
or sell)
for the
symbol.
For
exampl
e, with
the
limitati
on of 5
lots,
you can
have an
open
buy
position
with the
volume
of 5 lots
and
place a
pending
order
S ell
Limit
with the
volume
of 5
lots.
But in
this
case
you
cannot
place a
Buy
Limit
pending
order
(since
the
total
volume
in one
directio
n will
exceed
the
limitati
on) or
place
S ell
Limit
with the
volume
more
than 5
lots.
g
e
d
· 1
–
s
i
n
g
l
e
s
w
a
p
· 3
–
t
r
i
p
l
e
s
w
a
p
SYM BOL _SWAP_MONDAY S wap double
calculati
on ratio
(SYM BO
L_SWAP
_LONG
or
SYM BOL
_SWAP_
SH OR T)
for
overnig
ht
position
s rolled
over
from
Monday
to
Tuesday
_LONG
or
SYM BOL
_SWAP_
SH OR T)
for
overnig
ht
position
s rolled
over
from
Thursda
y to
Friday
overnig
ht
position
s rolled
over
from
S aturda
y to
S unday
The
S ymbolI
nfoMarg
inRate()
function
provide
s data
on the
amount
of
charged
margin
dependi
ng on
the
order
type
and
directio
n.
SYM BOL _M ARGIN_M AINT ENANCE The double
mainten
ance
margin.
If it is
set, it
sets the
margin
amount
in the
margin
currenc
y of the
symbol,
charged
from
one lot.
It is
used for
checkin
g a
client's
assets
when
his /her
account
state
changes
. If the
mainten
ance
margin
is equal
to 0,
the
initial
margin
is used.
The
S ymbolI
nfoMarg
inRate()
function
provide
s data
on the
amount
of
charged
margin
dependi
ng on
the
order
type
and
directio
n.
SYM BOL _SESS ION_VOL UM E S ummar double
y
volume
of
current
session
deals
SYM BOL _SESS ION_T URNOVER S ummar double
y
turnove
r of the
current
session
SYM BOL _SESS ION_INT ERES T S ummar double
y open
interest
SYM BOL _SESS ION_BUY_ORDERS_VOL UM E Current double
volume
of Buy
orders
SYM BOL _SESS ION_SELL _ORDERS_VOL UM E Current double
volume
of S ell
orders
s of one
symbol)
. Two
margin
calculati
on
method
s are
possible
for
hedged
position
s. The
calculati
on
method
is
defined
by the
broker.
Basic
calculati
on:
· If the
initial
margi
n
(SYM
BOL _
M ARG
IN_INI
TIAL)
is
specif
ied
for a
symb
ol,
the
hedge
d
margi
n is
specif
ied as
an
absol
ute
value
(in
mone
tary
terms
).
· If the
initial
margi
n is
not
specif
ied
(equa
l to
0),
SYM B
OL_M
ARGI
N_HE
DGED
is
equal
to the
size
of the
contr
act,
that
will
be
used
to
calcul
ate
the
margi
n by
the
appro
priate
formu
la in
accor
dance
with
the
type
of the
finan
cial
instru
ment
(SYM
BOL _
TRAD
E_CA
LC_M
ODE).
Calculat
ion for
the
largest
position
:
· The
SYM B
OL_M
ARGI
N_HE
DGED
value
is not
taken
into
accou
nt.
· The
volum
e of
all
short
and
all
long
positi
ons
of a
symb
ol is
calcul
ated.
· For
each
direct
ion, a
weigh
ted
avera
ge
open
price
and a
weigh
ted
avera
ge
rate
of
conve
rsion
to the
depos
it
curre
ncy is
calcul
ated.
· Next,
using
the
appro
priate
formu
la
chose
n in
accor
dance
with
the
symb
ol
type
(SYM
BOL _
TRAD
E_CA
LC_M
ODE)
the
margi
n is
calcul
ated
for
the
short
and
the
long
part.
· The
larges
t one
of the
value
s is
used
as
the
margi
n.
SYM BOL _PR ICE_CHANGE Change double
of the
current
price
relative
to the
end of
the
previou
s
trading
day in %
SYM BOL _PR ICE_VOL ATILIT Y Price double
volatilit
y in %
SYM BOL _PR ICE_T HEORETICAL Theoret double
ical
option
price
SYM BOL _PR ICE_DELT A Option/ double
warrant
delta
shows
the
value
the
option
price
changes
by,
when
the
underlyi
ng
asset
price
changes
by 1
SYM BOL _PR ICE_T HET A Option/ double
warrant
theta
shows
the
number
of
points
the
option
price is
to lose
every
day due
to a
tempor
ary
breakup
, i.e.
when
the
expirati
on date
approac
hes
SYM BOL _PR ICE_GAMM A Option/ double
warrant
gamma
shows
the
change
rate of
delta –
how
quick ly
or
slowly
the
option
premiu
m
changes
SYM BOL _PR ICE_VEGA Option/ double
warrant
vega
shows
the
number
of
points
the
option
price
changes
by when
the
volatilit
y
changes
by 1%
SYM BOL _PR ICE_RH O Option/ double
warrant
rho
reflects
the
sensitiv
ity of
the
theoreti
cal
option
price to
the
interest
rate
changin
g by 1%
SYM BOL _PR ICE_OM EGA Option/ double
warrant
omega.
Option
elasticit
y shows
a
relative
percent
age
change
of the
option
price by
the
percent
age
change
of the
underlyi
ng
asset
price
SYM BOL _PR ICE_SENS ITIVIT Y Option/ double
warrant
sensitiv
ity
shows
by how
many
points
the
price of
the
option's
underlyi
ng
asset
should
change
so that
the
price of
the
option
changes
by one
point
For function S ymbolInfoS tring()
ENUM_SY MBOL_INFO_STRING
should be
used
around
this
symbol
name.
· S
y
n
t
h
e
t
i
c
s
y
m
b
o
l
:
"
@
E
S
U
1
9
"
/
E
U
R
C
A
D
· C
a
l
e
n
d
a
r
s
p
r
e
a
d
:
"
S
i
-
9
.
1
3
"
-
"
S
i
-
6
.
1
3
"
· E
u
r
o
i
n
d
e
x
:
3
4
.
3
8
8
0
5
7
2
6
*
p
o
w
(
E
U
R
U
S
D
,
0
.
3
1
5
5
)
*
p
o
w
(
E
U
R
G
B
P
,
0
.
3
0
5
6
)
*
p
o
w
(
E
U
R
J
P
Y
,
0
.
1
8
9
1
)
*
p
o
w
(
E
U
R
C
H
F
,
0
.
1
1
1
3
)
*
p
o
w
(
E
U
R
S
E
K
,
0
.
0
7
8
5
)
SYM BOL _IS IN The name string
of a
symbol in
the IS IN
system
(Internati
onal
S ecurities
Identificat
ion
Number).
The
Internatio
nal
S ecurities
Identificat
ion
Number is
a 12-digit
alphanum
eric code
that
uniquely
identifies
a
security.
The
presence
of this
symbol
property
is
determine
d on the
side of a
trade
server.
SYM BOL _PAGE The string
address of
the web
page
containing
symbol
informati
on. This
address
will be
displayed
as a link
when
viewing
symbol
properties
in the
terminal
SYM BOL _PAT H Path in string
the
symbol
tree
A symbol price chart can be based on Bid or Last prices. The price selected for symbol charts also
affects the generation and display of bars in the terminal. Possible values of the
SYM BOL _CHAR T _MODE property are described in ENUM _SYM BOL _CHAR T _MODE
ENUM_SY MBOL_CHART_MODE
Identifier Description
For each symbol several expiration modes of pending orders can be specified. A flag is matched to
each mode. Flags can be combined using the operation of logical OR (|), for example,
SYM BOL _EXPIRATION_GTC|SYM BOL _EXPIRATION_S PECIFIED. In order to check whether a certain mode
is allowed for the symbol, the result of the logical AND (&) should be compared to the mode flag.
If flag SYM BOL_EXPIRATION_S PECIFIED is specified for a symbol, then while sending a pending order,
you may specify the moment this pending order is valid till.
Identifier Value Description
//+------------------------------------------------------------------+
//| Checks if the specified expiration mode is allowed |
//+------------------------------------------------------------------+
bool IsExpirationTypeAllowed(string symbol,int exp_type)
{
//--- Obtain the value of the property that describes allowed expiration modes
int expiration=(int)SymbolInfoInteger(symbol,SYMBOL_EXPIRATION_MODE);
//--- Return true, if mode exp_type is allowed
return((expiration&exp_type)==exp_type);
}
If the SYM BOL_EXPIRATION_MODE property is set to SYM BOL_EXPIRATION_GTC (good till canceled),
the expiration of pending orders, as well as of S top Loss /Take Profit orders should be additionally set
using the ENUM _SYM BOL_ORDER_GTC_MODE enumeration.
ENUM_SY MBOL_ORDER_GTC_MODE
Identifier Description
SYM BOL _ORDERS_GTC Pending orders and S top Loss /Take Profit levels
are valid for an unlimited period until their
explicit cancellation
SYM BOL _ORDERS_DAIL Y Orders are valid during one trading day. At the
end of the day, all S top Loss and Take Profit
levels, as well as pending orders are deleted.
SYM BOL _ORDERS_DAIL Y_EXCL UDING_S TOPS W hen a trade day changes, only pending orders
are deleted, while S top Loss and Take Profit levels
are preserved.
W hen sending an order, we can specify the filling policy of a volume set in the order. The possible
volume-based order execution options for each symbol are specified in the table. It is possible to set
several modes for each instrument via a combination of flags. The combination of flags is expressed
by the logical OR (|) operation, for example SYM BOL_FILLING_FOK|SYM BOL_FILLING_IOC. To check if
a specific mode is allowed for an instrument, compare the logical AND (&) result with the mode flag -
example.
Fill policy ID Value D
e
s
c
r
i
p
ti
o
n
o
r
d
e
r
c
a
n
b
e
e
x
e
c
u
t
e
d
i
n
t
h
e
s
p
e
c
if
i
e
d
v
o
l
u
m
e
o
n
ly
.
If
t
h
e
n
e
c
e
s
s
a
r
y
a
m
o
u
n
t
o
f
a
fi
n
a
n
c
i
a
l
i
n
s
t
r
u
m
e
n
t
i
s
c
u
r
r
e
n
tl
y
u
n
a
v
a
il
a
b
l
e
i
n
t
h
e
m
a
r
k
e
t
,
t
h
e
o
r
d
e
r
w
il
l
n
o
t
b
e
e
x
e
c
u
t
e
d
.
T
h
e
d
e
s
ir
e
d
v
o
l
u
m
e
c
a
n
b
e
m
a
d
e
u
p
o
f
s
e
v
e
r
a
l
a
v
a
il
a
b
l
e
o
f
f
e
r
s
.
W
h
e
n
s
e
n
d
i
n
g
a
n
o
r
d
e
r
,
t
h
e
O
R
D
E
R
_
F
I
L
L
I
N
G
_
F
O
K
fi
ll
i
n
g
t
y
p
e
s
h
o
u
l
d
b
e
s
p
e
c
if
i
e
d
f
o
r
t
h
i
s
p
o
li
c
y
.
T
h
e
p
o
s
s
i
b
i
l
i
t
y
o
f
u
s
i
n
g
F
O
K
o
r
d
e
r
s
i
s
d
e
t
e
r
m
i
n
e
d
a
t
t
h
e
t
r
a
d
e
s
e
r
v
e
r
.
Immediate or Cancel SYM BOL _FILLING_IOC 2 A
t
r
a
d
e
r
a
g
r
e
e
s
t
o
e
x
e
c
u
t
e
a
d
e
a
l
w
it
h
t
h
e
v
o
l
u
m
e
m
a
x
i
m
a
ll
y
a
v
a
il
a
b
l
e
i
n
t
h
e
m
a
r
k
e
t
w
it
h
i
n
t
h
a
t
i
n
d
i
c
a
t
e
d
i
n
t
h
e
o
r
d
e
r
.
If
t
h
e
r
e
q
u
e
s
t
c
a
n
n
o
t
b
e
fi
ll
e
d
c
o
m
p
l
e
t
e
ly
,
a
n
o
r
d
e
r
w
it
h
t
h
e
a
v
a
il
a
b
l
e
v
o
l
u
m
e
w
il
l
b
e
e
x
e
c
u
t
e
d
,
a
n
d
t
h
e
r
e
m
a
i
n
i
n
g
v
o
l
u
m
e
w
il
l
b
e
c
a
n
c
e
l
e
d
.
W
h
e
n
s
e
n
d
i
n
g
a
n
o
r
d
e
r
,
t
h
e
O
R
D
E
R
_
F
I
L
L
I
N
G
_
I
O
C
fi
ll
i
n
g
t
y
p
e
s
h
o
u
l
d
b
e
s
p
e
c
if
i
e
d
f
o
r
t
h
i
s
p
o
li
c
y
.
T
h
e
p
o
s
s
i
b
il
it
y
o
f
u
s
i
n
g
I
O
C
o
r
d
e
r
s
i
s
d
e
t
e
r
m
i
n
e
d
a
t
t
h
e
t
r
a
d
e
s
e
r
v
e
r
.
Passive SYM BOL _FILLING_BOC 4 T
h
e
B
O
C
(
B
o
o
k
-
o
r
-
C
a
n
c
e
l
)
p
o
l
i
c
y
a
s
s
u
m
e
s
t
h
a
t
a
n
o
r
d
e
r
c
a
n
o
n
l
y
b
e
p
l
a
c
e
d
i
n
t
h
e
D
e
p
t
h
o
f
M
a
r
k
e
t
a
n
d
c
a
n
n
o
t
b
e
i
m
m
e
d
i
a
t
e
l
y
e
x
e
c
u
t
e
d
.
I
f
t
h
e
o
r
d
e
r
c
a
n
b
e
e
x
e
c
u
t
e
d
i
m
m
e
d
i
a
t
e
l
y
w
h
e
n
p
l
a
c
e
d
,
t
h
e
n
i
t
i
s
c
a
n
c
e
l
e
d
.
I
n
f
a
c
t
,
t
h
i
s
e
x
e
c
u
t
i
o
n
p
o
l
i
c
y
c
a
n
o
n
l
y
b
e
s
p
e
c
i
f
i
e
d
w
h
e
n
t
h
e
p
r
i
c
e
o
f
t
h
e
p
l
a
c
e
d
o
r
d
e
r
i
s
t
o
b
e
w
o
r
s
e
t
h
a
n
t
h
e
c
u
r
r
e
n
t
m
a
r
k
e
t
.
B
o
C
o
r
d
e
r
s
a
r
e
u
s
e
d
t
o
i
m
p
l
e
m
e
n
t
p
a
s
s
i
v
e
t
r
a
d
i
n
g
,
s
o
t
h
a
t
t
h
e
o
r
d
e
r
i
s
n
o
t
e
x
e
c
u
t
e
d
i
m
m
e
d
i
a
t
e
l
y
w
h
e
n
p
l
a
c
e
d
a
n
d
d
o
e
s
n
o
t
a
f
f
e
c
t
c
u
r
r
e
n
t
l
i
q
u
i
d
i
t
y
.
O
n
l
y
l
i
m
i
t
a
n
d
s
t
o
p
l
i
m
i
t
o
r
d
e
r
s
a
r
e
s
u
p
p
o
r
t
e
d
,
i
.
e
.
t
h
e
S
Y
M
B
O
L
_
O
R
D
E
R
_
M
O
D
E
f
l
a
g
s
h
o
u
l
d
c
o
n
t
a
i
n
t
h
e
S
Y
M
B
O
L
_
O
R
D
E
R
_
L
I
M
I
T
a
n
d
/
o
r
S
Y
M
B
O
L
_
O
R
D
E
R
_
S
T
O
P
_
L
I
M
I
T
v
a
l
u
e
s
.
R eturn No identifier I
n
c
a
s
e
o
f
p
a
r
ti
a
l
fi
ll
i
n
g
,
a
m
a
r
k
e
t
o
r
li
m
it
o
r
d
e
r
w
it
h
r
e
m
a
i
n
i
n
g
v
o
l
u
m
e
i
s
n
o
t
c
a
n
c
e
l
e
d
b
u
t
p
r
o
c
e
s
s
e
d
f
u
r
t
h
e
r
.
W
h
e
n
s
e
n
d
i
n
g
a
n
o
r
d
e
r
,
t
h
e
O
R
D
E
R
_
F
I
L
L
I
N
G
_
R
E
T
U
R
N
fi
ll
i
n
g
t
y
p
e
s
h
o
u
l
d
b
e
s
p
e
c
if
i
e
d
f
o
r
t
h
i
s
p
o
li
c
y
.
R
e
t
u
r
n
o
r
d
e
r
s
a
r
e
n
o
t
a
l
l
o
w
e
d
i
n
t
h
e
M
a
r
k
e
t
E
x
e
c
u
t
i
o
n
m
o
d
e
(
m
a
r
k
e
t
e
x
e
c
u
t
i
o
n
—
S
Y
M
B
O
L
_
T
R
A
D
E
_
E
X
E
C
U
T
I
O
N
_
M
A
R
K
E
T
)
.
W hen sending a trade request using the OrderS end() function, the necessary volume execution policy
can be set in the type_filling field, namely in the special M qlTradeRequest structure. The values from
the ENUM _ORDER_TYPE_FILLING enumeration are available. If no filling type is specified,
ORDER_FILLING_RETURN is automatically set in the trade request. The ORDER_FILLING_RETURN filling
Prices
for a
certain
market
order
are
request
ed
from
the
broker
before
the
order
is sent.
Upon
receivi
ng the
prices,
order
executi
on at
the
given
price
can be
either
confir
med or
rejecte
d.
Instant Execution Executi SYM BOL _T RADE_EXECUTION_INS T ANT
ng a
market
order
at the
specifi
ed
price
immedi
ately.
W hen
sendin
g a
trade
request
to be
execut
ed, the
platfor
m
automa
tically
adds
the
current
prices
to the
order.
· I
f
t
h
e
b
r
o
k
e
r
a
c
c
e
p
t
s
t
h
e
p
r
i
c
e
,
t
h
e
o
r
d
e
r
i
s
e
x
e
c
u
t
e
d
.
· I
f
t
h
e
b
r
o
k
e
r
d
o
e
s
n
o
t
a
c
c
e
p
t
t
h
e
r
e
q
u
e
s
t
e
d
p
r
i
c
e
,
a
"
R
e
q
u
o
t
e
"
i
s
s
e
n
t
—
t
h
e
b
r
o
k
e
r
r
e
t
u
r
n
s
p
r
i
c
e
s
,
a
t
w
h
i
c
h
t
h
i
s
o
r
d
e
r
c
a
n
b
e
e
x
e
c
u
t
e
d
.
Market Execution A SYM BOL _T RADE_EXECUTION_M ARKET
broker
makes
a
decisio
n about
the
order
executi
on
price
without
any
additio
nal
discuss
ion
with
the
trader.
S endin
g the
order
in such
a mode
means
advanc
e
consen
t to its
executi
on at
this
price.
Exchange Execution Trade SYM BOL _T RADE_EXECUTION_EXCHANGE
operati
ons are
execut
ed at
the
prices
of the
current
market
offers.
Before sending an order with the current execution time, for the correct setting of the
ORDER_TYPE_FILLING value (volume execution type), you can use the S ymbolInfoInteger() function
with each financial instrument to get the SYM BOL_FILLING_MODE property value, which shows volume
execution types allowed for the symbol as a combination of flags. The ORDER_FILLING_RETURN filling
type is enabled at all times except for the " Market execution" mode
(SYM BOL_TRADE_EXECUTION_M ARKET).
The use of filling types depending on the execution mode can be shown as the following table:
Type of Execution\Fill Policy Fill or Kill (FOK Immediate or Return (Return
ORDER_FILLIN Cancel (IOC ORDER_FILLING
G_FOK) ORDER_FILLING _RETURN)
_IOC)
//+------------------------------------------------------------------+
//| check if a given filling mode is allowed |
//+------------------------------------------------------------------+
bool IsFillingTypeAllowed(string symbol,int fill_type)
{
//--- get the value of the property describing the filling mode
int filling=(int)SymbolInfoInteger(symbol,SYMBOL_FILLING_MODE);
//--- return 'true' if the fill_type mode is allowed
return((filling&fill_type)==fill_type);
}
W hen sending a trade request using OrderS end() function, an order type from ENUM _ORDER_TYPE
enumeration should be specified for some operations. Not all types of orders may be allowed for a
specific symbol. SYM BOL_ORDER_MODE property describes the flags of the allowed order types.
Identifier Value Description
SYM BOL _ORDER_M ARKET 1 Market orders are allowed (Buy and
S ell)
Example:
//+------------------------------------------------------------------+
//| The function prints out order types allowed for a symbol |
//+------------------------------------------------------------------+
void Check_SYMBOL_ORDER_MODE(string symbol)
{
//--- receive the value of the property describing allowed order types
int symbol_order_mode=(int)SymbolInfoInteger(symbol,SYMBOL_ORDER_MODE);
//--- check for market orders (Market Execution)
if((SYMBOL_ORDER_MARKET&symbol_order_mode)==SYMBOL_ORDER_MARKET)
Print(symbol+": Market orders are allowed (Buy and Sell)");
//--- check for Limit orders
if((SYMBOL_ORDER_LIMIT&symbol_order_mode)==SYMBOL_ORDER_LIMIT)
Print(symbol+": Buy Limit and Sell Limit orders are allowed");
//--- check for Stop orders
if((SYMBOL_ORDER_STOP&symbol_order_mode)==SYMBOL_ORDER_STOP)
Print(symbol+": Buy Stop and Sell Stop orders are allowed");
The ENUM _SYM BOL_CALC_MODE enumeration is used for obtaining information about how the margin
requirements for a symbol are calculated.
ENUM_SY MBOL_CALC_MODE
marg
in
for
Fore
x
symb
ols
with
out
takin
g
into
acco
unt
the
lever
age
SYM BOL _CALC_MODE_FUT URES Futur Margin: Lots * InitialMargin * Margin_Rate
es
mod Profit: (close_price - open_price) * TickPrice /
e - TickS ize*Lots
calcu
latio
n of
marg
in
and
profi
t for
futur
es
SYM BOL _CALC_MODE_CFD CFD Margin: Lots * ContractS ize * MarketPrice *
mod Margin_Rate
e -
calcu Profit: (close_price - open_price) * Contract_S ize *
latio Lots
n of
marg
in
and
profi
t for
CFD
SYM BOL _CALC_MODE_CFDINDEX CFD Margin: (Lots * ContractS ize * MarketPrice) *
inde TickPrice / TickS ize * Margin_Rate
x
mod Profit: (close_price - open_price) * Contract_S ize *
e - Lots
calcu
latio
n of
marg
in
and
profi
t for
CFD
by
inde
xes
SYM BOL _CALC_MODE_CFDL EVERAGE CFD Margin: (Lots * ContractS ize * MarketPrice) /
Leve Leverage * Margin_Rate
rage
mod Profit: (close_price-open_price) * Contract_S ize *
e - Lots
calcu
latio
n of
marg
in
and
profi
t for
CFD
at
lever
age
tradi
ng
SYM BOL _CALC_MODE_EXCH_S TOCKS Exch Margin: Lots * ContractS ize * LastPrice *
ange Margin_Rate
mod
e – Profit: (close_price - open_price) * Contract_S ize *
calcu Lots
latio
n of
marg
in
and
profi
t for
tradi
ng
secur
ities
on a
stock
exch
ange
SYM BOL _CALC_MODE_EXCH_FUT URE Futur Margin: Lots * InitialMargin * Margin_Rate or Lots *
S es MaintenanceMargin * Margin_Rate
mod
e – Profit: (close_price - open_price) * Lots * TickPrice
calcu / TickS ize
latio
n of
marg
in
and
profi
t for
tradi
ng
futur
es
contr
acts
on a
stock
exch
ange
SYM BOL _CALC_MODE_EXCH_FUT URE FO R Margin: Lots * InitialMargin * Margin_Rate or Lots *
S_FOR T S TS MaintenanceMargin * Margin_Rate * Margin_Rate
Futur
es Profit: (close_price - open_price) * Lots * TickPrice
mod / TickS ize
e –
calcu
latio
n of
marg
in
and
profi
t for
tradi
ng
futur
es
contr
acts
on
FO R
TS .
The
marg
in
may
be
redu
ced
by
the
amo
unt
of
Marg
inDis
coun
t
devi
ation
accor
ding
to
the
follo
wing
rules
:
1. If
the
price
of a
long
posit
ion
(buy
order
) is
less
than
the
esti
mate
d
price
,
Marg
inDis
coun
t =
Lots *
((Pri
ceS e
ttle-
Price
Orde
r)
*Tick
Price
/Tic
kS ize
)
2. If
the
price
of a
short
posit
ion
(sell
order
)
exce
eds
the
esti
mate
d
price
,
Marg
inDis
coun
t =
Lots *
((Pri
ceOr
der-
Price
S ettl
e)
*Tick
Price
/Tic
kS ize
)
wher
e:
oP
r
i
c
e
S
e
t
t
l
e
–
e
s
t
i
m
a
t
e
d
(
c
l
e
a
r
i
n
g
)
p
r
i
c
e
o
f
t
h
e
p
r
e
v
i
o
u
s
s
e
s
s
i
o
n
;
oP
r
i
c
e
O
r
d
e
r
–
a
v
e
r
a
g
e
w
e
i
g
h
t
e
d
p
o
s
i
t
i
o
n
p
r
i
c
e
o
r
o
p
e
n
p
r
i
c
e
s
e
t
i
n
t
h
e
o
r
d
e
r
(
r
e
q
u
e
s
t
)
;
oT
i
c
k
P
r
i
c
e
–
t
i
c
k
p
r
i
c
e
(
c
o
s
t
o
f
t
h
e
p
r
i
c
e
c
h
a
n
g
e
b
y
o
n
e
p
o
i
n
t
)
oT
i
c
k
S
i
z
e
–
t
i
c
k
s
i
z
e
(
m
i
n
i
m
u
m
p
r
i
c
e
c
h
a
n
g
e
s
t
e
p
)
SYM BOL _CALC_MODE_EXCH_BONDS Exch Margin: Lots * ContractS ize * FaceValue *
ange open_price * /100
Bond
s
the
volu
me,
curre
nt
mark
et
price
,
contr
act
size
and
liqui
dity
ratio
. The
value
is
inclu
ded
into
Asse
ts,
whic
h are
adde
d to
Equit
y.
Open
posit
ions
of
such
symb
ols
incre
ase
the
Free
Marg
in
amo
unt
and
are
used
as
addit
ional
marg
in
(colla
teral
) for
open
posit
ions
of
trada
ble
instr
ume
nts.
There are several symbol trading modes. Information about trading modes of a certain symbol is
reflected in the values of enumeration ENUM _SYM BOL_TRADE_MODE.
ENUM_SY MBOL_TRADE_MODE
Identifier Description
Possible deal execution modes for a certain symbol are defined in enumeration
ENUM _SYM BOL _T RADE_EXECUTION.
Identifier Description
Identifier Description
Identifier Description
Values of the ENUM _DAY_OF_WEEK enumeration are used for specifying days of week.
ENUM_DAY _OF_WEEK
Identifier Description
SUNDAY S unday
MONDAY Monday
TUESDAY Tuesday
WEDNESDAY W ednesday
THURSDAY Thursday
FR IDAY Friday
An option isa contract, which gives the right, but not the obligation, to buy or sell an underlying asset
(goods, stocks, futures, etc.) at a specified price on or before a specific date. The following
enumerations describe option properties, including the option type and the right arising from it.
ENUM_SY MBOL_OPTION_RIGHT
Identifier Description
SYM BOL _OPTION_R IGH T _CALL A call option gives you the right to buy an asset at
a specified price
SYM BOL _OPTION_R IGH T _PUT A put option gives you the right to sell an asset at
a specified price
ENUM_SY MBOL_OPTION_MODE
Identifier Description
ID Description
SECTOR_UNDEFINED Undefined
SECTOR_FINANCIAL Finance
Each financial instrument can be assigned to a specific type of industry or economy branch. An
industry is a branch of an economy that produces a closely related set of raw materials, goods, or
services. ENUM _SYM BOL_INDUS TRY lists industries which a trading instrument can belong to.
ID Description
Basic materials
ID Description
Communication services
INDUS TRY_ADVERTIS ING Advertising agencies
INDUS TRY_BROADCAS TING Broadcasting
ID Description
ID Description
Finance
H ealthcare
ID Description
R eal estate
ID Description
Utilities
ID Description
Account Properties
To obtain information about the current account there are several functions : AccountInfoInteger(),
AccountInfoDouble() and AccountInfoS tring(). The function parameter values can accept values from
the corresponding ENUM _ACCOUNT_INFO enumerations.
For the function AccountInfoInteger()
ENUM_ACCOUNT_INFO_INTEGER
same
order,
in
which
they
are
opened
,
starting
with
the
oldest
one. In
case of
an
attemp
t to
close
positio
ns in a
differe
nt
order,
the
trader
will
receive
an
appropr
iate
error.
For
account
s with
the
non-
hedging
positio
n
account
ing
mode
(ACCOU
NT _M A
RGIN_M
ODE!=A
CCOUN
T_M AR
GIN_M
ODE_RE
TAIL_H
EDGING
), the
propert
y value
is
always
false.
ACCOUNT _HEDGE_ALLOWED Allowed bool
opposit
e
positio
ns on a
single
symbol
For the function AccountInfoDouble()
ENUM_ACCOUNT_INFO_DOUBLE
minimu
m
amount
of all
open
positio
ns
ACCOUNT _ASSET S The double
current
assets
of an
account
ACCOUNT _LIABILITIES The double
current
liabiliti
es on
an
account
ACCOUNT _COMMISS ION_BLOCKED The double
current
blocked
commis
sion
amount
on an
account
For function AccountInfoS tring()
ENUM_ACCOUNT_INFO_STRING
y that
serves
the
account
There are several types of accounts that can be opened on a trade server. The type of account on
which an MQL5 program is running can be found out using the ENUM _ACCOUNT_TRADE_MODE
enumeration.
ENUM_ACCOUNT_TRADE_MODE
Identifier Description
In case equity is not enough for maintaining open positions, the S top Out situation, i.e. forced closing
occurs. The minimum margin level at which S top Out occurs can be set in percentage or in monetary
terms. To find out the mode set for the account use the ENUM _ACCOUNT_S TOPOUT_MODE
enumeration.
ENUM_ACCOUNT_STOPOUT_MODE
Identifier Description
ENUM_ACCOUNT_MARGIN_MODE
Identifier Description
ACCOUNT _M ARGIN_MODE_RET AIL _NETTING Used for the OTC markets to interpret
positions in the " netting" mode (only one
position can exist for one symbol). The margin
is calculated based on the symbol type
(SYM BOL_TRADE_CALC_MODE).
ACCOUNT _M ARGIN_MODE_EXCHANGE Used for the exchange markets. Margin is
calculated based on the discounts specified in
symbol settings. Discounts are set by the
broker, but not less than the values set by the
exchange.
ACCOUNT _M ARGIN_MODE_RET AIL _HEDGING Used for the exchange markets where
individual positions are possible (hedging,
multiple positions can exist for one symbol).
The margin is calculated based on the symbol
Identifier Description
PrintFormat("MarginCall=%G, StopOut=%G",margin_call,stop_out);
}
Testing Statistics
After the testing is over, different parameters of the trading results statistics are calculated. The
values of the parameters can be obtained using the TesterS tatistics() function, by specifying the
parameter ID from the ENUM _S TATIS TICS enumeration.
Although two types of parameters (int and double) are used for calculating statistics, the function
returns all values in the double form. All the statistic values of the double type are expressed in the
deposit currency by default, unless otherwise specified.
ENUM_STATISTICS
ID Description of a Type
statistic parameter
ID Description of a Type
statistic parameter
ID Description of a Type
statistic parameter
ID Description of a Type
statistic parameter
terms
(S TAT_EQUITY_DD).
S T AT _EQUIT Y_DDREL _PER CENT Maximum equity double
drawdown as a
percentage. In the
process of trading, an
equity may have
numerous drawdowns,
for each of which the
relative drawdown
value in percents is
calculated. The
greatest value is
returned
S T AT _EQUIT Y_DD_REL ATIVE Equity drawdown in double
monetary terms that
was recorded at the
moment of the
maximum equity
drawdown in percent
(S TAT_EQUITY_DDREL
_PER CENT).
ID Description of a Type
statistic parameter
Trade Constants
Various constants used for programming trading strategies are divided into the following groups :
· H istory Database Properties – receiving general information on a symbol;
· Order properties – obtaining information about trade orders ;
· Position properties – obtaining information about current positions ;
· Deal properties – obtaining information about deals ;
· Trade operation types – description of trade operations available;
· Trade transaction types - description of possible trade transactions types ;
· Trade orders in DOM – separation of orders according to the direction of a requested operation.
Order Properties
R equests to execute trade operations are formalized as orders. Each order has a variety of properties
for reading. Information on them can be obtained using functions OrderGet...() and
H istoryOrderGet...().
W hen sendinga trade request using the OrderS end() function, some operations require the indication
of the order type. The order type is specified in the type field of the special structure
M qlTradeRequest, and can accept values of the ENUM _ORDER_TYPE enumeration.
ENUM_ORDER_TY PE
Identifier Description
Identifier Description
Each order has a status that describes its state. To obtain information, use OrderGetInteger() or
H istoryOrderGetInteger() with the ORDER_S T AT E modifier. Allowed values are stored in the
ENUM _ORDER_S T AT E enumeration.
ENUM_ORDER_STATE
Identifier Description
ORDER_S TATE_S TARTED Order checked, but not yet accepted by broker
ORDER_S TATE_PLACED Order accepted
ORDER_S TATE_CANCELED Order canceled by client
ORDER_S TATE_PARTIAL Order partially executed
ORDER_S TATE_FILLED Order fully executed
ORDER_S TATE_REJECTED Order rejected
ORDER_S TATE_EXPIRED Order expired
ORDER_S TATE_REQUES T_ADD Order is being registered (placing to the trading system)
ORDER_S TATE_REQUES T_MODIFY Order is being modified (changing its parameters)
ORDER_S TATE_REQUES T_CANCEL Order is being deleted (deleting from the trading system)
W hen sending a trade request for execution at the current time (time in force), the price and the
required buy/sell volume should be specified. Also, keep in mind that financial markets provide no
guarantee that the entire requested volume is available for a certain financial instrument at the
desired price. Therefore, trading operations in real time are regulated using the price and volume
execution modes. The modes, or execution policies, define the rules for cases when the price has
changed or the requested volume cannot be completely fulfilled at the moment.
Price execution mode can be obtained from the SYM BOL _T RADE_EXEMODE symbol property containing
the combination of flags from the ENUM _SYM BOL_TRADE_EXECUTION enumeration.
Execution mode Descrip The value in ENUM _SYM BOL _T RADE_EXECUTION
tion
Prices
for a
certain
market
order
are
request
ed
from
the
broker
before
the
order
is sent.
Upon
receivi
ng the
prices,
order
executi
on at
the
given
price
can be
either
confir
med or
rejecte
d.
W hen
sendin
g a
trade
request
to be
execut
ed, the
platfor
m
automa
tically
adds
the
current
prices
to the
order.
· I
f
t
h
e
b
r
o
k
e
r
a
c
c
e
p
t
s
t
h
e
p
r
i
c
e
,
t
h
e
o
r
d
e
r
i
s
e
x
e
c
u
t
e
d
.
· I
f
t
h
e
b
r
o
k
e
r
d
o
e
s
n
o
t
a
c
c
e
p
t
t
h
e
r
e
q
u
e
s
t
e
d
p
r
i
c
e
,
a
"
R
e
q
u
o
t
e
"
i
s
s
e
n
t
—
t
h
e
b
r
o
k
e
r
r
e
t
u
r
n
s
p
r
i
c
e
s
,
a
t
w
h
i
c
h
t
h
i
s
o
r
d
e
r
c
a
n
b
e
e
x
e
c
u
t
e
d
.
Market Execution A SYM BOL _T RADE_EXECUTION_M ARKET
broker
(Market Execution) makes
a
decisio
n about
the
order
executi
on
price
without
any
additio
nal
discuss
ion
with
the
trader.
S endin
g the
order
in such
a mode
means
advanc
e
consen
t to its
executi
on at
this
price.
Exchange Execution Trade SYM BOL _T RADE_EXECUTION_EXCHANGE
operati
(Exchange Execution) ons are
execut
ed at
the
prices
of the
current
market
offers.
Volume filling policy is specified in the ORDER_T YPE_FILLING order property and may contain only
the values from the ENUM _ORDER_TYPE_FILLING enumeration
If the
necess
ary
amoun
t of a
financi
al
instru
ment
is
current
ly
unavail
able in
the
market
, the
order
will not
be
execut
ed.
The
desire
d
volume
can be
made
up of
several
availab
le
offers.
The
possibi
lity of
using
FO K
orders
is
determ
ined at
the
trade
server.
Immediate or Cancel A ORDER_FILLING_IOC
trader
agrees
to
execut
e a
deal
with
the
volume
maxim
ally
availab
le in
the
market
within
that
indicat
ed in
the
order.
If the
reques
t
cannot
be
filled
comple
tely,
an
order
with
the
availab
le
volume
will be
execut
ed,
and
the
remain
ing
volume
will be
cancel
ed.
The
possibi
lity of
using
IOC
orders
is
determ
ined at
the
trade
server.
can be
execut
ed
immed
iately
when
placed,
then it
is
cancel
ed.
In
fact,
the
BOC
policy
guaran
tees
that
the
price
of the
placed
order
will be
worse
than
the
current
market
. BoC
orders
are
used
to
imple
ment
passiv
e
trading
, so
that
the
order
is not
execut
ed
immed
iately
when
placed
and
does
not
affect
current
liquidit
y.
Only
limit
and
stop
limit
orders
are
suppor
ted
(ORDE
R_T YP
E_BUY
_LIMIT
,
ORDER
_T YPE
_SELL _
LIMIT,
ORDER
_T YPE
_BUY_
S TOP_
LIMIT,
ORDER
_T YPE
_SELL _
S TOP_
LIMIT)
.
R eturn In case ORDER_FILLING_RETURN
of
partial
filling,
an
order
with
remain
ing
volume
is not
cancel
ed but
proces
sed
further
.
R eturn
orders
are not
allowe
d in
the
Market
Execut
ion
mode
(marke
t
execut
ion —
SYM BO
L_TRA
DE_EX
ECUTI
ON_M A
RKET).
W hen sending a trade request using the OrderS end() function, the necessary volume execution policy
can be set in the type_filling field, namely in the special M qlTradeRequest structure. The values from
the ENUM _ORDER_TYPE_FILLING enumeration are available. To get the property value in a specific
active/completed order, use the OrderGetInteger() or HistoryOrderGetInteger() function with the
ORDER_TYPE_FILLING modifier.
Before sending an order with the current execution time, for the correct setting of the
ORDER_TYPE_FILLING value (volume execution type), you can use the S ymbolInfoInteger() function
with each financial instrument to get the SYM BOL_FILLING_MODE property value, which shows volume
execution types allowed for the symbol as a combination of flags. The ORDER_FILLING_RETURN filling
type is enabled at all times except for the " Market execution" mode
(SYM BOL_TRADE_EXECUTION_M ARKET).
The use of filling types depending on the execution mode can be shown as the following table:
The order validity period can be set in the type_time field of the special structure M qlTradeRequest
when sending a trade request using the OrderS end() function. Values of the ENUM _ORDER_TYPE_TIM E
enumeration are allowed. To obtain the value of this property use the function OrderGetInteger() or
H istoryOrderGetInteger() with the ORDER_T YPE_TIM E modifier.
ENUM_ORDER_TY PE_TIME
Identifier Description
ORDER_TIM E_S PECIFIED_DAY The order will be effective till 23:59:59 of the specified day.
If this time is outside a trading session, the order expires in
the nearest trading time.
The reason for order placing is contained in the ORDER_REAS ON property. An order can be placed by
an MQL5 program, from a mobile application, as a result of S topOut, etc. Possible values of
ORDER_REAS ON are described in the ENUM _ORDER_REAS ON enumeration.
ENUM_ORDER_REASON
Identifier Description
ORDER_REAS ON_CLIENT The order was placed from a des ktop terminal
ORDER_REAS ON_MOBILE The order was placed from a mobile application
ORDER_REAS ON_WEB The order was placed from a web platform
ORDER_REAS ON_EXPERT The order was placed from an MQL5-program, i.e. by an
Expert Advisor or a script
ORDER_REAS ON_S L The order was placed as a result of S top Loss activation
ORDER_REAS ON_TP The order was placed as a result of Take Profit activation
ORDER_REAS ON_S O The order was placed as a result of the S top Out event
Position Properties
Execution of trade operations results in the opening of a position, changing of its volume and/or
direction, or its disappearance. Trade operations are conducted based on orders, sent by the
OrderS end() function in the form of trade requests. For each financial security (symbol) only one open
position is possible. A position has a set of properties available for reading by the PositionGet...()
functions.
For the function PositionGetInteger()
ENUM_POSITION_PROPERTY _INTEGER
POS ITION_TICKET
value corresponds
to
M qlTradeRequest:
:position.
Position identifier
is specified in
each order
(ORDER_POS ITIO
N_ID) and deal
(DEAL_POS ITION_
ID) used to open,
modify, or close
it. Use this
property to
search for orders
and deals related
to the position.
W hen reversing a
position in
netting mode
(using a single
in/out trade),
POS ITION_IDENTI
FIER does not
change. However,
POS ITION_TICKET
is replaced with
Direction of an open position (buy or sell) is defined by the value from the ENUM _POS ITION_TYPE
enumeration. In order to obtain the type of an open position use the PositionGetInteger() function
with the POS ITION_TYPE modifier.
ENUM_POSITION_TY PE
Identifier Description
The reason for opening a position is contained in the POS ITION_REAS ON property. A position can be
opened as a result of activation of an order placed from a des ktop terminal, a mobile application, by
an Expert Advisor, etc. Possible values of POS ITION_REAS ON are described in the
ENUM _POS ITION_REAS ON enumeration.
ENUM_POSITION_REASON
Identifier Description
POS ITION_REAS ON_CLIENT The position was opened as a result of activation of an order
placed from a des ktop terminal
POS ITION_REAS ON_MOBILE The position was opened as a result of activation of an order
placed from a mobile application
POS ITION_REAS ON_WEB The position was opened as a result of activation of an order
placed from the web platform
POS ITION_REAS ON_EXPERT The position was opened as a result of activation of an order
placed from an MQL5 program, i.e. an Expert Advisor or a
script
Deal Properties
A deal is the reflection of the fact of a trade operation execution based on an order that contains a
trade request. Each trade is described by properties that allow to obtain information about it. In order
to read values of properties, functions of the HistoryDealGet...() type are used, that return values
from corresponding enumerations.
For the function HistoryDealGetInteger()
ENUM_DEAL_PROPERTY _INTEGER
DEAL _ENT RY Deal entry - entry in, entry out, reverse ENUM _DEAL _ENT RY
Each deal ischaracterized by a type, allowed values are enumerated in ENUM _DEAL_TYPE. In order to
obtain information about the deal type, use the HistoryDealGetInteger() function with the DEAL_TYPE
modifier.
ENUM_DEAL_TY PE
Identifier Description
Identifier Description
DEAL _T YPE_SELL _CANCEL ED Canceled sell deal. There can be a situation when a previously
executed sell deal is canceled. In this case, the type of the
previously executed deal (DEA L _T YPE_SELL) is changed to
DEAL _T YPE_SELL _CANCEL ED, and its profit/loss is zeroized.
Previously obtained profit/loss is charged/withdrawn using a
separated balance operation
Deals differ not only in their types set in ENUM _DEAL_TYPE, but also in the way they change positions.
This can be a simple position opening, or accumulation of a previously opened position (market
entering), position closing by an opposite deal of a corresponding volume (market exiting), or position
reversing, if the opposite-direction deal covers the volume of the previously opened position.
Allthese situations are described by values from the ENUM _DEAL_ENTRY enumeration. In order to
receive this information about a deal, use the HistoryDealGetInteger() function with the DEAL_ENTRY
modifier.
ENUM_DEAL_ENTRY
Identifier Description
The reason for deal execution is contained in the DEAL_REAS ON property. A deal can be executed as a
result of triggering of an order placed from a mobile application or an MQL5 program, as well as as a
result of the S topOut event, variation margin calculation, etc. Possible values of DEAL_REAS ON are
described in the ENUM _DEAL_REAS ON enumeration. For non-trading deals resulting from balance,
credit, commission and other operations, DEAL_REAS ON_CLIENT is indicated as the reason.
ENUM_DEAL_REASON
Identifier Description
DEAL _REAS ON_CLIENT The deal was executed as a result of activation of an order placed from a
des ktop terminal
DEAL _REAS ON_MOBIL E The deal was executed as a result of activation of an order placed from a
mobile application
DEAL _REAS ON_WEB The deal was executed as a result of activation of an order placed from
the web platform
DEAL _REAS ON_EXPER T The deal was executed as a result of activation of an order placed from
an MQL5 program, i.e. an Expert Advisor or a script
DEAL _REAS ON_S L The deal was executed as a result of S top Loss activation
DEAL _REAS ON_TP The deal was executed as a result of Take Profit activation
DEAL _REAS ON_S O The deal was executed as a result of the S top Out event
DEAL _REAS ON_R OLLOV The deal was executed due to a rollover
ER
DEAL _REAS ON_VM ARGI The deal was executed after charging the variation margin
N
DEAL _REAS ON_S PLIT The deal was executed after the split (price reduction) of an instrument,
which had an open position during split announcement
Identifier Description
}
}
//+------------------------------------------------------------------+
Example of the TRADE_ACTION_S LTP trade operation for modifying the S top Loss and Take Profit
values of an open position:
//--- calculation and rounding of the Stop Loss and Take Profit values
price_level=stop_level*SymbolInfoDouble(position_symbol,SYMBOL_POINT);
if(type==POSITION_TYPE_BUY)
{
sl=NormalizeDouble(bid-price_level,digits);
tp=NormalizeDouble(ask+price_level,digits);
}
else
{
sl=NormalizeDouble(ask+price_level,digits);
tp=NormalizeDouble(bid-price_level,digits);
}
//--- zeroing the request and result values
ZeroMemory(request);
ZeroMemory(result);
//--- setting the operation parameters
request.action =TRADE_ACTION_SLTP; // type of trade operation
request.position=position_ticket; // ticket of the position
request.symbol=position_symbol; // symbol
request.sl =sl; // Stop Loss of the position
request.tp =tp; // Take Profit of the position
request.magic=EXPERT_MAGIC; // MagicNumber of the position
//--- output information about the modification
PrintFormat("Modify #%I64d %s %s",position_ticket,position_symbol,EnumToString(type));
//--- send the request
if(!OrderSend(request,result))
PrintFormat("OrderSend error %d",GetLastError()); // if unable to send the request, ou
//--- information about the operation
PrintFormat("retcode=%u deal=%I64u order=%I64u",result.retcode,result.deal,result.order)
}
}
}
//+------------------------------------------------------------------+
Example of the TRADE_ACTION_MODIFY trade operation for modifying the price levels of pending
orders :
request.sl = NormalizeDouble(price-offset*point,digits);
request.price =NormalizeDouble(price,digits); // normalized opening
}
else if(type==ORDER_TYPE_SELL_STOP)
{
price = SymbolInfoDouble(Symbol(),SYMBOL_ASK)-offset*point;
request.tp = NormalizeDouble(price-offset*point,digits);
request.sl = NormalizeDouble(price+offset*point,digits);
request.price =NormalizeDouble(price,digits); // normalized opening
}
//--- send the request
if(!OrderSend(request,result))
PrintFormat("OrderSend error %d",GetLastError()); // if unable to send the request, ou
//--- information about the operation
PrintFormat("retcode=%u deal=%I64u order=%I64u",result.retcode,result.deal,result.order)
//--- zeroing the request and result values
ZeroMemory(request);
ZeroMemory(result);
}
}
}
//+------------------------------------------------------------------+
Example of the TRADE_ACTION_CLOSE_BY trade operation for closing positions by opposite positions :
Identifier Description
Identifier Description
Identifier Description
See also
S tructures and classes, S tructure of the DOM, Trade operation types, Market Info
Signal Properties
The following enumerations are used when working with trading signals and signal copy settings.
Enumeration of double type properties of the trading signal:
ENUM_SIGNAL_BASE_DOUBLE
ID Description
ID Description
ID Description
ID Description
ID Description
ID Description
ID Description
See also
Trade signals
Named Constants
All constants used in MQL5 can be divided into the following groups :
· Predefined macro substitutions – values are substituted during compilation;
· Mathematical constants – values of some mathematical expressions ;
· Numerical type constants – some of the simple type restrictions ;
· Uninitialization reason codes – description of uninitialization reasons ;
· Checking Object Pointer – enumeration of types of pointers returned by the CheckPointer() function;
· Other constants – all other constants.
__CPU_AR CH IT ECT URE__ Name of architecture (set of commands) EX5 file compiled
for
__DAT E__ Filecompilation date without time (hours, minutes and
seconds are equal to 0)
__DAT ETIM E__ File compilation date and time
Constant Description
Example:
//+------------------------------------------------------------------+
//| test2 |
//+------------------------------------------------------------------+
void test2()
{
//--- information output inside the function
Print(" __FUNCTION__ = ",__FUNCTION__," __LINE__ = ",__LINE__);
}
//+------------------------------------------------------------------+
//| OnTimer event handler |
//+------------------------------------------------------------------+
void OnTimer()
{
//---
Print(" __FUNCTION__ = ",__FUNCTION__," __LINE__ = ",__LINE__);
test1(__FUNCTION__);
}
The example for learning how to work with the __COUNTER__ macro
//--- create a macro for a quick display of the expression and its value in the journal
#define print(expr) Print(#expr,"=",expr)
//--- define the MACRO_COUNTER custom macro via the predefined __COUNTER__ macro
#define MACRO_COUNTER __COUNTER__
//--- set the input value of the variable using the __COUNTER__ macro
input int InpVariable = __COUNTER__;
//--- set the value of the global variable using the __COUNTER__ macro before defining the function
int ExtVariable = __COUNTER__;
//+------------------------------------------------------------------+
//| the function returns the __COUNTER__ value |
//+------------------------------------------------------------------+
int GlobalFunc(void)
{
return(__COUNTER__);
}
//+------------------------------------------------------------------+
//| the template function returns the __COUNTER__ value |
//+------------------------------------------------------------------+
template<typename T>
int GlobalTemplateFunc(void)
{
return(__COUNTER__);
}
//+------------------------------------------------------------------+
int Method(void)
{
return(__COUNTER__);
}
};
//+------------------------------------------------------------------+
//| the template structure with the method returning __COUNTER__ |
//+------------------------------------------------------------------+
template<typename T>
struct B
{
int dummy; // not used
int Method(void)
{
return(__COUNTER__);
}
};
//+------------------------------------------------------------------+
//| the structure with the template method returning __COUNTER__ |
//+------------------------------------------------------------------+
struct C
{
int dummy; // not used
template<typename T>
int Method(void)
{
return(__COUNTER__);
}
};
//+------------------------------------------------------------------+
//| the function #2, which returns the __COUNTER__ value |
//+------------------------------------------------------------------+
int GlobalFunc2(void)
{
return(__COUNTER__);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart(void)
{
//--- let's have another look at __COUNTER__ in the macro and the global variable
print(MACRO_COUNTER); // the value has changed
print(ExtGlobal2);
}
//--- set the value of the global variable using the __COUNTER__ macro after defining the functions
int ExtGlobal2 = __COUNTER__;
//+------------------------------------------------------------------+
/* Result
__COUNTER__=3
InpVariable=0
ExtVariable=1
GlobalFunc()=5
GlobalFunc()=5
GlobalTemplateFunc<int>()=8
GlobalTemplateFunc<int>()=8
GlobalTemplateFunc<double>()=9
GlobalFunc2()=7
GlobalFunc2()=7
a1.Method()=6
a2.Method()=6
b1.Method()=10
b2.Method()=10
b3.Method()=11
c1.Method<int>()=12
c1.Method<double>()=13
c2.Method<int>()=12
__COUNTER__=4
ExtGlobal2=2
*/
Mathematical Constants
S pecial constants
containing values are reserved for some mathematical expressions. These constants
can be used in any place of the program instead of calculating their values using mathematical
functions.
Constant Description Value
M _E e 2.71828182845904523536
M _PI pi 3.14159265358979323846
Example:
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- print the values of constants
Print("M_E = ",DoubleToString(M_E,16));
Print("M_LOG2E = ",DoubleToString(M_LOG2E,16));
Print("M_LOG10E = ",DoubleToString(M_LOG10E,16));
Print("M_LN2 = ",DoubleToString(M_LN2,16));
Print("M_LN10 = ",DoubleToString(M_LN10,16));
Print("M_PI = ",DoubleToString(M_PI,16));
Print("M_PI_2 = ",DoubleToString(M_PI_2,16));
Print("M_PI_4 = ",DoubleToString(M_PI_4,16));
Print("M_1_PI = ",DoubleToString(M_1_PI,16));
Print("M_2_PI = ",DoubleToString(M_2_PI,16));
Print("M_2_SQRTPI = ",DoubleToString(M_2_SQRTPI,16));
Print("M_SQRT2 = ",DoubleToString(M_SQRT2,16));
Print("M_SQRT1_2 = ",DoubleToString(M_SQRT1_2,16));
void OnStart()
{
//--- print the constant values
printf("CHAR_MIN = %d",CHAR_MIN);
printf("CHAR_MAX = %d",CHAR_MAX);
printf("UCHAR_MAX = %d",UCHAR_MAX);
printf("SHORT_MIN = %d",SHORT_MIN);
printf("SHORT_MAX = %d",SHORT_MAX);
printf("USHORT_MAX = %d",USHORT_MAX);
printf("INT_MIN = %d",INT_MIN);
printf("INT_MAX = %d",INT_MAX);
printf("UINT_MAX = %u",UINT_MAX);
printf("LONG_MIN = %I64d",LONG_MIN);
printf("LONG_MAX = %I64d",LONG_MAX);
printf("ULONG_MAX = %I64u",ULONG_MAX);
printf("EMPTY_VALUE = %.16e",EMPTY_VALUE);
printf("DBL_MIN = %.16e",DBL_MIN);
printf("DBL_MAX = %.16e",DBL_MAX);
printf("DBL_EPSILON = %.16e",DBL_EPSILON);
printf("DBL_DIG = %d",DBL_DIG);
printf("DBL_MANT_DIG = %d",DBL_MANT_DIG);
printf("DBL_MAX_10_EXP = %d",DBL_MAX_10_EXP);
printf("DBL_MAX_EXP = %d",DBL_MAX_EXP);
printf("DBL_MIN_10_EXP = %d",DBL_MIN_10_EXP);
printf("DBL_MIN_EXP = %d",DBL_MIN_EXP);
printf("FLT_MIN = %.8e",FLT_MIN);
printf("FLT_MAX = %.8e",FLT_MAX);
printf("FLT_EPSILON = %.8e",FLT_EPSILON);
/*
CHAR_MIN = -128
CHAR_MAX = 127
UCHAR_MAX = 255
SHORT_MIN = -32768
SHORT_MAX = 32767
USHORT_MAX = 65535
INT_MIN = -2147483648
INT_MAX = 2147483647
UINT_MAX = 4294967295
LONG_MIN = -9223372036854775808
LONG_MAX = 9223372036854775807
ULONG_MAX = 18446744073709551615
EMPTY_VALUE = 1.7976931348623157e+308
DBL_MIN = 2.2250738585072014e-308
DBL_MAX = 1.7976931348623157e+308
DBL_EPSILON = 2.2204460492503131e-16
DBL_DIG = 15
DBL_MANT_DIG = 53
DBL_MAX_10_EXP = 308
DBL_MAX_EXP = 1024
DBL_MIN_10_EXP = -307
DBL_MIN_EXP = -1021
FLT_MIN = 1.17549435e-38
FLT_MAX = 3.40282347e+38
FLT_EPSILON = 1.19209290e-07
*/
}
//+------------------------------------------------------------------+
//| get text description |
//+------------------------------------------------------------------+
string getUninitReasonText(int reasonCode)
{
string text="";
//---
switch(reasonCode)
{
case REASON_ACCOUNT:
text="Account was changed";break;
case REASON_CHARTCHANGE:
text="Symbol or timeframe was changed";break;
case REASON_CHARTCLOSE:
text="Chart was closed";break;
case REASON_PARAMETERS:
text="Input-parameter was changed";break;
case REASON_RECOMPILE:
Constant Description
See also
R untime errors, Object Delete Operator delete, CheckPointer
Other Constants
The CLR_NONE constant is used to outline the absence of color, it means that the graphical object or
graphical series of an indicator will not be plotted. This constant was not included into the W eb-color
constants list, but it can be applied everywhere where the color arguments are required.
The INVALID_HANDLE constant can be used for checking file handles (see FileOpen() and
FileFindFirst()).
ObjectGetInteger() the result is true, a value from ENUM _LINE_S T YL E is returned; otherwise
WR ONG_VAL UE is returned.
void OnStart()
{
if(CheckLineStyle("MyChartObject")==WRONG_VALUE)
printf("Error line style getting.");
}
//+------------------------------------------------------------------+
//| returns the line style for an object specified by its name |
//+------------------------------------------------------------------+
ENUM_LINE_STYLE CheckLineStyle(string name)
{
long style;
//---
if(ObjectGetInteger(0,name,OBJPROP_STYLE,0,style))
return((ENUM_LINE_STYLE)style);
else
return(WRONG_VALUE);
}
The WHOLE_ARRAY constant is intended for functions that require specifying the number of elements
in processed arrays :
· ArrayCopy();
· ArrayMinimum();
· ArrayMaximum();
· FileR eadArray();
· FileW riteArray().
If you want to specify that all the array values from a specified position till the end must be processed,
you should specify just the WHOLE_ARRAY value.
IS_PROFILE_MODE constant allows changing a program operation for correct data collection in the
profiling mode. Profiling allows measuring the execution time of the individual program fragments
(usually comprising functions), as well as calculating the number of such calls. S leep() function calls
can be disabled to determine the execution time in the profiling mode, like in this example:
//--- Sleep can greatly affect (change) profiling result
if(!IS_PROFILE_MODE) Sleep(100); // disabling Sleep() call in the profiling mode
IS_PROFILE_MODE constant value is set by the compiler during the compilation, while it is set to zero
in conventional mode. W hen launching a program in the profiling mode, a special compilation is
performed and IS_PROFILE_MODE is replaced with a non-zero value.
The IS_DEBUG_MODE constant can be useful when you need to slightly change the operation of a mql5
program in the debugging mode. For example, in debug mode you may need to display additional
debugging information in the terminal log or create additional graphical objects in a chart.
The following example creates a Label object and sets its description and color depending on the script
running mode. In order to run a script in the debug mode from MetaEditor, press F5. If you run the
script from the browser window in the terminal, then the color and text of the object Label will be
different.
Example:
//+------------------------------------------------------------------+
//| Check_DEBUG_MODE.mq5 |
//| Copyright © 2009, MetaQuotes Software Corp. |
//| https://www.metaquotes.net |
//+------------------------------------------------------------------+
#property copyright "Copyright © 2009, MetaQuotes Software Corp."
#property link "https://www.metaquotes.net"
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//---
string label_name="invisible_label";
if(ObjectFind(0,label_name)<0)
{
Print("Object",label_name,"not found. Error code = ",GetLastError());
//--- create Label
ObjectCreate(0,label_name,OBJ_LABEL,0,0,0);
//--- set X coordinate
ObjectSetInteger(0,label_name,OBJPROP_XDISTANCE,200);
//--- set Y coordinate
ObjectSetInteger(0,label_name,OBJPROP_YDISTANCE,300);
ResetLastError();
if(IS_DEBUG_MODE) // debug mode
{
//--- show message about the script execution mode
ObjectSetString(0,label_name,OBJPROP_TEXT,"DEBUG MODE");
//--- set text color to red
if(!ObjectSetInteger(0,label_name,OBJPROP_COLOR,clrRed))
Print("Unable to set the color. Error",GetLastError());
}
else // operation mode
{
ObjectSetString(0,label_name,OBJPROP_TEXT,"RELEASE MODE");
//--- set text color to invisible
if(!ObjectSetInteger(0,label_name,OBJPROP_COLOR,CLR_NONE))
Print("Unable to set the color. Error ",GetLastError());
}
ChartRedraw();
DebugBreak(); // here termination will occur, if we are in debug mode
}
Crypt Methods
The ENUM _CRYPT_M ETHOD enumeration is used to specify the data transformation method, used in
CryptEncode() and CryptDecode() functions.
ENUM_CRY PT_METHOD
Constant Description
CRYPT_BASE64 BASE64
See also
Debug Break , Executed MQL5 program properties, CryptEncode(), CryptDecode()
Data Structures
MQL5 Language offers 12 predefined structures :
· M qlDateTime is intended for working with date and time;
· M qlParam can send input parameters when creating a handle of the indicator using the
IndicatorCreate() function;
· M qlRates is intended for manipulating the historical data, it contains information about the price,
volume and spread;
· M qlBookInfo is intended for obtaining information about the Depth of Market;
· M qlTradeRequest is used for creating a trade request for trade operations ;
· M qlTradeCheckResult is intended for checking the prepared trade request before sending it;
· M qlTradeResult contains a trade server reply to a trade request, sent by OrderS end() function;
· M qlTradeTransaction contains description of a trade transaction;
· M qlTick is designed for fast retrieval of the most requested information about current prices.
· Economic calendar structures are used to obtain data on the economic calendar events sent to the
MetaTrader 5 platform in real time. Economic calendar functions allow analyzing macroeconomic
parameters immediately after new reports are released, since relevant values are broadcast directly
from the source with no delay.
MqlDateTime
The date type structure contains eight fields of the int type:
struct MqlDateTime
{
int year; // Year
int mon; // Month
int day; // Day
int hour; // Hour
int min; // Minutes
int sec; // Seconds
int day_of_week; // Day of week (0-Sunday, 1-Monday, ... ,6-Saturday)
int day_of_year; // Day number of the year (January 1st is assigned the number value of zero)
};
Note
The day number of the year day_of_year for the leap year, since March, will differ from a number of
the corresponding day for a non-leap year.
Example:
void OnStart()
{
//---
datetime date1=D'2008.03.01';
datetime date2=D'2009.03.01';
MqlDateTime str1,str2;
TimeToStruct(date1,str1);
TimeToStruct(date2,str2);
printf("%02d.%02d.%4d, day of year = %d",str1.day,str1.mon,
str1.year,str1.day_of_year);
printf("%02d.%02d.%4d, day of year = %d",str2.day,str2.mon,
str2.year,str2.day_of_year);
}
/* Result:
01.03.2008, day of year = 60
01.03.2009, day of year = 59
*/
See also
All input parameters of an indicator are transmitted in the form of an array of the M qlParam type, the
type field of each element of this array specifies the type of data transmitted by the element. The
indicator values must be first placed in the appropriate fields for each element (in integer_value, in
double_value or string_value) depending on what value of ENUM _DA T A T YPE enumeration is specified
MqlRates
This structure stores information about the prices, volumes and spread.
struct MqlRates
{
datetime time; // Period start time
double open; // Open price
double high; // The highest price of the period
double low; // The lowest price of the period
double close; // Close price
long tick_volume; // Tick volume
int spread; // Spread
long real_volume; // Trade volume
};
Example:
void OnStart()
{
MqlRates rates[];
int copied=CopyRates(NULL,0,0,100,rates);
if(copied<=0)
Print("Error copying price data ",GetLastError());
else Print("Copied ",ArraySize(rates)," bars");
}
See also
MqlBookInfo
It provides information about the market depth data.
struct MqlBookInfo
{
ENUM_BOOK_TYPE type; // Order type from ENUM_BOOK_TYPE enumeration
double price; // Price
long volume; // Volume
double volume_real; // Volume with greater accuracy
};
Note
The M qlBookInfo structure is predefined, thus it doesn't require any declaration and description. To
use the structure, just declare a variable of this type.
The DOM is available only for some symbols.
Example:
MqlBookInfo priceArray[];
bool getBook=MarketBookGet(NULL,priceArray);
if(getBook)
{
int size=ArraySize(priceArray);
Print("MarketBookInfo about ",Symbol());
}
else
{
Print("Failed to receive DOM for the symbol ",Symbol());
}
See also
Fields description
Field Description
action Trade operation type. Can be one of the ENUM _T RADE_REQUES T _ACTIONS
enumeration values.
magic Expert Advisor ID. It allows organizing analytical processing of trade orders. Each
Expert Advisor can set its own unique ID when sending a trade request.
Field Description
stoplimit The price value, at which the Limit pending order will be placed, when price
reaches the price value (this condition is obligatory). Until then the pending order
is not placed.
sl S top Loss price in case of the unfavorable price movement
tp Take Profit price in the case of the favorable price movement
deviation The maximal price deviation, specified in points
type Order type. Can be one of the ENUM _ORDER_TYPE enumeration values.
type_filling Order execution type. Can be one of the enumeration
ENUM _ORDER_T YPE_FILLING values.
type_time Order expiration type. Can be one of the enumeration ENUM _ORDER_T YPE_TIM E
values.
expiration Order expiration time (for orders of ORDER_TIM E_S PECIFIED type)
comment Order comment
position Ticket of a position. S hould be filled in when a position is modified or closed to
identify the position. As a rule it is equal to the ticket of the order, based on
which the position was opened.
position_by Ticket of an opposite position. Used when a position is closed by an opposite one
open for the same symbol in the opposite direction.
W hen modifying or closing a position in the hedging system, make sure to specify its ticket
(M qlTradeRequest::position). The ticket can also be specified in the netting system, though a
position is identified by the symbol name.
For sending orders to perform trade operations it is necessary to use the OrderS end() function. For
each trade operation it is necessary to specify obligatory fields ; optional fields also may be filled.
There are seven possible cases to send a trade order:
Request Execution
This is a trade order to open a position in the Request Execution mode (trade upon requested
prices). It requires to specify the following 9 fields :
· action
· symbol
· volume
· price
· sl
· tp
· deviation
· type
· type_filling
Also it is possible to specify the " magic" and " comment" field values.
Instant Execution
This is a trade order to open a position in the Instant Execution mode (trade by current prices). It
requires specification of the following 9 fields :
· action
· symbol
· volume
· price
· sl
· tp
· deviation
· type
· type_filling
Also it is possible to specify the " magic" and " comment" field values.
Market Execution
This is a trade order to open a position in the Market Execution mode. It requires to specify the
following 5 fields :
· action
· symbol
· volume
· type
· type_filling
Also it is possible to specify the " magic" and " comment" field values.
Exchange Execution
This is a trade order to open a position in the Exchange Execution mode. It requires to specify the
following 5 fields :
· action
· symbol
· volume
· type
· type_filling
Also it is possible to specify the " magic" and " comment" field values.
Example of the TRADE_ACTION_DEAL trade operation for opening a Buy position:
}
}
//+------------------------------------------------------------------+
SL & TP Modification
Trade order to modify the S topLoss and/or TakeProfit price levels. It requires to specify the
following 4 fields :
· action
· symbol
· sl
· tp
· position
Example of the TRADE_ACTION_S LTP trade operation for modifying the S top Loss and Take Profit
values of an open position:
#define EXPERT_MAGIC 123456 // MagicNumber of the expert
//+------------------------------------------------------------------+
//| Modification of Stop Loss and Take Profit of position |
//+------------------------------------------------------------------+
void OnStart()
{
//--- declare and initialize the trade request and result of trade request
MqlTradeRequest request;
MqlTradeResult result;
int total=PositionsTotal(); // number of open positions
//--- iterate over all open positions
for(int i=0; i<total; i++)
{
//--- parameters of the order
ulong position_ticket=PositionGetTicket(i);// ticket of the position
string position_symbol=PositionGetString(POSITION_SYMBOL); // symbol
int digits=(int)SymbolInfoInteger(position_symbol,SYMBOL_DIGITS); // number of decimal pla
ulong magic=PositionGetInteger(POSITION_MAGIC); // MagicNumber of the position
double volume=PositionGetDouble(POSITION_VOLUME); // volume of the position
double sl=PositionGetDouble(POSITION_SL); // Stop Loss of the position
double tp=PositionGetDouble(POSITION_TP); // Take Profit of the position
ENUM_POSITION_TYPE type=(ENUM_POSITION_TYPE)PositionGetInteger(POSITION_TYPE); // type of th
//--- output information about the position
PrintFormat("#%I64u %s %s %.2f %s sl: %s tp: %s [%I64d]",
position_ticket,
position_symbol,
EnumToString(type),
volume,
DoubleToString(PositionGetDouble(POSITION_PRICE_OPEN),digits),
DoubleToString(sl,digits),
DoubleToString(tp,digits),
magic);
//--- if the MagicNumber matches, Stop Loss and Take Profit are not defined
if(magic==EXPERT_MAGIC && sl==0 && tp==0)
{
//--- calculation and rounding of the Stop Loss and Take Profit values
price_level=stop_level*SymbolInfoDouble(position_symbol,SYMBOL_POINT);
if(type==POSITION_TYPE_BUY)
{
sl=NormalizeDouble(bid-price_level,digits);
tp=NormalizeDouble(bid+price_level,digits);
}
else
{
sl=NormalizeDouble(ask+price_level,digits);
tp=NormalizeDouble(ask-price_level,digits);
}
//--- zeroing the request and result values
ZeroMemory(request);
ZeroMemory(result);
//--- setting the operation parameters
request.action =TRADE_ACTION_SLTP; // type of trade operation
request.position=position_ticket; // ticket of the position
request.symbol=position_symbol; // symbol
request.sl =sl; // Stop Loss of the position
request.tp =tp; // Take Profit of the position
request.magic=EXPERT_MAGIC; // MagicNumber of the position
//--- output information about the modification
PrintFormat("Modify #%I64d %s %s",position_ticket,position_symbol,EnumToString(type));
//--- send the request
if(!OrderSend(request,result))
PrintFormat("OrderSend error %d",GetLastError()); // if unable to send the request, ou
//--- information about the operation
PrintFormat("retcode=%u deal=%I64u order=%I64u",result.retcode,result.deal,result.order)
}
}
}
//+------------------------------------------------------------------+
Pending Order
Trade order to place a pending order. It requires to specify the following 11 fields :
· action
· symbol
· volume
· price
· stoplimit
· sl
· tp
· type
· type_filling
· type_time
· expiration
Also it is possible to specify the " magic" and " comment" field values.
Example of the TRADE_ACTION_PENDING trade operation for placing a pending order:
Trade order to modify the prices of a pending order. It requires to specify the following 7 fields :
· action
· order
· price
· sl
· tp
· type_time
· expiration
Example of the TRADE_ACTION_MODIFY trade operation for modifying the price levels of pending
orders :
request.sl = NormalizeDouble(price-offset*point,digits);
request.price =NormalizeDouble(price,digits); // normalized opening
}
else if(type==ORDER_TYPE_SELL_STOP)
{
price = SymbolInfoDouble(Symbol(),SYMBOL_BID)-offset*point;
request.tp = NormalizeDouble(price-offset*point,digits);
request.sl = NormalizeDouble(price+offset*point,digits);
request.price =NormalizeDouble(price,digits); // normalized opening
}
//--- send the request
if(!OrderSend(request,result))
PrintFormat("OrderSend error %d",GetLastError()); // if unable to send the request, ou
//--- information about the operation
PrintFormat("retcode=%u deal=%I64u order=%I64u",result.retcode,result.deal,result.order)
//--- zeroing the request and result values
ZeroMemory(request);
ZeroMemory(result);
}
}
}
//+------------------------------------------------------------------+
Trade order to delete a pending order. It requires to specify the following 2 fields :
· action
· order
//+------------------------------------------------------------------+
//| Deleting pending orders |
//+------------------------------------------------------------------+
void OnStart()
{
//--- declare and initialize the trade request and result of trade request
MqlTradeRequest request={};
MqlTradeResult result={};
int total=OrdersTotal(); // total number of placed pending orders
//--- iterate over all placed pending orders
for(int i=total-1; i>=0; i--)
{
ulong order_ticket=OrderGetTicket(i); // order ticket
ulong magic=OrderGetInteger(ORDER_MAGIC); // MagicNumber of the order
//--- if the MagicNumber matches
if(magic==EXPERT_MAGIC)
{
//--- zeroing the request and result values
ZeroMemory(request);
ZeroMemory(result);
//--- setting the operation parameters
request.action=TRADE_ACTION_REMOVE; // type of trade operation
request.order = order_ticket; // order ticket
//--- send the request
if(!OrderSend(request,result))
PrintFormat("OrderSend error %d",GetLastError()); // if unable to send the request, ou
//--- information about the operation
PrintFormat("retcode=%u deal=%I64u order=%I64u",result.retcode,result.deal,result.order)
}
}
}
//+------------------------------------------------------------------+
See also
Description of Fields
Field Description
balance Balance value that will be after the execution of the trade operation
equity Equity value that will be after the execution of the trade operation
profit Value of the floating profit that will be after the execution of the trade operation
margin Margin required for the trade operation
margin_free Free margin that will be left after the execution of the trade operation
margin_level Margin level that will be set after the execution of the trade operation
comment Comment to the reply code, error description
See also
Trade Request S tructure, S tructure for Current Prices, OrderS end, OrderCheck
Fields description
Field Description
The trade operation result is returned to a variable of the M qlTradeResult type, which is passed as the
second parameter to OrderS end() to perform trade operations.
The terminal fixes request ID in request_id field when sending it to the trade server using
Orders S end() and OrderS endAsync() functions. The terminal receives messages about performed
transactions from the trade server and submits them for processing by OnTradeTransaction() function
containing the following components as parameters :
· description of the trade transaction in M qlTradeTransaction structure;
· description of the trade request sent from OrderS end() or Orders S endAsync() function. Request ID is
sent by the terminal to the trade server, while the request itself and its request_id are stored in the
terminal memory;
· the trade request execution result as M qlTradeResult structure with request_id field containing ID of
this request.
OnTradeTransaction() function receives three input parameters but the last two should be analyzed
only for transactions having TRADE_TRANSACTION_REQUES T type. In all other cases, data on the trade
request and its execution result are not filled. Example of parameters analysis can be found at
S tructure of a Trade R equest.
S ettingrequest_id by the terminal for the trade request when sending it to the server is mainly
introduced for working with OrderS endAsync() asynchronous function. This identifier allows to
associate the performed action (OrderS end or OrderS endAsync functions call) with the result of this
action sent to OnTradeTransaction().
Example:
//+------------------------------------------------------------------+
//| Sending a trade request with the result processing |
//+------------------------------------------------------------------+
bool MyOrderSend(MqlTradeRequest request,MqlTradeResult result)
{
//--- reset the last error code to zero
ResetLastError();
//--- send request
bool success=OrderSend(request,result);
//--- if the result fails - try to find out why
if(!success)
{
int answer=result.retcode;
Print("TradeLog: Trade request failed. Error = ",GetLastError());
switch(answer)
{
//--- requote
case 10004:
{
Print("TRADE_RETCODE_REQUOTE");
Print("request.price = ",request.price," result.ask = ",
result.ask," result.bid = ",result.bid);
break;
}
//--- order is not accepted by the server
case 10006:
{
Print("TRADE_RETCODE_REJECT");
Fields Description
Field Description
order_type Trade order type. The value can be one of ENUM _ORDER_T YPE enumeration
values.
order_state Trade order state. The value can be one of ENUM _ORDER_S TATE enumeration
values.
deal_type Deal type. The value can be one of ENUM _DEAL_TYPE enumeration values.
time_type Order type upon expiration. The value can be one of ENUM _ORDER_TYPE_TIM E
values.
time_expiration Pending order expiration term (for orders of ORDER_TIM E_S PECIFIED and
ORDER_TIM E_S PECIFIED_DAY types).
price Price. Depending on a trade transaction type, it may be a price of an order, a
deal or a position.
price_trigger S top limit order stop (activation) price (ORDER_TYPE_BUY_S TOP_LIMIT and
ORDER_TYPE_SELL_S TOP_LIMIT).
price_sl S topLoss price. Depending on a trade transaction type, it may relate to an
order, a deal or a position.
price_tp Take Profit price. Depending on a trade transaction type, it may relate to an
order, a deal or a position.
volume Volume in lots. Depending on a trade transaction type, it may indicate the
current volume of an order, a deal or a position.
position The ticket of the position affected by the transaction.
position_by The ticket of the opposite position. Used when closing a position by an
opposite one, i.e. by a position of the same symbol that was opened in the
opposite direction.
The essential parameter for received transaction analysis is its type specified in type field. For
example, if a transaction is of TRADE_TRANSACTION_REQUES T type (a result of handling a trade
request by the server has been received), the structure has only only one field that is filled completely
- type. Other fields are not analyzed. In this case, we may analyze two additional request and result
parameters submitted to OnTradeTransaction() handler, as shown below.
H aving data on a trading operation type, you can decide on the analysis of the current state of orders,
positions and deals on a trading account. Remember that one trade request sent to the server from
the terminal can generate several new transactions. The priority of their arrival at the terminal is not
guaranteed.
The following fields in M qlTradeTransaction structure are filled for trade transactions related to
open orders handling (TRADE_TRANSACTION_ORDER_ADD, TRADE_TRANSACTION_ORDER_UPDATE
and TRADE_TRANSACTION_ORDER_DELETE) and orders history
(TRADE_TRANSACTION_HIS TORY_ADD, TRADE_TRANSACTION_HIS TORY_UPDATE,
TRADE_TRANSACTION_HIS TORY_DELETE):
· order - order tick et;
· symbol - order symbol name;
· type - trade transaction type;
· order_type - order type;
· orders _state - order current state;
· time_type - order expiration type;
· time_expiration - order expiration time (for orders having ORDER_TIM E_S PECI FI ED and
ORDER_TIM E_S PECIFIED_DAY expiration types);
· price - order price specified by a client;
· price_trigger - stop limit order stop price (only for ORDER_T YPE_BUY_S TOP_LIMIT and
ORDER_TYPE_SELL_S TOP_LIMIT);
· price_sl - S top Loss order price (filled, if specified in the order);
· price_tp - Tak e Profit order price (filled, if specified in the order);
· volume - order current volume (unfilled). Initial order volume can be found in the orders history
using HistoryOrders * function.
· position - the tick et of the position that was opened, modified or closed as a result of order
execution. It is only filled for market orders, not filled for TRADE_TRANSACTION_ORDER_ADD.
· position_by - the tick et of the opposite position. It is only filled for the close by orders (to close a
position by an opposite one).
TRADE_TRANSACTION_DEAL_*
The following fields in M qlTradeTransaction structure are filled for trade transactions related to
deals handling (TRADE_TRANSACTION_DEAL_ADD, TRADE_TRANSACTION_DEAL_UPDATE and
TRADE_TRANSACTION_DEAL_DELETE):
· deal - deal tick et;
· order - order tick et, based on which a deal has been performed;
· symbol - deal symbol name;
· type - trade transaction type;
· deal_type - deal type;
· price - deal price;
· price_sl - S top Loss price (filled, if specified in the order, based on which a deal has been
performed);
· price_tp - Tak e Profit price (filled, if specified in the order, based on which a deal has been
performed);
· volume - deal volume in lots.
· position - the tick et of the position that was opened, modified or closed as a result of deal
execution.
· position_by - the ticket of the opposite position. It is only filled for the out by deals (closing a
position by an opposite one).
TRADE_TRANSACTION_POSITION
The following fields in M qlTradeTransaction structure are filled for trade transactions related to
changing the positions not connected with deals execution (TRADE_TRANSACTION_POS ITION):
· symbol - position symbol name;
· type - trade transaction type;
· deal_type - position type (DEAL _T YPE_BUY or DEAL _T YPE_SELL);
· price - weighted average position open price;
· price_sl - S top Loss price;
· price_tp - Tak e Profit price;
· volume - position volume in lots, if it has been changed.
Position change (adding, changing or closing), as a result of a deal execution, does not lead to
the occurrence of TRADE_TRANSACTION_POS ITION transaction.
TRADE_TRANSACTION_REQUEST
Only one field in M qlTradeTransaction structure is filled for trade transactions describing the fact
that a trade request has been processed by a server and processing result has been received
(TRADE_TRANSACTION_REQUES T):
· type - trade transaction type;
Only type field (trade transaction type) must be analyzed for such transactions. The second and
third parameters of OnTradeTransaction function (request and result) must be analyzed for
additional data.
Example:
//--- enable CTrade trading class and declare the variable of this class
#include <Trade\Trade.mqh>
CTrade trade;
//--- flags for installing and deleting the pending order
bool pending_done=false;
bool pending_deleted=false;
//--- pending order ticket will be stored here
ulong order_ticket;
//+------------------------------------------------------------------+
//| Expert initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- set MagicNumber to mark all our orders
trade.SetExpertMagicNumber(MagicNumber);
//--- trade requests will be sent in asynchronous mode using OrderSendAsync() function
trade.SetAsyncMode(true);
//--- initialize the variable by zero
order_ticket=0;
//---
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Expert tick function |
//+------------------------------------------------------------------+
void OnTick()
{
//---installing a pending order
if(!pending_done)
{
double ask=SymbolInfoDouble(_Symbol,SYMBOL_ASK);
double buy_stop_price=NormalizeDouble(ask+1000*_Point,(int)SymbolInfoInteger(_Symbol,SYMBOL_D
bool res=trade.BuyStop(0.1,buy_stop_price,_Symbol);
//--- if BuyStop() function performed successfully
if(res)
{
pending_done=true;
//--- get a result of the request sending from ctrade
MqlTradeResult trade_result;
trade.Result(trade_result);
//--- get request_id for the sent request
uint request_id=trade_result.request_id;
Print("Request has been sent to set a pending order. Request_ID=",request_id);
//--- storing the order ticket (will be zero if using the asynchronous mode of sending to
order_ticket=trade_result.order;
//--- all is done, early exit from OnTick() handler
return;
}
}
//--- delete the pending order
if(!pending_deleted)
//--- additional check
if(pending_done && (order_ticket!=0))
{
//--- trying to delete the pending order
bool res=trade.OrderDelete(order_ticket);
Print("OrderDelete=",res);
//--- when delete request is sent successfully
if(res)
{
pending_deleted=true;
//--- get the request execution result
MqlTradeResult trade_result;
trade.Result(trade_result);
//--- take request ID from the result
uint request_id=trade_result.request_id;
//--- display in Journal
//---
}
//+------------------------------------------------------------------+
//| Returns transaction textual description |
//+------------------------------------------------------------------+
string TransactionDescription(const MqlTradeTransaction &trans)
{
//---
string desc=EnumToString(trans.type)+"\r\n";
desc+="Symbol: "+trans.symbol+"\r\n";
desc+="Deal ticket: "+(string)trans.deal+"\r\n";
See also
The variable of the M qlTick type allows obtaining values of As k, Bid, Last and Volume within a single
call of the S ymbolInfoTick() function.
The parameters of each tick are filled in regardless of whether there are changes compared to the
previous tick. Thus, it is possible to find out a correct price for any moment in the past without the
need to search for previous values at the tick history. For example, even if only a Bid price changes
during a tick arrival, the structure still contains other parameters as well, including the previous As k
price, volume, etc.
You can analyze the tick flags to find out what data have been changed exactly:
· TICK_FLAG_BID – tick has changed a Bid price
· TICK_FLAG_ASK – a tick has changed an As k price
· TICK_FLAG_LAS T – a tick has changed the last deal price
· TICK_FLAG_VOLUM E – a tick has changed a volume
· TICK_FLAG_BUY – a tick is a result of a buy deal
· TICK_FLAG_SELL – a tick is a result of a sell deal
Example:
void OnTick()
{
MqlTick last_tick;
//---
if(SymbolInfoTick(Symbol(),last_tick))
{
Print(last_tick.time,": Bid = ",last_tick.bid,
" Ask = ",last_tick.ask," Volume = ",last_tick.volume);
}
else Print("SymbolInfoTick() failed, error = ",GetLastError());
//---
}
See also
Event descriptions are set by the M qlCalendarEvent structure. It is used in the CalendarEventById(),
CalendarEventByCountry() and CalendarEventByCurrency() functions
struct MqlCalendarEvent
{
ulong id; // event ID
ENUM_CALENDAR_EVENT_TYPE type; // event type from the ENUM_CALENDAR_
ENUM_CALENDAR_EVENT_SECTOR sector; // sector an event is related to
ENUM_CALENDAR_EVENT_FREQUENCY frequency; // event frequency
ENUM_CALENDAR_EVENT_TIMEMODE time_mode; // event time mode
ulong country_id; // country ID
ENUM_CALENDAR_EVENT_UNIT unit; // economic indicator value's unit of
ENUM_CALENDAR_EVENT_IMPORTANCE importance; // event importance
ENUM_CALENDAR_EVENT_MULTIPLIER multiplier; // economic indicator value multiplie
uint digits; // number of decimal places
string source_url; // URL of a source where an event is
string event_code; // event code
string name; // event text name in the terminal la
};
Event values are set by the M qlCalendarValue structure. It is used in the CalendarValueById(),
CalendarValueHistoryByEvent(), CalendarValueHistory(), CalendarValueLastByEvent() and
CalendarValueLast() functions
struct MqlCalendarValue
{
ulong id; // value ID
ulong event_id; // event ID
datetime time; // event date and time
datetime period; // event reporting period
int revision; // revision of the published indicato
long actual_value; // actual value multiplied by 10^6 or
long prev_value; // previous value multiplied by 10^6
long revised_prev_value; // revised previous value multiplied
long forecast_value; // forecast value multiplied by 10^6
ENUM_CALENDAR_EVENT_IMPACT impact_type; // potential impact on the currency r
//--- functions checking the values
bool HasActualValue(void) const; // returns true if actual_value is se
bool HasPreviousValue(void) const; // returns true if prev_value is set
bool HasRevisedValue(void) const; // returns true if revised_prev_value
bool HasForecastValue(void) const; // returns true if forecast_value is
//--- functions receiving the values
double GetActualValue(void) const; // returns actual_value or nan if the
double GetPreviousValue(void) const; // returns prev_value or nan if the v
double GetRevisedValue(void) const; // returns revised_prev_value or nan
double GetForecastValue(void) const; // returns forecast_value or nan if t
};
The M qlCalendarValue structure provides methods for checking and setting values from the
actual_value, forecast_value, prev_value and revised_prev_value fields. If no value is specified, the
//--- Create a structure to store calendar events with real values instead of integers
struct AdjustedCalendarValue
{
ulong id; // value ID
ulong event_id; // event ID
datetime time; // event date and time
datetime period; // event reporting period
int revision; // revision of the published indicato
double actual_value; // actual value
if(values[i].prev_value==LONG_MIN)
values_adjusted_1[i].prev_value=double("nan");
else
values_adjusted_1[i].prev_value=values[i].prev_value/1000000.;
if(values[i].revised_prev_value==LONG_MIN)
values_adjusted_1[i].revised_prev_value=double("nan");
else
values_adjusted_1[i].revised_prev_value=values[i].revised_prev_value/1000000.;
if(values[i].forecast_value==LONG_MIN)
values_adjusted_1[i].forecast_value=double("nan");
else
values_adjusted_1[i].forecast_value=values[i].forecast_value/1000000.;
}
Print("The first method to check and get calendar values");
ArrayPrint(values_adjusted_1);
if(values[i].HasPreviousValue())
values_adjusted_2[i].prev_value=values[i].GetPreviousValue();
else
values_adjusted_2[i].prev_value=double("nan");
if(values[i].HasRevisedValue())
values_adjusted_2[i].revised_prev_value=values[i].GetRevisedValue();
else
values_adjusted_2[i].revised_prev_value=double("nan");
if(values[i].HasForecastValue())
values_adjusted_2[i].forecast_value=values[i].GetForecastValue();
else
values_adjusted_2[i].forecast_value=double("nan");
}
Print("The second method to check and get calendar values");
ArrayPrint(values_adjusted_2);
Event frequency is specified in the M qlCalendarEvent structure. Possible values are set in the listing
ENUM_CALENDAR_EVENT_FREQUENCY
ID Description
Event type is specified in the M qlCalendarEvent structure. Possible values are set in the listing
ENUM_CALENDAR_EVENT_TY PE
ID Description
A sector of the economy an event is related to is specified in the M qlCalendarEvent structure. Possible
values are set in the listing ENUM_CALENDAR_EVENT_SECTOR
ID Description
ID Description
CALENDAR_SECTOR_CONSUM ER Consumption
CALENDAR_SECTOR_HOUS ING H ousing
CALENDAR_SECTOR_TAXES Taxes
CALENDAR_SECTOR_HOLIDAYS H olidays
Event importance is specified in the M qlCalendarEvent structure. Possible values are set in the listing
ENUM_CALENDAR_EVENT_IMPORTANCE
ID Description
Measurement unit type used in displaying event values is specified in the M qlCalendarEvent structure.
Possible values are set in the listing ENUM_CALENDAR_EVENT_UNIT
ID Description
CALENDAR_UNIT_HOUR H ours
CALENDAR_UNIT_JOB Jobs
ID Description
CALENDAR_UNIT_USD USD
CALENDAR_UNIT_PEOPLE People
CALENDAR_UNIT_MORTGAGE Mortgage loans
CALENDAR_UNIT_VOTE Votes
CALENDAR_UNIT_BARREL Barrels
CALENDAR_UNIT_BUILDING Buildings
In some cases, economic parameter values require a multiplier set in the M qlCalendarEvent structure.
Possible multiplier values are set in the listing ENUM_CALENDAR_EVENT_MULTIPLIER
ID Description
Event's potential impact on a national currency rate is indicated in the M qlCalendarValue structure.
Possible values are set in the listing ENUM_CALENDAR_EVENT_IMPACT
ID Description
Event time is specified in the M qlCalendarEvent structure. Possible values are set in the listing
ENUM_CALENDAR_EVENT_TIMEMODE
ID Description
ID Description
See also
Economic Calendar
Compiler Warnings
Compiler warnings are shown for informational purposes only and are not error messages.
Code Description
26 Too large volume of local variables (> 512Kb) of the function, reduce the number
29 Enumeration already defined (duplication) - members will be added to the first
definition
30 Overriding macro
31 The variable is declared but is not used anywhere
32 Constructor must be of void type
33 Destructor must be of void type
34 Constant does not fit in the range of integers (X> _UI64_M AX | | X <_I64_MIN) and
will be converted to the double type
35 Too long HEX - more than 16 significant characters (senior nibbles are cut)
36 No nibbles in HEX string "0x"
37 No function - nothing to be performed
38 A non-initialized variable is used
41 Function has no body, and is not called
43 Possible loss of data at typecasting. Example: int x = (double) z;
44 Loss of accuracy (of data) when converting a constant. Example: int x = M _PI
45 Difference between the signs of operands in the operations of comparison.
Example: (char) c1> (uchar) c2
Code Description
47 Too large description - extra characters will not be included in the executable file
48 The number of indicator buffers declared is less than required
49 No color to plot a graphical series in the indicator
50 No graphical series to draw the indicator
51 'OnS tart' handler function not found in the script
52 'OnS tart' handler function is defined with wrong parameters
53 'OnS tart' function can be defined only in a script
54 'OnInit' function is defined with wrong parameters
55 'OnInit' function is not used in scripts
56 'OnDeinit' function is defined with wrong parameters
57 'OnDeinit' function is not used in scripts
58 Two 'OnCalculate' functions are defined. OnCalculate () at one price array will be
used
59 Overfilling detected when calculating a complex integer constant
60 Probably, the variable is not initialized.
61 This declaration makes it impossible to refer to the local variable declared on the
specified line
62 This declaration makes it impossible to refer to the global variable declared on the
specified line
63 Cannot be used for static allocated array
64 This variable declaration hides predefined variable
65 The value of the expression is always true/false
66 Using a variable or bool type expression in mathematical operations is unsafe
67 The result of applying the unary minus operator to an unsigned ulong type is
undefined
68 The version specified in the #property version property is unacceptable for the
Market section; the correct format of #property version id "XXX.YYY"
69 Empty controlled statement found
70 Invalid function return type or incorrect parameters during declaration of the event
handler function
71 An implicit cast of structures to one type is required
72 This declaration makes direct access to the member of a class declared in the
specified string impossible. Access will be possible only with the scope resolution
operation ::
Code Description
Compilation Errors
MetaEdtior 5 shows error messages about the program errors detected by the built-in compiler during
compilation. The list of these errors is given below in table. To compile a source code into an
executable one, press F7. Programs that contain errors cannot be compiled until the errors identified
by the compiler are eliminated.
Code Description
Code Description
Code Description
Code Description
Code Description
Code Description
Code Description
Code Description
Code Description
352 An overload operation (+,-,[],++,-- etc.) is expected after the operator keyword
353 Not all operations can be overloaded in MQL5
354 Definition does not match declaration
355 An invalid number of parameters is specified for the operator
356 Event handling function not found
357 Method cannot be exported
358 A pointer to the constant object cannot be normalized by a non-constant object
359 Class templates are not supported yet
360 Function template overload is not supported yet
361 Function template cannot be applied
Code Description
381 Illegal syntax when declaring pure virtual function, only "=NULL" or "=0" are allowed
382 Only virtual functions can be declared with the pure-specifier ("=NULL" or "=0" )
383 Abstract class cannot be instantiated
384 A pointer to a user-defined type should be applied as a target type for dynamic
casting using the dynamic_cast operator
385 " Pointer to function" type is expected
386 Pointers to methods are not supported
387 Error – cannot define the type of a pointer to function
388 Type cast is not available due to private inheritance
389 A variable with const modifier should be initialized during declaration
393 Only methods with public access can be declared in an interface
394 Invalid nesting of an interface inside of another interface
395 An interface can only be derived from another interface
396 An interface is expected
397 Interfaces only support public inheritance
398 An interface cannot contain members
Code Description
413 MQL4 is not supported. To compile this program, use MetaEditor from your
MetaTrader 4 installation folder
Runtime Errors
GetLastError() is the function that returns the last error code that is stored in the predefined variable
_LastError. This value can be reset to zero by the R esetLastError() function.
ERR_WR ONG_INT ERNAL _PARAM ET ER 4002 W rong parameter in the inner call
of the client terminal function
ERR_INVALID_PARAM ET ER 4003 W rongparameter when calling the
system function
ERR_NOT _ENOUGH_M EMORY 4004 Not enough memory to perform
the system function
ERR_S T RUCT _W IT H OBJECT S_OR CL ASS 4005 The structure contains objects of
strings and/or dynamic arrays
and/or structure of such objects
and/or classes
ERR_INVALID_ARRAY 4006 Array ofa wrong type, wrong size,
or a damaged object of a dynamic
array
ERR_ARRAY_RES IZE_ERR OR 4007 Not enough memory for the
relocation of an array, or an
attempt to change the size of a
static array
ERR_S T R ING_RES IZE_ERR OR 4008 Not enough memory for the
relocation of string
ERR_NOTINITIALIZED_S T R ING 4009 Not initialized string
ERR_RES OUR CE_UNSUPPOR T ED_T YPE 4017 Unsupported resource type or its
size exceeds 16 Mb
ERR_RES OUR CE_NAM E_IS_TOO_LONG 4018 The resource name exceeds 63
characters
ERR_M AT H_OVERFLOW 4019 Overflow occurred when
calculating math function
ERR_S L EEP_ERR OR 4020 Out of test end date after calling
S leep()
Global_Variables
ERR_GLOBAL VAR IABL E_NOT _FOUND 4501 Global variable of the client
terminal is not found
ERR_GLOBAL VAR IABL E_EXIS T S 4502 Global variable of the client
terminal with the same name
already exists
ERR_GLOBAL VAR IABL E_NOT _MODIFIED 4503 Global variables were not
modified
ERR_GLOBAL VAR IABL E_CANNOT READ 4504 Cannot read file with global
variable values
ERR_GLOBAL VAR IABL E_CANNOT WR IT E 4505 Cannot write file with global
variable values
ERR_M AIL _SEND_FAIL ED 4510 Email sending failed
ERR_PL AY_S OUND_FAIL ED 4511 S ound playing failed
ERR_MQL5_WR ONG_PR OPER T Y 4512 W rong identifier of the program
property
ERR_T ER MINAL _WR ONG_PR OPER T Y 4513 W rong identifier of the terminal
property
ERR_FTP_SEND_FAIL ED 4514 File sending via ftp failed
ERR_NOTIFICATION_SEND_FAIL ED 4515 Failed to send a notification
ERR_NOTIFICATION_WR ONG_PARAM ET ER 4516 Invalid parameter for sending a
notification – an empty string or
NULL has been passed to the
S endNotification() function
ERR_CUS TOM _WR ONG_PR OPER T Y 4603 W rong ID of the custom indicator
property
Account
ERR_CUS TOM _SYM BOL _NAM E_LONG 5302 The name of the custom symbol is
too long. The length of the symbol
name must not exceed 32
characters including the ending 0
character
ERR_CUS TOM _SYM BOL _PAT H_LONG 5303 The path of the custom symbol is
too long. The path length should
not exceed 128 characters
including " Custom\\" , the symbol
name, group separators and the
ending 0
ERR_CUS TOM _SYM BOL _EXIS T 5304 A custom symbol with the same
name already exists
ERR_CUS TOM _SYM BOL _ERR OR 5305 Error occurred while creating,
deleting or changing the custom
symbol
ERR_CUS TOM _SYM BOL _SEL ECT ED 5306 Youare trying to delete a custom
symbol selected in Market W atch
ERR_CUS TOM _SYM BOL _PR OPER T Y_WR ONG 5307 An invalid custom symbol property
ERR_CUS TOM _SYM BOL _PARAM ET ER_ERR OR 5308 A wrong parameter while setting
the property of a custom symbol
ERR_CUS TOM _SYM BOL _PARAM ET ER_LONG 5309 A too long string parameter while
setting the property of a custom
symbol
ERR_CUS TOM _TICKS_WR ONG_ORDER 5310 Ticks in the array are not
arranged in the order of time
Economic Calendar
ONNX models
See also
Trade S erver Return Codes
FIL E_UNICODE 64 S trings of UNICODE type (two byte symbols). Flag is used
in FileOpen().
FIL E_SHARE_READ 128 S hared access for reading from several programs. Flag is
used in FileOpen(), but it does not replace the necessity
to indicate FILE_WRITE and/or the FILE_READ flag when
opening a file.
FIL E_SHARE_WR IT E 256 S hared access for writing from several programs. Flag is
used in FileOpen(), but it does not replace the necessity
to indicate FILE_WRITE and/or the FILE_READ flag when
opening a file.
FIL E_REWR IT E 512 Possibility for the file rewrite using functions FileCopy()
and FileMove(). The file should exist or should be opened
for writing, otherwise the file will not be opened.
FIL E_COMMON 4096 The file path in the common folder of all client terminals
\Terminal\Common\Files. Flag is used in FileOpen(),
FileCopy(), FileMove() and in FileIs Exist() functions.
One or several flags can be specified when opening a file. This is a combination of flags. The
combination of flags is written using the sign of logical OR (|), which is positioned between
enumerated flags. For example, to open a file in CSV format for reading and writing at the same time,
specify the combination FILE_READ|FILE_WRITE|FILE_CSV.
Example:
int filehandle=FileOpen(filename,FILE_READ|FILE_WRITE|FILE_CSV);
There are some specific features of work when you specify read and write flags :
· If FILE_READ is specified, an attempt is made to open an existing file. If a file does not exist, file
opening fails, a new file is not created.
· FIL E_READ|FIL E_WR IT E – a new file is created if the file with the specified name does not exist.
W hen opening a file, specification of FIL E_WR IT E and/or FIL E_READ is required.
Flags that define the type of reading of an open file possess priority. The highest flag is FILE_CSV,
then goes FILE_BIN, and FILE_TXT is of lowest priority. Thus, if several flags are specified at the same
time, (FILE_TXT|FILE_CSV or FILE_TXT|FILE_BIN or FILE_BIN|FILE_CSV), the flag with the highest
priority will be used.
Flags that define the type of encoding also have priority. FIL E_UNICODE is of a higher priority than
FIL E_ANS I. S o if you specify combination FIL E_UNICODE|FIL E_ANS I, flag FIL E_UNICODE will be used.
If neither FILE_UNICODE nor FILE_ANS I is indicated, FILE_UNICODE is implied. If neither FILE_CSV, nor
FIL E_BIN, nor FIL E_T XT is specified, FIL E_CSV is implied.
If a file is opened for reading as a text file (FILE_TXT or FILE_CSV), and at the file beginning a special
two-byte indication 0xff,0xfe is found, the encoding flag will be FILE_UNICODE, even if FILE_ANS I is
specified.
See also
File Functions
File Properties
The FileGetInteger() function is used for obtaining file properties. The identifier of the required
property from the ENUM _FILE_PROPERTY_INTEGER enumeration is passed to it during call.
ENUM_FILE_PROPERTY _INTEGER
ID ID description
FIL E_IS_T EXT The file is opened as a text file (see FILE_TXT)
FIL E_IS_BINARY The file is opened as a binary file (see FILE_BIN)
FIL E_IS_CSV The file is opened as CSV (see FILE_CSV)
FIL E_IS_ANS I The file is opened as ANS I (see FILE_ANS I)
FIL E_IS_READABL E The opened file is readable (see FILE_READ)
FIL E_IS_WR IT ABL E The opened file is writable (see FILE_WRITE)
The FileGetInteger() function has two different options of call. In the first option, for getting
properties of a file, its handle is specified, which is obtained while opening the file using the
FileOpen() function. This option allows getting all properties of a file.
The second option of the FileGetInteger() function returns values of file properties by the file name.
Using this option, only the following general properties can be obtained:
· FIL E_MODI FY_DAT E – date of modification of the file with the specified name
· FIL E_ACCESS_DAT E – date of the last access to the file with the specified name
W hen trying to get properties other than specified above, the second option of FileGetInteger() call
will return an error.
Identifier Description
See also
FileIs Ending, FileIsLineEnding
See also
Client Terminal Properties
The main flags of the MessageBox() function define contents and behavior of the dialog window. This
value can be a combination of the following flag groups :
MQL5 Programs
For the mql5-program to operate, it must be compiled (Compile button or F7 key). Compilation should
pass without errors (some warnings are possible; they should be analyzed). At this process, an
executable file with the same name and with EX5 extension must be created in the corresponding
directory, terminal_dir\MQL5\Experts, terminal_dir\MQL5\indicators or terminal_dir\MQL5\scripts.
This file can be run.
Operating features of MQL5 programs are described in the following sections :
· Program running – order of calling predefined event-handlers.
· Testing trading strategies – operating features of MQL5 programs in the S trategy Tester.
· Client terminal events – description of events, which can be processed in programs.
· Call of imported functions – description order, allowed parameters, search details and call agreement
for imported functions.
· R untime errors – getting information about runtime and critical errors.
Expert Advisors,custom indicators and scripts are attached to one of opened charts by Drag'n'Drop
method from the Navigator window.
For an expert Advisor to stop operating, it should be removed from a chart. To do it select "Expert
list" in chart context menu, then select an Expert Advisor from list and click "Remove" button.
Operation of Expert Advisors is also affected by the state of the "AutoTrading" button.
In order to stop a custom indicator, it should be removed from a chart.
Custom indicators and Expert Advisors work until they are explicitly removed from a chart;
information about attached Expert Advisors and Indicators is saved between client terminal sessions.
S criptsare executed once and are deleted automatically upon operation completion or change of the
current chart state, or upon client terminal shutdown. After the restart of the client terminal scripts
are not started, because the information about them is not saved.
Maximum one Expert Advisor, one script and unlimited number of indicators can operate in one chart.
S ervices do not require to be bound to a chart to work and are designed to perform auxiliary functions.
For example, in a service, you can create a custom symbol, open its chart, receive data for it in an
endless loop using the network functions and constantly update it.
Program Running
Each script, each service and each Expert Advisor runs in its own separate thread. All indicators
calculated on one symbol, even if they are attached to different charts, work in the same thread.
Thus, all indicators on one symbol share the resources of one thread.
Allother actions associated with a symbol, like processing of ticks and history synchronization, are
also consistently performed in the same thread with indicators. This means that if an infinite action is
performed in an indicator, all other events associated with its symbol will never be performed.
W hen running an Expert Advisor, make sure that it has an actual trading environment and can access
the history of the required symbol and period, and synchronize data between the terminal and the
server. For all these procedures, the terminal provides a start delay of no more than 5 seconds, after
which the Expert Advisor will be started with available data. Therefore, in case there is no connection
to the server, this may lead to a delay in the start of an Expert Advisor.
The below table contains a brief summary of MQL5 programs :
Indicator One thread for all indicators on a An infinite loop in one indicator
symbol. The number of threads is will stop all other indicators on
equal to the number of symbols this symbol
with indicators
R ight aftera program is attached to a chart, it is uploaded to the client terminal memory, as well as
global variable are initialized. If some global variable of the class type has a constructor, this
constructor will be called during initialization of global variables.
Afterthat the program is waiting for an event from the client terminal. Each mql5-program should
have at least one event-handler, otherwise the loaded program will not be executed. Event handlers
have predefined names, parameters and return types.
void OnDeinit const int reason Expert Advisors Deinit event handler.
and indicators
void OnS tart none scripts and S tart event handler.
services
int OnCalculate const int rates _total, indicators Calculate event
const int handler for all prices.
prev _calculated,
const datetime &Time[],
const double &Open[],
const double &High[],
const double &Low[],
const double &Close[],
const long
&TickVolume[],
const long &Volume[],
const int &S pread[]
int OnCalculate const int rates _total, indicators Calculate event
const int handler on the single
prev _calculated, data array.
const int begin, Indicator cannot have
const double &price[] two event handlers
simultaneously.
In this case the only
one event handler will
work on the data
array.
void OnTick none Expert Advisors NewTick event
handler. W hile the
event of a new tick
receipt is being
processed, no other
events of this type
are received.
void OnTimer none Expert Advisors Timer event handler.
and indicators
void OnTrade none Expert Advisors Trade event handler.
double OnTester none Expert Advisors Tester event handler.
void OnChartEvent const int id, Expert Advisors ChartEvent event
const long &lparam, and indicators handler.
const double &dparam,
const string &sparam
void OnBookEvent const string Expert Advisors BookEvent event
&symbol_name and indicators handler.
A client terminal sends new events to the corresponding open charts. Events can also be generated by
charts (chart events) or mql5-programs (custom events). Generation of events of creation or deletion
of graphical objects on a chart can be enabled or disabled by setting CHART_EVENT_OBJECT_CREATE
and CHART_EVENT_OBJECT_DELETE chart properties. Each MQL5 program and each chart has its own
queue of events, where all new incoming events are added.
A program receives only events from the chart it runs on. All events are processed one after another in
the order they are received. If a queue already has a NewTick event, or this event is currently being
processed, then the new NewTick event is not placed in the queue of the MQL5 program. S imilarly, if
ChartEvent is already enqueued, or this event is being processed, no new event of this kind is
enqueued. The timer events are handled the same way – if the Timer event is in the queue or being
handled, the new timer event is not enqueued.
Event queues have a limited but sufficient size, so that the queue overflow for well written programs
is unlikely. In case of queue overflow, new events are discarded without queuing.
It is strongly recommended not to use infinite loops to handle events. Possible exceptions are scripts
and services handling a single S tart event.
Libraries do not handle any events.
Indicators, scripts and Expert Advisors are executable programs written in MQL5. They are designed
for different types of tas ks. Therefore there are some restrictions on the use of certain functions,
depending on the type of program. The following functions are prohibited in indicators :
· OrderCalcMargin();
· OrderCalcProfit();
· OrderCheck();
· OrderS end();
· S endFTP();
· S leep();
· ExpertR emove();
· MessageBox().
All functions designed for indicators are prohibited in Expert Advisors and scripts :
· S etIndex Buffer();
· IndicatorS etDouble();
· IndicatorS etInteger();
· IndicatorS etS tring();
· PlotIndexS etDouble();
· PlotIndexS etInteger();
· PlotIndexS etS tring();
· PlotIndexGetInteger.
The library is not an independent program and is executed in the context of the MQL5 program that
has called it: script, indicator or Expert Advisor. Accordingly, the above restrictions apply to the called
library.
S ervicesdo not accept any events, as they are not bound to a chart. The following functions are
prohibited in services :
ExpertR emove();
EventS etMillisecondTimer();
EventS etTimer();
EventKillTimer();
S etIndex Buffer();
IndicatorS etDouble();
IndicatorS etInteger();
IndicatorS etS tring();
PlotIndexS etDouble();
PlotIndexS etInteger();
PlotIndexS etS tring();
PlotIndexGetInteger();
S cripts
are loaded immediately after they are attached to a chart and unloaded immediately after they
complete their operation. OnInit() and OnDeinit() are not called for scripts.
W hen a program is unloaded (deleted from a chart) the client terminal performs deinitialization of
global variables and deletes the events queue. In this case deinitialization means reset of all the
string-type variables, deallocation of dynamical array objects and call of their destructors if they are
available.
S ervicesare loaded right after starting the terminal if they were launched at the moment of the
terminal shutdown. S ervices are unloaded immediately after completing their work.
S erviceshave a single OnS tart() handler, in which you can implement an endless data receiving and
handling loop, for example creating and updating custom symbols using the network functions.
Unlik e Expert Advisors, indicators and scripts, services are not bound to a specific chart, therefore a
separate mechanism is provided to launch them. A new service instance is created in the Navigator
using the "Add S ervice" command. A service instance can be launched, stopped and removed using the
appropriate instance menu. To manage all instances, use the service menu.
For a better understanding of the Expert Advisor operation we recommend to compile the code of the
following Expert Advisor and perform actions of load/unload, template change, symbol change,
timeframe change etc:
Example:
//+------------------------------------------------------------------+
//| TestExpert.mq5 |
//| Copyright 2009, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "2009, MetaQuotes Software Corp."
#property link "https://www.mql5.com"
#property version "1.00"
class CTestClass
{
public:
CTestClass() { Print("CTestClass constructor"); }
~CTestClass() { Print("CTestClass destructor"); }
};
CTestClass global;
//+------------------------------------------------------------------+
//| Expert initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//---
Print("Initialization");
//---
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Expert deinitialization function |
//+------------------------------------------------------------------+
void OnDeinit(const int reason)
{
//---
Print("Deinitialization with reason",reason);
}
//+------------------------------------------------------------------+
//| Expert tick function |
//+------------------------------------------------------------------+
void OnTick()
{
//---
}
//+------------------------------------------------------------------+
See also
Client terminal events, Event handlers
Trade Permission
Trade Automation
MQL5 language provides a special group of trade functions designed for developing automated trading
systems. Programs developed for automated trading with no human intervention are called Expert
Advisors or trading robots. In order to create an Expert Advisor in MetaEditor, launch MQL5 W izard
and select one of the two options :
· Expert Advisor (template) – allows you to create a template with ready-made event handling
functions that should be supplemented with all necessary functionality by means of programming.
· Expert Advisor (generate) – allows you to develop a full-fledged trading robot simply by selecting the
necessary modules : trading signals module, money management module and trailing stop module.
Trading functions can work only in Expert Advisors and scripts. Trading is not allowed for indicators.
The terminal settings provide you with an ability to allow or forbid automated trading for all programs.
You can switch automated trading option right on the terminal's S tandard panel:
if (!TerminalInfoInteger(TERMINAL_TRADE_ALLOWED))
Alert("Check if automated trading is allowed in the terminal settings!");
You can allow or forbid automated trading for a certain program when launching it. To do this, use the
special check box in the program properties.
S ample check:
if(!TerminalInfoInteger(TERMINAL_TRADE_ALLOWED))
Alert("Check if automated trading is allowed in the terminal settings!");
else
{
if(!MQLInfoInteger(MQL_TRADE_ALLOWED))
Alert("Automated trading is forbidden in the program settings for ",__FILE__);
}
Checking if trading is allowed for any Expert Advisors/scripts for the current
account
Automated trading can be disabled at the trade server side. S ample check:
if(!AccountInfoInteger(ACCOUNT_TRADE_EXPERT))
Alert("Automated trading is forbidden for the account ",AccountInfoInteger(ACCOUNT_LOGIN),
" at the trade server side");
If automated trading is disabled for a trading account, trading operations of Expert Advisors /scripts
are not executed.
In some cases, any trading operations are disabled for a certain trading account – neither manual nor
automated trading can be performed. S ample check when an investor password has been used to
connect to a trading account:
if(!AccountInfoInteger(ACCOUNT_TRADE_ALLOWED))
Comment("Trading is forbidden for the account ",AccountInfoInteger(ACCOUNT_LOGIN),
".\n Perhaps an investor password has been used to connect to the trading account.",
"\n Check the terminal journal for the following entry:",
See also
Client Terminal Properties, Account Properties, Properties of a Running MQL5 Program
Deinit
Before global variables are deinitialized and the program (Expert Advisor or custom indicator) is
unloaded, the client terminal sends the Deinit event to the program. Deinit is also generated when the
client terminal is closed, when a chart is closed, right before the security and/or timeframe is
changed, at a successful program re-compilation, when input parameters are changed, and when
account is changed.
The deinitialization reason can be obtained from the parameter, passed to the OnDeinit() function.
The OnDeinit() function run is restricted to 2.5 seconds. If during this time the function hasn't been
completed, then it is forcibly terminated. The Deinit event is not generated for scripts.
Start
S tart is
a special event for launching a script or a service after loading it. It is handled by the OnS tart
function. The S tart event is not passed to EAs and custom indicators.
NewTick
The NewTick event is generated if there are new quotes, it is processed by OnTick() of Expert
Advisors attached. In case when OnTick function for the previous quote is being processed when a new
quote is received, the new quote will be ignored by an Expert Advisor, because the corresponding
event will not enqueued.
Allnew quotes that are received while the program is running are ignored until the OnTick() is
completed. After that the function will run only after a new quote is received. The NewTick event is
generated irrespective of whether automated trade is allowed or not ("Allow/prohibit Auto trading"
button). The prohibition of automated trading denotes only that sending of trade requests from an
Expert Advisor is not allowed, while the Expert Advisor k eeps work ing.
The prohibition of automated trading by pressing the appropriate button will not stop the current
execution of the OnTick() function.
Calculate
The Calculate event is generated only for indicators right after the Init event is sent and at any change
of price data. It is processed by the OnCalculate function.
Timer
The Timer event is periodically generated by the client terminal for the Expert Advisor that has
activated the timer by the EventS etTimer function. Usually, this function is called by OnInit. Timer
event processing is performed by the OnTimer function. After the operation of the Expert Advisor is
completed, it is necessary to destroy the timer using the EventKillTimer function, which is usually
called in the OnDeinit function.
Trade
The Trade event is generated when a trade operation is completed on a trade server. The Trade event
is handled by the OnTrade() function for the following trade operations :
· sending, modifying or removing of a pending order;
· cancellation of a pending order with not enough of money or expiration;
· activation of a pending order;
· opening, adding or closing a position (or part of the position);
· modifying of the open position (change stops – S top Loss and/or Take Profit).
TradeTransaction
W hen performing some definite actions on a trade account, its state changes. S uch actions include:
· S ending a trade request from any MQL5 application in the client terminal using OrderS end and
OrderS endAsync functions and its further execution;
· S ending a trade request via the terminal graphical interface and its further execution;
· Pending orders and stop orders activation on the server;
· Performing operations on a trade server side.
The following trade transactions are performed as a result of these actions :
· handling a trade request;
· changing open orders ;
· changing orders history;
· changing deals history;
· changing positions.
For example, when sending a market buy order, it is handled, an appropriate buy order is created for
the account, the order is then executed and removed from the list of the open ones, then it is added
to the orders history, an appropriate deal is added to the history and a new position is created. All
these actions are trade transactions. Arrival of such a transaction at the terminal is a
TradeTransaction event. This event is handled by OnTradeTransaction function.
Tester
The Tester event is generated after testing of an Expert Advisor on history data is over. The event is
handled by the OnTester() function.
TesterInit
The TesterInit event is generated with the start of optimization in the strategy tester before the first
optimization pass. The TesterInit event is handled by the OnTesterInit() function.
TesterPass
The TesterPass event is generated when a new data frame is received. The TesterPass event is
handled by the OnTesterPass() function.
TesterDeinit
The TesterDeinit event is generated after the end of optimization of an Expert Advisor in the strategy
tester. The TesterDeinit event is handled by the OnTesterDeinit() function.
ChartEvent
The ChartEvent event is generated by the client terminal when a user is working with a chart:
· k eystrok e, when the chart window is in focus ;
· graphical object created
· graphical object deleted
· mouse press on the graphical object of the chart
· move of the graphical object using the mouse
· end of text editing in LabelEdit.
Also there is a custom event ChartEvent, which can be sent to an Expert Advisor by any mql5 program
by using the EventChartCustom function. The event is processed by the OnChartEvent function.
BookEvent
The BookEvent event is generated by the client terminal after the Depth Of Market is changed; it is
processed by the OnBookEvent function. To start generation of BookEvent for the specified symbol, it
is necessary to subscribe the symbol to this event by using the MarketBookAdd function.
To unsubscribe from BookEvent for a specified symbol, it is necessary to call the MarketBookRelease
function. The BookEvent event is a broadcasting-type event - it means that it is sufficient to subscribe
just one Expert Advisor for this event, and all other Expert Advisors that have the OnBookEvent event
handler, will receive it. That's why it is necessary to analyze the symbol name, which is passed to a
handler as a parameter.
See also
Event handlers, Program running
Resources
Using graphics and sound in MQL5 programs
Programs in MQL5 allow working with sound and graphic files :
· PlayS ound() plays a sound file;
· ObjectCreate() allows creating user interfaces using graphical objects OBJ_BITM AP and
OBJ_BITM AP_LABEL.
PlaySound()
The example shows how to play sounds from files 'Ok.wav ' and 'timeout.wav ', which are included into
the standard terminal package. These files are located in the folder terminal_directory\Sounds. Here
terminal_directory is a folder, from which the MetaTrader 5 Client Terminal is started. The location
of the terminal directory can be found out from an mql5 program in the following way:
//--- Folder, in which terminal data are stored
string terminal_path=TerminalInfoString(TERMINAL_PATH);
You can use sound files not only from the folder terminal_directory\Sounds, but also from any
subfolder located in terminal_data_directory\MQL5. You can find out the location of the terminal
data directory from the terminal menu "File" -> " Open Data Folder" or using program method:
//--- Folder, in which terminal data are stored
string terminal_data_path=TerminalInfoString(TERMINAL_DATA_PATH);
For example, if the Demo.wav sound file is located in terminal_data_directory\MQL5\Files, then call of
PlayS ound() should be written the following way:
//--- play Demo.wav from the folder terminal_directory_data\MQL5\Files\
PlaySound("\\Files\\Demo.wav");
Please note that in the comment the path to the file is written using backslash "\" , and in the function
"\\" is used.
W hen specifying the path, always use only the double backslash as a separator, because a single
backslash is a control symbol for the compiler when dealing with constant strings and character
constants in the program source code.
Call PlayS ound() function with NULL parameter to stop playback:
//--- call of PlaySound() with NULL parameter stops playback
PlaySound(NULL);
ObjectCreate()
Example of an Expert Advisor, which creates a graphical label (OBJ_BITM AP_LABEL) using the
ObjectCreate() function.
string label_name="currency_label"; // name of the OBJ_BITMAP_LABEL object
string euro ="\\Images\\euro.bmp"; // path to the file terminal_data_directory\MQL5\Images\
string dollar ="\\Images\\dollar.bmp"; // path to the file terminal_data_directory\MQL5\Images\
//+------------------------------------------------------------------+
//| Expert initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- create a button OBJ_BITMAP_LABEL, if it hasn't been created yet
if(ObjectFind(0,label_name)<0)
{
//--- trying to create object OBJ_BITMAP_LABEL
bool created=ObjectCreate(0,label_name,OBJ_BITMAP_LABEL,0,0,0);
if(created)
{
//--- link the button to the left upper corner of the chart
ObjectSetInteger(0,label_name,OBJPROP_CORNER,CORNER_RIGHT_UPPER);
//--- now set up the object properties
ObjectSetInteger(0,label_name,OBJPROP_XDISTANCE,100);
ObjectSetInteger(0,label_name,OBJPROP_YDISTANCE,50);
//--- reset the code of the last error to 0
ResetLastError();
//--- download a picture to indicate the "Pressed" state of the button
bool set=ObjectSetString(0,label_name,OBJPROP_BMPFILE,0,euro);
//--- test the result
if(!set)
{
PrintFormat("Failed to download image from file %s. Error code %d",euro,GetLastError())
}
ResetLastError();
//--- download a picture to indicate the "Unpressed" state of the button
set=ObjectSetString(0,label_name,OBJPROP_BMPFILE,1,dollar);
if(!set)
{
PrintFormat("Failed to download image from file %s. Error code %d",dollar,GetLastError(
}
//--- send a command for a chart to refresh so that the button appears immediately without
ChartRedraw(0);
}
else
{
//--- failed to create an object, notify
PrintFormat("Failed to create object OBJ_BITMAP_LABEL. Error code %d",GetLastError());
}
}
//---
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Expert deinitialization function |
//+------------------------------------------------------------------+
void OnDeinit(const int reason)
{
//--- delete an object from a chart
ObjectDelete(0,label_name);
}
Creation and setup of the graphical object named currency_label are carried out in the OnInit()
function. The paths to the graphical files are set in global variables euro and dollar, a double backlash
is used for a separator:
string euro ="\\Images\\euro.bmp"; // path to the file terminal_dara_directory\MQL5\Images\
string dollar ="\\Images\\dollar.bmp"; // path to the file terminal_dara_directory\MQL5\Images\
The size of the button with a graphical interface is automatically adjusted to the size of the picture.
The image is changed by a left mouse button click on the OBJ_BITM AP_LABEL object (" Disable
selection" option must be checked in the properties). The OBJ_BITM AP object is created the same
way - it is used for creating the background with a necessary image.
The value of the OBJPROP_BMPFILE property, which is responsible for the appearance of the objects
OBJ_BITM AP and OBJ_BITM AP_LABEL, can be changed dynamically. This allows creating various
interactive user interfaces for mql5 programs.
The #resource command tells the compiler that the resource at the specified path
path_to_resource_file should be included into the executable EX5 file. Thus all the necessary images
and sounds can be located directly in an EX5 file, so that there is no need to transfer separately the
files used in it, if you want to run the program on a different terminal. Any EX5 file can contain
resources, and any EX5 program can use resources from another EX5 program.
The files in format BMP and WAV are automatically compressed before including them to an EX5 file.
This denotes that in addition to the creation of complete programs in MQL5, using resources also
allows to reduce the total size of necessary files when using graphics and sounds, as compared to the
usual way of MQL5 program writing.
The resource file size must not exceed 128 Mb.
The length of the constant string <path_to_resource_file> must not exceed 63 characters.
The compiler searches for a resource at the specified path in the following order:
· if the backslash "\" separator (written as "\\" ) is placed at the beginning of the path, it searches for
the resource relative to the directory terminal_data_directory\MQL5\,
· if there is no backslash, it searches for the resource relative to the location of the source file, in
which the resource is written.
The resource path cannot contain the substrings " ..\\" and ":\\" .
Examples of resource inclusion:
//--- correct specification of resources
#resource "\\Images\\euro.bmp" // euro.bmp is located in terminal_data_directory\MQL5\Images\
#resource "picture.bmp" // picture.bmp is located in the same directory as the source file
#resource "Resource\\map.bmp" // the resource is located in source_file_directory\Resource\map.bmp
Use of Resources
Resource name
After a resource is declared using the #resource directive, it can be used in any part of a program. The
name of the resource is its path without a backslash at the beginning of the line, which sets the path
to the resource. To use your own resource in the code, the special sign "::" should be added before the
resource name.
Examples :
ObjectSetString(0,bitmap_name,OBJPROP_BMPFILE,0,"::Images\\euro.bmp");
...
ObjectSetString(0,my_bitmap,OBJPROP_BMPFILE,0,"::picture.bmp");
...
set=ObjectSetString(0,bitmap_label,OBJPROP_BMPFILE,1,"::Files\\Pictures\\good.bmp");
...
PlaySound("::Files\\Demo.wav");
...
PlaySound("::Sounds\\thrill.wav");
It should be noted that when setting images from a resource to the OBJ_BITM AP and
OBJ_BITM AP_LABEL objects, the value of the OBJPROP_BMPFILE property cannot be modified
manually. For example, for creating OBJ_BITM AP_LABEL we use resources euro.bmp and dollar.bmp.
#resource "\\Images\\euro.bmp"; // euro.bmp is located in terminal_data_directory\MQL5\Images\
#resource "\\Images\\dollar.bmp"; // dollar.bmp is located in terminal_data_directory\MQL5\Images\
W hen viewing the properties of this object, we'll see that the properties BitMap File (On) and BitMap
File (Off) are dimmed and cannot be change manually:
There is another advantage of using resources – in any MQL5 program, resources of another EX5 file
can be used. Thus the resources from one EX5 file can be used in many other mql5 programs.
In order to use a resource name from another file, it should be specified as
<path_EX5_file_name>::<resource_name>. For example, suppose the Draw_Triangles _S cript.mq5
script contains a resource to an image in the file triangle.bmp:
#resource "\\Files\\triangle.bmp"
Then its name, for using in the script itself, will look like "Files \triangle.bmp" , and in order to use it,
"::" should be added to the resource name.
In order to use the same resource from another program, e.g. from an Expert Advisor, we need to add
to the resource name the path to the EX5 file relative to terminal_data_directory\MQL5\ and the
name of the script's EX5 file - Draw_Triangles_Script.ex5. S uppose the script is located in the
standard folder terminal_data_directory\MQL5\S cripts \, then the call should be written the following
way:
//--- using a resource from a script in an EA
ObjectSetString(0,my_bitmap_name,OBJPROP_BMPFILE,0,"\\Scripts\\Draw_Triangles_Script.ex5::Files\\tr
If the path to the executable file is not specified when calling the resource from another EX5, the
executable file is searched for in the same folder that contains the program that calls the resource.
This means that if an Expert Advisor calls a resource from Draw_Triangles _S cript.ex5 without
specification of the path, like this :
//--- call script resource in an EA without specifying the path
ObjectSetString(0,my_bitmap_name,OBJPROP_BMPFILE,0,"Draw_Triangles_Script.ex5::Files\\triangle.bmp"
then the file will be searched for in the folder terminal_data_directory\MQL5\Experts \, if the Expert
Advisor is located in terminal_data_directory\MQL5\Experts \.
One or several custom indicators may be necessary for the operation of MQL5 applications. All of them
can be included into the code of an executable MQL5 program. Inclusion of indicators as resources
simplifies the distribution of applications.
Below is an example of including and using S ampleIndicator.ex5 custom indicator located in
terminal_data_folder \MQL5\Indicators \ directory:
//+------------------------------------------------------------------+
//| SampleEA.mq5 |
//| Copyright 2013, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#resource "\\Indicators\\SampleIndicator.ex5"
int handle_ind;
//+------------------------------------------------------------------+
//| Expert initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//---
handle_ind=iCustom(_Symbol,_Period,"::Indicators\\SampleIndicator.ex5");
if(handle_ind==INVALID_HANDLE)
{
Print("Expert: iCustom call: Error code=",GetLastError());
return(INIT_FAILED);
}
//--- ...
return(INIT_SUCCEEDED);
}
The case when a custom indicator in OnInit() function creates one or more copies of itself requires
special consideration. Please keep in mind that the resource should be specified in the following way:
<path_EX 5_file_name>::<resource_name>.
The path to itself can be received using GetRelativeProgramPath() function. The example of its usage
is provided below:
//+------------------------------------------------------------------+
//| SampleIndicator.mq5 |
//| Copyright 2013, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property indicator_separate_window
#property indicator_plots 0
int handle;
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- the wrong way to provide a link to itself
//--- string path="\\Experts\\SampleEA.ex5::Indicators\\SampleIndicator.ex5";
//--- the right way to receive a link to itself
string path=GetRelativeProgramPath();
//--- indicator buffers mapping
handle=iCustom(_Symbol,_Period,path,0,0);
if(handle==INVALID_HANDLE)
{
Print("Indicator: iCustom call: Error code=",GetLastError());
return(INIT_FAILED);
}
else Print("Indicator handle=",handle);
//---
return(INIT_SUCCEEDED);
}
///....
//+------------------------------------------------------------------+
//| GetRelativeProgramPath |
//+------------------------------------------------------------------+
string GetRelativeProgramPath()
{
int pos2;
//--- get the absolute path to the application
string path=MQLInfoString(MQL_PROGRAM_PATH);
//--- find the position of "\MQL5\" substring
int pos =StringFind(path,"\\MQL5\\");
//--- substring not found - error
if(pos<0)
return(NULL);
//--- skip "\MQL5" directory
pos+=5;
//--- skip extra '\' symbols
while(StringGetCharacter(path,pos+1)=='\\')
pos++;
//--- if this is a resource, return the path relative to MQL5 directory
if(StringFind(path,"::",pos)>=0)
return(StringSubstr(path,pos));
//--- find a separator for the first MQL5 subdirectory (for example, MQL5\Indicators)
//--- if not found, return the path relative to MQL5 directory
if((pos2=StringFind(path,"\\",pos+1))<0)
return(StringSubstr(path,pos));
//--- return the path relative to the subdirectory (for example, MQL5\Indicators)
return(StringSubstr(path,pos2+1));
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const int begin,
const double& price[])
{
//--- return value of prev_calculated for next call
return(rates_total);
}
Resource variables
R esources can be declared using the resource variables and treated as if they are variables of the
appropriate type. Declaration format:
#resource path_to_the_resource_file as resource_variable_type resource_variable_name
S ample declarations :
#resource "data.bin" as int ExtData[] // declare the numeric array containing data from
#resource "data.bin" as MqlRates ExtData[] // declare the simple structures array containing
//--- strings
#resource "data.txt" as string ExtCode // declare the string containing the data.txt fil
//--- graphical resources
#resource "image.bmp" as bitmap ExtBitmap[] // declare the one-dimensional array containing a
#resource "image.bmp" as bitmap ExtBitmap2[][] // declare the two-dimensional array containing a
In case of such declaration, the resource data can be addressed only via the variable, auto addressing
via "::<rsource name>" does not work.
#resource "\\Images\\euro.bmp" as bitmap euro[][]
#resource "\\Images\\dollar.bmp"
//+------------------------------------------------------------------+
//| OBJ_BITMAP_LABEL object creation function using the resource |
//+------------------------------------------------------------------+
void Image(string name,string rc,int x,int y)
{
ObjectCreate(0,name,OBJ_BITMAP_LABEL,0,0,0);
ObjectSetInteger(0,name,OBJPROP_XDISTANCE,x);
ObjectSetInteger(0,name,OBJPROP_YDISTANCE,y);
ObjectSetString(0,name,OBJPROP_BMPFILE,rc);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- output the size of the image [width, height] stored in euro resource variable
Print(ArrayRange(euro,1),", ",ArrayRange(euro,0));
//--- change the image in euro - draw the red horizontal stripe in the middle
for(int x=0;x<ArrayRange(euro,1);x++)
euro[ArrayRange(euro,1)/2][x]=0xFFFF0000;
//--- create the graphical resource using the resource variable
ResourceCreate("euro_icon",euro,ArrayRange(euro,1),ArrayRange(euro,0),0,0,ArrayRange(euro,1),COL
//--- create the Euro graphical label object, to which the image from the euro_icon resource will b
Image("Euro","::euro_icon",10,40);
//--- another method of applying the resource, we cannot draw do it
Image("USD","::Images\\dollar.bmp",15+ArrayRange(euro,1),40);
//--- direct method of addressing the euro.bmp resource is unavailable since it has already been de
Image("E2","::Images\\euro.bmp",20+ArrayRange(euro,1)*2,40); // execution time error is to occur
}
S cript
execution result – only two OBJ_BITM AP_LABEL objects out of three ones are created. The
image of the first object has the red stripe in the middle.
An important advantage of applying the resources is that the resource files are automatically
compressed before they are included into an executable EX5 file prior to compilation. Thus, using the
resource variables allows you to put all necessary data directly into the executable EX5 file as well as
reduce the number and total size of the files compared to the conventional way of writing MQL5
programs.
Using the resource variables is particularly convenient for publishing products in the Market.
Features
· The special bitmap resource variable type informs the compiler that the resource is an image. S uch
variables receive the uint type.
· The bitmap type array resource variable may have two dimensions. In this case, the array size is
defined as [image_height ][ image_width ]. If an array of one dimension is specified, the number of
elements is equal to image_height*image_width.
· W hen downloading a 24-bit image, the alpha channel component is set to 255 for all the image
pixels.
· W hen downloading a 32-bit image without the alpha channel, the alpha channel component is also
set to 255 for all the image pixels.
· W hen downloading a 32-bit image with the alpha channel, the pixels are not processed in any way.
· The resource file size cannot exceed 128 Mb.
· The automatic encoding detection by BOM (header) presence is performed for string files. If BOM is
absent, the encoding is defined by the file contents. The files in the ANS I, UTF-8 and UTF-16
encodings are supported. All strings are converted to Unicode when reading data from the files.
OpenCL programs
Using the resource string variables may greatly facilitate the development of some programs. For
example, you are able to write a code of an OpenCL program in a separate CL file and then include it
as a string into your MQL5 program resources.
In this example, you would have had to write the entire code as a single big string if no cl_program
If the library hasn't been found, then the client terminal performs an attempt to load it from
terminal_dir\experts folder.
The system libraries (DLL) are loaded by the operating system rules. If the library is already loaded
(for example, another Expert Advisor, and even from another client terminal, running in parallel), then
it uses requests to the library already loaded. Otherwise, it performs a search in the following
sequence:
1. Directory, from which the module importing dll was started. The module here is an Expert Advisor,
a script, an indicator or EX5 library;
2. Directory terminal_data_directory\MQL5\Libraries (T ER MINAL _DAT A_PAT H\MQL5\Libraries);
3. Directory, from which the MetaTrader 5 client terminal was started;
4. S ystem directory;
5. W indows directory;
6. Current directory;
7. Directories listed in the PAT H system variable.
If the DLL library uses another DLL in its work, the first one cannot be loaded in case when there is no
second DLL.
Before an Expert Advisor (script, indicator) is loaded, a common list of all EX5 library modules is
formed. It's going to be used both from a loaded Expert Advisor (script, indicator) and from libraries
of this list. Thus the one-time loading of many times used EX5 library modules is needed. Libraries use
predefined variables of the Expert Advisor (script, indicator) they were called by.
The imported library EX5 is searched for in the following sequence:
1. Directory, path to which is set relative to the directory of the Expert Advisor (script, indicator) that
imports EX5;
2. Directory terminal_directory\MQL5\Libraries ;
3. Directory MQL5\Libraries in the common directory of all MetaTrader 5 client terminals
(Common\MQL5\Libraries).
Functions imported DLL into a mql5-program must ensure the W indows API calls agreement. To ensure
such an agreement, in the source text of programs written in C or C++, use the keyword __stdcall,
which is specific to the Microsoft(r) compilers. This agreement is characterized by the following:
· caller (in our case it is a mq5-program) should " see" a prototype of a function called (imported from
the DLL), in order to properly combine parameters to a stack;
· caller (in our case it is a mql5-program) puts parameters to the stack in a reverse order, from right
to left - in this order an imported function reads parameters passed to it;
· parameters are passed by value, except those explicitly passed by reference (in our case strings)
· an imported function cleans the stack independently by reading parameters passed to it.
W hen describing the prototype of an imported function, default parameters can be used.
If the corresponding library is unable to load, or there is a prohibition on the DLL use, or the imported
function is not found - the Expert Advisor stops its operation with the appropriate message "Expert
Advisor stopped" in the Journal (log file). In this case the Expert Advisor will not run until it is
reinitialized. An Expert Advisor can be reinitialized as a result of recompilation or after the table of its
properties is opened and OK is pressed.
Passing Parameters
All parameters of simple types are passed by values unless it is explicitly indicated that they are
passed by reference. W hen a string is passed, the address of the buffer of the copied string is passed;
if a string is passed by reference, the address of the buffer of this string without copying it is passed
to the function imported from DLL.
S tructures
that contain dynamic arrays, strings, classes, other complex structures, as well as static or
dynamic arrays of the enumerated objects, can't be passed as a parameter to an imported function.
W hen passing an array to DLL, the address of the beginning of the data buffer is always passed
(irrespective of the AS_SERIES flag). A function inside a DLL knows nothing about the AS_SERIES flag,
the passed array is a static array of an undefined length; an additional parameter should be used for
specifying the array size.
Runtime Errors
The executing subsystem of the client terminal has an opportunity to save the error code in case it
occurs during a MQL5 program run. There is a predefined variable _LastError for each executable
MQL5 program.
Before starting the OnInit function, the _LastError variable is reset. In case an erroneous situation
occurs during calculations or in the process of internal function calls, the _LastError variable accepts a
corresponding error code. The value stored in this variable can be obtained using the GetLastError()
function.
There are several critical errors in case of which a program is terminated immediately:
· division by zero
· going beyond array boundary
· using an incorrect object pointer
If you need to get information from each optimization pass, send frames without writing to dis k. To
avoid using file operations in Expert Advisors during calculations in the MQL5 Cloud Network, you can
use the following check:
int handle=INVALID_HANDLE;
bool file_operations_allowed=true;
if(MQLInfoInteger(MQL_OPTIMIZATION) || MQLInfoInteger(MQL_FORWARD))
file_operations_allowed=false;
if(file_operations_allowed)
{
...
handle=FileOpen(...);
...
}
To increase performance Comment(), Print() and PrintFormat() functions are not executed when
optimizing the trading robot's parameters. The exception is the use of these functions inside the
OnInit() handler. This allows you to easily find the cause of errors when they occur.
The Alert(), MessageBox(), PlayS ound(), S endFTP(), S endMail(), S endNotification() and W ebRequest()
functions designed for interaction with the " outside world" are not executed in the S trategy Tester.
The basic and the most detailed is the "Every tick" mode, the other two modes are the simplifications
of the basic one, and will be described in comparison to the "Every tick" mode. Consider all three
modes in order to understand the differences between them.
"Every Tick"
The historical quotes data for financial instruments is transferred from the trading server to the
MetaTrader 5 client terminal in the form of packed minute bars. Detailed information on the
occurrence of requests and the construction of the required time-frames can be obtained from the
Organizing Data Access chapter of MQL5 Reference.
The minimal element of the price history is the minute bar, from which you can obtain information on
the four values of the price:
· Open - the price at which the minute bar was opened;
· H igh - the maximum that was achieved during this minute bar;
· Low - the minimum that was achieved during this minute bar;
· Close - the closing price of the bar.
The new minute bar is not opened at the moment when the new minute begins (number of seconds
becomes equal to 0), but when a tick occurs - a price change by at least one point. The figure shows
the first minute bar of the new trading week, which has the opening time of 2011.01.10 00:00. The
price gap between Friday and Monday, which we see on the chart, is common, since currency rates
fluctuates even on weekends in response to incoming news.
For this bar, we only know that the minute bar was opened on January 10th 2011 at 00 hours 00
minutes, but we know nothing about the seconds. It could have been opened at 00:00:12 or 00:00:36
(12 or 36 seconds after the start of a new day) or any other time within that minute. But we do know
that the Open price of EURUSD was at 1.28940 at the opening time of the new minute bar.
W e also don't know (accurate within a second) when we received the tick corresponding to the closing
price of the considered minute bar. W e known only one thing - the last Close price of the minute bar.
For this minute, the price was 1.28958. The time of the appearance of H igh and Low prices is also
unknown, but we know that the maximum and minimum prices were on the levels of 1.28958 and
1.28940, respectively.
To test the trading strategy, we need a sequence of ticks, on which the work of the Expert Advisor will
be simulated. Thus, for every minute bar, we know the 4 control points, where the price has
definitely been. If a bar has only 4 ticks, then this is enough information to perform a testing, but
usually the tick volume is greater than 4.
H ence, there is a need to generate additional control points for ticks, which occurred between the
Open, High, Low, and Close prices. The principle of the "Every tick" ticks generation mode is
described in the The Algorithm of Ticks ’ Generation within the S trategy Tester of the MetaTrader 5
Terminal a figure from which is presented below.
W hen testing in the "Every tick" mode, the OnTick () function of the EA will be called at every control
point. Each control point is a tick from a generated sequence. The EA will receive the time and price
of the simulated tick, just as it would when working online.
Important: the "Every tick" testing mode is the most accurate, but at the same time, the most
time consuming. For an initial testing of the majority of trading strategies, it is usually sufficient
to use one of the other two testing modes.
Open price is determined. This makes it possible to create a " Testing Grail" , which shows a nice
upward graph of the testing balance.
An example of such Grail is presented in the CodeBase - Grr-al.
The figure shows a very attractive graph of this EA testing. How was it obtained? W e know 4 prices for
a minute bar, and we also know that the first is the Open price, and the last is the Close price. W e
have the High and Low prices between them, and the sequence of their occurrence is unknown, but it
is known, that the High price is greater than or equal to the Open price (and the Low price is less than
or equal to the Open price).
It is sufficient enough to determine the moment of receiving the Open price, and then analyze the
next tick in order to determine what price we have at the moment - either the High or the Low. If the
price is below the Open price, then we have a Low price and buy at this tick, the next tick will
correspond to the High price, at which we will close the buy and open for sell. The next tick is the last
one, this is the Close price, and we close the sale on it.
If after the price, we receive a tick with a price greater than the opening price, then the sequence of
deals is reversed. Process a minute bar in this " cheat" mode, and wait for the next one.
W hen testing such EA on the history, everything goes smoothly, but once we launch it online, the truth
begins to get revealed - the balance line remains steady, but heads downwards. To expose this trick,
we simply need to run the EA in the "Every tick" mode.
Note: If the test results of the EA in the rough testing modes ("1 minute OHLC" and " Open Prices
only" ) seem too good, make sure to test it in the "Every tick" mode.
S uppose we test an Expert Advisor on EURUSD H1 in the " Open Prices Only" mode. In this case the
total number of ticks (control points) will be no more than 4*number of one-hour bars within the tested
interval. But the OnTick() handler is called only at the opening of the one-hour bar. The checks
required for a correct testing occur on the rest of the ticks (that are " hidden" from the EA).
· The calculation of margin requirements ;
· The triggering of S top Loss and Take Profit levels ;
· The triggering of pending orders ;
· The removal of expired pending orders.
If there are no open positions or pending orders, we don't need to perform these checks on hidden
ticks, and the increase of speed may be quite substantial. This " Open prices only" mode is well suited
for testing strategies, which process deals only at the opening of the bar and do not use pending
orders, as well as S topLoss and TakeProfit orders. For the class of such strategies, the necessary
accuracy of testing is preserved.
Let's use the Moving Average Expert Advisor from the standard package as an example of an EA,
which can be tested in any mode. The logic of this EA is built in such a way that all of the decisions are
made at the opening of the bar, and deals are carried out immediately, without the use of pending
orders.
R un atesting of the EA on EURUSD H1 on an interval from 2010.09.01 to 2010.12.31, and compare the
graphs. The figure shows the balance graph from the test report for all of the three modes.
As you can see, the graphs on different testing modes are exactly the same for the Moving Average EA
from the standard package.
There are some limitations on the " Open Prices Only" mode:
· You cannot use the Random Delay execution mode.
· In the tested Expert Advisor, you cannot access data of the timeframe lower than that used for
testing/optimization. For example, if you run testing/optimization on the H1 period, you can access
data of H2, H3, H4 etc., but not M 30, M 20, M 10 etc. In addition, the higher timeframes that are
accessed must be multiple of the testing timeframe. For example, if you run testing in M 20, you
cannot access data of M 30, but it is possible to access H1. These limitations are connected with the
impossibility to obtain data of lower or non-multiple timeframes out of the bars generated during
testing/optimization.
· Limitations on accessing data of other timeframes also apply to other symbols whose data are used
by the Expert Advisor. In this case the limitation for each symbol depends on the first timeframe
accessed during testing/optimization. S uppose, during testing on EURUSD H1, an Expert Advisor
accesses data of GBPUSD M 20. In this case the Expert Advisor will be able to further use data of
EURUSD H1, H2, etc., as well as GBPUSD M 20, H1, H2 etc.
Note: The " Open prices only" mode has the fastest testing time, but it is not suitable for all of the
trading strategies. S elect the desired test mode based on the characteristics of the trading
system.
To conclude the section on the tick generation modes, let's consider a visual comparison of the
different tick generation modes for EURUSD, for two M 15 bars on an interval from 2011.01.11
21:00:00 - 2011.01.11 21:30:00.
The ticks were saved into different files using the W riteTicks FromTester.mq5 EA and the ending of
these files names are specified in filenameEveryTick, filenameOHLC and filenameOpenPrice input-
parameters.
To obtain three files with three tick sequences (for each of the following modes "Every tick" , "1 minute
OHLC" and " Open prices only), the EA was launched three times in the corresponding modes, in single
runs. Then, the data from these three files were displayed on the chart using the
Ticks FromTester.mq5 indicator. The indicator code is attached to this article.
By default, all of the file operations in the MQL5 language are made within the " file sandbox" , and
during testing the EA has access only to its own " file sandbox" . In order for the indicator and the EA to
work with files from one folder during testing, we used the flag FILE_COMMON. An example of code
from the EA:
//--- open the file
file=FileOpen(filename,FILE_WRITE|FILE_CSV|FILE_COMMON,";");
//--- check file handle
if(file==INVALID_HANDLE)
{
PrintFormat("Error in opening of file %s for writing. Error code=%d",filename,GetLastError())
return;
}
else
{
PrintFormat("The file will be created in %s folder",TerminalInfoString(TERMINAL_COMMONDATA_PA
}
Forreading the data in the indicator, we also used the flag FILE_COMMON. This allowed us to avoid
manually transferring the necessary files from one folder to another.
//--- open the file
int file=FileOpen(fname,FILE_READ|FILE_CSV|FILE_COMMON,";");
//--- check file handle
if(file==INVALID_HANDLE)
{
PrintFormat("Error in open of file %s for reading. Error code=%d",fname,GetLastError());
return;
}
else
{
Simulation of spread
The price difference between the Bid and the As k prices is called the spread. During testing, the
spread is not modeled but is taken from historical data. If the spread is less than or equal to zero in
the historical data, then the last known (at the moment of generation) spread is used by testing
agent.
In the S trategy Tester, the spread is always considered floating. That is, S ymbolInfoInteger(symbol,
SYM BOL _S PREAD_FLOAT) always returns true.
In addition, the historical data contains tick values and trading volumes. For the storage and retrieval
of data we use a special M qlRates structure:
struct MqlRates
{
datetime time; // Period start time
double open; // Open price
double high; // The highest price of the period
double low; // The lowest price of the period
double close; // Close price
long tick_volume; // Tick volume
int spread; // Spread
long real_volume; // Trade volume
};
Tick data may not coincide with minute bars for various reasons, for example because of connection
losses or other failures when transmitting data from a source to the client terminal. The minute data
is considered more reliable during tests.
Keep in mind the following features when testing on real ticks :
· W hen launching a test, the minute data on a symbol is synchronized along with the tick one.
· Ticks are stored in the symbol cache of the strategy tester. The cache size does not exceed 128 000
ticks. W hen new ticks arrive, the oldest data is removed from the cache. However, the CopyTicks
function allows receiving ticks outside the cache (only when testing on real ticks). In that case, the
data is requested from the tester tick database that is completely similar to the corresponding client
terminal database. No minute bar corrections are implemented to this base. Therefore, the ticks
there may differ from the ones stored in the cache.
In the visual testing mode, all indicators are unconditionally recalculated when a new tick arrives in
order to be correctly displayed on the visual testing chart.
The indicator is calculated once per tick. All subsequent requests for indicator data do not lead to
recalculation until a new tick arrives. Therefore, if the timer is enabled in an EA via the
EventS etTimer() function, the indicator data is requested from the last tick before each call of the
OnTimer() handler. If the indicator has not been calculated on the last tick yet, the calculations of the
indicator values are launched. If the data has already been prepared, it is provided without a new
recalculation.
Thus, all indicator calculations are performed in the most resource-saving manner — if the indicator
has already been calculated at a given tick, its data is provided 'as is '. No recalculation is launched.
during the first call to such data. If historical data are available in the terminal, they are immediately
passed to the testing agent. If data are not available, the terminal requests and downloads them from
the server, and then passes to the testing agent.
Data of additional instruments is also required for calculating cross-rates for trade operations. For
example, when testing a strategy on EURCHF with the deposit currency in USD, prior to processing the
first trading operation, the testing agent requests the history data of EURUSD and USDCHF from the
client terminal, though the strategy does not contain direct use call of these symbols.
Before testing a multi-currency strategy, it is recommended to download all the necessary historical
data to the client terminal. This will help to avoid delays in testing/optimization associated with
download of the required data. You can download history, for example, by opening the appropriate
charts and scrolling them to the history beginning. An example of forced loading of history into the
terminal is available in the Organizing Access to Data section of the MQL5 Reference.
Testing agents, in turn, receive history from the terminal in the packed form. During the next testing,
the tester does not load history from the terminal, because the required data is available since the
previous run of the tester.
· The terminal loads history from a trade server only once, the first time the agent requests the
history of a symbol to be tested from the terminal. The history is loaded in a packed form to
reduce the traffic.
· Ticks are not sent over the network, they are generated on testing agents.
Multi-Currency Testing
The S trategy Tester allows us to perform a testing of strategies, trading on multiple symbols. S uch EAs
are conventionally referred to as multi-currency Expert Advisors, since originally, in the previous
platforms, testing was performed only for a single symbol. In the S trategy Tester of the MetaTrader 5
terminal, we can model trading for all of the available symbols.
The tester loads the history of the used symbols from the client terminal (not from the trade server!)
automatically during the first call of the symbol data.
The testing agent downloads only the missing history, with a small margin to provide the necessary
data on the history, for the calculation of the indicators at the starting time of testing. For the time-
frames D1 and less, the minimum volume of the downloaded history is one year.
Thus, if we run a testing on an interval 2010.11.01-2010.12.01 (testing for an interval of one month)
with a period of M 15 (each bar is equal to 15 minutes), then the terminal will be requested the history
for the instrument for the entire year of 2010. For the weekly time-frame, we will request a history of
100 bars, which is about two years (a year has 52 week s). For testing on a monthly time-frame the
agent will request the history of 8 years (12 months x 8 years = 96 months).
If there isn't necessary bars, the starting date of testing will be automatically shifted from past to
present to provide the necessary reserve of bars before the testing.
During testing, the " Market W atch" is emulated as well, from which one can obtain information on
symbols.
By default, at the beginning of testing, there is only one symbol in the " Market W atch" of the S trategy
Tester - the symbol that the testing is running on. All of the necessary symbols are connected to the
" Mark et W atch" of the S trategy Tester (not terminal!) automatically when referred to.
R eferral to the data of an " other" symbol occurs in the following cases :
· W hen using the technical indicators function and IndicatorCreate() on the symbol/timeframe;
· The request to the " Market W atch" data for the other symbol:
1. S eriesInfoInteger
2. Bars
3. S ymbolS elect
4. S ymbolIs S ynchronized
5. S ymbolInfoDouble
6. S ymbolInfoInteger
7. S ymbolInfoS tring
8. S ymbolInfoTick
9. S ymbolInfoS essionQuote
10. S ymbolInfoS essionTrade
11.Mark etBookAdd
12.Mark etBookGet
· R equest of the time-series for a symbol/timeframe by using the following functions :
1. CopyBuffer
2. CopyR ates
3. CopyTime
4. CopyOpen
5. CopyHigh
6. CopyLow
7. CopyClose
8. CopyTickVolume
9. CopyR ealVolume
10.CopyS pread
At the moment of the first call to an " other" symbol, the testing process is stopped and the history is
downloaded for the symbol/timeframe, from the terminal to the testing agent. At the same time, the
generation of tick sequence for this symbol is made.
An individual tick sequence is generated for each symbol, according to the selected tick generation
mode. You can also request the history explicitly for the desired symbols by calling the S ymbolS elect()
in the OnInit() handler - the downloading of the history will be made immediately prior to the testing
of the Expert Advisor.
Thus, it does not require any extra effort to perform multi-currency testing in the MetaTrader 5 client
terminal. Just open the charts of the appropriate symbols in the client terminal. The history will be
automatically uploaded from the trading server for all the required symbols, provided that it contains
this data.
{
EventSetTimer(timer);
}
//---
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Expert deinitialization function |
//+------------------------------------------------------------------+
void OnDeinit(const int reason)
{
//--- stop the timer
EventKillTimer();
}
//+------------------------------------------------------------------+
//| Timer function |
//+------------------------------------------------------------------+
void OnTimer()
{
//---
// take no actions, the body of the handler is empty
}
//+------------------------------------------------------------------+
Testing time measurements were taken at different values of the timer parameter (periodicity of the
Timer event). On the obtained data, we plot a testing time as function of Timer period.
It can be clearly seen that the smaller is the parameter timer, during the initialization of the
EventS etTimer(Timer) function, the smaller is the period (Period) between the calls of the OnTimer()
handler, and the larger is the testing time T, under the same other conditions.
The S leep() function allows the EA or script to suspend the execution of the mql5-program for a while,
when working on the graph. This can be useful when requesting data, which is not ready at the time of
the request and you need to wait until it is ready. A detailed example of using the S leep() function can
be found in the section Organizing Data Access.
The testing process is not lingered by the S leep() calls.W hen you call the S leep(), the generated ticks
are " played" within a specified delay, which may result in the triggering of pending orders, stops, etc.
After a S leep() call, the simulated time in the S trategy Tester increases by an interval, specified in the
parameter of the S leep function.
If as a result of the execution of the S leep() function, the current time in the S trategy Tester went
over the testing period, then you will receive an error " Infinite S leep loop detected while testing" . If
you receive this error, the test results are not rejected, all of the computations are performed in their
full volume (the number of deals, subsidence, etc.), and the results of this testing are passed on to
the terminal.
The S leep() function will not work in OnDeinit(), since after it is called, the testing time will be
guaranteed to surpass the range of the testing interval.
In this case, only three functions will be called: OnInit(), OnTester(), OnDeinit(). In " Math calculations "
mode the S trategy Tester doesn't generate any ticks and download the history.
The S trategy Tester works in " Math calculations " mode also if you specify the starting date greater
than ending date.
W hen using the tester to solve mathematical problems, the uploading of the history and the
generation of ticks does not occur.
A typical mathematical problem for solving in the MetaTrader 5 S trategy Tester - searching for an
extremum of a function with many variables.
To solve it we need to:
· The calculation of function value should be located in OnTester() function;
· The function parameters must be defined as input-variables of the Expert Advisor;
Compile the EA, open the "S trategy Tester" window. In the " Input parameters " tab, select the required
input variables, and define the set of parameter values by specifying the start, stop and step values
for each of the function variables.
S electthe optimization type - "S low complete algorithm" (full search of parameters space) or "Fast
genetic based algorithm" . For a simple search of the extremum of the function, it is better to choose a
fast optimization, but if you want to calculate the values for the entire set of variables, then it is best
to use the slow optimization.
S elect " Math calculation"
mode and using the "S tart" button, run the optimization procedure. Note that
during the optimization the S trategy Tester will search for the maximum values of the OnTester
function. To find a local minimum, return the inverse of the computed function value from the
OnTester function:
return(1/function_value);
It is necessary to check that the function_value is not equal to zero, since otherwise we can obtain a
critical error of dividing by zero.
There is another way, it is more convenient and does not distort the results of optimization, it was
suggested by the readers of this article:
return(-function_value);
This option does not require the checking of the function_value for being equal to zero, and the
surface of the optimization results in a 3D-representation has the same shape. The only difference is
that it is mirrored comparing to the original.
As an example, we provide the sink() function:
The code of the EA for finding the extremum of this function is placed into the OnTester():
//+------------------------------------------------------------------+
//| Sink.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
//--- input parameters
input double x=-3.0; // start=-3, step=0.05, stop=3
input double y=-3.0; // start=-3, step=0.05, stop=3
//+------------------------------------------------------------------+
//| Tester function |
//+------------------------------------------------------------------+
double OnTester()
{
//---
double sink=MathSin(x*x+y*y);
//---
return(sink);
}
//+------------------------------------------------------------------+
Perform an optimization and see the optimization results in the form of a 2D graph.
The better the value is for a given pair of parameters (x, y), the more saturated the color is. As was
expected from the view of the form of the sink() formula, its values forms concentric circles with a
center at (0,0). One can see in the 3D-graph, that the sink() function has no single global extremum:
The S trategy Tester generates and plays a tick sequence for each instrument in accordance with the
selected trading mode. At the same time, a new bar for each symbol is opened, regardless of how the
bar opened on another symbol. This means that when testing a multi-currency EA, a situation may
occur (and often does), when for one instrument a new bar has already opened, and for the other it
has not. Thus, in testing, everything happens just like in reality.
This authentic simulation of the history in the tester does not cause any problems as long as the
"Every tick" and "1 minute OH LC" testing modes are used. For these modes, enough tick s are
generated for one candlestick, to be able to wait until the synchronization of bars from different
symbols takes place. But how do we test multi-currency strategies in the " Open prices only" mode, if
the synchronization of bars on trading instruments is mandatory? In this mode, the EA is called only on
one tick, which corresponds to the time of the opening of the bars.
W e'llillustrate it on an example: we are testing an EA on the EURUSD, and a new H1 candlestick has
been opened on EURUSD. W e can easily recognize this fact - while testing in the " Open prices only"
mode, the NewTick event corresponds to the moment of a bar opening on the tested period. But there
is no guarantee that the new candlestick was opened on the USDJPY symbol, which is used in the EA.
Under normal circumstances, it is sufficient enough to complete the work of the OnTick() function and
to check for the emergence of a new bar on USDJPY at the next tick. But when testing in the " Open
prices only" mode, there will be no other tick, and so it may seem that this mode is not fit for testing
multi-currency EAs. But this is not so - do not forget that the tester in MetaTrader 5 behaves just as it
would in real life. You can wait until a new bar is opened on another symbols using the function
S leep()!
The code of the EA S ynchronize_Bars _Use_S leep.mq5, which shows an example of the synchronization
of bars in the " Open prices only" mode:
//+------------------------------------------------------------------+
//| Synchronize_Bars_Use_Sleep.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
//--- input parameters
input string other_symbol="USDJPY";
//+------------------------------------------------------------------+
//| Expert initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- check symbol
if(_Symbol==other_symbol)
{
PrintFormat("You have to specify the other symbol in input parameters or select other symbol
//--- forced stop testing
return(INIT_PARAMETERS_INCORRECT);
}
//---
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Expert tick function |
//+------------------------------------------------------------------+
void OnTick()
{
//--- static variable, used for storage of last bar time
static datetime last_bar_time=0;
//--- sync flag
static bool synchonized=false;
//--- if static variable isn't initialized
if(last_bar_time==0)
{
//--- it's first call, save bar time and exit
last_bar_time=(datetime)SeriesInfoInteger(_Symbol,Period(),SERIES_LASTBAR_DATE);
PrintFormat("The last_bar_time variable is initialized with value %s",TimeToString(last_bar_t
}
//--- get open time of the last bar of chart symbol
datetime curr_time=(datetime)SeriesInfoInteger(Symbol(),Period(),SERIES_LASTBAR_DATE);
//--- if times aren't equal
if(curr_time!=last_bar_time)
{
//--- save open bar time to the static variable
last_bar_time=curr_time;
//--- not synchronized
synchonized=false;
//--- print message
PrintFormat("A new bar has appeared on symbol %s at %s",_Symbol,TimeToString(TimeCurrent()));
}
//--- open time of the other symbol's bar
datetime other_time;
//--- loop until the open time of other symbol become equal to curr_time
while(!(curr_time==(other_time=(datetime)SeriesInfoInteger(other_symbol,Period(),SERIES_LASTBAR_
{
PrintFormat("Waiting 5 seconds..");
//--- wait 5 seconds and call SeriesInfoInteger(other_symbol,Period(),SERIES_LASTBAR_DATE)
Sleep(5000);
}
//--- bars are synchronized
synchonized=true;
PrintFormat("Open bar time of the chart symbol %s: is %s",_Symbol,TimeToString(last_bar_time));
PrintFormat("Open bar time of the symbol %s: is %s",other_symbol,TimeToString(other_time));
//--- TimeCurrent() is not useful, use TimeTradeServer()
Notice the last line in the EA, which displays the current time when the fact of synchronization was
established:
Print("The bars synchronized at ",TimeToString(TimeTradeServer(),TIME_SECONDS));
To display the current time we used the TimeTradeS erver() function rather than TimeCurrent(). The
TimeCurrent() function returns the time of the last tick, which does not change after using S leep().
R un the EA in the " Open prices only" mode, and you will see a message about the synchronization of
the bars.
Use the TimeTradeS erver() function instead of the TimeCurrent(), if you need to obtain the current
server time, and not the time of the last tick arrival.
There is another way to synchronize bars - using a timer. An example of such an EA is
S ynchronize_Bars _Use_OnTimer.mq5, which is attached to this article.
Note: indicators, displayed on the chart, which automatically opens after the completion of the
testing, are calculated anew after the completion of testing. Even if these indicators were used in
the tested EA.
But in some cases, the programmer may want to hide the information on which indicators were
involved in the trading algorithms. For example, the code of the EA is rented or sold as an executable
file, without the provision of the source code. For this purpose, the IndicatorRelease() function is
suitable.
If the terminal sets a template with the name tester.tpl in the directory/profiles /templates of the
client terminal, then it will be applied to the opened chart. In its absence, the default template is
applied. (default.tpl).
The IndicatorRelease() function is originally intended for releasing the calculating portion of the
indicator, if it is no longer needed. This allows you to save both the memory and the CPU resources,
because each tick calls for an indicator calculation. Its second purpose is to prohibit the showing of an
indicator on the testing chart, after a single test run.
To prohibit the showing of the indicator on the chart after testing, call the IndicatorRelease() with the
handle of the indicator in the handler OnDeinit(). The OnDeinit() function is always called after the
completion and before the showing of the testing chart.
//+------------------------------------------------------------------+
//| Expert deinitialization function |
//+------------------------------------------------------------------+
void OnDeinit(const int reason)
{
//---
bool hidden=IndicatorRelease(handle_ind);
if(hidden) Print("IndicatorRelease() successfully completed");
else Print("IndicatorRelease() returned false. Error code ",GetLastError());
}
In order to prohibit the showing of the indicator on the chart, after the completion of a single test, use
the function IndicatorRelease() in the handler OnDeinit().
· TesterPass - this event is generated when a new data frame is received. The TesterPass event is
handled using the OnTesterPass() function. An Expert Advisor with this handler is automatically
loaded on a separate terminal chart with the symbol/period specified for testing, and receives the
TesterPass event when a frame is received during optimization. The function is used for dynamic
handling of optimization results " on the spot" without waiting for its completion. Frames are added
using the FrameAdd() function, which can be called after the end of a single pass in the OnTester()
handler.
· TesterDeinit - this event is generated after the end of Expert Advisor optimization in the strategy
tester. The TesterDeinit event is handles using the OnTesterDeinit() function. An Expert Advisor
with this handler is automatically loaded on a chart at the start of optimization, and receives
TesterDeinit after its completion. The function is used for final processing of all optimization
results.
Testing Agents
Testing in the MetaTrader 5 client terminal is carried out using test agents. Local agents are created
and enabled automatically. The default number of local agents corresponds to the number of cores in a
computer.
Each testing agent has its own copy of the global variables, which is not related to the client terminal.
The terminal itself is the dispatcher, which distributes the tas ks to the local and remote agents. After
executing a tas k on the testing of an EA, with the given parameters, the agent returns the results to
the terminal. W ith a single test, only one agent is used.
The agent stores the history, received from the terminal, in separate folders, by the name of the
instrument, so the history for EURUSD is stored in a folder named EURUSD. In addition, the history of
the instruments is separated by their sources. The structure for storing the history looks the following
way:
tester_catalog\Agent-IPaddress-Port\bases\name_source\history\symbol_name
For example, the history for EURUSD from the server MetaQuotes-Demo can be stored in the folder
tester_catalog\Agent-127.0.0.1-3000\bases \MetaQuotes-Demo\EURUSD.
A local agent, after the completion of testing, goes into a standby mode, awaiting for the next tas k
for another 5 minutes, so as not to waste time on launching for the next call. Only after the waiting
period is over, the local agent shuts down and unloads from the CPU memory.
In case of an early completion of the testing, from the user's side (the " Cancel" button), as well as with
the closing of the client terminal, all local agents immediately stop their work and are unloaded from
the memory.
· The Expert Advisor to be tested and the values of its input parameters
· Information about additional files (libraries, indicators, data files - # property tester_ ...)
For each block of parameters, a digital fingerprint in the form of M D5-hash is created, which is sent to
the agent. M D5-hash is unique for each set, its volume is many more times smaller than the amount of
information on which it is calculated.
The agent receives a hash of blocks and compares them with those that it already has. If the
fingerprint of the given parameter block is not present in the agent, or the received hash is different
from the existing one, the agent requests this block of parameters. This reduces the traffic between
the terminal and the agent.
After the testing, the agent returns to the terminal all of the results of the run, which are shown in the
tabs " Test Results " and " Optimization Results ": the received profit, the number of deals, the S harpe
coefficient, the result of the OnTester() function, etc.
During optimizing, the terminal hands out testing tas ks to the agents in small packages, each package
contains several tas ks (each tas k means single testing with a set of input parameters). This reduces
the exchange time between the terminal and the agent.
The agents never record to the hard dis k the EX5-files, obtained from the terminal (EA, indicators,
libraries, etc.) for security reasons, so that a computer with a running agent could not use the sent
data. All other files, including DLL, are recorded in the sandbox. In remote agents you can not test EAs
using DLL.
The testing results are added up by the terminal into a special cache of results (the result cache), for a
quick access to them when they are needed. For each set of parameters, the terminal searches the
result cache for already available results from the previous runs, in order to avoid re-runs. If the result
with such a set of parameters is not found, the agent is given the tas k to conduct the testing.
All traffic between the terminal and the agent is encrypted.
Ticks are not sent over the network, they are generated on testing agents.
Using DLLs
To speed up the optimization we can use not only local, but also remote agents. In this case, there are
some limitations for remote agents. First of all, remote agents do not display in their logs the results
of the execution of the Print() function, messages about the opening and closing of positions. A
minimum of information is displayed in the log to prevent incorrectly written EAs from trashing up the
computer, on which the remote agent is working, with messages.
A second limitation - the prohibition on the use of DLL when testing EAs. DLL calls are absolutely
forbidden on remote agents for security reasons. On local agent, DLL calls in tested EAs are allowed
only with the appropriate permission "Allow import DLL" .
Note: W hen using 3rd party EAs (scripts, indicators) that require allowed DLL calls, you should be
aware of the ris ks which you assume when allowing this option in the settings of the terminal.
R egardless of how the EA will be used - for testing or for running on a chart.
Variable Value
_AppliedTo The _AppliedTo variable allows finding out the type of data, used for
indicator calculation
_Digits Number of decimal places
_Point S ize of the current symbol point in the quote currency
_LastError The last error code
_Period Timeframe of the current chart
_R andomS eed Current status of the generator of pseudo-random integers
_S topFlag Program stop flag
_S ymbol S ymbol name of the current chart
_UninitR eason Uninitialization reason code
_Is X64 The _Is X64 variable allows finding out the bit version of the terminal, in
which an MQL5 application is running
Predefined variables cannot be defined in a library. A library uses such variables that are defined in
program from which this library is called.
int _AppliedTo
The _AppliedTo variable allows finding out the type of data, used for indicator calculation:
— 0 The indicator uses the second OnCalculate() call form - the data for
calculation are not specified by a certain buffer or data array
Close 1 Close prices
Open 2 Open prices
H igh 3 H igh prices
Indicator handle 10+ Data of the indicator, which was passed to the iCustom() function
using the indicator handle. The _AppliedTo value contains the
indicator handle
Example:
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- indicator buffers mapping
SetIndexBuffer(0,Label1Buffer,INDICATOR_DATA);
// Getting the type of data used for indicator calculation
Print("_AppliedTo=",_AppliedTo);
Print(getIndicatorDataDescription(_AppliedTo));
//---
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
See also
ENUM _APPLIED_PR ICE
int _Digits
The _Digits variable stores number of digits after a decimal point, which defines the price accuracy of
the symbol of the current chart.
You may also use the Digits() function.
double _Point
The _Point variable contains the point size of the current symbol in the quote currency.
You may also use the Point() function.
int _LastError
The _LastError variable contains code of the last error, that occurred during the mql5-program run. Its
value can be reset to zero by ResetLastError().
To obtain the code of the last error, you may also use the GetLastError() function.
ENUM_TIMEFRAMES _Period
The _Period variable contains the value of the timeframe of the current chart.
Also you may use the Period() function.
See also
_RandomSeed
Variable forstoring the current state when generating pseudo-random integers. _RandomS eed changes
its value when calling MathRand(). Use MathS rand() to set the required initial condition.
x random number received by MathRand() function is calculated in the following way at each call:
x=_RandomSeed*214013+2531011;
_RandomSeed=x;
x=(x>>16)&0x7FFF;
See also
MathRand(), MathS rand(), Integer types
bool _StopFlag
The _S topFlag variable contains the flag of the mql5-program stop. W hen the client terminal is trying
to stop the program, it sets the _S topFlag variable to true.
To check the state of the _S topFlag you may also use the Is S topped() function.
string _Symbol
The _S ymbol variable contains the symbol name of the current chart.
You may also use the S ymbol() function.
int _UninitReason
The _UninitReason variable contains the code of the program uninitialization reason.
Usually, this code is obtained by UninitializeReason()the function.
int _IsX64
The _Is X64 variable allows finding out the bit version of the terminal, in which an MQL5 application is
running: _Is X64=0 for the 32-bit terminal and _Is X64!=0 for the 64-bit terminal.
Also, function TerminalInfoInteger(TERMINAL_X64) can be used.
Example:
See also
MQLInfoInteger, Importing functions (#import)
Common Functions
General-purpose functions not included into any specialized group are listed here.
Function Action
S etR eturnError S etsthe code that returns the terminal process when completing the
operation.
Function Action
Alert
Displays a message in a separate window.
void Alert(
argument, // first value
... // other values
);
Parameters
argument
[in] Any values separated by commas. To split the information output in several lines you can use
the line feed character "\n" or "\r\n" . The number of parameters can not exceed 64.
Return Value
No return value.
Note
Arrays can't be passed to the Alert() function. Arrays should be output elementwise. Data of the
double type are output with 8 digits after the decimal point, data of the float type are displayed with
5 digits after the decimal point. To output the real numbers with a different precision or in a
scientific format, use the DoubleToS tring() function.
Data of the bool type is output as " true" or " false" strings. Dates are output as YYYY.MM.DD
HH:MI:SS . To display a date in another format use the TimeToS tring() function. Data of the color
type are output either as an R,G,B string or as a color name, if the color is present in a color set.
Alert() function does not work in the S trategy Tester.
CheckPointer
The function returns the type of the object pointer.
ENUM_POINTER_TYPE CheckPointer(
object* anyobject // object pointer
);
Parameters
anyobject
[in] Object pointer.
Return value
An attempt to call an incorrect pointer results in the critical termination of a program. That's why
it's necessary to call the CheckPointer function before using a pointer. A pointer can be incorrect in
the following cases :
· the pointer is equal to NULL;
· the object has been deleted using the delete operator.
This function can be used for checking pointer validity. A non-zero value warranties that the pointer
can be used for accessing.
To quickly validate the pointer, you can also use operator "!" (example) which checks it via an
implicit call of the CheckPointer function.
Example:
//+------------------------------------------------------------------+
//| Deletes list by deleting its elements |
//+------------------------------------------------------------------+
void CMyList::Destroy()
{
//--- service pointer for working in the loop
CItem* item;
//--- go through loop and try to delete dynamic pointers
while(CheckPointer(m_items)!=POINTER_INVALID)
{
item=m_items;
m_items=m_items.Next();
if(CheckPointer(item)==POINTER_DYNAMIC)
{
Print("Dynamic object ",item.Identifier()," to be deleted");
delete (item);
}
else Print("Non-dynamic object ",item.Identifier()," cannot be deleted");
}
//---
}
See also
Object Pointers, Checking the Object Pointer, Object Delete Operator delete
Comment
This function outputs a comment defined by a user in the top left corner of a chart.
void Comment(
argument, // first value
... // next values
);
Parameters
...
[in] Anyvalues, separated by commas. To delimit output information into several lines, a line
break symbol "\n" or "\r\n" is used. Number of parameters cannot exceed 64. Total length of the
input comment (including invisible symbols) cannot exceed 2045 characters (excess symbols will be
cut out during output).
Return Value
No return value
Note
Arrays can't be passed to the Comment() function. Arrays must be entered element-by-element.
Data of double type are output with the accuracy of up to 16 digits after a decimal point, and can be
output either in traditional or in scientific format, depending on what notation will be more
compact. Data of float type are output with 5 digits after a decimal point. To output real numbers
with another accuracy or in a predefined format, use the DoubleToS tring() function.
Data of bool type are output as " true" or " false" strings. Dates are shown as YYYY.MM.DD HH:MI:SS .
To show dates in another format, use the TimeToS tring() function. Data of color type are output
either as R,G,B string or as a color name, if this color is present in the color set.
Comment() function does not work during optimization in the S trategy Tester.
Example:
void OnTick()
{
//---
double Ask,Bid;
int Spread;
Ask=SymbolInfoDouble(Symbol(),SYMBOL_ASK);
Bid=SymbolInfoDouble(Symbol(),SYMBOL_BID);
Spread=SymbolInfoInteger(Symbol(),SYMBOL_SPREAD);
//--- Output values in three lines
Comment(StringFormat("Show prices\nAsk = %G\nBid = %G\nSpread = %d",Ask,Bid,Spread));
}
See also
ChartS etS tring, ChartGetS tring
CryptEncode
Transforms the data from array with the specified method.
int CryptEncode(
ENUM_CRYPT_METHOD method, // method
const uchar& data[], // source array
const uchar& key[], // key
uchar& result[] // destination array
);
Parameters
method
[in] Data transformation method. Can be one of the values of ENUM _CRYPT _M ET H OD
enumeration.
data[]
[in] S ource array.
key[]
[in] Key array.
result[]
[out] Destination array.
Return Value
Amount of bytes in the destination array or 0 in case of error. To obtain information about the error
call the GetLastError() function.
Example:
//+------------------------------------------------------------------+
//| ArrayToHex |
//+------------------------------------------------------------------+
string ArrayToHex(uchar &arr[],int count=-1)
{
string res="";
//--- check
if(count<0 || count>ArraySize(arr))
count=ArraySize(arr);
//--- transform to HEX string
for(int i=0; i<count; i++)
res+=StringFormat("%.2X",arr[i]);
//---
return(res);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
string text="The quick brown fox jumps over the lazy dog";
string keystr="ABCDEFG";
uchar src[],dst[],key[];
//--- prepare key
StringToCharArray(keystr,key);
//--- copy text to source array src[]
StringToCharArray(text,src);
//--- print initial data
PrintFormat("Initial data: size=%d, string='%s'",ArraySize(src),CharArrayToString(src));
//--- encrypt src[] with DES 56-bit key in key[]
int res=CryptEncode(CRYPT_DES,src,key,dst);
//--- check error
if(res>0)
{
//--- print encrypted data
PrintFormat("Encoded data: size=%d %s",res,ArrayToHex(dst));
//--- decode dst[] to src[]
res=CryptDecode(CRYPT_DES,dst,key,src);
//--- check error
if(res>0)
{
//--- print decoded data
PrintFormat("Decoded data: size=%d, string='%s'",ArraySize(src),CharArrayToString(src));
}
else
Print("Error in CryptDecode. Error code=",GetLastError());
}
else
Print("Error in CryptEncode. Error code=",GetLastError());
}
See also
Array Functions, CryptDecode()
CryptDecode
Performs the inverse transformation of the data from array, tranformed by CryptEncode().
int CryptEncode(
ENUM_CRYPT_METHOD method, // method
const uchar& data[], // source array
const uchar& key[], // key
uchar& result[] // destination array
);
Parameters
method
[in] Data transformation method. Can be one of the values of ENUM _CRYPT _M ET H OD
enumeration.
data[]
[in] S ource array.
key[]
[in] Key array.
result[]
[out] Destination array.
Return Value
Amount of bytes in the destination array or 0 in case of error. To obtain information about the error
call the GetLastError() function.
See also
Array Functions, CryptEncode()
DebugBreak
It is a program breakpoint in debugging.
void DebugBreak();
Return Value
No return value.
Note
Execution of an MQL5 program is interrupted only if a program is started in a debugging mode. The
function can be used for viewing values of variables and/or for further step-by-step execution.
ExpertRemove
The function stops an Expert Advisor and unloads it from a chart.
void ExpertRemove();
Return Value
No return value.
Note
The Expert Advisor is not stopped immediately as you call ExpertRemove(); just a flag to stop the
EA operation is set. That is, any next event won't be processed, OnDeinit() will be called and the
Expert Advisor will be unloaded and removed from the chart.
Calling ExpertRemove() in the strategy tester inside the OnInit() handler cancels testing on the
current set of parameters. S uch completion is considered an initialization error.
W hen calling ExpertR emove() in the strategy tester after successful initialization of an EA, a test is
completed normally with the call of OnDeinit() and OnTester(). In this case, the entire trading
statistics and an optimization criterion value are obtained.
Example:
//+------------------------------------------------------------------+
//| Test_ExpertRemove.mq5 |
//| Copyright 2009, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "2009, MetaQuotes Software Corp."
#property link "https://www.mql5.com"
#property version "1.00"
input int ticks_to_close=20;// number of ticks before EA unload
//+------------------------------------------------------------------+
//| Expert deinitialization function |
//+------------------------------------------------------------------+
void OnDeinit(const int reason)
{
//---
Print(TimeCurrent(),": " ,__FUNCTION__," reason code = ",reason);
//--- "clear" comment
Comment("");
//---
}
//+------------------------------------------------------------------+
//| Expert tick function |
//+------------------------------------------------------------------+
void OnTick()
{
static int tick_counter=0;
//---
tick_counter++;
Comment("\nBefore unloading expert advisor ",__FILE__," left",
(ticks_to_close-tick_counter)," ticks");
//--- before
if(tick_counter>=ticks_to_close)
{
ExpertRemove();
Print(TimeCurrent(),": ",__FUNCTION__," expert advisor will be unloaded");
}
Print("tick_counter =",tick_counter);
//---
}
//+------------------------------------------------------------------+
See also
Program running, Client terminal events
GetPointer
The function returns the object pointer.
void* GetPointer(
any_class anyobject // object of any class
);
Parameters
anyobject
[in] Object of any class.
Return Value
Only class objects have pointers. Instances of structures and simple-type variables can't have
pointers. The class object not created using the new() operator, but, e.g., automatically created in
the array of objects, still has a pointer. But this pointer will be of the automatic type
POINTER_AUTOM ATIC, therefore the delete() operator can't be applied to it. Aside from that, the
type pointer doesn't differ from dynamic pointers of the POINTER_DYNAMIC type.
S ince variables of structure types and simple types do not have pointers, it's prohibited to apply the
GetPointer() function to them. It's also prohibited to pass the pointer as a function argument. In all
these cases the compiler will notify an error.
An attempt to call an incorrect pointer causes the critical termination of a program. That's why the
CheckPointer() function should be called prior to using a pointer. A pointer can be incorrect in the
following cases :
· the pointer is equal to NULL;
· the object has been deleted using the delete operator.
This function can be used to check the validity of a pointer. A non-zero value guarantees, that the
pointer can be used for accessing.
Example:
//+------------------------------------------------------------------+
//| Check_GetPointer.mq5 |
//| Copyright 2009, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "2009, MetaQuotes Software Corp."
#property link "https://www.mql5.com"
#property version "1.00"
//+------------------------------------------------------------------+
//| Class implementing the list element |
//+------------------------------------------------------------------+
class CItem
{
int m_id;
string m_comment;
CItem* m_next;
public:
CItem() { m_id=0; m_comment=NULL; m_next=NULL; }
~CItem() { Print("Destructor of ",m_id,
(CheckPointer(GetPointer(this))==POINTER_DYNAMIC)?
"dynamic":"non-dynamic"); }
void Initialize(int id,string comm) { m_id=id; m_comment=comm; }
void PrintMe() { Print(__FUNCTION__,":",m_id,m_comment); }
int Identifier() { return(m_id); }
CItem* Next() {return(m_next); }
void Next(CItem *item) { m_next=item; }
};
//+------------------------------------------------------------------+
//| Simplest class of the list |
//+------------------------------------------------------------------+
class CMyList
{
CItem* m_items;
public:
CMyList() { m_items=NULL; }
~CMyList() { Destroy(); }
bool InsertToBegin(CItem* item);
void Destroy();
};
//+------------------------------------------------------------------+
//| Inserts list element at the beginning |
//+------------------------------------------------------------------+
bool CMyList::InsertToBegin(CItem* item)
{
if(CheckPointer(item)==POINTER_INVALID) return(false);
//---
item.Next(m_items);
m_items=item;
//---
return(true);
}
//+------------------------------------------------------------------+
//| Deleting the list by deleting elements |
//+------------------------------------------------------------------+
void CMyList::Destroy()
{
//--- service pointer to work in a loop
CItem* item;
//--- go through the loop and try to delete dynamic pointers
while(CheckPointer(m_items)!=POINTER_INVALID)
{
item=m_items;
m_items=m_items.Next();
if(CheckPointer(item)==POINTER_DYNAMIC)
{
Print("Dynamyc object ",item.Identifier()," to be deleted");
delete (item);
}
else Print("Non-dynamic object ",item.Identifier()," cannot be deleted");
}
//---
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
CMyList list;
CItem items[10];
CItem* item;
//--- create and add into the list a dynamic object pointer
item=new CItem;
if(item!=NULL)
{
item.Initialize(100,"dynamic");
item.PrintMe();
list.InsertToBegin(item);
}
//--- add automatic pointers into the list
for(int i=0; i<10; i++)
{
items[i].Initialize(i,"automatic");
items[i].PrintMe();
item=GetPointer(items[i]);
if(CheckPointer(item)!=POINTER_INVALID)
list.InsertToBegin(item);
}
//--- add one more dynamic object pointer at the list beginning
item=new CItem;
if(item!=NULL)
{
item.Initialize(200,"dynamic");
item.PrintMe();
list.InsertToBegin(item);
}
//--- delete all the list elements
list.Destroy();
//--- all the list elements will be deleted after the script is over
//--- see the Experts tab in the terminal
See also
Object Pointers, Checking the Object Pointer, Object Delete Operator delete
GetTickCount
The GetTickCount() function returns the number of milliseconds that elapsed since the system start.
uint GetTickCount();
Return Value
Counter is limited by the restrictions of the system timer. Time is stored as an unsigned integer, so
it's overfilled every 49.7 days if a computer works uninterruptedly.
Example:
#define MAX_SIZE 40
//+------------------------------------------------------------------+
//| Script for measuring computation time of 40 Fibonacci numbers |
//+------------------------------------------------------------------+
void OnStart()
{
//--- Remember the initial value
uint start=GetTickCount();
//--- A variable for getting the next number in the Fibonacci series
long fib=0;
//--- In loop calculate the specified amount of numbers from Fibonacci series
for(int i=0;i<MAX_SIZE;i++) fib=TestFibo(i);
//--- Get the spent time in milliseconds
uint time=GetTickCount()-start;
//--- Output a message to the Experts journal
PrintFormat("Calculating %d first Fibonacci numbers took %d ms",MAX_SIZE,time);
//--- Script completed
return;
}
//+------------------------------------------------------------------+
//| Function for getting Fibonacci number by its serial number |
//+------------------------------------------------------------------+
long TestFibo(long n)
{
//--- The first member of the Fibonacci series
if(n<2) return(1);
//--- All other members are calculated by the following formula
return(TestFibo(n-2)+TestFibo(n-1));
}
See also
GetTickCount64
The GetTickCount64() function returns the number of milliseconds that have elapsed since the system
was launched.
ulong GetTickCount64();
Return Value
The counter is limited to the accuracy of the system timer, which usually returns a result with the
10-16 millisecond precision. Unlik e GetTick Count, which is of uint type and the contents of which
overflow every 49.7 days in the case of continued computer operation, GetTickCount64() can be
used for the unlimited computer operation time and is not subject to overflow.
See also
GetMicrosecondCount
The GetMicrosecondCount() function returns the number of microseconds that have elapsed since the
start of MQL5-program.
ulong GetMicrosecondCount();
Return Value
//+------------------------------------------------------------------+
//| Test function |
//+------------------------------------------------------------------+
void Test()
{
int res_int=0;
double res_double=0;
//---
for(int i=0;i<10000;i++)
{
res_int+=i*i;
res_int++;
res_double+=i*i;
res_double++;
}
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
uint ui=0,ui_max=0,ui_min=INT_MAX;
ulong ul=0,ul_max=0,ul_min=INT_MAX;
//--- number of measurements
for(int count=0;count<1000;count++)
{
uint ui_res=0;
ulong ul_res=0;
//---
for(int n=0;n<2;n++)
{
//--- select measurement type
if(n==0) ui=GetTickCount();
else ul=GetMicrosecondCount();
//--- execute code
Test();
//--- add measurement result (depending on type)
if(n==0) ui_res+=GetTickCount()-ui;
else ul_res+=GetMicrosecondCount()-ul;
}
//--- calculate minimum and maximum time for both measurements
if(ui_min>ui_res) ui_min=ui_res;
if(ui_max<ui_res) ui_max=ui_res;
if(ul_min>ul_res) ul_min=ul_res;
if(ul_max<ul_res) ul_max=ul_res;
}
//---
Print("GetTickCount error(msec): ",ui_max-ui_min);
Print("GetMicrosecondCount error(msec): ",DoubleToString((ul_max-ul_min)/1000.0,2));
}
See also
MessageBox
It creates and shows a message box and manages it. A message box contains a message and header,
any combination of predefined signs and command buttons.
int MessageBox(
string text, // message text
string caption=NULL, // box header
int flags=0 // defines set of buttons in the box
);
Parameters
text
[in] Text, containing message to output.
caption=NULL
[in]Optional text to be displayed in the box header. If the parameter is empty, Expert Advisor
name is shown in the box header.
flags=0
[in] Optional flags defining appearance and behavior of a message box. Flags can be a
combination of a special group of flags.
Return Value
If the function is successfully performed, the returned value is one of values of MessageBox() return
codes.
Note
The function cannot be used in custom indicators since calling MessageBox() suspends the thread of
execution for the whole time while waiting for the user's response. S ince all indicators for each
symbol are executed in a single thread, such suspension makes the operation of all charts on all
timeframes for this symbol impossible.
MessageBox() function does not work in the S trategy Tester.
PeriodSeconds
This function returns number of seconds in a period.
int PeriodSeconds(
ENUM_TIMEFRAMES period=PERIOD_CURRENT // chart period
);
Parameters
period=PERIOD_CURRENT
[in] Value of a chart period from the enumeration ENUM _TIM EFRAM ES . If the parameter isn't
specified, it returns the number of seconds of the current chart period, at which the program runs.
Return Value
PlaySound
It plays a sound file.
bool PlaySound(
string filename // file name
);
Parameters
filename
[in] Path to a sound file. If filename=NULL, the playback is stopped.
Return Value
The file must be located in terminal_directory\S ounds or its sub-directory. Only WAV files are
played.
Call of PlayS ound() with NULL parameter stops playback.
PlayS ound() function does not work in the S trategy Tester.
See also
R esources
Print
It enters a message in the Expert Advisor log. Parameters can be of any type.
void Print(
argument, // first value
... // next values
);
Parameters
...
[in] Any values separated by commas. The number of parameters cannot exceed 64.
Note
Arrays cannot be passed to the Print() function. Arrays must be input element-by-element.
Data of double type are shown with the accuracy of up to 16 digits after a decimal point, and can be
output either in traditional or in scientific format, depending on what entry will be more compact.
Data of float type are output with 5 digits after a decimal point. To output real numbers with
another accuracy or in a predefined format, use the PrintFormat() function.
Data of bool type are output as " true" or " false" lines. Dates are shown as YYYY.MM.DD HH:MI:SS . To
show data in another format, use TimeToS tring(). Data of color type are returned either as R,G,B
line or as a color name, if this color is present in the color set.
Print() function does not work during optimization in the S trategy Tester.
Example:
void OnStart()
{
//--- Output DBL_MAX using Print(), this is equivalent to PrintFormat(%%.16G,DBL_MAX)
Print("---- how DBL_MAX looks like -----");
Print("Print(DBL_MAX)=",DBL_MAX);
//--- Now output a DBL_MAX number using PrintFormat()
PrintFormat("PrintFormat(%%.16G,DBL_MAX)=%.16G",DBL_MAX);
//--- Output to the Experts journal
// Print(DBL_MAX)=1.797693134862316e+308
// PrintFormat(%.16G,DBL_MAX)=1.797693134862316E+308
//--- Show what can happen with arithmetic operations with real types
double a=7,b=200;
Print("---- Before arithmetic operations");
Print("a=",a," b=",b);
Print("Print(DoubleToString(b,16))=",DoubleToString(b,16));
//--- Divide a by b (7/200)
a=a/b;
//--- Now emulate restoring a value in the b variable
b=7.0/a; // It is expected that b=7.0/(7.0/200.0)=>7.0/7.0*200.0=200 - but it differs
//--- Output the newly calculated value of b
Print("----- After arithmetic operations");
Print("Print(b)=",b);
Print("Print(DoubleToString(b,16))=",DoubleToString(b,16));
//--- Output to the Experts journal
// Print(b)=200.0
// Print(DoubleToString(b,16))=199.9999999999999716 (see that b is no more equal to 200.0)
See also
DoubleToS tring, S tring Format
PrintFormat
It formats and enters sets of symbols and values in the Expert Advisor log in accordance with a preset
format.
void PrintFormat(
string format_string, // format string
... // values of simple types
);
Parameters
format_string
[in] A format string consists of simple symbols, and if the format string is followed by arguments,
it also contains format specifications.
...
[in] Any values of simple types separated by commas. Total number of parameters can't exceed 64
including the format string.
Return Value
S tring.
Note
PrintFormat() function does not work during optimization in the S trategy Tester.
The number, order and type of parameters must exactly match the set of qualifiers, otherwise the
print result is undefined. Instead of PrintFormat() you can use printf().
If the format string is followed by parameters, this string must contain format specifications that
denote output format of these parameters. S pecification of format always starts with the percent
sign (%).
A format string is read from left to right. W hen the first format specification is met (if there is
any), the value of the first parameter after the format string is transformed and output according to
the preset specification. The second format specification calls transformation and output of the
second parameter, and so on till the format string end.
The format specification has the following form:
% [flags][width][.precision][{h | l | ll | I32 | I64}]type
Each field of the format specification is either a simple symbol, or a number denoting a simple
format option. The simplest format specification contains only the percent sign (%) and a symbol
defining the type of the output parameter (for example, %s). If you need to output the percent sign
in the format string, use the format specification %%.
flags
width
A non-negative decimal number that sets the minimal number of output symbols of the formatted
value. If the number of output symbols is less than the specified width, the corresponding number of
spaces is added from the left or right depending on the alignment (flag –). If there is flag zero (0),
the corresponding number of zeroes is added before the output value. If the number of output
symbols is greater than the specified width, the output value is never cut off.
If an asteris k (*) is specified as width, value of int type must be indicated in the corresponding place
of the list of passed parameters. It will be used for specifying width of the output value.
precision
A non-negative decimal number that sets the output precision - number of digits after a decimal
point. As distinct from width specification, precision specification can cut off the part of fractional
type with or without rounding.
The use of precision specification is different for different format types.
h | l | ll | I32 | I64
short h d, i, o, x, or X
ushort h o, u, x, or X
int I32 d, i, o, x, or X
uint I32 o, u, x, or X
long I64 d, i, o, x, or X
ulong I64 o, u, x, or X
type
a doubl A real number in format [−]0xh.hhhh p±dd, where h.hhhh – mantissa in the
e form of hexadecimal digits, using " abcdef" , dd - One or more digits of
exponent. Number of decimal places is determined by the accuracy
specification
A doubl A real number in format [−]0xh.hhhh P±dd, where h.hhhh – mantissa in the
e form of hexadecimal digits, using "ABCDEF" , dd - One or more digits of
exponent. Number of decimal places is determined by the accuracy
specification
s string S tring output
void OnStart()
{
//--- trade server name
string server=AccountInfoString(ACCOUNT_SERVER);
//--- account number
int login=(int)AccountInfoInteger(ACCOUNT_LOGIN);
//--- long value output
long leverage=AccountInfoInteger(ACCOUNT_LEVERAGE);
PrintFormat("%s %d: leverage = 1:%I64d",
server,login,leverage);
//--- account currency
string currency=AccountInfoString(ACCOUNT_CURRENCY);
//--- double value output with 2 digits after the decimal point
double equity=AccountInfoDouble(ACCOUNT_EQUITY);
PrintFormat("%s %d: account equity = %.2f %s",
server,login,equity,currency);
//--- double value output with mandatory output of the +/- sign
double profit=AccountInfoDouble(ACCOUNT_PROFIT);
PrintFormat("%s %d: current result for open positions = %+.2f %s",
server,login,profit,currency);
//--- double value output with variable number of digits after the decimal point
double point_value=SymbolInfoDouble(_Symbol,SYMBOL_POINT);
string format_string=StringFormat("%%s: point value = %%.%df",_Digits);
PrintFormat(format_string,_Symbol,point_value);
//--- int value output
int spread=(int)SymbolInfoInteger(_Symbol,SYMBOL_SPREAD);
PrintFormat("%s: current spread in points = %d ",
_Symbol,spread);
//--- double value output in the scientific (floating point) format with 17 meaningful digits after
PrintFormat("DBL_MAX = %.17e",DBL_MAX);
//--- double value output in the scientific (floating point) format with 17 meaningful digits after
PrintFormat("EMPTY_VALUE = %.17e",EMPTY_VALUE);
//--- output using PrintFormat() with default accuracy
PrintFormat("PrintFormat(EMPTY_VALUE) = %e",EMPTY_VALUE);
//--- simple output using Print()
Print("Print(EMPTY_VALUE) = ",EMPTY_VALUE);
/* execution result
MetaQuotes-Demo 1889998: leverage = 1:100
MetaQuotes-Demo 1889998: account equity = 22139.86 USD
MetaQuotes-Demo 1889998: current result for open positions = +174.00 USD
EURUSD: point value = 0.00001
EURUSD: current spread in points = 12
DBL_MAX = 1.79769313486231570e+308
EMPTY_VALUE = 1.79769313486231570e+308
PrintFormat(EMPTY_VALUE) = 1.797693e+308
Print(EMPTY_VALUE) = 1.797693134862316e+308
*/
}
See also
StringFormat, DoubleToS tring, R eal types (double, float)
ResetLastError
S ets the value of the predefined variable _LastError into zero.
void ResetLastError();
Return Value
No return value.
Note
It should be noted that the GetLastError() function doesn't zero the _LastError variable. Usually the
R esetLastError() function is called before calling a function, after which an error appearance is
checked.
ResourceCreate
Creates an image resource based on a data set. There are two variants of the function:
Creating a resource based on a file
bool ResourceCreate(
const string resource_name, // Resource name
const string path // A relative path to the file
);
bool ResourceCreate(
const string resource_name, // Resource name
const uint& data[], // Data set as an array
uint img_width, // The width of the image resource
uint img_height, // The height of the image resource
uint data_xoffset, // The horizontal rightward offset of the upper left corn
uint data_yoffset, // The vertical downward offset of the upper left corner
uint data_width, // The total width of the image based on the data set
ENUM_COLOR_FORMAT color_format // Color processing method
);
Parameters
resource_name
[in] R esource name.
data[][]
[in] A one-dimensional or two-dimensional array for creating a complete image.
img_width
[in] The width of the rectangular image area in pixels to be placed in the resource in the form of
an image. It cannot be greater than the data_width value.
img_height
[in] The height of the rectangular image area in pixels to be placed in the resource in the form of
an image.
data_xoffset
[in] The horizontal rightward offset of the rectangular area of the image.
data_yoffset
[in] The vertical downward offset of the rectangular area of the image.
data_width
[in] R equired only for
one-dimensional arrays. It denotes the full width of the image from the data
set. If data_width=0, it is assumed to be equal to img_width. For two-dimensional arrays the
parameter is ignored and is assumed to be equal to the second dimension of the data[] array.
color_format
[in] Color processing method, from a value from the ENUM _COLOR_FORM AT enumeration.
Return Value
R eturns true if successful, otherwise false. To get information about the error call the
GetLastError() function. The following errors may occur:
· 4015 – ERR_RES OUR CE_NAM E_DUPLICAT ED (identical names of the dynamic and the static
resource)
· 4016 – ERR_RES OUR CE_NOT _FOUND (the resource is not found)
· 4017 – ERR_RES OUR CE_UNSUPPOR T ED_T YPE (this type of resource is not supported)
· 4018 – ERR_RES OUR CE_NAM E_IS_TOO_LONG (the name of the resource is too long)
Note
If the second version of the function is called for creating the same resource with different width,
height and shift parameters, it does not create a new resource, but simply updates the existing one.
The first version of the function is used for uploading images and sounds from files, and the second
version is used only for the dynamic creation of images.
Images must be in the BMP format with a color depth of 24 or 32 bits. S ounds can only be in the
WAV format. The size of the resource should not exceed 16 Mb.
ENUM_COLOR_FORMAT
Identifier Description
See also
ResourceFree
The function deletes dynamically created resource (freeing the memory allocated for it).
bool ResourceFree(
const string resource_name // resource name
);
Parameters
resource_name
[in] R esource name should start with "::" .
Return Value
True if successful, otherwise false. To get information about the error, call the GetLastError()
function.
Note
R esourceFree() allows mql5 application developers to manage memory consumption when actively
working with resources. Graphical objects bound to the resource being deleted from the memory will
be displayed correctly after its deletion. However, newly created graphical objects (OBJ_BITM AP and
OBJ_BITM AP_LABEL) will not be able to use the deleted resource.
The function deletes only dynamic resources created by the program.
See also
ResourceReadImage
The function reads data from the graphical resource created by ResourceCreate() function or saved in
EX5 file during compilation.
bool ResourceReadImage(
const string resource_name, // graphical resource name for reading
uint& data[], // array for receiving data from the resource
uint& width, // for receiving the image width in the resource
uint& height, // for receiving the image height in the resource
);
Parameters
resource_name
[in] Name of the graphical resource containing an image. To gain access to its own resources, the
name is used in brief form "::resourcename" . If we download a resource from a compiled EX5 file,
the full name should be used with the path relative to MQL5 directory, file and resource names –
" path\\filename.ex5::resourcename" .
data[][]
[in] One- or two-dimensional array for receiving data from the graphical resource.
img_width
[out] Graphical resource image width in pixels .
img_height
[out] Graphical resource image height in pixels .
Return Value
true if successful, otherwise false. To get information about the error, call the GetLastError()
function.
Note
ResourceSave
S aves a resource into the specified file.
bool ResourceSave(
const string resource_name // Resource name
const string file_name // File name
);
Parameters
resource_name
[in] The name of the resource, must start with "::" .
file_name
[in] The name of the file relative to MQL5\Files.
Return Value
true – in case of success, otherwise false. For the error information call GetLastError().
Note
The function always overwrites a file and creates all the required intermediate directories in the file
name if necessary.
See also
SetReturnError
S ets the code that returns the terminal process when completing the operation.
void SetReturnError(
int ret_code // client terminal completion code
);
Parameters
ret_code
[in] The code to be returned by the client terminal process when completing the operation.
Return Value
No return value.
Note
S etting
the specified ret_code return code using the S etReturnError() function is useful for analyzing
reasons of the programmatic operation completion when launching the terminal via the command
line.
Unlik e TerminalClose(), the S etR eturnError() function does not complete the terminal operation.
Instead, it only sets the code that returns the terminal process upon its completion.
If the S etReturnError() function is called multiple times and/or from different MQL5 programs, the
terminal returns the last set return code.
The set code is returned upon the terminal process completion except for the following cases :
· a critical error has occurred during execution;
· the TerminalClose(int ret_code) function issuing the terminal operation completion command with
a specified code has been called.
See also
Program Running, Runtime Errors, Uninitialization Reason Codes, TerminalClose
SetUserError
S ets the predefined variable _LastError into the value equal to ERR_USER_ERROR_FIRS T + user_error
void SetUserError(
ushort user_error, // error number
);
Parameters
user_error
[in] Error number set by a user.
Return Value
No return value.
Note
After an error has been set using the S etUserError(user_error) function, GetLastError() returns value
equal to ERR_USER_ERROR_FIRS T + user_error.
Example:
void OnStart()
{
//--- set error number 65537=(ERR_USER_ERROR_FIRST +1)
SetUserError(1);
//--- get last error code
Print("GetLastError = ",GetLastError());
/*
Result
GetLastError = 65537
*/
}
Sleep
The function suspends execution of the current Expert Advisor or script within a specified interval.
void Sleep(
int milliseconds // interval
);
Parameters
milliseconds
[in] Delay interval in milliseconds.
Return Value
No return value.
Note
The S leep() function can't be called for custom indicators, because indicators are executed in the
interface thread and must not slow down it. The function has the built-in check of EA halt flag every
0.1 seconds.
TerminalClose
The function commands the terminal to complete operation.
bool TerminalClose(
int ret_code // closing code of the client terminal
);
Parameters
ret_code
[in] R eturn code, returned by the process of the client terminal at the operation completion.
Return Value
The TerminalClose() function does not stop the terminal immediately, it just commands the terminal
to complete its operation.
The code of an Expert Advisor that called TerminalClose() must have all arrangements for the
immediate completion (e.g. all previously opened files must be closed in the normal mode). Call of
this function must be followed by the return operator.
The ret_code parameter allows indicating the necessary return code for analyzing reasons of the
program termination of the terminal operation when starting it from the command prompt.
Example:
MqlTick tick;
double distance;
//---
SymbolInfoTick(_Symbol,tick);
tick_counter++;
if(first_bid==0.0)
{
launch_time=tick.time;
first_bid=tick.bid;
Print("first_bid =",first_bid);
return;
}
//--- price distance in pips
distance=(tick.bid-first_bid)/_Point;
//--- show a notification to track the EA operation
string comm="From the moment of start:\r\n\x25CF elapsed seconds: "+
IntegerToString(tick.time-launch_time)+" ;"+
"\r\n\x25CF ticks received: "+(string)tick_counter+" ;"+
"\r\n\x25CF price went in points: "+StringFormat("%G",distance);
Comment(comm);
//--- section for checking condition to close the terminal
if(tick_counter>=tiks_before)
TerminalClose(0); // exit by tick counter
if(distance>pips_to_go)
TerminalClose(1); // go up by the number of pips equal to pips_to_go
if(distance<-pips_to_go)
TerminalClose(-1); // go down by the number of pips equal to pips_to_go
if(tick.time-launch_time>seconds_st)
TerminalClose(100); // termination by timeout
//---
}
See also
Program running, Execution errors, Reasons for deinitialization
TesterHideIndicators
S etsthe mode of displaying/hiding indicators used in an EA. The function is intended for managing
the visibility of used indicators only during testing.
void TesterHideIndicators(
bool hide // flag
);
Parameters
hide
[in] Flag for hiding indicators when testing. S et true to hide created indicators, otherwise false.
Return Value
None.
Note
By default, all indicators created in a tested EA are displayed on the visual testing chart. Besides,
these indicators are displayed on the chart that is automatically opened when testing is complete.
The TesterHideIndicators() function allows developers to implement the ability to disable the display
of used indicators.
To disable the display of an applied indicator when testing an EA, call TesterHideIndicators() equal
to true before creating the EA's handle – all indicators created after that are marked with the hide
flag. These indicators are not displayed during a visual test and on the chart that is automatically
opened upon completion of the test.
To disable the hide mode of the newly created indicators, call TesterHideIndicators() equal to false.
Only indicators generated directly from the tested EA can be displayed on the testing chart. This rule
applies only to cases where there is not a single template in <data_folder>MQL5\Profiles \Templates.
If the <data_folder>MQL5\Profiles \Templates directory contains a special template <EA_name>.tpl,
only the indicators from this template are displayed during a visual testing and on the testing chart.
In this case, no indicators applied in the tested EA are displayed. This behavior remains even if
TesterHideIndicators() equal to true is called in the EA code.
If the <data_folder>MQL5\Profiles \Templates directory contains no special <EA_name>.tpl template
having tester.tpl instead, indicators from the tester.tpl and the ones from the EA not disabled by
the TesterHideIndicators() function are displayed during a visual testing and on the testing chart. If
there is no tester.tpl template, indicators from the default.tpl template are used instead.
If the strategy tester finds no suitable template (<EA_name>.tpl, tester.tpl or default.tpl), display of
the indicators applied in the EA is fully managed by the TesterHideIndicators() function.
Example:
bool CSampleExpert::InitIndicators(void)
{
TesterHideIndicators(true);
//--- create MACD indicator
if(m_handle_macd==INVALID_HANDLE)
if((m_handle_macd=iMACD(NULL,0,12,26,9,PRICE_CLOSE))==INVALID_HANDLE)
{
printf("Error creating MACD indicator");
return(false);
}
TesterHideIndicators(false);
//--- create EMA indicator and add it to collection
if(m_handle_ema==INVALID_HANDLE)
if((m_handle_ema=iMA(NULL,0,InpMATrendPeriod,0,MODE_EMA,PRICE_CLOSE))==INVALID_HANDLE)
{
printf("Error creating EMA indicator");
return(false);
}
//--- succeed
return(true);
}
See also
IndicatorRelease
TesterStatistics
The function returns the value of the specified statistical parameter calculated based on testing
results.
double TesterStatistics(
ENUM_STATISTICS statistic_id // ID
);
Parameters
statistic_id
[in] The ID of the statistical parameter from the ENUM _S TATIS TICS enumeration.
Return Value
The function can be called inside OnTester() or OnDeinit() in the tester. In other cases the result is
undefined.
TesterStop
Gives program operation completion command when testing.
void TesterStop();
Return Value
No return value.
Note
The TesterS top() function is designed for a routine early shutdown of an EA on a test agent – for
example, when reaching a specified number of losing trades or a preset drawdown level.
TesterS top() call is considered a normal completion of a test, therefore the OnTester() function is
called, and the entire accumulated trading statistics and optimization criterion value are submitted
to the strategy tester.
Calling ExpertRemove() in the strategy tester also means normal test completion and allows for
obtaining trading statistics, but the EA is unloaded from the agent’s memory. In this case,
performing a pass on the next set of parameters requires time in order to reload the program.
Therefore, TesterS top() is a preferred option for an early routine completion of a test.
See also
Program Running, Testing Trading S trategies, ExpertRemove, S etReturnError
TesterDeposit
The special function that emulates depositing funds during a test. It can be used in some money
management systems.
bool TesterDeposit(
double money // deposited sum
);
Parameters
money
[in] Money to be deposited to an account in the deposit currency.
Return Value
See also
TesterW ithdrawal
TesterWithdrawal
The special function to emulate the operation of money withdrawal in the process of testing. Can be
used in some asset management systems.
bool TesterWithdrawal(
double money // the sum to withdraw
);
Parameters
money
[in] The sum of money that we need to withdraw (in the deposit currency).
Return Value
See also
TesterDeposit
TranslateKey
R eturns a Unicode character by a virtual key code considering the current input language and the
status of control keys.
short TranslateKey(
int key_code // key code for receiving a Unicode character
);
Parameters
key_code
[in] Key code.
Return Value
Unicode character in case of a successful conversion. The function returns -1 in case of an error.
Note
The function uses ToUnicodeEx to convert keys pressed by a user into Unicode characters. An error
may occur in case ToUnicodeEx is not triggered – for example, when trying to receive the SHIFT key
character.
Example:
void OnChartEvent(const int id,const long& lparam,const double& dparam,const string& sparam)
{
if(id==CHARTEVENT_KEYDOWN)
{
short sym=TranslateKey((int)lparam);
//--- if the entered character is successfully converted to Unicode
if(sym>0)
Print(sym,"'",ShortToString(sym),"'");
else
Print("Error in TranslateKey for key=",lparam);
}
}
See also
Client terminal events, OnChartEvent
ZeroMemory
The function resets a variable passed to it by reference.
void ZeroMemory(
void & variable // reset variable
);
Parameters
variable
[in] [out] Variable passed by reference, you want to reset (initialize by zero values).
Return Value
No return value.
Note
If the function parameter is a string, the call will be equivalent to indicating NULL as its value.
For simple types and their arrays, as well as for structures /classes consisting of such types, this is a
simple reset.
For objects containing strings and dynamic arrays, ZeroMemory() is called for each element.
For any arrays not protected by the const modifier, this is the zeroing of all elements.
For arrays of complex objects, ZeroMemory() is called for each element.
Function Action
ArrayBsearch R eturns index of the first found element in the first array dimension
ArrayCopy Copies one array into another
ArrayCompare R eturns the result of comparing two arrays of simple types or custom
structures without complex objects
ArrayFree Frees up buffer of any dynamic array and sets the size of the zero
dimension in 0.
ArrayGetAs S eries Checks direction of array indexing
ArrayInitialize S ets all elements of a numeric array into a single value
ArrayFill Fills an array with the specified value
ArrayIs S eries Checks whether an array is a timeseries
ArrayIs Dynamic Checks whether an array is dynamic
ArrayMaximum S earch for an element with the maximal value
ArrayMinimum S earch for an element with the minimal value
ArrayPrint Prints an array of a simple type or a simple structure into journal
ArrayR ange R eturns the number of elements in the specified dimension of the array
ArrayR esize S ets the new size in the first dimension of the array
ArrayInsert Inserts the specified number of elements from a source array to a
receiving one starting from a specified index
ArrayR emove R emoves the specified number of elements from the array starting with a
specified index
ArrayR everse R everses the specified number of elements in the array starting with a
specified index
ArrayS etAs S eries S ets the direction of array indexing
ArrayS ize R eturns the number of elements in the array
ArrayS ort S orting of numeric arrays by the first dimension
ArrayS wap S waps the contents of two dynamic arrays of the same type
ArrayBsearch
S earchesfor a specified value in a multidimensional numeric array sorted ascending. S earch is
performed through the elements of the first dimension.
For searching in an array of double type
int ArrayBsearch(
const double& array[], // array for search
double value // what is searched for
);
int ArrayBsearch(
const float& array[], // array for search
float value // what is searched for
);
int ArrayBsearch(
const long& array[], // array for search
long value // what is searched for
);
int ArrayBsearch(
const int& array[], // array for search
int value // what is searched for
);
int ArrayBsearch(
const short& array[], // array for search
short value // what is searched for
);
int ArrayBsearch(
const char& array[], // array for search
char value // what is searched for
);
Parameters
array[]
[in] Numeric array for search.
value
Return Value
The function returns index of a found element. If the wanted value isn't found, the function returns
the index of an element nearest in value.
Note
Binary search processes only sorted arrays. To sort numeric arrays use the ArrayS ort() function.
Example:
ResetLastError();
if(CopyBuffer(rsi_handle,0,InpDateStart,InpDateFinish,rsi_buff)==-1)
{
PrintFormat("Failed to copy the indicator values. Error code = %d",GetLastError());
return;
}
//--- receive the array size
size=ArraySize(rsi_buff);
//--- sort out the array
ArraySort(rsi_buff);
//--- find out the time (in percentage terms) the market was in the oversold area
double ovs=(double)ArrayBsearch(rsi_buff,InpOversoldValue)*100/(double)size;
//--- find out the time (in percentage terms) the market was in the overbought area
double ovb=(double)(size-ArrayBsearch(rsi_buff,InpOverboughtValue))*100/(double)size;
//--- form the strings for displaying the data
string str="From "+TimeToString(InpDateStart,TIME_DATE)+" to "
+TimeToString(InpDateFinish,TIME_DATE)+" the market was:";
string str_ovb="in overbought area "+DoubleToString(ovb,2)+"% of time";
string str_ovs="in oversold area "+DoubleToString(ovs,2)+"% of time";
//--- display the data on the chart
CreateLabel("top",5,60,str,clrDodgerBlue);
CreateLabel("overbought",5,35,str_ovb,clrDodgerBlue);
CreateLabel("oversold",5,10,str_ovs,clrDodgerBlue);
//--- redraw the chart
ChartRedraw(0);
//--- pause
Sleep(10000);
}
//+------------------------------------------------------------------+
//| Display comment in the bottom left corner of the chart |
//+------------------------------------------------------------------+
void CreateLabel(const string name,const int x,const int y,
const string str,const color clr)
{
//--- create the label
ObjectCreate(0,name,OBJ_LABEL,0,0,0);
//--- bind the label to the bottom left corner
ObjectSetInteger(0,name,OBJPROP_CORNER,CORNER_LEFT_LOWER);
//--- change position of the anchor point
ObjectSetInteger(0,name,OBJPROP_ANCHOR,ANCHOR_LEFT_LOWER);
//--- distance from the anchor point in X-direction
ObjectSetInteger(0,name,OBJPROP_XDISTANCE,x);
//--- distance from the anchor point in Y-direction
ObjectSetInteger(0,name,OBJPROP_YDISTANCE,y);
//--- label text
ObjectSetString(0,name,OBJPROP_TEXT,str);
//--- text color
ObjectSetInteger(0,name,OBJPROP_COLOR,clr);
//--- text size
ObjectSetInteger(0,name,OBJPROP_FONTSIZE,12);
}
ArrayCopy
It copies an array into another one.
int ArrayCopy(
void& dst_array[], // destination array
const void& src_array[], // source array
int dst_start=0, // index starting from which write into destination array
int src_start=0, // first index of a source array
int count=WHOLE_ARRAY // number of elements
);
Parameters
dst_array[]
[out] Destination array
src_array[]
[in] S ource array
dst_start=0
[in] S tarting index from the destination array. By default, start index is 0.
src_start=0
[in] S tarting index for the source array. By default, start index is 0.
count=WHOLE_ARRAY
[in] Number of elements that should be copied. By default, the whole array is copied
(count=WHOLE_ARRAY).
Return Value
If count<0 or count>src_size-src_start, all the remaining array part is copied. Arrays are copied from
left to right. For series arrays, the starting position is correctly defined adjusted for copying from
left to right.
If arrays are of different types, during copying it tries to transform each element of a source array
into the type of the destination array. A string array can be copied into a string array only. Array of
classes and structures containing objects that require initialization aren't copied. An array of
structures can be copied into an array of the same type only.
For dynamic arrays with indexing as in timeseries, the size of a destination array is automatically
increased to the amount of copied data (if the latter exceeds the array size). The destination array
size is not decreased automatically.
Example:
#property description "The indicator highlights the candlesticks that are local"
#property description "highs and lows. Interval length for finding"
#property description "extreme values should be found using an input parameters."
PlotIndexSetString(0,PLOT_LABEL,"Open;High;Low;Close");
//---
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
//--- set straight indexing in time series
ArraySetAsSeries(open,false);
ArraySetAsSeries(high,false);
ArraySetAsSeries(low,false);
ArraySetAsSeries(close,false);
//--- variable of the bar calculation start
int start=prev_calculated;
//--- calculation is not performed for the first InpNum*2 bars
if(start==0)
{
start+=InpNum*2;
ExtStart=0;
ExtCount=0;
}
//--- if the bar has just formed, check the next potential extremum
if(rates_total-start==1)
start--;
//--- bar index to be checked for the extremum
int ext;
//--- indicator value calculation loop
for(int i=start;i<rates_total-1;i++)
{
//--- initially on i bar without drawing
ExtOpen[i]=0;
ExtHigh[i]=0;
ExtLow[i]=0;
ExtClose[i]=0;
//--- extremum index for check
ext=i-InpNum;
//--- check for the local maximum
if(IsMax(high,ext))
{
//--- highlight an extremum candlestick
ExtOpen[ext]=open[ext];
ExtHigh[ext]=high[ext];
ExtLow[ext]=low[ext];
ExtClose[ext]=close[ext];
ExtColor[ext]=1;
//--- highlight other candles up to the extremum with a neutral color
FillCandles(open,high,low,close);
//--- change the variable colors
ExtStart=ext+1;
ExtCount=0;
//--- pass to the next iteration
continue;
}
//--- check for the local minimum
if(IsMin(low,ext))
{
//--- highlight an extremum candlestick
ExtOpen[ext]=open[ext];
ExtHigh[ext]=high[ext];
ExtLow[ext]=low[ext];
ExtClose[ext]=close[ext];
ExtColor[ext]=2;
//--- highlight other candles up to the extremum with a neutral color
FillCandles(open,high,low,close);
//--- change variable values
ExtStart=ext+1;
ExtCount=0;
//--- pass to the next iteration
continue;
}
//--- increase the number of non-extremums at the interval
ExtCount++;
}
//--- return value of prev_calculated for next call
return(rates_total);
}
//+------------------------------------------------------------------+
//| Check if the current array element is a local high |
//+------------------------------------------------------------------+
bool IsMax(const double &price[],const int ind)
{
//--- interval start variable
int i=ind-InpNum;
//--- interval end period
int finish=ind+InpNum+1;
//--- check for the first half of the interval
for(;i<ind;i++)
{
if(price[ind]<=price[i])
return(false);
}
//--- check for the second half of the interval
for(i=ind+1;i<finish;i++)
{
if(price[ind]<=price[i])
return(false);
}
//--- this is an extremum
return(true);
}
//+------------------------------------------------------------------+
//| Check if the current array element is a local low |
//+------------------------------------------------------------------+
bool IsMin(const double &price[],const int ind)
{
//--- interval start variable
int i=ind-InpNum;
//--- interval end variable
int finish=ind+InpNum+1;
//--- check for the first half of the interval
for(;i<ind;i++)
{
if(price[ind]>=price[i])
return(false);
}
//--- check for the second half of the interval
for(i=ind+1;i<finish;i++)
{
if(price[ind]>=price[i])
return(false);
}
//--- this is an extremum
return(true);
}
ArrayCompare
The function returns the result of comparing two arrays of the same type. It can be used to compare
arrays of simple types or custom structures without complex objects, that is the custom structures
that do not contain strings, dynamic arrays, classes and other structures with complex objects.
int ArrayCompare(
const void& array1[], // first array
const void& array2[], // second array
int start1=0, // initial offset in the first array
int start2=0, // initial offset in the second array
int count=WHOLE_ARRAY // number of elements for comparison
);
Parameters
array1[]
[in] First array.
array2[]
[in] S econd array.
start1=0
[in] The element's initial index in the first array, from which comparison starts. The default start
index - 0.
start2=0
[in] The element's initial index in the second array, from which comparison starts. The default
start index - 0.
count=WHOLE_ARRAY
[in] Number of elements to be compared. All elements of both arrays participate in comparison by
default (count=WHOLE_ARRAY).
Return Value
· -1, if array1[] less than array2[]
· 0, if array1[] equal to array2[]
· 1, if array1[] more than array2[]
· -2, if an error occurs due to incompatibility of the types of compared arrays or if start1, start2 or
count values lead to falling outside the array.
Note
The function will not return 0 (the arrays will not be considered equal) if the arrays differ in size and
count=WHOLE_ARRAY for the case when one array is a faithful subset of another one. In this case,
the result of comparing the sizes of that arrays will be returned: -1, if the size of array1[] is less
than the size of array2[] , otherwise 1.
ArrayFree
It frees up a buffer of any dynamic array and sets the size of the zero dimension to 0.
void ArrayFree(
void& array[] // array
);
Parameters
array[]
[in] Dynamic array.
Return Value
No return value.
Note
The need for using ArrayFree() function may not appear too often considering that all used memory
is freed at once and main work with the arrays comprises the access to the indicator buffers. The
sizes of the buffers are automatically managed by the terminal's executive subsystem.
In case it is necessary to manually manage the memory in complex dynamic environment of the
application, ArrayFree() function allows users to free the memory occupied by the already
unnecessary dynamic array explicitly and immediately.
Example:
#include <Controls\Dialog.mqh>
#include <Controls\Button.mqh>
#include <Controls\Label.mqh>
#include <Controls\ComboBox.mqh>
//--- predefined constants
#define X_START 0
#define Y_START 0
#define X_SIZE 280
#define Y_SIZE 300
//+------------------------------------------------------------------+
//| Dialog class for working with memory |
//+------------------------------------------------------------------+
class CMemoryControl : public CAppDialog
{
private:
//--- array size
int m_arr_size;
//--- arrays
char m_arr_char[];
int m_arr_int[];
float m_arr_float[];
double m_arr_double[];
long m_arr_long[];
//--- labels
CLabel m_lbl_memory_physical;
CLabel m_lbl_memory_total;
CLabel m_lbl_memory_available;
CLabel m_lbl_memory_used;
CLabel m_lbl_array_size;
CLabel m_lbl_array_type;
CLabel m_lbl_error;
CLabel m_lbl_change_type;
CLabel m_lbl_add_size;
//--- buttons
CButton m_button_add;
CButton m_button_free;
//--- combo boxes
CComboBox m_combo_box_step;
CComboBox m_combo_box_type;
//--- current value of the array type from the combo box
int m_combo_box_type_value;
public:
CMemoryControl(void);
~CMemoryControl(void);
//--- class object creation method
virtual bool Create(const long chart,const string name,const int subwin,const int x1,const
//--- handler of chart events
virtual bool OnEvent(const int id,const long &lparam,const double &dparam,const string &spa
protected:
//--- create labels
bool CreateLabel(CLabel &lbl,const string name,const int x,const int y,const string
//--- create control elements
bool CreateButton(CButton &button,const string name,const int x,const int y,const s
bool CreateComboBoxStep(void);
bool CreateComboBoxType(void);
//--- event handlers
void OnClickButtonAdd(void);
void OnClickButtonFree(void);
void OnChangeComboBoxType(void);
//--- methods for working with the current array
void CurrentArrayFree(void);
bool CurrentArrayAdd(void);
};
//+------------------------------------------------------------------+
//| Free memory of the current array |
//+------------------------------------------------------------------+
void CMemoryControl::CurrentArrayFree(void)
{
//--- reset array size
m_arr_size=0;
//| Destructor |
//+------------------------------------------------------------------+
CMemoryControl::~CMemoryControl(void)
{
}
//+------------------------------------------------------------------+
//| Class object creation method |
//+------------------------------------------------------------------+
bool CMemoryControl::Create(const long chart,const string name,const int subwin,
const int x1,const int y1,const int x2,const int y2)
{
//--- create base class object
if(!CAppDialog::Create(chart,name,subwin,x1,y1,x2,y2))
return(false);
//--- prepare strings for labels
string str_physical="Memory physical = "+(string)TerminalInfoInteger(TERMINAL_MEMORY_PHYSICAL)+"
string str_total="Memory total = "+(string)TerminalInfoInteger(TERMINAL_MEMORY_TOTAL)+" Mb";
string str_available="Memory available = "+(string)TerminalInfoInteger(TERMINAL_MEMORY_AVAILABLE
string str_used="Memory used = "+(string)TerminalInfoInteger(TERMINAL_MEMORY_USED)+" Mb";
//--- create labels
if(!CreateLabel(m_lbl_memory_physical,"physical_label",X_START+10,Y_START+5,str_physical,12,clrB
return(false);
if(!CreateLabel(m_lbl_memory_total,"total_label",X_START+10,Y_START+30,str_total,12,clrBlack))
return(false);
if(!CreateLabel(m_lbl_memory_available,"available_label",X_START+10,Y_START+55,str_available,12,
return(false);
if(!CreateLabel(m_lbl_memory_used,"used_label",X_START+10,Y_START+80,str_used,12,clrBlack))
return(false);
if(!CreateLabel(m_lbl_array_type,"type_label",X_START+10,Y_START+105,"Array type = double",12,cl
return(false);
if(!CreateLabel(m_lbl_array_size,"size_label",X_START+10,Y_START+130,"Array size = 0",12,clrBlac
return(false);
if(!CreateLabel(m_lbl_error,"error_label",X_START+10,Y_START+155,"",12,clrRed))
return(false);
if(!CreateLabel(m_lbl_change_type,"change_type_label",X_START+10,Y_START+185,"Change type",10,cl
return(false);
if(!CreateLabel(m_lbl_add_size,"add_size_label",X_START+10,Y_START+210,"Add to array",10,clrBlac
return(false);
//--- create control elements
if(!CreateButton(m_button_add,"add_button",X_START+15,Y_START+245,"Add",12,clrBlue))
return(false);
if(!CreateButton(m_button_free,"free_button",X_START+75,Y_START+245,"Free",12,clrBlue))
return(false);
if(!CreateComboBoxType())
return(false);
if(!CreateComboBoxStep())
return(false);
//--- initialize the variable
m_arr_size=0;
if(!Add(m_combo_box_step))
return(false);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Create a combo box for the array type |
//+------------------------------------------------------------------+
bool CMemoryControl::CreateComboBoxType(void)
{
//--- create the combo box
if(!m_combo_box_type.Create(m_chart_id,"type_combobox",m_subwin,X_START+100,Y_START+210,X_START+
return(false);
//--- add elements to the combo box
if(!m_combo_box_type.ItemAdd("char",0))
return(false);
if(!m_combo_box_type.ItemAdd("int",1))
return(false);
if(!m_combo_box_type.ItemAdd("float",2))
return(false);
if(!m_combo_box_type.ItemAdd("double",3))
return(false);
if(!m_combo_box_type.ItemAdd("long",4))
return(false);
//--- set the current combo box element
if(!m_combo_box_type.SelectByValue(3))
return(false);
//--- store the current combo box element
m_combo_box_type_value=3;
//--- add the combo box to control elements
if(!Add(m_combo_box_type))
return(false);
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Create a label |
//+------------------------------------------------------------------+
bool CMemoryControl::CreateLabel(CLabel &lbl,const string name,const int x,
const int y,const string str,const int font_size,
const int clr)
{
//--- create a label
if(!lbl.Create(m_chart_id,name,m_subwin,x,y,0,0))
return(false);
//--- text
if(!lbl.Text(str))
return(false);
//--- font size
if(!lbl.FontSize(font_size))
return(false);
//--- color
if(!lbl.Color(clr))
return(false);
//--- add the label to control elements
if(!Add(lbl))
return(false);
//--- succeed
return(true);
}
//+------------------------------------------------------------------+
//| Handler of clicking "Add" button event |
//+------------------------------------------------------------------+
void CMemoryControl::OnClickButtonAdd(void)
{
//--- increase the array size
m_arr_size+=(int)m_combo_box_step.Value();
//--- attempt to allocate memory for the current array
if(CurrentArrayAdd())
{
//--- memory allocated, display the current status on the screen
m_lbl_memory_available.Text("Memory available = "+(string)TerminalInfoInteger(TERMINAL_MEMORY
m_lbl_memory_used.Text("Memory used = "+(string)TerminalInfoInteger(TERMINAL_MEMORY_USED)+" M
m_lbl_array_size.Text("Array size = "+IntegerToString(m_arr_size));
m_lbl_error.Text("");
}
else
{
//--- failed to allocate memory, display the error message
m_lbl_error.Text("Array is too large, error!");
//--- return the previous array size
m_arr_size-=(int)m_combo_box_step.Value();
}
}
//+------------------------------------------------------------------+
//| Handler of clicking "Free" button event |
//+------------------------------------------------------------------+
void CMemoryControl::OnClickButtonFree(void)
{
//--- free the memory of the current array
CurrentArrayFree();
//--- display the current status on the screen
m_lbl_memory_available.Text("Memory available = "+(string)TerminalInfoInteger(TERMINAL_MEMORY_AV
m_lbl_memory_used.Text("Memory used = "+(string)TerminalInfoInteger(TERMINAL_MEMORY_USED)+" Mb")
m_lbl_array_size.Text("Array size = 0");
m_lbl_error.Text("");
}
//+------------------------------------------------------------------+
//+------------------------------------------------------------------+
void OnChartEvent(const int id,
const long &lparam,
const double &dparam,
const string &sparam)
{
ExtDialog.ChartEvent(id,lparam,dparam,sparam);
}
ArrayGetAsSeries
It checks direction of an array index.
bool ArrayGetAsSeries(
const void& array[] // array for checking
);
Parameters
array
[in] Checked array.
Return Value
R eturnstrue, if the specified array has the AS_SERIES flag set, i.e. access to the array is performed
back to front as in timeseries. A timeseries differs from a usual array in that the indexing of
timeseries elements is performed from its end to beginning (from the newest data to old).
Note
To check whether an array belongs to timeseries, use the ArrayIs S eries() function. Arrays of price
data passed as input parameters into the OnCalculate() function do not obligatorily have the
indexing direction the same as in timeseries. The necessary indexing direction can be set using the
ArrayS etAs S eries() function.
Example:
//--- work at the last bar if the indicator values have already been calculated at the previous tic
if(prev_calculated>0)
start--;
//--- define indexing direction in arrays
bool as_series_first=ArrayGetAsSeries(first);
bool as_series_second=ArrayGetAsSeries(second);
bool as_series_buffer=ArrayGetAsSeries(buffer);
//--- replace indexing direction with direct one if necessary
if(as_series_first)
ArraySetAsSeries(first,false);
if(as_series_second)
ArraySetAsSeries(second,false);
if(as_series_buffer)
ArraySetAsSeries(buffer,false);
//--- calculate indicator values
for(int i=start;i<rates_total;i++)
buffer[i]=MathAbs(first[i]-second[i]);
}
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- bind indicator buffers
SetIndexBuffer(0,ExtBuffer);
//--- set indexing element in the indicator buffer
ArraySetAsSeries(ExtBuffer,InpAsSeries);
//--- check for what prices the indicator is calculated
if(InpPrices)
{
//--- Open and Close prices
PlotIndexSetString(0,PLOT_LABEL,"BodySize");
//--- set the indicator color
PlotIndexSetInteger(0,PLOT_LINE_COLOR,clrOrange);
}
else
{
//--- High and Low prices
PlotIndexSetString(0,PLOT_LABEL,"ShadowSize");
//--- set the indicator color
PlotIndexSetInteger(0,PLOT_LINE_COLOR,clrDodgerBlue);
}
//---
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
See also
Access to timeseries, ArrayS etAs S eries
ArrayInitialize
The function initializes a numeric array by a preset value.
For initialization of an array of char type
int ArrayInitialize(
char array[], // initialized array
char value // value that will be set
);
int ArrayInitialize(
short array[], // initialized array
short value // value that will be set
);
int ArrayInitialize(
int array[], // initialized array
int value // value that will be set
);
int ArrayInitialize(
long array[], // initialized array
long value // value that will be set
);
int ArrayInitialize(
float array[], // initialized array
float value // value that will be set
);
int ArrayInitialize(
double array[], // initialized array
double value // value that will be set
);
int ArrayInitialize(
bool array[], // initialized array
bool value // value that will be set
);
int ArrayInitialize(
uint array[], // initialized array
uint value // value that will be set
);
Parameters
array[]
[out] Numeric array that should be initialized.
value
[in] New value that should be set to all array elements.
Return Value
The ArrayResize() function allows to set size of an array with a reserve for further expansion
without the physical relocation of memory. It is implemented for the better performance, because
the operations of memory relocation are reasonably slow.
Initialization of the array using ArrayInitialize(array, init_val) doesn't mean the initialization with
the same value of reserve elements allocated for this array. At further expanding of the array using
the ArrayResize() function, the elements will be added at the end of the array, their values will be
undefined and in most cases will not be equal to init_value.
Example:
void OnStart()
{
//--- dynamic array
double array[];
//--- let's set the array size for 100 elements and reserve a buffer for another 10 elements
ArrayResize(array,100,10);
//--- initialize the array elements with EMPTY_VALUE=DBL_MAX value
ArrayInitialize(array,EMPTY_VALUE);
Print("Values of 10 last elements after initialization");
for(int i=90;i<100;i++) printf("array[%d] = %G",i,array[i]);
//--- expand the array by 5 elements
ArrayResize(array,105);
Print("Values of 10 last elements after ArrayResize(array,105)");
//--- values of 5 last elements are obtained from reserve buffer
for(int i=95;i<105;i++) printf("array[%d] = %G",i,array[i]);
}
ArrayFill
The function fills an array with the specified value.
void ArrayFill(
void& array[], // array
int start, // starting index
int count, // number of elements to fill
void value // value
);
Parameters
array[]
[out] Array of simple type (char, uchar, short, ushort, int, uint, long, ulong, bool, color, datetime,
float, double).
start
[in] S tarting index. In such a case, specified AS_SERIES flag is ignored.
count
[in] Number of elements to fill.
value
[in] Value to fill the array with.
Return Value
No return value.
Note
W hen ArrayFill()function is called, normal indexation direction (from left to right) is always implied.
It means that the change of the order of access to the array elements using ArrayS etAs S eries()
function is ignored.
A multidimensional array is shown as one-dimensional when processed by ArrayFill() function. For
example, array[2][4] is processed as array[8]. Therefore, you may specify the initial element's index
to be equal to 5 when working with this array. Thus, the call of ArrayFill(array, 5, 2, 3.14) for
array[2][4] fills array[1][1] and array[1][2] elements with 3.14.
Example:
void OnStart()
{
//--- declare dynamic array
int a[];
//--- set size
ArrayResize(a,10);
//--- fill first 5 elements with 123
ArrayFill(a,0,5,123);
//--- fill next 5 elements with 456
ArrayFill(a,5,5,456);
ArrayIsDynamic
The function checks whether an array is dynamic.
bool ArrayIsDynamic(
const void& array[] // checked array
);
Parameters
array[]
[in] Checked array.
Return Value
#property description "This indicator does not calculate values. It makes a single attempt to"
#property description "apply the call of ArrayFree() function to three arrays: dynamic one, static
#property description "an indicator buffer. Results are shown in Experts journal."
//--- indicator settings
#property indicator_chart_window
#property indicator_buffers 1
#property indicator_plots 1
//--- global variables
double ExtDynamic[]; // dynamic array
double ExtStatic[100]; // static array
bool ExtFlag=true; // flag
double ExtBuff[]; // indicator buffer
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- allocate memory for the array
ArrayResize(ExtDynamic,100);
//--- indicator buffers mapping
SetIndexBuffer(0,ExtBuff);
PlotIndexSetDouble(0,PLOT_EMPTY_VALUE,0);
//---
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const int begin,
const double &price[])
{
//--- perform a single analysis
if(ExtFlag)
{
//--- attempt to free memory for arrays
//--- 1. Dynamic array
Print("+============================+");
Print("1. Check dynamic array:");
Print("Size before memory is freed = ",ArraySize(ExtDynamic));
Print("Is this a dynamic array = ",ArrayIsDynamic(ExtDynamic) ? "Yes" : "No");
//--- attempt to free array memory
ArrayFree(ExtDynamic);
Print("Size after memory is freed = ",ArraySize(ExtDynamic));
//--- 2. Static array
Print("2. Check static array:");
Print("Size before memory is freed = ",ArraySize(ExtStatic));
Print("Is this a dynamic array = ",ArrayIsDynamic(ExtStatic) ? "Yes" : "No");
//--- attempt to free array memory
ArrayFree(ExtStatic);
Print("Size after memory is freed = ",ArraySize(ExtStatic));
//--- 3. Indicator buffer
Print("3. Check indicator buffer:");
Print("Size before memory is freed = ",ArraySize(ExtBuff));
Print("Is this a dynamic array = ",ArrayIsDynamic(ExtBuff) ? "Yes" : "No");
//--- attempt to free array memory
ArrayFree(ExtBuff);
Print("Size after memory is freed = ",ArraySize(ExtBuff));
//--- change the flag value
ExtFlag=false;
}
//--- return value of prev_calculated for next call
return(rates_total);
}
See also
Access to timeseries and indicators
ArrayIsSeries
The function checks whether an array is a timeseries.
bool ArrayIsSeries(
const void& array[] // checked array
);
Parameters
array[]
[in] Checked array.
Return Value
It returns true, if a checked array is an array timeseries, otherwise it returns false. Arrays passed as
a parameter to the OnCalculate() function must be checked for the order of accessing the array
elements by ArrayGetAs S eries().
Example:
#property indicator_chart_window
#property indicator_buffers 1
#property indicator_plots 1
//---- plot Label1
#property indicator_label1 "Label1"
#property indicator_type1 DRAW_LINE
#property indicator_color1 clrRed
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
//--- indicator buffers
double Label1Buffer[];
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
void OnInit()
{
//--- indicator buffers mapping
SetIndexBuffer(0,Label1Buffer,INDICATOR_DATA);
//---
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
See also
Access to timeseries and indicators
ArrayMaximum
S earches for the largest element in the first dimension of a multidimensional numeric array.
int ArrayMaximum(
const void& array[], // array for search
int start=0, // index to start checking with
int count=WHOLE_ARRAY // number of checked elements
);
Parameters
array[]
[in] A numeric array, in which search is made.
start=0
[in] Index to start checking with.
count=WHOLE_ARRAY
[in] Number of elements for search. By default, searches in the entire array
(count=WHOLE_ARRAY).
Return Value
The function returns an index of a found element taking into account the array serial. In case of
failure it returns -1.
Note
The AS_SERIES flag value is taken into account while searching for a maximum.
Functions ArrayMaximum and ArrayMinimum accept any-dimensional arrays as a parameter.
H owever, searching is always applied to the first (zero) dimension.
Example:
#property description "The indicator displays larger timeframe's candlesticks on the current one."
//--- indicator settings
#property indicator_chart_window
#property indicator_buffers 16
#property indicator_plots 8
//---- plot 1
#property indicator_label1 "BearBody"
#property indicator_color1 clrSeaGreen,clrSeaGreen
//---- plot 2
#property indicator_label2 "BearBodyEnd"
#property indicator_color2 clrSeaGreen,clrSeaGreen
//---- plot 3
#property indicator_label3 "BearShadow"
#property indicator_color3 clrSalmon,clrSalmon
//---- plot 4
#property indicator_label4 "BearShadowEnd"
#property indicator_color4 clrSalmon,clrSalmon
//---- plot 5
#property indicator_label5 "BullBody"
#property indicator_color5 clrOlive,clrOlive
//---- plot 6
#property indicator_label6 "BullBodyEnd"
#property indicator_color6 clrOlive,clrOlive
//---- plot 7
#property indicator_label7 "BullShadow"
#property indicator_color7 clrSkyBlue,clrSkyBlue
//---- plot 8
#property indicator_label8 "BullShadowEnd"
#property indicator_color8 clrSkyBlue,clrSkyBlue
//--- predefined constant
#define INDICATOR_EMPTY_VALUE 0.0
//--- input parameters
input ENUM_TIMEFRAMES InpPeriod=PERIOD_H4; // Time frame for the indicator calculation
input datetime InpDateStart=D'2013.01.01 00:00'; // Analysis start date
//--- indicator buffers for bearish candlesticks
double ExtBearBodyFirst[];
double ExtBearBodySecond[];
double ExtBearBodyEndFirst[];
double ExtBearBodyEndSecond[];
double ExtBearShadowFirst[];
double ExtBearShadowSecond[];
double ExtBearShadowEndFirst[];
double ExtBearShadowEndSecond[];
//--- indicator buffers for bullish candlesticks
double ExtBullBodyFirst[];
double ExtBullBodySecond[];
double ExtBullBodyEndFirst[];
double ExtBullBodyEndSecond[];
double ExtBullShadowFirst[];
double ExtBullShadowSecond[];
double ExtBullShadowEndFirst[];
double ExtBullShadowEndSecond[];
//--- global variables
datetime ExtTimeBuff[]; // larger time frame's time buffer
int ExtSize=0; // time buffer size
int ExtCount=0; // index inside time buffer
int ExtStartPos=0; // initial position for the indicator calculation
bool ExtStartFlag=true; // auxiliary flag for receiving the initial position
datetime ExtCurrentTime[1]; // last time of the larger time frame's bar generation
datetime ExtLastTime; // last time from the larger time frame, for which the calculation is
bool ExtBearFlag=true; // flag for defining the order of writing the data to bearish indicato
bool ExtBullFlag=true; // flag for defining the order of writing the data to bullish indicato
int ExtIndexMax=0; // index of the maximum element in the array
int ExtIndexMin=0; // index of the minimum element in the array
int ExtDirectionFlag=0; // price movement direction for the current candlestick
//--- shift between the candlestick's open and close price for correct drawing
//--- if close and open prices are equal, use the shift for correct display
if(high[index_max]!=low[index_min])
FormCandleMain(ExtBearBodyFirst,ExtBearBodySecond,ExtBearShadowFirst,ExtBearShadowSecond,open
open[start]-ExtEmptyBodySize,high[index_max],low[index_min],start,count,ExtBea
else
FormCandleMain(ExtBearBodyFirst,ExtBearBodySecond,ExtBearShadowFirst,ExtBearShadowSecond,
open[start],open[start]-ExtEmptyBodySize,high[index_max],
high[index_max]-ExtEmptyBodySize,start,count,ExtBearFlag);
}
//+------------------------------------------------------------------+
//| Fill out the end of the candlestick |
//+------------------------------------------------------------------+
void FillCandleEnd(const double &open[],const double &close[],
const double &high[],const double &low[],
const int start,const int last,const int fill_index,
const int index_max,const int index_min)
{
//--- do not draw in case of a single bar
if(last-start==0)
return;
//--- if the close price at the first bar exceeds the one at the last bar, the candlestick is beari
if(open[start]>close[last])
{
//--- generate the end of the candlestick
FormCandleEnd(ExtBearBodyEndFirst,ExtBearBodyEndSecond,ExtBearShadowEndFirst,ExtBearShadowEnd
open[start],close[last],high[index_max],low[index_min],fill_index,ExtBearFlag);
//--- exit the function
return;
}
//--- if the close price at the first bar is less than the one at the last bar, the candlestick is
if(open[start]<close[last])
{
//--- generate the end of the candlestick
FormCandleEnd(ExtBullBodyEndFirst,ExtBullBodyEndSecond,ExtBullShadowEndFirst,ExtBullShadowEnd
close[last],open[start],high[index_max],low[index_min],fill_index,ExtBullFlag);
//--- exit the function
return;
}
//--- if you are in this part of the function, the open price at the first bar is equal to
//--- the close price at the last bar; such candlestick is considered bearish
//--- generate the end of the candlestick
if(high[index_max]!=low[index_min])
FormCandleEnd(ExtBearBodyEndFirst,ExtBearBodyEndSecond,ExtBearShadowEndFirst,ExtBearShadowEnd
open[start]-ExtEmptyBodySize,high[index_max],low[index_min],fill_index,ExtBearF
else
FormCandleEnd(ExtBearBodyEndFirst,ExtBearBodyEndSecond,ExtBearShadowEndFirst,ExtBearShadowEnd
open[start]-ExtEmptyBodySize,high[index_max],high[index_max]-ExtEmptyBodySize,f
}
//+------------------------------------------------------------------+
{
//--- in case there are no calculated bars yet
if(prev_calculated==0)
{
//--- receive larger time frame's bars arrival time
if(!GetTimeData())
return(0);
}
//--- set direct indexing
ArraySetAsSeries(time,false);
ArraySetAsSeries(high,false);
ArraySetAsSeries(low,false);
ArraySetAsSeries(open,false);
ArraySetAsSeries(close,false);
//--- start variable for calculation of bars
int start=prev_calculated;
//--- if the bar is generated, recalculate the indicator value on it
if(start!=0 && start==rates_total)
start--;
//--- the loop for calculating the indicator values
for(int i=start;i<rates_total;i++)
{
//--- fill i elements of the indicator buffers by empty values
FillIndicatorBuffers(i);
//--- perform calculation for bars starting from InpDateStart date
if(time[i]>=InpDateStart)
{
//--- define position, from which the values are to be displayed, for the first time
if(ExtStartFlag)
{
//--- store the number of the initial bar
ExtStartPos=i;
//--- define the first date from the larger time frame exceeding time[i]
while(time[i]>=ExtTimeBuff[ExtCount])
if(ExtCount<ExtSize-1)
ExtCount++;
//--- change the value of the flag in order not to run into this block again
ExtStartFlag=false;
}
//--- check if there are still any elements in the array
if(ExtCount<ExtSize)
{
//--- wait for the current time frame's value to reach the larger time frame's one
if(time[i]>=ExtTimeBuff[ExtCount])
{
//--- draw the main part of the candlestick (without filling out the area between th
FillCandleMain(open,close,high,low,ExtStartPos,i-1,i-2,ExtIndexMax,ExtIndexMin);
//--- fill out the end of the candlestick (the area between the last and the penulti
FillCandleEnd(open,close,high,low,ExtStartPos,i-1,i-1,ExtIndexMax,ExtIndexMin);
//--- shift the initial position for drawing the next candlestick
ExtStartPos=i;
//--- increase the array counter
ExtCount++;
}
else
continue;
}
else
{
//--- reset the array values
ResetLastError();
//--- receive the last date from the larger time frame
if(CopyTime(Symbol(),InpPeriod,0,1,ExtCurrentTime)==-1)
{
Print("Data copy error, code = ",GetLastError());
return(0);
}
//--- if the new date is later, stop generating the candlestick
if(ExtCurrentTime[0]>ExtLastTime)
{
//--- clear the area between the last and penultimate bars in the main indicator buf
ClearEndOfBodyMain(i-1);
//--- fill out the area using auxiliary indicator buffers
FillCandleEnd(open,close,high,low,ExtStartPos,i-1,i-1,ExtIndexMax,ExtIndexMin);
//--- shift the initial position for drawing the next candlestick
ExtStartPos=i;
//--- reset price direction flag
ExtDirectionFlag=0;
//--- store the new last date
ExtLastTime=ExtCurrentTime[0];
}
else
{
//--- generate the candlestick
FillCandleMain(open,close,high,low,ExtStartPos,i,i,ExtIndexMax,ExtIndexMin);
}
}
}
}
//--- return value of prev_calculated for next call
return(rates_total);
}
//+------------------------------------------------------------------+
//| Check correctness of the specified indicator period |
//+------------------------------------------------------------------+
bool CheckPeriod(int current_period,int high_period)
{
//--- the indicator period should exceed the timeframe on which it is displayed
if(current_period>=high_period)
{
Print("Error! The value of the indicator period should exceed the value of the current time f
return(false);
}
//--- if the indicator period is one week or month, the period is correct
if(high_period>32768)
return(true);
//--- convert period values to minutes
if(high_period>30)
high_period=(high_period-16384)*60;
if(current_period>30)
current_period=(current_period-16384)*60;
//--- the indicator period should be multiple of the time frame it is displayed on
if(high_period%current_period!=0)
{
Print("Error! The value of the indicator period should be multiple of the value of the curren
return(false);
}
//--- the indicator period should exceed the time frame it is displayed on 3 or more times
if(high_period/current_period<3)
{
Print("Error! The indicator period should exceed the current time frame 3 or more times!");
return(false);
}
//--- the indicator period is correct for the current time frame
return(true);
}
//+------------------------------------------------------------------+
//| Receive time data from the larger time frame |
//+------------------------------------------------------------------+
bool GetTimeData(void)
{
//--- reset the error value
ResetLastError();
//--- copy all data for the current time
if(CopyTime(Symbol(),InpPeriod,InpDateStart,TimeCurrent(),ExtTimeBuff)==-1)
{
//--- receive the error code
int code=GetLastError();
//--- print out the error message
PrintFormat("Data copy error! %s",code==4401
? "History is still being uploaded!"
: "Code = "+IntegerToString(code));
//--- return false to make a repeated attempt to download data
return(false);
}
//--- receive the array size
ExtSize=ArraySize(ExtTimeBuff);
if(flag)
{
//--- generate the end of the candlestick's body
FormEnd(body_fst,body_snd,fst_value,snd_value,end);
//--- generate the end of the candlestick's shadow
FormEnd(shadow_fst,shadow_snd,fst_extremum,snd_extremum,end);
//--- change the flag's value to the opposite one
flag=false;
}
else
{
//--- generate the end of the candlestick's body
FormEnd(body_fst,body_snd,snd_value,fst_value,end);
//--- generate the end of the candlestick's shadow
FormEnd(shadow_fst,shadow_snd,snd_extremum,fst_extremum,end);
//--- change the flag's value to the opposite one
flag=true;
}
}
//+---------------------------------------------------------------------------------+
//| Clear the end of the candlestick (the area between the last and the penultimate |
//| bar) |
//+---------------------------------------------------------------------------------+
void ClearEndOfBodyMain(const int ind)
{
ClearCandle(ExtBearBodyFirst,ExtBearBodySecond,ExtBearShadowFirst,ExtBearShadowSecond,ind,1);
ClearCandle(ExtBullBodyFirst,ExtBullBodySecond,ExtBullShadowFirst,ExtBullShadowSecond,ind,1);
}
//+--------------------------------------------------------------------------+
//| Clear the candlestick |
//+--------------------------------------------------------------------------+
void ClearCandle(double &body_fst[],double &body_snd[],double &shadow_fst[],
double &shadow_snd[],const int start,const int count)
{
//--- check
if(count!=0)
{
//--- fill indicator buffers with empty values
ArrayFill(body_fst,start,count,INDICATOR_EMPTY_VALUE);
ArrayFill(body_snd,start,count,INDICATOR_EMPTY_VALUE);
ArrayFill(shadow_fst,start,count,INDICATOR_EMPTY_VALUE);
ArrayFill(shadow_snd,start,count,INDICATOR_EMPTY_VALUE);
}
}
//+--------------------------------------------------------------------------+
//| Generate the main part of the candlestick |
//+--------------------------------------------------------------------------+
void FormMain(double &fst[],double &snd[],const double fst_value,
const double snd_value,const int start,const int count)
{
//--- check
if(count!=0)
{
//--- fill indicator buffers with values
ArrayFill(fst,start,count,fst_value);
ArrayFill(snd,start,count,snd_value);
}
}
//+-----------------------------------------------------------------------------+
//| Generate the end of the candlestick |
//+-----------------------------------------------------------------------------+
void FormEnd(double &fst[],double &snd[],const double fst_value,
const double snd_value,const int last)
{
//--- fill indicator buffers with values
ArrayFill(fst,last-1,2,fst_value);
ArrayFill(snd,last-1,2,snd_value);
}
//+------------------------------------------------------------------+
//| Fill i element of the indicator buffers by empty values |
//+------------------------------------------------------------------+
void FillIndicatorBuffers(const int i)
{
//--- set an empty value in the cell of the indicator buffers
ExtBearBodyFirst[i]=INDICATOR_EMPTY_VALUE;
ExtBearBodySecond[i]=INDICATOR_EMPTY_VALUE;
ExtBearShadowFirst[i]=INDICATOR_EMPTY_VALUE;
ExtBearShadowSecond[i]=INDICATOR_EMPTY_VALUE;
ExtBearBodyEndFirst[i]=INDICATOR_EMPTY_VALUE;
ExtBearBodyEndSecond[i]=INDICATOR_EMPTY_VALUE;
ExtBearShadowEndFirst[i]=INDICATOR_EMPTY_VALUE;
ExtBearShadowEndSecond[i]=INDICATOR_EMPTY_VALUE;
ExtBullBodyFirst[i]=INDICATOR_EMPTY_VALUE;
ExtBullBodySecond[i]=INDICATOR_EMPTY_VALUE;
ExtBullShadowFirst[i]=INDICATOR_EMPTY_VALUE;
ExtBullShadowSecond[i]=INDICATOR_EMPTY_VALUE;
ExtBullBodyEndFirst[i]=INDICATOR_EMPTY_VALUE;
ExtBullBodyEndSecond[i]=INDICATOR_EMPTY_VALUE;
ExtBullShadowEndFirst[i]=INDICATOR_EMPTY_VALUE;
ExtBullShadowEndSecond[i]=INDICATOR_EMPTY_VALUE;
}
ArrayMinimum
S earches for the lowest element in the first dimension of a multidimensional numeric array.
int ArrayMinimum(
const void& array[], // array for search
int start=0, // index to start checking with
int count=WHOLE_ARRAY // number of checked elements
);
Parameters
array[]
[in] A numeric array, in which search is made.
start=0
[in] Index to start checking with.
count=WHOLE_ARRAY
[in] Number of elements for search. By default, searches in the entire array
(count=WHOLE_ARRAY).
Return Value
The function returns an index of a found element taking into account the array serial. In case of
failure it returns -1.
Note
The AS_SERIES flag value is taken into account while searching for a minimum.
Functions ArrayMaximum and ArrayMinimum accept any-dimensional arrays as a parameter.
H owever, searching is always applied to the first (zero) dimension.
Example:
#property description "The indicator displays larger timeframe's candlesticks on the current one."
//--- indicator settings
#property indicator_chart_window
#property indicator_buffers 16
#property indicator_plots 8
//---- plot 1
#property indicator_label1 "BearBody"
#property indicator_color1 clrSeaGreen,clrSeaGreen
//---- plot 2
#property indicator_label2 "BearBodyEnd"
#property indicator_color2 clrSeaGreen,clrSeaGreen
//---- plot 3
#property indicator_label3 "BearShadow"
#property indicator_color3 clrSalmon,clrSalmon
//---- plot 4
#property indicator_label4 "BearShadowEnd"
#property indicator_color4 clrSalmon,clrSalmon
//---- plot 5
#property indicator_label5 "BullBody"
#property indicator_color5 clrOlive,clrOlive
//---- plot 6
#property indicator_label6 "BullBodyEnd"
#property indicator_color6 clrOlive,clrOlive
//---- plot 7
#property indicator_label7 "BullShadow"
#property indicator_color7 clrSkyBlue,clrSkyBlue
//---- plot 8
#property indicator_label8 "BullShadowEnd"
#property indicator_color8 clrSkyBlue,clrSkyBlue
//--- predefined constant
#define INDICATOR_EMPTY_VALUE 0.0
//--- input parameters
input ENUM_TIMEFRAMES InpPeriod=PERIOD_H4; // Time frame for the indicator calculation
input datetime InpDateStart=D'2013.01.01 00:00'; // Analysis start date
//--- indicator buffers for bearish candlesticks
double ExtBearBodyFirst[];
double ExtBearBodySecond[];
double ExtBearBodyEndFirst[];
double ExtBearBodyEndSecond[];
double ExtBearShadowFirst[];
double ExtBearShadowSecond[];
double ExtBearShadowEndFirst[];
double ExtBearShadowEndSecond[];
//--- indicator buffers for bullish candlesticks
double ExtBullBodyFirst[];
double ExtBullBodySecond[];
double ExtBullBodyEndFirst[];
double ExtBullBodyEndSecond[];
double ExtBullShadowFirst[];
double ExtBullShadowSecond[];
double ExtBullShadowEndFirst[];
double ExtBullShadowEndSecond[];
//--- global variables
datetime ExtTimeBuff[]; // larger time frame's time buffer
int ExtSize=0; // time buffer size
int ExtCount=0; // index inside time buffer
int ExtStartPos=0; // initial position for the indicator calculation
bool ExtStartFlag=true; // auxiliary flag for receiving the initial position
datetime ExtCurrentTime[1]; // last time of the larger time frame's bar generation
datetime ExtLastTime; // last time from the larger time frame, for which the calculation is
bool ExtBearFlag=true; // flag for defining the order of writing the data to bearish indicato
bool ExtBullFlag=true; // flag for defining the order of writing the data to bullish indicato
int ExtIndexMax=0; // index of the maximum element in the array
int ExtIndexMin=0; // index of the minimum element in the array
int ExtDirectionFlag=0; // price movement direction for the current candlestick
//--- shift between the candlestick's open and close price for correct drawing
//--- if close and open prices are equal, use the shift for correct display
if(high[index_max]!=low[index_min])
FormCandleMain(ExtBearBodyFirst,ExtBearBodySecond,ExtBearShadowFirst,ExtBearShadowSecond,open
open[start]-ExtEmptyBodySize,high[index_max],low[index_min],start,count,ExtBea
else
FormCandleMain(ExtBearBodyFirst,ExtBearBodySecond,ExtBearShadowFirst,ExtBearShadowSecond,
open[start],open[start]-ExtEmptyBodySize,high[index_max],
high[index_max]-ExtEmptyBodySize,start,count,ExtBearFlag);
}
//+------------------------------------------------------------------+
//| Fill out the end of the candlestick |
//+------------------------------------------------------------------+
void FillCandleEnd(const double &open[],const double &close[],
const double &high[],const double &low[],
const int start,const int last,const int fill_index,
const int index_max,const int index_min)
{
//--- do not draw in case of a single bar
if(last-start==0)
return;
//--- if the close price at the first bar exceeds the one at the last bar, the candlestick is beari
if(open[start]>close[last])
{
//--- generate the end of the candlestick
FormCandleEnd(ExtBearBodyEndFirst,ExtBearBodyEndSecond,ExtBearShadowEndFirst,ExtBearShadowEnd
open[start],close[last],high[index_max],low[index_min],fill_index,ExtBearFlag);
//--- exit the function
return;
}
//--- if the close price at the first bar is less than the one at the last bar, the candlestick is
if(open[start]<close[last])
{
//--- generate the end of the candlestick
FormCandleEnd(ExtBullBodyEndFirst,ExtBullBodyEndSecond,ExtBullShadowEndFirst,ExtBullShadowEnd
close[last],open[start],high[index_max],low[index_min],fill_index,ExtBullFlag);
//--- exit the function
return;
}
//--- if you are in this part of the function, the open price at the first bar is equal to
//--- the close price at the last bar; such candlestick is considered bearish
//--- generate the end of the candlestick
if(high[index_max]!=low[index_min])
FormCandleEnd(ExtBearBodyEndFirst,ExtBearBodyEndSecond,ExtBearShadowEndFirst,ExtBearShadowEnd
open[start]-ExtEmptyBodySize,high[index_max],low[index_min],fill_index,ExtBearF
else
FormCandleEnd(ExtBearBodyEndFirst,ExtBearBodyEndSecond,ExtBearShadowEndFirst,ExtBearShadowEnd
open[start]-ExtEmptyBodySize,high[index_max],high[index_max]-ExtEmptyBodySize,f
}
//+------------------------------------------------------------------+
{
//--- in case there are no calculated bars yet
if(prev_calculated==0)
{
//--- receive larger time frame's bars arrival time
if(!GetTimeData())
return(0);
}
//--- set direct indexing
ArraySetAsSeries(time,false);
ArraySetAsSeries(high,false);
ArraySetAsSeries(low,false);
ArraySetAsSeries(open,false);
ArraySetAsSeries(close,false);
//--- start variable for calculation of bars
int start=prev_calculated;
//--- if the bar is generated, recalculate the indicator value on it
if(start!=0 && start==rates_total)
start--;
//--- the loop for calculating the indicator values
for(int i=start;i<rates_total;i++)
{
//--- fill i elements of the indicator buffers by empty values
FillIndicatorBuffers(i);
//--- perform calculation for bars starting from InpDateStart date
if(time[i]>=InpDateStart)
{
//--- define position, from which the values are to be displayed, for the first time
if(ExtStartFlag)
{
//--- store the number of the initial bar
ExtStartPos=i;
//--- define the first date from the larger time frame exceeding time[i]
while(time[i]>=ExtTimeBuff[ExtCount])
if(ExtCount<ExtSize-1)
ExtCount++;
//--- change the value of the flag in order not to run into this block again
ExtStartFlag=false;
}
//--- check if there are still any elements in the array
if(ExtCount<ExtSize)
{
//--- wait for the current time frame's value to reach the larger time frame's one
if(time[i]>=ExtTimeBuff[ExtCount])
{
//--- draw the main part of the candlestick (without filling out the area between th
FillCandleMain(open,close,high,low,ExtStartPos,i-1,i-2,ExtIndexMax,ExtIndexMin);
//--- fill out the end of the candlestick (the area between the last and the penulti
FillCandleEnd(open,close,high,low,ExtStartPos,i-1,i-1,ExtIndexMax,ExtIndexMin);
//--- shift the initial position for drawing the next candlestick
ExtStartPos=i;
//--- increase the array counter
ExtCount++;
}
else
continue;
}
else
{
//--- reset the array values
ResetLastError();
//--- receive the last date from the larger time frame
if(CopyTime(Symbol(),InpPeriod,0,1,ExtCurrentTime)==-1)
{
Print("Data copy error, code = ",GetLastError());
return(0);
}
//--- if the new date is later, stop generating the candlestick
if(ExtCurrentTime[0]>ExtLastTime)
{
//--- clear the area between the last and penultimate bars in the main indicator buf
ClearEndOfBodyMain(i-1);
//--- fill out the area using auxiliary indicator buffers
FillCandleEnd(open,close,high,low,ExtStartPos,i-1,i-1,ExtIndexMax,ExtIndexMin);
//--- shift the initial position for drawing the next candlestick
ExtStartPos=i;
//--- reset price direction flag
ExtDirectionFlag=0;
//--- store the new last date
ExtLastTime=ExtCurrentTime[0];
}
else
{
//--- generate the candlestick
FillCandleMain(open,close,high,low,ExtStartPos,i,i,ExtIndexMax,ExtIndexMin);
}
}
}
}
//--- return value of prev_calculated for next call
return(rates_total);
}
//+------------------------------------------------------------------+
//| Check correctness of the specified indicator period |
//+------------------------------------------------------------------+
bool CheckPeriod(int current_period,int high_period)
{
//--- the indicator period should exceed the timeframe on which it is displayed
if(current_period>=high_period)
{
Print("Error! The value of the indicator period should exceed the value of the current time f
return(false);
}
//--- if the indicator period is one week or month, the period is correct
if(high_period>32768)
return(true);
//--- convert period values to minutes
if(high_period>30)
high_period=(high_period-16384)*60;
if(current_period>30)
current_period=(current_period-16384)*60;
//--- the indicator period should be multiple of the time frame it is displayed on
if(high_period%current_period!=0)
{
Print("Error! The value of the indicator period should be multiple of the value of the curren
return(false);
}
//--- the indicator period should exceed the time frame it is displayed on 3 or more times
if(high_period/current_period<3)
{
Print("Error! The indicator period should exceed the current time frame 3 or more times!");
return(false);
}
//--- the indicator period is correct for the current time frame
return(true);
}
//+------------------------------------------------------------------+
//| Receive time data from the larger time frame |
//+------------------------------------------------------------------+
bool GetTimeData(void)
{
//--- reset the error value
ResetLastError();
//--- copy all data for the current time
if(CopyTime(Symbol(),InpPeriod,InpDateStart,TimeCurrent(),ExtTimeBuff)==-1)
{
//--- receive the error code
int code=GetLastError();
//--- print out the error message
PrintFormat("Data copy error! %s",code==4401
? "History is still being uploaded!"
: "Code = "+IntegerToString(code));
//--- return false to make a repeated attempt to download data
return(false);
}
//--- receive the array size
ExtSize=ArraySize(ExtTimeBuff);
if(flag)
{
//--- generate the end of the candlestick's body
FormEnd(body_fst,body_snd,fst_value,snd_value,end);
//--- generate the end of the candlestick's shadow
FormEnd(shadow_fst,shadow_snd,fst_extremum,snd_extremum,end);
//--- change the flag's value to the opposite one
flag=false;
}
else
{
//--- generate the end of the candlestick's body
FormEnd(body_fst,body_snd,snd_value,fst_value,end);
//--- generate the end of the candlestick's shadow
FormEnd(shadow_fst,shadow_snd,snd_extremum,fst_extremum,end);
//--- change the flag's value to the opposite one
flag=true;
}
}
//+-------------------------------------------------------------------------------------+
//| Clear the end of the candlestick (the area between the last and the penultimate |
//| bar) |
//+-------------------------------------------------------------------------------------+
void ClearEndOfBodyMain(const int ind)
{
ClearCandle(ExtBearBodyFirst,ExtBearBodySecond,ExtBearShadowFirst,ExtBearShadowSecond,ind,1);
ClearCandle(ExtBullBodyFirst,ExtBullBodySecond,ExtBullShadowFirst,ExtBullShadowSecond,ind,1);
}
//+------------------------------------------------------------------+
//| Clear the candlestick |
//+------------------------------------------------------------------+
void ClearCandle(double &body_fst[],double &body_snd[],double &shadow_fst[],
double &shadow_snd[],const int start,const int count)
{
//--- check
if(count!=0)
{
//--- fill indicator buffers with empty values
ArrayFill(body_fst,start,count,INDICATOR_EMPTY_VALUE);
ArrayFill(body_snd,start,count,INDICATOR_EMPTY_VALUE);
ArrayFill(shadow_fst,start,count,INDICATOR_EMPTY_VALUE);
ArrayFill(shadow_snd,start,count,INDICATOR_EMPTY_VALUE);
}
}
//+------------------------------------------------------------------+
//| Generate the main part of the candlestick |
//+------------------------------------------------------------------+
void FormMain(double &fst[],double &snd[],const double fst_value,
const double snd_value,const int start,const int count)
{
//--- check
if(count!=0)
{
//--- fill indicator buffers with values
ArrayFill(fst,start,count,fst_value);
ArrayFill(snd,start,count,snd_value);
}
}
//+------------------------------------------------------------------+
//| Generate the end of the candlestick |
//+------------------------------------------------------------------+
void FormEnd(double &fst[],double &snd[],const double fst_value,
const double snd_value,const int last)
{
//--- fill indicator buffers with values
ArrayFill(fst,last-1,2,fst_value);
ArrayFill(snd,last-1,2,snd_value);
}
//+------------------------------------------------------------------+
//| Fill i element of the indicator buffers by empty values |
//+------------------------------------------------------------------+
void FillIndicatorBuffers(const int i)
{
//--- set an empty value in the cell of the indicator buffers
ExtBearBodyFirst[i]=INDICATOR_EMPTY_VALUE;
ExtBearBodySecond[i]=INDICATOR_EMPTY_VALUE;
ExtBearShadowFirst[i]=INDICATOR_EMPTY_VALUE;
ExtBearShadowSecond[i]=INDICATOR_EMPTY_VALUE;
ExtBearBodyEndFirst[i]=INDICATOR_EMPTY_VALUE;
ExtBearBodyEndSecond[i]=INDICATOR_EMPTY_VALUE;
ExtBearShadowEndFirst[i]=INDICATOR_EMPTY_VALUE;
ExtBearShadowEndSecond[i]=INDICATOR_EMPTY_VALUE;
ExtBullBodyFirst[i]=INDICATOR_EMPTY_VALUE;
ExtBullBodySecond[i]=INDICATOR_EMPTY_VALUE;
ExtBullShadowFirst[i]=INDICATOR_EMPTY_VALUE;
ExtBullShadowSecond[i]=INDICATOR_EMPTY_VALUE;
ExtBullBodyEndFirst[i]=INDICATOR_EMPTY_VALUE;
ExtBullBodyEndSecond[i]=INDICATOR_EMPTY_VALUE;
ExtBullShadowEndFirst[i]=INDICATOR_EMPTY_VALUE;
ExtBullShadowEndSecond[i]=INDICATOR_EMPTY_VALUE;
}
ArrayPrint
Prints an array of a simple type or a simple structure into journal.
void ArrayPrint(
const void& array[], // printed array
uint digits=_Digits, // number of decimal places
const string separator=NULL, // separator of the structure field values
ulong start=0, // first printed element index
ulong count=WHOLE_ARRAY, // number of printed elements
ulong flags=ARRAYPRINT_HEADER|ARRAYPRINT_INDEX|ARRAYPRINT_LIMIT|ARRAYPRINT_ALIGN
);
Parameters
array[]
[in] Array of a simple type or a simple structure.
digits=_Digits
[in] The number of decimal places for real types. The default value is _Digits.
separator=NULL
[in] S eparator of the structure element field values. The default value NULL means an empty line.
A space is used as a separator in that case.
start=0
[in] The index of the first printed array element. It is printed from the zero index by default.
count=WHOLE_ARRAY
[in] Number of the array elements to be printed. The entire array is displayed by default
(count=WHOLE_ARRAY).
flags=ARRAYPRINT_HEADER|ARRAYPRINT_INDEX|ARRAYPRINT_LIMIT|ARRAYPRINT_ALIGN
[in] Combination of flags setting the output mode. All flags are enabled by default:
o ARRAYPRINT_HEADER – print headers for the structure array
o ARRAYPRINT_INDEX – print index at the left side
o ARRAYPRINT_LIMIT – print only the first 100 and the last 100 array elements. Use if you want to
print only a part of a large array.
o ARRAYPRINT_ALIGN – enable alignment of the printed values – numbers are aligned to the right,
while lines to the left.
o ARRAYPRINT_DATE – when printing datetime, print the date in the dd.mm.yyyy format
o ARRAYPRINT_MINUTES – when printing datetime, print the time in the HH:MM format
o ARRAYPRINT_SECONDS – when printing datetime, print the time in the HH:MM :SS format
Return Value
No
Note
ArrayPrint() does not print all structure array fields into journal – array and object pointer fields are
s kipped. These columns are simply not printed for more convenient presentation. If you need to
print all structure fields, you need to write your own mass print function with the desired
formatting.
Example:
See also
ArrayRange
The function returns the number of elements in a selected array dimension.
int ArrayRange(
const void& array[], // array for check
int rank_index // index of dimension
);
Parameters
array[]
[in] Checked array.
rank_index
[in] Index of dimension.
Return Value
S ince indexesstart at zero, the number of the array dimensions is one greater than the index of the
last dimension.
Example:
void OnStart()
{
//--- create four-dimensional array
double array[][5][2][4];
//--- set the size of the zero dimension
ArrayResize(array,10,10);
//--- print dimensions
int temp;
for(int i=0;i<4;i++)
{
//--- receive the size of i dimension
temp=ArrayRange(array,i);
//--- print
PrintFormat("dim = %d, range = %d",i,temp);
}
//--- Result
// dim = 0, range = 10
// dim = 1, range = 5
// dim = 2, range = 2
// dim = 3, range = 4
}
ArrayResize
The function sets a new size for the first dimension
int ArrayResize(
void& array[], // array passed by reference
int new_size, // new array size
int reserve_size=0 // reserve size value (excess)
);
Parameters
array[]
[out] Array for changing sizes.
new_size
[in] New size for the first dimension.
reserve_size=0
[in] Distributed size to get reserve.
Return Value
If executed successfully, it returns count of all elements contained in the array after resizing,
otherwise, returns -1, and array is not resized.
If ArrayResize() is applied to a static array, a timeseries or an indicator buffer, the array size
remains the same – these arrays will not be reallocated. In this case, if new_size<=ArrayS ize(array),
the function will only return new_size; otherwise a value of -1 will be returned.
Note
The function can be applied only to dynamic arrays. It should be noted that you cannot change the
size of dynamic arrays assigned as indicator buffers by the S etIndexBuffer() function. For indicator
buffers, all operations of resizing are performed by the runtime subsystem of the terminal.
Total amount of elements in the array cannot exceed 2147483647.
W ith the frequent memory allocation, it is recommended to use a third parameter that sets a
reserve to reduce the number of physical memory allocations. All the subsequent calls of ArrayResize
do not lead to physical reallocation of memory, but only change the size of the first array dimension
within the reserved memory. It should be remembered that the third parameter will be used only
during physical memory allocation. For example:
ArrayResize(arr,1000,1000);
for(int i=1;i<3000;i++)
ArrayResize(arr,i,1000);
In this case the memory will be reallocated twice, first before entering the 3000 iterations loop (the
array size will be set to 1000), and the second time with i equal to 2000. If we s kip the third
parameter, there will be 2000 physical reallocations of memory, which will slow down the program.
Example:
//+------------------------------------------------------------------+
/*
Test_ArrayResize (EURUSD,H1) --- Test Fast: ArrayResize(arr,100000,100000)
Test_ArrayResize (EURUSD,H1) 1. ArraySize(arr)=100000 Time=0 ms
Test_ArrayResize (EURUSD,H1) 2. ArraySize(arr)=200000 Time=0 ms
Test_ArrayResize (EURUSD,H1) 3. ArraySize(arr)=300000 Time=0 ms
Test_ArrayResize (EURUSD,H1) ---- Test Slow: ArrayResize(slow,100000)
Test_ArrayResize (EURUSD,H1) 1. ArraySize(slow)=100000 Time=0 ms
Test_ArrayResize (EURUSD,H1) 2. ArraySize(slow)=200000 Time=0 ms
Test_ArrayResize (EURUSD,H1) 3. ArraySize(slow)=300000 Time=228511 ms
*/
See also
ArrayInitialize
ArrayInsert
Inserts the specified number of elements from a source array to a receiving one starting from a
specified index.
bool ArrayInsert(
void& dst_array[], // receiving array
const void& src_array[], // source array
uint dst_start, // receiver array index to be inserted
uint src_start=0, // source array index to be copied
uint count=WHOLE_ARRAY // number of elements to insert
);
Parameters
dst_array[]
[in][out] R eceiving array the elements should be added to.
src_array[]
[in] S ource array the elements are to be added from.
dst_start
[in] Index in the receiving array for inserting elements from the source array.
src_start=0
[in] Index in the source array, starting from which the elements of the source array are taken for
insertion.
count
[in] Number of elements to be added from the source array. The WH OL E_ARRAY means all
elements from the specified index up to the end of the array.
Return Value
R eturns true if successful, otherwise - false. To get information about the error, call the
GetLastError() function. Possible errors :
· 5052 – ERR_S M ALL _ARRAY (the start and/or count parameters are set incorrectly or the
src_array[] source array is empty),
· 5056 – ERR_SERIES_ARRAY (the array cannot be changed, indicator buffer),
· 4006 – ERR_INVALID_ARRAY (copying to oneself is not allowed, or the arrays are of different
types, or there is a fixed-size array containing class objects or destructor structures),
· 4005 - ERR_S T RUCT _W IT H OBJECT S_OR CL ASS (the array contains no POD structures meaning a
simple copying is impossible),
· Errors occurred when changing the dst_array[] receiving array size are provided in the
ArrayR emove() function description.
Note
If the function is used for a fixed-size array, the size of the dst_array[] receiving array itself does
not change. S tarting from the dst_start position, the elements of the receiving array are shifted to
the right (the last counts of the elements " come off" ), while the elements copied from the source
array take their place.
You cannot insert the elements to the dynamic arrays designated as the indicator buffers by the
S etIndex Buffer() function. For indicator buffers, all size changing operations are performed by the
terminal's executing subsystem.
In the source array, the elements are copied starting from the src_start index. The source array size
remains unchanged. The elements to be added to the receiving array are not links to the source
array elements. This means that subsequent changes of the elements in any of the two arrays are
not reflected in the second one.
Example:
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- declare the fixed-size array and fill in the values
int array_dest[10];
for(int i=0;i<10;i++)
{
array_dest[i]=i;
}
//--- source array
int array_source[10];
for(int i=0;i<10;i++)
{
array_source[i]=10+i;
}
//--- display arrays before inserting the elements
Print("Before calling ArrayInsert()");
ArrayPrint(array_dest);
ArrayPrint(array_source);
//--- insert 3 elements from the source array and show the new set of the receiving array
ArrayInsert(array_dest,array_source,4,0,3);
Print("After calling ArrayInsert()");
ArrayPrint(array_dest);
/*
Execution result
Before calling ArrayInsert()
0 1 2 3 4 5 6 7 8 9
After calling ArrayInsert()
0 1 2 3 10 11 12 7 8 9
*/
See also
ArrayR emove, ArrayCopy, ArrayR esize, ArrayFree
ArrayRemove
R emoves the specified number of elements from the array starting with a specified index.
bool ArrayRemove(
void& array[], // array of any type
uint start, // index the removal starts from
uint count=WHOLE_ARRAY // number of elements
);
Parameters
array[]
[in][out] Array.
start
[in] Index, starting from which the array elements are removed.
count=WHOLE_ARRAY
[in] Number of removed elements. The WHOLE_ARRAY value means removing all elements from
the specified index up the end of the array.
Return Value
R eturns true if successful, otherwise - false. To get information about the error, call the
GetLastError() function. Possible errors :
· 5052 – ERR_S M ALL_ARRAY (too big start value),
· 5056 – ERR_SERIES_ARRAY (the array cannot be changed, indicator buffer),
· 4003 – ERR_INVALID_PARAM ET ER (too big count value),
· 4005 - ERR_S T RUCT _W IT H OBJECT S_OR CL ASS (fixed-size array containing complex objects with
the destructor),
· 4006 - ERR_INVALID_ARRAY (fixed-size array containing structure or class objects with a
destructor).
Note
If the function is used for a fixed-size array, the array size does not change: the remaining " tail" is
physically copied to the start position. For accurate understanding of how the function works, see
the example below. " Physical" copying means the copied objects are not created by calling the
constructor or copying operator. Instead, the binary representation of an object is copied. For this
reason, you cannot apply the ArrayRemove() function to the fixed-size array containing objects with
the destructor (the ERR_INVALID_ARRAY or ERR_S TRUCT_W ITHOBJECTS_ORCLASS error is
activated). W hen removing such an object, the destructor should be called twice – for the original
object and its copy.
You cannot remove elements from dynamic arrays designated as the indicator buffers by the
S etIndex Buffer() function. This will result in the ERR_SER IES_ARRAY error. For indicator buffers, all
size changing operations are performed by the terminal's executing subsystem.
Example:
//+------------------------------------------------------------------+
See also
ArrayInsert, ArrayCopy, ArrayR esize, ArrayFree
ArrayReverse
R everses the specified number of elements in the array starting with a specified index.
bool ArrayReverse(
void& array[], // array of any type
uint start=0, // index to start reversing the array from
uint count=WHOLE_ARRAY // number of elements
);
Parameters
array[]
[in][out] Array.
start=0
[in] Index the array reversal starts from.
count=WHOLE_ARRAY
[in] Number of reversed elements. If WHOLE_ARRAY, then all array elements are moved in the
inversed manner starting with the specified start index up to the end of the array.
Return Value
The ArrayS etAs S eries() function does not move the array elements physically. Instead, it only
changes the indexation direction backwards to arrange the access to the elements as in the
timeseries. The ArrayReverse() function physically moves the array elements so that the array is
" reversed" .
Example:
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- declare the fixed-size array and fill in the values
int array[10];
for(int i=0;i<10;i++)
{
array[i]=i;
}
//--- display the array before reversing the elements
Print("Before calling ArrayReverse()");
ArrayPrint(array);
//--- reverse 3 elements in the array and show the new set
ArrayReverse(array,4,3);
Print("After calling ArrayReverse()");
ArrayPrint(array);
/*
Execution result:
Before calling ArrayReverse()
0 1 2 3 4 5 6 7 8 9
After calling ArrayReverse()
0 1 2 3 6 5 4 7 8 9
*/
See also
ArrayInsert, ArrayR emove, ArrayCopy, ArrayR esize, ArrayFree, ArrayGetAs S eries, ArrayS etAs S eries
ArraySetAsSeries
The function sets the AS_SERIES flag to a selected object of a dynamic array, and elements will be
indexed like in timeseries.
bool ArraySetAsSeries(
const void& array[], // array by reference
bool flag // true denotes reverse order of indexing
);
Parameters
array[]
[in][out] Numeric array to set.
flag
[in] Array indexing direction.
Return Value
The AS_SERIES flag can't be set for multi-dimensional arrays or static arrays (arrays, whose size in
s quare brackets is preset already on the compilation stage). Indexing in timeseries differs from a
common array in that the elements of timeseries are indexed from the end towards the beginning
(from the newest to oldest data).
Example: Indicator that shows bar number
#property indicator_chart_window
#property indicator_buffers 1
#property indicator_plots 1
//---- plot Numeration
See also
Access to timeseries, ArrayGetAs S eries
ArraySize
The function returns the number of elements of a selected array.
int ArraySize(
const void& array[] // checked array
);
Parameters
array[]
[in] Array of any type.
Return Value
For a one-dimensional array, the value to be returned by the ArrayS ize is equal to that of
ArrayR ange(array,0).
Example:
void OnStart()
{
//--- create arrays
double one_dim[];
double four_dim[][10][5][2];
//--- sizes
int one_dim_size=25;
int reserve=20;
int four_dim_size=5;
//--- auxiliary variable
int size;
//--- allocate memory without backup
ArrayResize(one_dim,one_dim_size);
ArrayResize(four_dim,four_dim_size);
//--- 1. one-dimensional array
Print("+==========================================================+");
Print("Array sizes:");
Print("1. One-dimensional array");
size=ArraySize(one_dim);
PrintFormat("Zero dimension size = %d, Array size = %d",one_dim_size,size);
//--- 2. multidimensional array
Print("2. Multidimensional array");
size=ArraySize(four_dim);
PrintFormat("Zero dimension size = %d, Array size = %d",four_dim_size,size);
//--- dimension sizes
int d_1=ArrayRange(four_dim,1);
int d_2=ArrayRange(four_dim,2);
int d_3=ArrayRange(four_dim,3);
Print("Check:");
Print("Zero dimension = Array size / (First dimension * Second dimension * Third dimension)");
PrintFormat("%d = %d / (%d * %d * %d)",size/(d_1*d_2*d_3),size,d_1,d_2,d_3);
//--- 3. one-dimensional array with memory backup
Print("3. One-dimensional array with memory backup");
//--- double the value
one_dim_size*=2;
//--- allocate memory with backup
ArrayResize(one_dim,one_dim_size,reserve);
//--- print out the size
size=ArraySize(one_dim);
PrintFormat("Size with backup = %d, Actual array size = %d",one_dim_size+reserve,size);
}
ArraySort
S orts the values in the first dimension of a multidimensional numeric array in the ascending order.
bool ArraySort(
void& array[] // array for sorting
);
Parameters
array[]
[in][out] Numeric array for sorting.
Return Value
An array is always sorted in the ascending order irrespective of the AS_SER IES flag value.
Functions ArrayS ort and ArrayBS earch accept any-dimensional arrays as a parameter. However,
searching and sorting are always applied to the first (zero) dimension.
Example:
#property description "The indicator analyzes data for the last month and draws all candlesticks wi
#property description "and large tick volumes. The tick volume array is sorted out"
#property description "to define such candlesticks. The candlesticks having the volumes comprising
#property description "per cent of the array are considered small. The candlesticks having the tick
#property description "the last InpBigVolume per cent of the array are considered large."
//--- indicator settings
#property indicator_chart_window
#property indicator_buffers 5
#property indicator_plots 1
//--- plot
#property indicator_label1 "VolumeFactor"
#property indicator_type1 DRAW_COLOR_CANDLES
#property indicator_color1 clrDodgerBlue,clrOrange
#property indicator_style1 STYLE_SOLID
#property indicator_width1 2
//--- predefined constant
#define INDICATOR_EMPTY_VALUE 0.0
//--- input parameters
input int InpSmallVolume=15; // Percentage value of small volumes (<50)
input int InpBigVolume=20; // Percentage value of large volumes (<50)
//--- analysis start time (will be shifted)
datetime ExtStartTime;
//--- indicator buffers
double ExtOpenBuff[];
double ExtHighBuff[];
double ExtLowBuff[];
double ExtCloseBuff[];
double ExtColorBuff[];
//--- volume boundary values for displaying the candlesticks
long ExtLeftBorder=0;
long ExtRightBorder=0;
//+------------------------------------------------------------------+
//| Receive border values for tick volumes |
//+------------------------------------------------------------------+
bool GetVolumeBorders(void)
{
//--- variables
datetime stop_time; // copy end time
long buff[]; // buffer for copying
//--- end time is the current one
stop_time=TimeCurrent();
//--- start time is one month earlier from the current one
ExtStartTime=GetStartTime(stop_time);
//--- receive the values of tick volumes
ResetLastError();
if(CopyTickVolume(Symbol(),Period(),ExtStartTime,stop_time,buff)==-1)
{
//--- failed to receive the data, return false to launch recalculation command
PrintFormat("Failed to receive tick volume values. Error code = %d",GetLastError());
return(false);
}
//--- calculate array size
int size=ArraySize(buff);
//--- sort out the array
ArraySort(buff);
//--- define the values of the left and right border for tick volumes
ExtLeftBorder=buff[size*InpSmallVolume/100];
ExtRightBorder=buff[(size-1)*(100-InpBigVolume)/100];
//--- successful execution
return(true);
}
//+------------------------------------------------------------------+
//| Receive the data that is one month less than the passed one |
//+------------------------------------------------------------------+
datetime GetStartTime(const datetime stop_time)
{
//--- convert end time into MqlDateTime type structure variable
MqlDateTime temp;
TimeToStruct(stop_time,temp);
//--- receive the data that is one month less
if(temp.mon>1)
temp.mon-=1; // the current month is not the first one in the year, therefore, the number of
else
{
temp.mon=12; // the current month is the first in the year, therefore, the number of the pre
//--- receive new values of the right and left borders for volumes
if(!GetVolumeBorders())
return(0);
}
//--- start variable for bar calculation
int start=prev_calculated;
//--- work at the last bar if the indicator values have already been calculated at the previous tic
if(start>0)
start--;
//--- set direct indexing in time series
ArraySetAsSeries(time,false);
ArraySetAsSeries(open,false);
ArraySetAsSeries(high,false);
ArraySetAsSeries(low,false);
ArraySetAsSeries(close,false);
ArraySetAsSeries(tick_volume,false);
//--- the loop of calculation of the indicator values
for(int i=start;i<rates_total;i++)
{
//--- fill out candlesticks starting from the initial date
if(ExtStartTime<=time[i])
{
//--- if the value is not less than the right border, fill out the candlestick
if(tick_volume[i]>=ExtRightBorder)
{
//--- receive data for drawing the candlestick
ExtOpenBuff[i]=open[i];
ExtHighBuff[i]=high[i];
ExtLowBuff[i]=low[i];
ExtCloseBuff[i]=close[i];
//--- DodgerBlue color
ExtColorBuff[i]=0;
//--- continue the loop
continue;
}
//--- fill out the candlestick if the value does not exceed the left border
if(tick_volume[i]<=ExtLeftBorder)
{
//--- receive data for drawing the candlestick
ExtOpenBuff[i]=open[i];
ExtHighBuff[i]=high[i];
ExtLowBuff[i]=low[i];
ExtCloseBuff[i]=close[i];
//--- Orange color
ExtColorBuff[i]=1;
//--- continue the loop
continue;
}
}
//--- set empty values for bars that have not been included in the calculation
ExtOpenBuff[i]=INDICATOR_EMPTY_VALUE;
ExtHighBuff[i]=INDICATOR_EMPTY_VALUE;
ExtLowBuff[i]=INDICATOR_EMPTY_VALUE;
ExtCloseBuff[i]=INDICATOR_EMPTY_VALUE;
}
//--- return value of prev_calculated for next call
return(rates_total);
}
See also
ArrayBsearch
ArraySwap
S waps the contents of two dynamic arrays of the same type. For multidimensional arrays, the number
of elements in all dimensions except the first one should match.
bool ArraySwap(
void& array1[], // first array
void& array2[] // second array
);
Parameters
array1[]
[in][out] Array of numerical type.
array2[]
[in][out] Array of numerical type.
Return Value
R eturns true if successful, otherwise false. In this case, GetLastError() returns the
ERR_INVALID_ARRAY error code.
Note
The function accepts dynamic arrays of the same type and the same dimensions except the first
one. For integer types, the sign is ignored, i.e. char==uchar)
Example:
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- arrays for storing quotes
double source_array[][8];
double dest_array[][8];
MqlRates rates[];
//--- get the data of the last 20 candles on the current timeframe
int copied=CopyRates(NULL,0,0,20,rates);
if(copied<=0)
{
PrintFormat("CopyRates(%s,0,0,20,rates) failed, error=%d",
Symbol(),GetLastError());
return;
}
//--- set the array size for the amount of copied data
ArrayResize(source_array,copied);
//--- fill the rate_array_1[] array by data from rates[]
for(int i=0;i<copied;i++)
{
source_array[i][0]=(double)rates[i].time;
source_array[i][1]=rates[i].open;
source_array[i][2]=rates[i].high;
source_array[i][3]=rates[i].low;
source_array[i][4]=rates[i].close;
source_array[i][5]=(double)rates[i].tick_volume;
source_array[i][6]=(double)rates[i].spread;
source_array[i][7]=(double)rates[i].real_volume;
}
//--- swap data between source_array[] and dest_array[]
if(!ArraySwap(source_array,dest_array))
{
PrintFormat("ArraySwap(source_array,rate_array_2) failed, error code=%d",GetLastError());
return;
}
//--- ensure that the source array has become zero after the swap
PrintFormat("ArraySwap() done: ArraySize(source_array)=%d",ArraySize(source_array));
//--- display the data of the dest_array[] destination array
ArrayPrint(dest_array);
}
See also
ArrayCopy, ArrayFill, ArrayR ange, ArrayIs Dynamic
C++
extern "C" __declspec(dllexport) bool sgemm(UINT flags, float *C, const float *A, const float *B, U
In addition to buffers, you should pass matrix and vector sizes for correct processing.
All matrix and vector methods are listed below in alphabetical order.
Function Action
Eye R eturn a matrix with ones on the diagonal and zeros elsewhere
Identity Create an identity matrix of the specified size
Ones Create and return a new matrix filled with ones
Zeros Create and return a new matrix filled with zeros
Full Create and return a new matrix filled with given value
Tri Construct a matrix with ones at and below the given diagonal and
zeros elsewhere
ENUM_AVERAGE_MODE
ID Description
ENUM_VECTOR_NORM
ID Description
ENUM_MATRIX _NORM
Enumeration of matrix norms for matrix::Norm and for obtaining the matrix::Cond matrix condition
number.
ID Description
ID Description
ENUM_VECTOR_CONVOLVE
ID Description
ENUM_REGRESSION_METRIC
ID Description
ENUM_CLASSIFICATION_METRIC
ID Description
CLASS IFICATION_PRECIS ION Model accuracy in predicting true positives for the
target class
CLASS IFICATION_RECALL Model completeness
CLASS IFICATION_ROC_AUC Area under the error curve
CLASS IFICATION_TOP_K_ACCURACY Frequency of the correct label appearing at the top of
k predicted labels
ENUM_LOSS_FUNCTION
ID Description
ID Description
ENUM_ACTIVATION_FUNCTION
Enumeration for the activation function vector::Activation and for the activation function derivative
vector::Derivative.
ID Description
AF_EXP Exponential
AF_LINEAR Linear
AF_L REL U Leaky Rectified Linear Unit
AF_REL U REctified Linear Unit
ENUM_SORT_MODE
ID Description
ID Description
ENUM_MATRIX _AX IS
Enumeration for specifying the axis in all statistical functions for matrices.
ID Description
Initialization
There are several ways to declare and initialize matrices and vectors.
Function Action
Declaration without specifying the size (no memory allocation for the data):
matrix matrix_a; // double type matrix
matrix<double> matrix_a1; // another way to declare a double matrix; can be used in templates
matrixf matrix_a2; // float matrix
matrix<float> matrix_a3; // float matrix
vector vector_a; // double vector
vector<double> vector_a1;
vectorf vector_a2; // float vector
vector<float> vector_a3;
Declaration with the specified size (with memory allocation for the data, but without any
initialization):
matrix matrix_a(128,128); // the parameters can be either constants
matrix<double> matrix_a1(InpRows,InpCols); // or variables
matrixf matrix_a2(1,128); // analog of a horizontal vector
matrix<float> matrix_a3(InpRows,1); // analog of a vertical vector
vector vector_a(256);
vector<double> vector_a1(InpSize);
vectorf vector_a2(SomeFunc()); // function SomeFunc returns a number of type ulong,
vector<float> vector_a3(InpSize+16); // expression can be used as a parameter
Declaration with initialization (matrix and vector sizes are determined by the initializing
sequence):
matrix matrix_a={{0.1,0.2,0.3},{0.4,0.5,0.6}};
matrix<double> matrix_a1=matrix_a; // must be matrices of the same type
matrixf matrix_a2={{1,0,0},{0,1,0},{0,0,1}};
matrix<float> matrix_a3={{1,2},{3,4}};
vector vector_a={-5,-4,-3,-2,-1,0,1,2,3,4,5};
vector<double> vector_a1={1,5,2.4,3.3};
vectorf vector_a2={0,1,2,3};
vector<float> vector_a3=vector_a2; // must be vectors of the same type
Please note that the matrix or vector dimensions can be changed, since the memory for data is always
dynamic.
Static methods
S tatic methods for creating matrices and vectors of the specified size, initialized in a certain way:
matrix matrix_a =matrix::Eye(4,5,1);
matrix<double> matrix_a1=matrix::Full(3,4,M_PI);
matrixf matrix_a2=matrixf::Identity(5,5);
matrixf<float> matrix_a3=matrixf::Ones(5,5);
matrix matrix_a4=matrix::Tri(4,5,-1);
vector vector_a =vector::Ones(256);
vectorf vector_a1=vector<float>::Zeros(16);
vector<float> vector_a2=vectorf::Full(128,float_value);
matrix_a.Fill(double_value);
vector_a1.Fill(FLT_MIN);
matrix_a1.Identity();
Assign
Copies a matrix, vector or array with auto cast.
bool matrix::Assign(
const matrix<T> &mat // copied matrix
);
bool matrix::Assign(
const void &array[] // copied array
);
bool vector::Assign(
const vector<T> &vec // copied vector
);
bool vector::Assign(
const void &array[] // copied array
);
Parameters
m, v or array
[in] The matrix, vector or array the values are copied from.
Return Value
Unlik e Copy,the Assign method allows copying arrays as well. In this case, the auto cast takes place,
while the resulting matrix or vector adjusts to the size of the copied array.
Example:
int_arr:
[,0][,1][,2][,3][,4]
[0,] 1 2 0 0 0
[1,] 3 4 0 0 0
[2,] 5 6 0 0 0
[3,] 0 0 0 0 0
[4,] 0 0 0 0 0
*/
See also
Copy
CopyIndicatorBuffer
Get the data of the specified indicator buffer in the specified quantity to a vector.
The data will be copied into the vector locating the oldest element at the beginning of the physical
memory allocated for the vector. There are three function options.
Access by the initial position and the number of required elements
bool vector::CopyIndicatorBuffer(
long indicator_handle, // indicator handle
ulong buffer_index, // indicator buffer number
ulong start_pos, // starting position to copy
ulong count // number of elements to copy
);
Access by the initial and final dates of the required time interval
bool vector::CopyIndicatorBuffer(
long indicator_handle, // indicator handle
ulong buffer_index, // indicator buffer number
datetime start_time, // from which date to copy
datetime stop_time // up to which date to copy
);
Parameters
indicator_handle
[in] The indicator handle obtained by the relevant indicator function.
buffer_index
[in] The number of the indicator buffer.
start_pos
[in] The number of the first copied element index.
count
[in] The number of copied elements.
start_time
[in] Bar time corresponding to the first element.
stop_time
[in] Bar time corresponding to the last element.
Return Value
The elements of the copied data (the indicator buffer with index buffer_index) are counted down
from the present to the past, and thus the starting position equal to 0 means the current bar (the
indicator value for the current bar).
W hen copying an unknown amount of data, you should declare a vector without specifying a size
(without allocating memory for the data), since the CopyBuffer() function tries to distribute the size
of the receiving vector to the size of the copied data.
W hen partialcopying of the indicator values is needed, you should use an intermediate vector into
which the required quantity is copied. From this intermediate vector, you can copy the required
number of values member by member, to the required places of the receiving vector.
If you are copying a predetermined amount of data, it is recommended to pre-declare a vector and
specify its size to avoid unnecessary memory reallocation.
W hen requesting data from an indicator, the function immediately returns false if requested
timeseries have not yet been constructed or they need to be downloaded from the server, while it
initiates loading/constructing.
W hen requesting data from an EA or a script, download from the server is initiated if the terminal
does not have the appropriate data locally, or construction of the necessary timeseries starts if the
data can be constructed from the local history but the required timeframes are not ready yet. The
function returns the amount that will be ready by the time the timeout expires.
See also
CopyBuffer
CopyRates
Gets the historical series of the M qlRates structure of the specified symbol-period in the specified
amount into a matrix or vector. Elements are counted down from the present to the past, which means
that the starting position equal to 0 means the current bar.
The data is copied so that the oldest element is placed at the beginning of the matrix/vector. There
are three function options.
Access by the initial position and the number of required elements
bool CopyRates(
string symbol, // symbol name
ENUM_TIMEFRAMES period, // period
ulong rates_mask, // combination of flags to specify the requested series
ulong start, // index of the initial bar copying starts from
ulong count // how many to copy
);
Access by the initial and final dates of the required time interval
bool CopyRates(
string symbol, // symbol name
ENUM_TIMEFRAMES period, // period
ulong rates_mask, // combination of flags to specify the requested series
datetime from, // start date
datetime to // end date
);
Parameters
symbol
[in] S ymbol.
period
[in] Period.
rates_mask
[in] The ENUM _COPY_RATES enumeration combination of flags specifying the type of requested
series. W hen copying to a vector, only one value from the ENUM _COPY_RATES enumeration can
be specified, otherwise an error occurs.
start
count
[in] Number of copied elements.
from
[in] Bar time corresponding to the first element.
to
[in] Bar time corresponding to the last element.
Return Value
If the interval of the requested data is completely outside the available data on the server, then the
function returns false. If the data outside TERMINAL_M AXBARS (maximum number of bars on the
chart) is requested, the function also returns false.
W hen requesting data from an EA or a script, download from the server is initiated if the terminal
does not have the appropriate data locally, or construction of the necessary timeseries starts if the
data can be constructed from the local history but they are not ready yet. The function returns the
amount that will be ready by the time the timeout expires, however the history download continues,
and the function returns more data during the next similar request.
W hen requesting data by the start date and the number of required items, only data whose date is
less than (before) or equal to the specified one is returned. The interval is set and considered up to
a second. In other words, the opening date of any bar the value is returned for (volume, spread,
Open, High, Low, Close or Time) is always equal to or less than the specified one.
W hen requesting data in a given date range, only data that falls within the requested interval is
returned. The interval is set and considered up to a second. In other words, the opening time of any
bar the value is returned for (volume, spread, indicator buffer value, Open, High, Low, Close or
Time) is always located in the requested interval.
For example, if the current day of the week is S aturday, the function returns 0 when attempting to
copy data on the weekly timeframe by setting start_time=Last_Tuesday and stop_time=Last_Friday
because the open time on the weekly timeframe always falls on S unday, but not a single weekly bar
falls within the specified range.
If you need to get the value corresponding to the current incomplete bar, then you can use the first
call form indicating start_pos =0 and count=1.
ENUM_COPY _RATES
The ENUM _COPY_RATES enumeration contains the flags to specify the type of data to be passed to the
matrix or array. The flag combination allows getting several series from the history in one request.
The order of the rows in the matrix will correspond to the order of the values in the
ENUM _COPY_RAT ES enumeration. In other words, the row with H igh data will always be higher in the
matrix than the row with Low data.
ID Value Description
Combination
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- get quotes to the matrix
matrix matrix_rates;
if(matrix_rates.CopyRates(Symbol(), PERIOD_CURRENT, COPY_RATES_OHLCT, 1, 10))
See also
Access to Timeseries and Indicators, CopyRates
CopyTicks
Get tick s from an M qlTick structure into a matrix or a vector. Elements are counted from the past to
the present, which means that the tick with index 0 is the oldest one. To analyze a tick, check the
flags field which shows what exactly has changed in the tick .
bool matrix::CopyTicks(
string symbol, // symbol name
ulong ticks_mask, // mask indicating the type of ticks to be received
uint flags=COPY_TICKS_ALL, // flag indicating the type of ticks to be received
ulong from_msc=0, // time from which ticks are requested
ulong count=0 // number of ticks to be received
);
Vector Method
bool vector::CopyTicks(
string symbol, // symbol name
ulong ticks_mask, // mask indicating the type of ticks to be received
uint flags=COPY_TICKS_ALL, // flag indicating the type of ticks to be received
ulong from_msc=0, // time from which ticks are requested
ulong count=0 // number of ticks to be received
);
Parameters
symbol
[in] S ymbol.
ticks_mask
[in] A combination of flags from the ENUM _COPY_TICKS enumeration indicating the contents of
the requested data. W hen copying to a vector, you can specify only one value from the
ENUM _COPY_TICKS enumeration, otherwise an error will occur.
flags
[in] A flag defining the type of the requested tick s. COPY_TICKS_INFO means tick s cased by Bid
and/or As k changes, COPY_TICKS_TRADE — ticks with Last and Volume changes, COPY_TICKS_ALL
— all tick s. For any type of request, the values of the previous tick are added to the remaining
fields of the M qlTick structure.
from_msc
[in] Time starting from which tick s are requested. Time is specified in milliseconds since
01/01/1970. If from_msc=0, the last number of tick s equal to 'count' are returned.
count
[in] The number of requested ticks. If parameters 'from_msc' and 'count' are not specified, all
available ticks, but no more than 2000, will be written.
Return Value
The first call of CopyTicks() initiates synchronization of the relevant symbol's tick database stored
on the hard drive. If the local database does not provide all the requested ticks, then missing ticks
will be automatically downloaded from the trade server. Ticks from from_msc specified in
CopyTicks() to the current moment will be synchronized. After that, all ticks arriving for this symbol
will be added to the tick database thus keeping it in the synchronized state.
If from_msc and count parameters are not specified, all available ticks, but no more than 2000, will
be written to the matrix/vector.
In indicators, the CopyTicks() method returns the result immediately: W hen called from an
indicator, CopyTick() immediately returns all available ticks of a symbol and launches
synchronization of the tick database if available data is not enough. All indicators on the same
symbol operate in one common thread, so the indicator cannot wait for the completion of
synchronization. After synchronization, CopyTicks() will return all requested ticks during the next
call. In indicators, the OnCalculate() function is called after the arrival of each tick.
In Expert Advisors and scripts, CopyTicks() can wait for the result for 45 seconds: as distinct
from indicators, every Expert Advisor or script operates in a separate thread, and therefore can
wait up to 45 seconds for the synchronization to complete. If the required amount of ticks fails to be
synchronized during this time, CopyTicks() will return available ticks by timeout and will continue
synchronization. OnTick() in Expert Advisors is not a handler of every tick, while it only notifies the
Expert Advisor about changes in the mark et. This can be a batch of changes : the terminal can
simultaneously receive multiple ticks, while OnTick() will be called only once, to notify the Expert
Advisor about the latest mark et state.
Rate of data return: the terminal stores 4096 last tick s for each instrument in the fast access cache
(65536 ticks for symbols with the Market Depth running). Requests concerning this data are
executed the fastest. If requested ticks for the current trading session are beyond the cache,
CopyTicks() calls the ticks stored in the terminal memory. These requests require more time to
complete. The slowest requests are those requesting ticks for other days, since the data is read
from the drive in this case.
ENUM_COPY _TICKS
The ENUM _COPY_TICKS enumeration contains the flags to specify the type of data to be passed to the
matrix or array. The flag combination allows getting several series from the history in one request.
The order of the rows in the matrix will correspond to the order of the values in the
ENUM _COPY_TICKS enumeration. In other words, the row with H igh data will always be higher in the
matrix than the row with Low data.
ID Value Description
COPY_TICKS_ASK 4 As k price
COPY_TICKS_LAS T 8 Last price (last deal price)
COPY_TICKS_VOLUM E 16 Last price Volume
ID Value Description
COPY_TICKS_VERTICAL 32768 Ticks are copied into the matrix along the
vertical axis. The received ticks will be
arranged vertically in the matrix, i.e., the
oldest ticks will be in the first row, while the
most recent ticks will be in the last matrix
row.
See also
Access to Timeseries and Indicators, CopyTicks
CopyTicksRange
Get tick s from an M qlTick structure into a matrix or a vector within the specified date range.
Elements are counted from the past to the present, which means that the tick with index 0 is the
oldest one. To analyze a tick, check the flags field which shows what exactly has changed in the tick.
bool matrix::CopyTicksRange(
string symbol, // symbol name
ulong ticks_mask, // mask indicating the type of ticks to be received
uint flags=COPY_TICKS_ALL, // flag indicating the type of ticks to be received
ulong from_msc=0, // time from which ticks are requested
ulong to_msc=0 // time up to which ticks are requested
);
Vector Method
bool vector::CopyTicksRange(
string symbol, // symbol name
ulong ticks_mask, // mask indicating the type of ticks to be received
uint flags=COPY_TICKS_ALL, // flag indicating the type of ticks to be received
ulong from_msc=0, // time from which ticks are requested
ulong to_msc=0 // time up to which ticks are requested
);
Parameters
symbol
[in] S ymbol.
ticks_mask
[in] A combination of flags from the ENUM _COPY_TICKS enumeration indicating the contents of
the requested data. W hen copying to a vector, you can specify only one value from the
ENUM _COPY_TICKS enumeration, otherwise an error will occur.
flags
[in] A flag defining the type of the requested tick s. COPY_TICKS_INFO means tick s cased by Bid
and/or As k changes, COPY_TICKS_TRADE — ticks with Last and Volume changes, COPY_TICKS_ALL
— all tick s. For any type of request, the values of the previous tick are added to the remaining
fields of the M qlTick structure.
from_msc
[in] Time starting from which tick s are requested. Time is specified in milliseconds since
01/01/1970. If the 'from_msc' parameter is not specified, tick s from the beginning of the history
are returned. Ticks with the time >= from_msc will be returned.
to_msc
[in] Time up to which tick s are requested. Time is specified in milliseconds since 01/01/1970.
Ticks with the time <= to_msc are returned. If the to_msc parameter is not specified, all ticks up
to the history end are returned.
Return Value
R eturns true on success or false if error occurs. GetLastError() can return the following errors :
· ERR_H IS TORY_TIM EOUT — timeout for tick synchronization has expired, the function has returned
all it had.
· ERR_H IS TORY_S M ALL _BUFFER — static buffer is too small. Only the amount the array can store
has been returned.
· ERR_NOT _ENOUGH_M EMORY — not enough memory to receive historical data from the specified
range into a dynamic tick array. Failed to allocate enough memory for the tick array.
Note
The CopyTicks Range() method is used to request ticks from exactly the specified range. For
example, ticks for a specific day in history. CopyTicks() allows specifying only the start date, for
example, to receive all ticks from the beginning of the month up to now.
See also
Access to Timeseries and Indicators, CopyTicks Range
Eye
A static function. Constructs a matrix having a specified size with ones on the main diagonal and
zeros elsewhere. R eturns a matrix with ones on the diagonal and zeros elsewhere.
Parameters
rows
[in] Number of rows in the output.
cols
[in] Number of columns in the output.
ndiag=0
[in] Index of the diagonal: 0 (the default) refers to the main diagonal, a positive value refers to
an upper diagonal, and a negative value to a lower diagonal.
Return Value
A matrix where all elements are equal to zero, except for the k-th diagonal, whose values are equal
to one.
MQL5 example:
eye=matrix::Eye(4, 4,1);
Print("eye = \n", eye);
/*
eye =
[[1,0,0]
[0,1,0]
[0,0,1]]
eye =
[[0,1,0,0]
[0,0,1,0]
[0,0,0,1]
[0,0,0,0]]
*/
Python example:
np.eye(3, dtype=int)
array([[1, 0, 0],
[0, 1, 0],
[0, 0, 1]])
np.eye(4, k=1)
array([[0., 1., 0., 0.],
[0., 0., 1., 0.],
[0., 0., 0., 1.],
[0., 0., 0., 0.]])
Identity
It is a static function which creates an identity matrix of the specified size (not necessarily s quare).
An identity matrix contains ones on the main diagonal and zeros elsewhere. The main diagonal
consists of the matrix elements having equal row and column indexes, such as [0,0],[1,1],[2,2] etc.
Creates a new identity matrix.
There is also the method Identity that transforms an already existing matrix into an identity one.
static matrix matrix::Identity(
const ulong rows, // number of rows
const ulong cols, // number of columns
);
void matrix::Identity();
Parameters
rows
[in] Number of rows (and columns) in n x n matrix.
Return Value
R eturn the identity matrix. The identity matrix is a s quare matrix with ones on the main diagonal.
MQL5 example:
matrix identity=matrix::Identity(3,3);
Print("identity = \n", identity);
/*
identity =
[[1,0,0]
[0,1,0]
[0,0,1]]
*/
matrix identity2(3,5);
identity2.Identity();
Print("identity2 = \n", identity2);
/*
identity2 =
[[1,0,0,0,0]
[0,1,0,0,0]
[0,0,1,0,0]]
*/
Python example:
np.identity(3)
array([[1., 0., 0.],
Ones
This is a static function that creates and returns a new matrix filled with ones.
static matrix matrix::Ones(
const ulong rows, // number of rows
const ulong cols // number of columns
);
Parameters
rows
[in] Number of rows.
cols
[in] Number of columns.
Return Value
MQL5 example:
Python example:
np.ones((4, 1))
array([[1.],
[1.]])
Zeros
This is a static function that creates and returns a new matrix filled with zeros.
static matrix matrix::Zeros(
const ulong rows, // number of rows
const ulong cols // number of columns
);
Parameters
rows
[in] Number of rows.
cols
[in] Number of columns.
Return Value
Python example:
np.zeros((2, 1))
array([[ 0.],
[ 0.]])
Full
The static function creates and returns a new matrix filled with given value.
static matrix matrix::Full(
const ulong rows, // number or rows
const ulong cols, // number of columns
const double value // value to fill
);
Parameters
rows
[in] Number of rows.
cols
[in] Number of columns.
value
[in] Value to fill all the matrix elements.
Return Value
R eturn a new matrix of given rows and columns, filled with specified value.
MQL5 example:
matrix full=matrix::Full(3,4,10);
Print("full = \n", full);
/*
full =
[[10,10,10,10]
[10,10,10,10]
[10,10,10,10]]
*/
Example
Tri
This is a static function Construct a matrix with ones at and below the given diagonal and zeros
elsewhere.
static matrix matrix::Tri(
const ulong rows, // number of rows
const ulong cols, // number of columns
const int ndiag=0 // number of diagonal
);
Parameters
rows
[in] Number of rows in the array.
cols
[in] Number of columns in the array.
ndiag=0
[in] The sub-diagonal at and below which the array is filled. k = 0 is the main diagonal, while k <0
is below it, and k > 0 is above. The default is 0.
Return Value
Array with its lower triangle filled with ones and zero elsewhere.
MQL5 example:
matrix matrix_a=matrix::Tri(3,4,1);
Print("Tri(3,4,1)\n",matrix_a);
matrix_a=matrix::Tri(4,3,-1);
Print("Tri(4,3,-1)\n",matrix_a);
/*
Tri(3,4,1)
[[1,1,0,0]
[1,1,1,0]
[1,1,1,1]]
Tri(4,3,-1)
[[0,0,0]
[1,0,0]
[1,1,0]
[1,1,1]]
*/
Example
np.tri(3, 5, 2, dtype=int)
array([[1, 1, 1, 0, 0],
[1, 1, 1, 1, 0],
[1, 1, 1, 1, 1]])
Init
Initialize a matrix or a vector.
void matrix::Init(
const ulong rows, // number of rows
const ulong cols, // number of columns
func_name init_func=NULL, // init function placed in some scope or static method of class
... parameters
);
void vector::Init(
const ulong size, // vector size
func_name init_func=NULL, // init function placed in some scope or static method of class
... parameters
);
Parameters
rows
[in] Number of rows.
cols
[in] Number of columns.
func_name
[in] Initializing function.
...
[in] Parameters of the initializing function.
Return Value
No return value.
Example
template<typename T>
void MatrixArange(matrix<T> &mat,T value=0.0,T step=1.0)
{
for(ulong i=0; i<mat.Rows(); i++)
{
for(ulong j=0; j<mat.Cols(); j++,value+=step)
mat[i][j]=value;
}
}
template<typename T>
void VectorArange(vector<T> &vec,T value=0.0,T step=1.0)
{
Fill
Fill an existing matrix or vector with the specified value.
void matrix::Fill(
const double value // value to fill
);
void vector::Fill(
const double value // value to fill
);
Parameters
value
[in] Value to fill all the matrix elements.
Return Value
No return value. The matrix is filled in place with the specified value.
Example
matrix matrix_a(2,2);
matrix_a.Fill(10);
Print("matrix_a\n",matrix_a);
/*
matrix_a
[[10,10]
[10,10]]
*/
Function Action
TriU R eturn a copy of a matrix with elements below the k-th diagonal
zeroed. Upper triangular matrix
HasNan
R eturn the number of NaN values in a matrix/vector.
ulong vector::HasNan();
ulong matrix::HasNan();
Return Value
Note
W hen comparing the appropriate pair of elements having NaN values, the Compare and
CompareByDigits methods consider these elements equal, while in case of a usual comparison of
floating-point numbers NaN != NaN.
Example:
void OnStart(void)
{
double x=sqrt(-1);
Print("single: ",x==x);
vector<double> v1={x};
vector<double> v2={x};
/* Result:
single: false
vector: true
*/
See also
MathClassify, Compare, CompareByDigits
Transpose
Matrix transposition. Reverse or permute the axes of a matrix; returns the modified matrix.
matrix matrix::Transpose()
Return Value
Transposed matrix.
return(matrix_c);
}
MQL5 example:
/*
matrix a
[[0,1,2]
[3,4,5]]
a.Transpose()
[[0,3]
[1,4]
[2,5]]
*/
Python example:
import numpy as np
a = np.arange(6).reshape((2,3))
print("a \n",a)
print("np.transpose(a) \n",np.transpose(a))
a
[[0 1 2]
[3 4 5]]
np.transpose(a)
[[0 3]
[1 4]
[2 5]]
TriL
R eturn a copy of a matrix with elements above the k-th diagonal zeroed. Lower triangular matrix.
matrix matrix::Tril(
const int ndiag=0 // index of diagonal
);
Parameters
ndiag=0
[in] Diagonal above which to zero elements. ndiag =0 (the default) is the main diagonal, ndiag <
0 is below it and ndiag > 0 is above.
Return Value
Array with its lower triangle filled with ones and zero elsewhere.
MQL5 example:
matrix a={{1,2,3},{4,5,6},{7,8,9},{10,11,12}};
matrix b=a.TriL(-1);
Print("matrix b \n",b);
/*
matrix_c
[[0,0,0]
[4,0,0]
[7,8,0]
[10,11,12]]
*/
Python example:
import numpy as np
a=np.tril([[1,2,3],[4,5,6],[7,8,9],[10,11,12]], -1)
[[ 0 0 0]
[ 4 0 0]
[ 7 8 0]
[10 11 12]]
TriU
R eturn a copy of a matrix with the elements below the k-th diagonal zeroed. Upper triangular matrix.
matrix matrix::Triu(
const int ndiag=0 // index of diagonal
);
Parameters
ndiag=0
[in] Diagonal below which to zero elements. ndiag = 0 (the default) is the main diagonal, ndiag < 0
is below it and ndiag > 0 is above.
MQL5 example:
matrix a={{1,2,3},{4,5,6},{7,8,9},{10,11,12}};
matrix b=a.TriU(-1);
Print("matrix b \n",b);
/*
matrix b
[[1,2,3]
[4,5,6]
[0,8,9]
[0,0,12]]
*/
Python example:
import numpy as np
a=np.triu([[1,2,3],[4,5,6],[7,8,9],[10,11,12]], -1)
print(a)
[[ 1 2 3]
[ 4 5 6]
[ 0 8 9]
[ 0 0 12]]
Diag
Extract a diagonal or construct a diagonal matrix.
vector matrix::Diag(
const int ndiag=0 // number of diagonal
);
void matrix::Diag(
const vector v, // diagonal vector
const int ndiag=0 // number of diagonal
);
Parameters
v
[in] Avector whose elements will be contained in the corresponding diagonal (ndiag=0 is the main
diagonal).
ndiag=0
[in] Diagonal in question. The default is 0. Use ndiag >0 for diagonals above the main diagonal,
and ndiag<0 for diagonals below the main diagonal.
Note
A diagonal can be set for unallocated matrices (which do not have dimensions). In this case, a zero
matrix of the size will be created with the size corresponding to the size of the diagonal vector,
after which the vector values will be populated in the corresponding diagonal. If the diagonal is set
to an already existing matrix, the matrix dimensions do not change and the values of the matrix
elements outside the diagonal vector do not change.
Example
vector v1={1,2,3};
matrix m1;
m1.Diag(v1);
Print("m1\n",m1);
matrix m2;
m2.Diag(v1,-1);
Print("m2\n",m2);
matrix m3;
m3.Diag(v1,1);
Print("m3\n",m3);
matrix m4=matrix::Full(4,5,9);
m4.Diag(v1,1);
Print("m4\n",m4);
Print("diag -1 - ",m4.Diag(-1));
Print("diag 0 - ",m4.Diag());
Print("diag 1 - ",m4.Diag(1));
/*
m1
[[1,0,0]
[0,2,0]
[0,0,3]]
m2
[[0,0,0]
[1,0,0]
[0,2,0]
[0,0,3]]
m3
[[0,1,0,0]
[0,0,2,0]
[0,0,0,3]]
m4
[[9,1,9,9,9]
[9,9,2,9,9]
[9,9,9,3,9]
[9,9,9,9,9]]
diag -1 - [9,9,9]
diag 0 - [9,9,9,9]
diag 1 - [1,2,3,9]
*/
Row
R eturn a row vector. W rite a vector to the specified row
vector matrix::Row(
const ulong nrow // row number
);
void matrix::Row(
const vector v, // row vector
const ulong nrow // row number
);
Parameters
nrow
[in] Number of row.
Return Value
Vector.
Note
A row can be set for unallocated matrices (which do not have dimensions). In this case, a zero
matrix will be created with the size of the vector size x row number+1, after which the values of the
vector elements will be populated in the corresponding row. If the row is set to an already existing
matrix, the matrix dimensions do not change and the values of the matrix elements outside the row
vector do not change.
Example
vector v1={1,2,3};
matrix m1;
m1.Row(v1,1);
Print("m1\n",m1);
matrix m2=matrix::Full(4,5,7);
m2.Row(v1,2);
Print("m2\n",m2);
Print("row 1 - ",m2.Row(1));
Print("row 2 - ",m2.Row(2));
/*
m1
[[0,0,0]
[1,2,3]]
m2
[[7,7,7,7,7]
[7,7,7,7,7]
[1,2,3,7,7]
[7,7,7,7,7]]
row 1 - [7,7,7,7,7]
row 2 - [1,2,3,7,7]
*/
Col
R eturn a column vector. W rite a vector to the specified column.
vector matrix::Col(
const ulong ncol // column number
);
void matrix::Col(
const vector v, // column vector
const ulong ncol // column number
);
Parameters
ncol
[in] Number of column.
Return Value
Vector.
Note
A column can be set for unallocated matrices (which do not have dimensions). In this case, a zero
matrix will be created with the size of the vector size x column number+1, after which the values of
the vector elements will be populated in the corresponding column. If the column is set to an already
existing matrix, the matrix dimensions do not change and the values of the matrix elements outside
the column vector do not change.
Example
vector v1={1,2,3};
matrix m1;
m1.Col(v1,1);
Print("m1\n",m1);
matrix m2=matrix::Full(4,5,8);
m2.Col(v1,2);
Print("m2\n",m2);
Print("col 1 - ",m2.Col(1));
Print("col 2 - ",m2.Col(2));
/*
m1
[[0,1]
[0,2]
[0,3]]
m2
[[8,8,1,8,8]
[8,8,2,8,8]
[8,8,3,8,8]
[8,8,8,8,8]]
col 1 - [8,8,8,8]
col 2 - [1,2,3,8]
*/
Copy
Create a copy of the given matrix/vector.
bool matrix::Copy(
const matrix& a // copied matrix
);
bool vector::Copy(
const vector& v // copied vector
);
Parameters
v
[in] Matrix or vector to copy.
Return Value
MQL5 example:
/*
/*
matrix b
[[1,0,0,0]
[0,1,0,0]
[0,0,1,0]]
matrix_c
[[1,0,0,0]
[0,1,0,0]
[0,0,1,0]]
*/
*/
Python example:
import numpy as np
a = np.eye(3,4)
print('a \n',a)
b = a
print('b \n',b)
c = np.copy(a)
print('c \n',c)
a
[[1. 0. 0. 0.]
[0. 1. 0. 0.]
[0. 0. 1. 0.]]
b
[[1. 0. 0. 0.]
[0. 1. 0. 0.]
[0. 0. 1. 0.]]
c
[[1. 0. 0. 0.]
[0. 1. 0. 0.]
[0. 0. 1. 0.]]
Compare
Compare the elements of two matrices /vectors with the specified precision.
ulong vector::Compare(
const vector& vec, // vector to compare
const double epsilon // precision
);
ulong matrix::Compare(
const matrix& mat, // matrix to compare
const double epsilon // precision
);
Parameters
vector_b
[in] Vector to compare.
epsilon
[in] Precision.
Return Value
The number of mismatched elements of the matrices or vectors being compared: 0 if the matrices
are equal, greater than 0 otherwise.
Note
The comparison operators == or != execute an exact element-wise comparison. It is known that the
exact comparison of real numbers is of limited use, so the epsilon comparison method was added. It
may happen that one matrix can contain elements in a range, for example from 1e-20 to 1e+20.
S uch matrices can be processed using element-wise comparison up to significant figures.
Example
matrix matrix_a={{10,3,2},{1,8,12},{6,5,4}};
matrix matrix_i=matrix::Identity(3,3);
matrix matrix_c=matrix_a.Inv();
matrix matrix_check=matrix_a.MatMul(matrix_c);
Print("matrix_check\n",matrix_check);
ulong errors=matrix_check.Compare(matrix::Identity(3,3),1e-15);
Print("errors=",errors);
/*
matrix_check
[[1,0,0]
[4.440892098500626e-16,1,8.881784197001252e-16]
[4.440892098500626e-16,2.220446049250313e-16,0.9999999999999996]]
errors=0
*/
CompareByDigits
Compare the elements of two matrices /vectors with the significant digits precision.
ulong vector::CompareByDigits(
const vector& vec, // vector to compare
const int digits // number of significant digits
);
ulong matrix::CompareByDigits(
const matrix& mat, // matrix to compare
const int digits // number of significant digits
);
Parameters
vector_b
[in] Vector to compare.
digits
[in] Number of significant digits to compare.
epsilon
[in] Comparison precision. If two values differ in absolute value by less than the specified
precision, they are considered equal.
Return Value
The number of mismatched elements of the matrices or vectors being compared: 0 if the matrices
are equal, greater than 0 otherwise.
Note
The comparison operators == or != execute an exact element-wise comparison. It is known that the
exact comparison of real numbers is of limited use, so the epsilon comparison method was added. It
may happen that one matrix can contain elements in a range, for example from 1e-20 to 1e+20.
S uch matrices can be processed using element-wise comparison up to significant digits.
Example
int size_m=128;
int size_k=256;
matrix matrix_a(size_m,size_k);
//--- fill the matrix
double value=0.0;
for(int i=0; i<size_m; i++)
{
for(int j=0; j<size_k; j++)
{
if(i==j)
matrix_a[i][j]=1.0+i;
else
{
value+=1.0;
matrix_a[i][j]=value/1e+20;
}
}
}
//--- get another matrix
matrix matrix_c = matrix_a * -1;
ulong errors_epsilon=matrix_a.Compare(matrix_c,1e-15);
ulong errors_digits=matrix_a.CompareByDigits(matrix_c,15);
/*
Compare matrix 128 x 256 errors_epsilon=128 errors_digits=32768
*/
Flat
Allows addressing a matrix element through one index instead of two.
bool matrix::Flat(
const ulong index, // index
const double value // value to set
);
double matrix::Flat(
const ulong index, // index
);
Parameters
index
[in] Flat index
value
[in] Value to set by given index.
Return Value
Note
Example
matrix matrix_a={{10,3,2},{1,8,12},{6,5,4},{7,11,9}};
Print("matrix_a\n",matrix_a);
ulong arg_max=matrix_a.ArgMax();
Print("max_value=",matrix_a.Flat(arg_max));
matrix_a.Flat(arg_max,0);
arg_max=matrix_a.ArgMax();
Print("max_value=",matrix_a.Flat(arg_max));
/*
matrix_a
[[10,3,2]
[1,8,12]
[6,5,4]
[7,11,9]]
max_value=12.0
max_value=11.0
*/
Clip
Limit the elements of a matrix/vector to a specified range of valid values.
bool matrix::Clip(
const double min_value, // minimum value
const double max_value // maximum value
);
bool vector::Clip(
const double min_value, // minimum value
const double max_value // maximum value
);
Parameters
min_value
[in] Minimum value.
max_value
[in] Maximum value.
Return Value
Note
The matrix (or vector) is processed in place. No copies are created.
Example
matrix matrix_a={{1,2,3},{4,5,6},{7,8,9},{10,11,12}};
bool res=matrix_a.Clip(4,8);
Print("matrix_a\n",matrix_a);
/*
matrix_a
[[4,4,4]
[4,5,6]
[7,8,8]
[8,8,8]]
*/
Reshape
Change the shape of a matrix without changing its data.
void Reshape(
const ulong rows, // new number or rows
const ulong cols // new number or columns
);
Parameters
rows
[in] New number or rows.
cols
[in] New number or columns.
Note
The matrix is processed in place. No copies are created. Any size can be specified, i.e.,
rows _new*cols _new!=rows _old*cols _old. W hen the matrix buffer is increased, the extra values are
undefined.
Example
matrix matrix_a={{1,2,3},{4,5,6},{7,8,9},{10,11,12}};
Print("matrix_a\n",matrix_a);
matrix_a.Reshape(2,6);
Print("Reshape(2,6)\n",matrix_a);
matrix_a.Reshape(3,5);
Print("Reshape(3,5)\n",matrix_a);
matrix_a.Reshape(2,4);
Print("Reshape(2,4)\n",matrix_a);
/*
matrix_a
[[1,2,3]
[4,5,6]
[7,8,9]
[10,11,12]]
Reshape(2,6)
[[1,2,3,4,5,6]
[7,8,9,10,11,12]]
Reshape(3,5)
[[1,2,3,4,5]
[6,7,8,9,10]
[11,12,0,3,0]]
Reshape(2,4)
[[1,2,3,4]
[5,6,7,8]]
*/
Resize
R eturn a new matrix with a changed shape and size.
bool matrix::Resize(
const ulong rows, // new number or rows
const ulong cols, // new number or columns
const ulong reserve=0 // reserve amount in items
);
bool vector::Resize(
const ulong size, // new size.
const ulong reserve=0 // reserve amount in items.
);
Parameters
rows
[in] New number or rows.
cols
[in] New number or columns.
Return Value
Note
The matrix (or vector) is processed in place. No copies are created. Any size can be specified,
i.e., rows _new*cols _new!=rows _old*cols _old. Unlike Reshape, the matrix is processed row by row.
W hen increasing the number of columns, the values of the extra columns are undefined. W hen
increasing the number of rows, the values of elements in the new rows are undefined. W hen the
number of columns is reduced, each row of the matrix is truncated.
Example
matrix matrix_a={{1,2,3},{4,5,6},{7,8,9},{10,11,12}};
Print("matrix_a\n",matrix_a);
matrix_a.Resize(2,6);
Print("Ressize(2,6)\n",matrix_a);
matrix_a.Resize(3,5);
Print("Resize(3,5)\n",matrix_a);
matrix_a.Resize(2,4);
Print("Resize(2,4)\n",matrix_a);
/*
matrix_a
[[1,2,3]
[4,5,6]
[7,8,9]
[10,11,12]]
Ressize(2,6)
[[1,2,3,4,5,6]
[4,5,6,10,11,12]]
Resize(3,5)
[[1,2,3,4,5]
[4,5,6,10,11]
[11,12,3,8,8]]
Resize(2,4)
[[1,2,3,4]
[4,5,6,10]]
*/
Set
S ets the value for a vector element by the specified index.
bool vector::Set(
ulong index, // element index
double value // value
);
Parameters
index
[in] Index of the element the value needs to be set for.
value
[in] Value.
Return Value
Note
The S et method does the same thing as assigning a value using s quare brackets, namely:
vector[index]=value. The method has been added to simplify transferring a code from languages
where this type of notation is used. The example below shows both options for filling the vector
with values by the specified index.
Example:
void OnStart()
{
//---
vector v1(10, VectorAssignValues);
Print("v1 = ", v1);
SwapRows
S wap rows in a matrix.
bool matrix::SwapRows(
const ulong row1, // index of first row
const ulong row2 // index of second row
);
Parameters
row1
[in] Index of the first row.
row2
[in] Index of the second row.
Return Value
Example
matrix matrix_a={{1,2,3,4},
{5,6,7,8},
{9,10,11,12},
{13,14,15,16}};
matrix matrix_i=matrix::Identity(4,4);
matrix matrix_a1=matrix_a;
matrix_a1.SwapRows(0,3);
Print("matrix_a1\n",matrix_a1);
matrix matrix_p=matrix_i;
matrix_p.SwapRows(0,3);
matrix matrix_c1=matrix_p.MatMul(matrix_a);
Print("matrix_c1\n",matrix_c1);
/*
matrix_a1
[[13,14,15,16]
[5,6,7,8]
[9,10,11,12]
[1,2,3,4]]
matrix_c1
[[13,14,15,16]
[5,6,7,8]
[9,10,11,12]
[1,2,3,4]]
*/
SwapCols
S wap columns in a matrix.
bool matrix::SwapCols(
const ulong row1, // index of first column
const ulong row2 // index of second column
);
Parameters
col1
[in] Index of the first column.
col2
[in] Index of the second column.
Return Value
Example
matrix matrix_a={{1,2,3,4},
{5,6,7,8},
{9,10,11,12},
{13,14,15,16}};
matrix matrix_i=matrix::Identity(4,4);
matrix matrix_a1=matrix_a;
matrix_a1.SwapCols(0,3);
Print("matrix_a1\n",matrix_a1);
matrix matrix_p=matrix_i;
matrix_p.SwapCols(0,3);
matrix matrix_c1=matrix_a.MatMul(matrix_p);
Print("matrix_c1\n",matrix_c1);
/*
matrix_a1
[[4,2,3,1]
[8,6,7,5]
[12,10,11,9]
[16,14,15,13]]
matrix_c1
[[4,2,3,1]
[8,6,7,5]
[12,10,11,9]
[16,14,15,13]]
*/
Split
S plit a matrix into multiple submatrices.
bool matrix::Split(
const ulong parts, // number of submatrices
const int axis, // axis
matrix& splitted[] // array of resulting submatrices
);
void matrix::Split(
const ulong& parts[], // sizes of submatrices
const int axis, // axis
matrix& splitted[] // array of resulting submatrices
);
Parameters
parts
[in] The number of submatrices to divide the matrix into.
axis
[in] Axis. 0 - horizontal axis, 1 - vertical axis.
splitted
[out] Array of resulting submatrices.
Return Value
Note
If the number of submatrices is specified, then same size submatrices are obtained. It means that
the matrix size (0 - the number of rows, 1 - the number of columns) must be divisible by 'parts '
without a remainder. S ubmatrices of different sizes can be obtained using an array of submatrix
sizes. The elements of the size array are used until the entire matrix is divided. If the array of
sizes has ended, and the matrix has not yet been completely divided, the undivided remainder will
be the last submatrix.
Example
bool res=matrix_a.Split(2,0,splitted);
Print(res," ",GetLastError());
ResetLastError();
for(uint i=0; i<splitted.Size(); i++)
Print("splitted ",i,"\n",splitted[i]);
res=matrix_a.Split(2,1,splitted);
Print(res," ",GetLastError());
for(uint i=0; i<splitted.Size(); i++)
Print("splitted ",i,"\n",splitted[i]);
res=matrix_a.Split(parts,0,splitted);
Print(res," ",GetLastError());
for(uint i=0; i<splitted.Size(); i++)
Print("splitted ",i,"\n",splitted[i]);
/*
false 4003
true 0
splitted 0
[[1,2,3]
[7,8,9]
[13,14,15]
[19,20,21]
[25,26,27]]
splitted 1
[[4,5,6]
[10,11,12]
[16,17,18]
[22,23,24]
[28,29,30]]
true 0
splitted 0
[[1,2,3,4,5,6]
[7,8,9,10,11,12]]
splitted 1
[[13,14,15,16,17,18]
[19,20,21,22,23,24]]
splitted 2
[[25,26,27,28,29,30]]
*/
Hsplit
S plit a matrix horizontally into multiple submatrices. S ame as S plit with axis =0
bool matrix::Hsplit(
const ulong parts, // number of submatrices
matrix& splitted[] // array of resulting submatrices
);
void matrix::Hsplit(
const ulong& parts[], // sizes of submatrices
matrix& splitted[] // array of resulting submatrices
);
Parameters
parts
[in] The number of submatrices to divide the matrix into.
splitted
[out] Array of resulting submatrices.
Return Value
Note
If the number of submatrices is specified, then same size submatrices are obtained. It means that
the number of rows must be divisible by 'parts ' without a remainder. S ubmatrices of different sizes
can be obtained using an array of submatrix sizes. The elements of the size array are used until
the entire matrix is divided. If the array of sizes has ended, and the matrix has not yet been
completely divided, the undivided remainder will be the last submatrix.
Example
bool res=matrix_a.Hsplit(2,splitted);
Print(res," ",GetLastError());
ResetLastError();
for(uint i=0; i<splitted.Size(); i++)
Print("splitted ",i,"\n",splitted[i]);
res=matrix_a.Hsplit(5,splitted);
Print(res," ",GetLastError());
for(uint i=0; i<splitted.Size(); i++)
Print("splitted ",i,"\n",splitted[i]);
res=matrix_a.Hsplit(parts,splitted);
Print(res," ",GetLastError());
for(uint i=0; i<splitted.Size(); i++)
Print("splitted ",i,"\n",splitted[i]);
/*
false 4003
true 0
splitted 0
[[1,2,3,4,5,6]]
splitted 1
[[7,8,9,10,11,12]]
splitted 2
[[13,14,15,16,17,18]]
splitted 3
[[19,20,21,22,23,24]]
splitted 4
[[25,26,27,28,29,30]]
true 0
splitted 0
[[1,2,3,4,5,6]
[7,8,9,10,11,12]]
splitted 1
[[13,14,15,16,17,18]
[19,20,21,22,23,24]
[25,26,27,28,29,30]]
*/
Vsplit
S plit a matrix vertically into multiple submatrices. S ame as S plit with axis =1
bool matrix::Vsplit(
const ulong parts, // number of submatrices
matrix& splitted[] // array of resulting submatrices
);
void matrix::Vsplit(
const ulong& parts[], // sizes of submatrices
matrix& splitted[] // array of resulting submatrices
);
Parameters
parts
[in] The number of submatrices to divide the matrix into.
splitted
[out] Array of resulting submatrices.
Return Value
Example
matrix_a.Vsplit(2,splitted);
for(uint i=0; i<splitted.Size(); i++)
Print("splitted ",i,"\n",splitted[i]);
matrix_a.Vsplit(3,splitted);
for(uint i=0; i<splitted.Size(); i++)
Print("splitted ",i,"\n",splitted[i]);
matrix_a.Vsplit(parts,splitted);
for(uint i=0; i<splitted.Size(); i++)
Print("splitted ",i,"\n",splitted[i]);
/*
splitted 0
[[1,2,3]
[7,8,9]
[13,14,15]]
splitted 1
[[4,5,6]
[10,11,12]
[16,17,18]]
splitted 0
[[1,2]
[7,8]
[13,14]]
splitted 1
[[3,4]
[9,10]
[15,16]]
splitted 2
[[5,6]
[11,12]
[17,18]]
splitted 0
[[1,2]
[7,8]
[13,14]]
splitted 1
[[3,4,5]
[9,10,11]
[15,16,17]]
splitted 2
[[6]
[12]
[18]]
*/
ArgSort
Indirect sort of a matrix or vector.
vector vector::Sort(
func_name compare_func=NULL, // comparison function
T context // parameter for the custom sort function
);
matrix matrix::Sort(
func_name compare_func=NULL // comparison function
T context // parameter for the custom sort function
);
matrix matrix::Sort(
const int axis, // axis for sorting
func_name compare_func=NULL // comparison function
T context // parameter for the custom sort function
);
Parameters
axis
[in] The axing along which to sort: 0 is horizontal, 1 is vertical.
func_name
[in]Comparator. You can specify one of the values of the ENUM _S ORT_MODE enumeration or your
own comparison function. If no function is specified, ascending sort is used.
Return Value
Vector or matrix with the indexes of sorted elements. For example, the result [4,2,0,1,3] indicates
that there should be an element with index 4 in the zero position, an element with index 2 in the
first position, and so on.
Sort
S ort a matrix or vector in place.
void vector::Sort(
func_name compare_func=NULL, // comparison function
T context // parameter for the custom sort function
);
void matrix::Sort(
func_name compare_func=NULL // comparison function
T context // parameter for the custom sort function
);
void matrix::Sort(
const int axis, // axis for sorting
func_name compare_func=NULL // comparison function
T context // parameter for the custom sort function
);
Parameters
axis
[in] The axing along which to sort: 0 is horizontal, 1 is vertical.
func_name
[in]Comparator. You can specify one of the values of the ENUM _S ORT_MODE enumeration or your
own comparison function. If no function is specified, ascending sort is used.
Return Value
None. S orting is performed in place, i.e. it is applied to the data of the matrix/vector for which the
S ort method is called.
Example
//+------------------------------------------------------------------+
//| Sort function |
//+------------------------------------------------------------------+
int MyDoubleComparator(double x1,double x2,int sort_mode=0)
{
For MathMod and MathPow, the second element can be either a scalar or a matrix/vector of the
appropriate size.
The following example shows how to calculate the standard deviation by applying math functions to a
vector.
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- use the initializing function to fill the vector
vector r(10, ArrayRandom); // array of random numbers from 0 to 1
//--- calculate the mean value
double avr=r.Mean(); // array mean value
vector d=r-avr; // calculate an array of deviations from the mean
Print("avr(r)=", avr);
Print("r=", r);
Print("d=", d);
vector s2=MathPow(d, 2); // array of squared deviations
double sum=s2.Sum(); // sum of squared deviations
//--- calculate the standard deviation in two different methods
double std=MathSqrt(sum/r.Size());
Print(" std(r)=", std);
Print("r.Std()=", r.Std());
}
/*
avr(r)=0.5300302133243813
r=[0.8346201971495713,0.8031556138798182,0.6696676534318063,0.05386516922513505,0.549119541001617
d=[0.30458998382519,0.2731254005554369,0.1396374401074251,-0.4761650440992462,0.01908932767723626
std(r)=0.2838269732183663
r.Std()=0.2838269732183663
*/
//+------------------------------------------------------------------+
//| Fills a vector with random values |
//+------------------------------------------------------------------+
void ArrayRandom(vector& v)
{
for(ulong i=0; i<v.Size(); i++)
v[i]=double(MathRand())/32767.;
}
Mathematical operations
Mathematical operations, including addition, subtraction, multiplication and division, can be
performed on matrices and vectors element-wise.
Bothmatrices or both vectors must be of the same type and must have the same dimensions. Each
element of the matrix operates on the corresponding element of the second matrix.
You can also use a scalar of the appropriate type (double, float or complex) as the second term
(multiplier, subtrahend or divisor). In this case, each member of the matrix or vector will operate on
the specified scalar.
matrix matrix_a={{0.1,0.2,0.3},{0.4,0.5,0.6}};
matrix matrix_b={{1,2,3},{4,5,6}};
matrix matrix_c1=matrix_a+matrix_b;
matrix matrix_c2=matrix_b-matrix_a;
matrix matrix_c3=matrix_a*matrix_b; // Hadamard product, not to be confused with matrix product
matrix matrix_c4=matrix_b/matrix_a;
matrix_c1=matrix_a+1;
matrix_c2=matrix_b-double_value;
matrix_c3=matrix_a*M_PI;
matrix_c4=matrix_b/0.1;
Mathematical functions
The following mathematical functions can be applied to matrices and vectors : MathAbs, MathArccos,
MathArcsin, MathArctan, MathCeil, MathCos, MathExp, MathFloor, MathLog, MathLog10, MathMod,
MathPow, MathRound, MathS in, MathSqrt, MathTan, MathExpm1, MathLog1p, MathArccosh,
MathArcsinh, MathArctanh, MathCosh, MathS inh, MathTanh. S uch operations imply element-wise
processing of matrices and vectors.
For MathMod and MathPow, the second element can be either a scalar or a matrix/vector of the
appropriate size.
matrix<T> mat1(128,128);
matrix<T> mat3(mat1.Rows(),mat1.Cols());
ulong n,size=mat1.Rows()*mat1.Cols();
...
mat2=MathPow(mat1,(T)1.9);
for(n=0; n<size; n++)
{
T res=MathPow(mat1.Flat(n),(T)1.9);
if(res!=mat2.Flat(n))
errors++;
}
mat2=MathPow(mat1,mat3);
for(n=0; n<size; n++)
{
T res=MathPow(mat1.Flat(n),mat3.Flat(n));
if(res!=mat2.Flat(n))
errors++;
}
...
vector<T> vec1(16384);
vector<T> vec3(vec1.Size());
ulong n,size=vec1.Size();
...
vec2=MathPow(vec1,(T)1.9);
for(n=0; n<size; n++)
{
T res=MathPow(vec1[n],(T)1.9);
if(res!=vec2[n])
errors++;
}
vec2=MathPow(vec1,vec3);
for(n=0; n<size; n++)
{
T res=MathPow(vec1[n],vec3[n]);
if(res!=vec2[n])
errors++;
}
Function Action
MatMul
The MatMul method, which enables the multiplication of matrices and vectors, has several overloads.
Multiplying a matrix by a matrix: matrix[M][K] * matrix[K][N] = matrix[M][N]
matrix matrix::MatMul(
const matrix& b // second matrix
);
Parameters
b
[in] Matrix or vector.
Return Value
Note
The matrices should be compatible for multiplication, i.e. the number of columns in the first matrix
should be equal to the number of rows in the second matrix. Matrix multiplication is non-
commutative: the result of multiplying the first matrix by the second one is not equal to the result
of multiplying the second matrix by the first one in the general case.
The matrix product consists of all possible combinations of scalar products of the row vectors of the
first matrix and the column vectors of the second matrix.
In scalar multiplication, vectors must have the same length.
W hen multiplyinga vector and a matrix, the length of the vector must exactly match the number of
columns in the matrix.
if(matrix_a.Cols()!=matrix_b.Rows())
return(matrix_c);
ulong M=matrix_a.Rows();
ulong K=matrix_a.Cols();
ulong N=matrix_b.Cols();
matrix_c=matrix::Zeros(M,N);
return(matrix_c);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- create a 3x5 matrix
matrix m35;
m35.Init(3, 5, Arange);
//---
vector v3 = {1, 2, 3};
Print("Product of horizontal vector v and matrix m[3,5]");
Print("On the left, vector v3 = ", v3);
Print("On the right, matrix m35 = \n", m35);
Print("v3.MatMul(m35) = horizontal vector v[5] \n", v3.MatMul(m35));
/* Result
Product of horizontal vector v3 and matrix m[3,5]
On the left, vector v3 = [1,2,3]
On the right, matrix m35 =
[[0,1,2,3,4]
[5,6,7,8,9]
[10,11,12,13,14]]
v3.MatMul(m35) = horizontal vector v[5]
[40,46,52,58,64]
*/
}
//+------------------------------------------------------------------+
//| Fill the matrix with increasing values |
//+------------------------------------------------------------------+
void Arange(matrix & m, double start = 0, double step = 1)
{
//---
ulong cols = m.Cols();
ulong rows = m.Rows();
double value = start;
for(ulong r = 0; r < rows; r++)
{
for(ulong c = 0; c < cols; c++)
{
m[r][c] = value;
value += step;
}
}
//---
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- create a 3x5 matrix
matrix m35;
m35.Init(3, 5, Arange);
//---
Print("Product of matrix m[3,5] and vertical vector v[5]");
vector v5 = {1,2,3,4,5};
Print("On the left, m35 = \n",m35);
Print("On the right v5 = ",v5);
Print("m35.MatMul(v5) = vertical vector v[3] \n",m35.MatMul(v5));
/* Result
Product of matrix m[3,5] and vertical vector v[5]
On the left, m35 =
[[0,1,2,3,4]
[5,6,7,8,9]
[10,11,12,13,14]]
On the right, v5 = [1,2,3,4,5]
m35.MatMul(v5) = vertical vector v[3]
[40,115,190]
*/
}
//+------------------------------------------------------------------+
//| Fill the matrix with increasing values |
//+------------------------------------------------------------------+
void Arange(matrix & m, double start = 0, double step = 1)
{
//---
ulong cols = m.Cols();
ulong rows = m.Rows();
double value = start;
for(ulong r = 0; r < rows; r++)
{
for(ulong c = 0; c < cols; c++)
{
m[r][c] = value;
value += step;
}
}
//---
}
void OnStart()
{
/* Result
a = [1,2,3]
b = [4,5,6]
1) a.MatMul(b) = 32.0
2) a.Dot(b) = 32.0
*/
}
See also
Dot, GeMM
GeMM
The GeMM (General Matrix Multiply) method implements the general multiplication of two matrices.
The operation is defined as C ← α A B + β C , where A and B matrices can be optionally transposed.
W ith a normal multiplication of matrices AB (MatMul), the alpha scalar is assumed to be equal to 1 and
beta equal to zero.
The main difference between GeMM and MatMul in terms of efficiency is that MatMul always creates a
new matrix/vector object, while GeMM works with an existing matrix object and does not re-create it.
Therefore, when you use GeMM and pre-allocate memory for the corresponding matrix, then, while
working with the same matrix sizes, there will be no memory reallocations. This can be an important
advantage of GeMM for bulk computing, for example, when running optimizations in a strategy tester
or when training a neural network.
S imilar
to MatMul, GeMM also has 4 overloads. However, the semantics of the fourth overload has
been modified in order to enable the multiplication of a vertical vector with a and horizontal one.
In an existing matrix/vector object, it is not necessary to pre-allocate memory. The memory will be
allocated and filled with zeros at the first GeMM call.
Multiplying a matrix by a matrix: matrix C[M][N] = α * ( matrix A[M][K] * matrix B[K][N])
+ β * matrix C[M][N]
bool matrix::GeMM(
const matrix &A, // first matrix
const matrix &B, // second matrix
double alpha, // alpha multiplier for product AB
double beta, // beta multiplier for matrix C
uint flags // a combination of ENUM_GEMM values (bitwise OR), which determines whether m
);
Parameters
A
[in] Matrix or vector.
B
[in] Matrix or vector.
alpha
[in] Alpha multiplier for the AB product.
beta
[in] Beta multiplier for the resulting C matrix.
flags
[in] The ENUM _GEMM enumeration value that determines whether matrices A, B and C are
transposed.
Return Value
ENUM_GEMM
ID Description
Note
Matrices and vectors of float, double and complex types can be used as parameters A and B. The
template variants of the GeMM method are as follows :
bool matrix<T>::GeMM(const matrix<T> &A,const matrix<T> &B,T alpha,T beta,ulong flags);
Example:
void OnStart()
{
vector vector_a= {1, 2, 3, 4, 5};
vector vector_b= {4, 3, 2, 1};
matrix matrix_c;
//--- calculate GeMM for two vectors
matrix_c.GeMM(vector_a, vector_b, 1, 0);
Print("matrix_c:\n ", matrix_c, "\n");
/*
matrix_c:
[[4,3,2,1]
[8,6,4,2]
[12,9,6,3]
[16,12,8,4]
[20,15,10,5]]
*/
//--- create matrices as vectors
matrix matrix_a(5, 1);
matrix matrix_b(1, 4);
matrix_a.Col(vector_a, 0);
matrix_b.Row(vector_b, 0);
Print("matrix_a:\n ", matrix_a);
Print("matrix_b:\n ", matrix_b);
/*
matrix_a:
[[1]
[2]
[3]
[4]
[5]]
matrix_b:
[[4,3,2,1]]
*/
//-- calculate GeMM for two matrices and get the same result
matrix_c.GeMM(matrix_a, matrix_b, 1, 0);
Print("matrix_c:\n ", matrix_c);
/*
matrix_c:
[[4,3,2,1]
[8,6,4,2]
[12,9,6,3]
[16,12,8,4]
[20,15,10,5]]
*/
}
See also
MatMul
Power
R aise a s quare matrix to the integer power.
matrix matrix::Power(
const int power // power
);
Parameters
power
[in] The exponent can be any integer, positive, negative, or zero.
Return Value
Matrix.
Note
The resulting matrix has the same size as the original matrix. In raised to the power of 0, the
identity matrix is returned. The positive power n means that the original matrix is multiplied n
times by itself. The negative power -n means that the original matrix is first inverted, and then the
inverted matrix is multiplied by itself n times.
else
{
result=a;
for(int i=1; i<power; i++)
result=result.MatMul(a);
}
}
//---
c=result;
return(true);
}
MQL5 example:
Print("i.Power(3):\n", i.Power(3));
Print("i.Power(0):\n", i.Power(0));
Print("i.Power(-3):\n", i.Power(-3));
/*
i:
[[0,1]
[-1,0]]
i.Power(3):
[[0,-1]
[1,0]]
i.Power(0):
[[1,0]
[0,1]]
i.Power(-3):
[[0, -1]
[1,0]]
*/
Python example:
import numpy as np
from numpy.linalg import matrix_power
# should = -i
print("matrix_power(i, 3) :\n",matrix_power(i, 3) )
i:
[[ 0 1]
[-1 0]]
matrix_power(i, 3) :
[[ 0 -1]
[ 1 0]]
matrix_power(i, 0):
[[1 0]
[0 1]]
matrix_power(i, -3):
[[ 0. 1.]
[-1. 0.]]
Dot
Dot product of two vectors.
double vector::Dot(
const vector& b // second vector
);
Parameters
b
[in] Vector.
Return Value
S calar.
Note
if(vector_a.Size()==vector_b.Size())
{
for(ulong i=0; i<vector_a.Size(); i++)
dot+=vector_a[i]*vector_b[i];
}
return(dot);
}
MQL5 example:
Python example:
import numpy as np
a = [1, 0, 0, 1]
b = [4, 1, 2, 2]
print(np.dot(a, b))
>>> 6
Kron
R eturn Kroneck er product of two matrices, matrix and vector, vector and matrix or two vectors.
matrix matrix::Kron(
const matrix& b // second matrix
);
matrix matrix::Kron(
const vector& b // vector
);
matrix vector::Kron(
const matrix& b // matrix
);
matrix vector::Kron(
const vector& b // second vector
);
Parameters
b
[in] second matrix.
Return Value
Matrix.
Note
A simple algorithm for the Kronecker product for two matrices in MQL5:
matrix_c[m*P+p][n*Q+q]=matrix_a[m][n] * matrix_b[p][q];
return(matrix_c);
}
MQL5 example:
matrix a={{1,2,3},{4,5,6}};
matrix b=matrix::Identity(2,2);
vector v={1,2};
Print(a.Kron(b));
Print(a.Kron(v));
/*
[[1,0,2,0,3,0]
[0,1,0,2,0,3]
[4,0,5,0,6,0]
[0,4,0,5,0,6]]
[[1,2,2,4,3,6]
[4,8,5,10,6,12]]
*/
Python example:
import numpy as np
A = np.arange(1,7).reshape(2,3)
B = np.identity(2)
V = [1,2]
print(np.kron(A, B))
print("")
print(np.kron(A, V))
[[1. 0. 2. 0. 3. 0.]
[0. 1. 0. 2. 0. 3.]
[4. 0. 5. 0. 6. 0.]
[0. 4. 0. 5. 0. 6.]]
[[ 1 2 2 4 3 6]
[ 4 8 5 10 6 12]]
Inner
Inner product of two matrices.
matrix matrix::Inner(
const matrix& b // second matrix
);
Parameters
b
[in] Matrix.
Return Value
Matrix.
Note
The inner product for two vectors is the dot product of the two vectors vector::Dot().
MQL5 example:
matrix a={{0,1,2},{3,4,5}};
matrix b={{0,1,2},{3,4,5},{6,7,8}};
matrix c=a.Inner(b);
Print(c);
matrix a1={{0,1,2}};
matrix c1=a1.Inner(b);
Print(c1);
/*
[[5,14,23]
[14,50,86]]
[[5,14,23]]
*/
Python example:
import numpy as np
A = np.arange(6).reshape(2, 3)
B = np.arange(9).reshape(3, 3)
A1= np.arange(3)
print(np.inner(A, B))
print("");
print(np.inner(A1, B))
import numpy as np
A = np.arange(6).reshape(2, 3)
B = np.arange(9).reshape(3, 3)
A1= np.arange(3)
print(np.inner(A, B))
print("");
print(np.inner(A1, B))
Outer
Compute the outer product of two matrices or two vectors.
matrix matrix::Outer(
const matrix& b // second matrix
);
matrix vector::Outer(
const vector& b // second vector
);
Parameters
b
[in] Matrix.
Return Value
Matrix.
Note
The outer product, like the Kronecker product, is also a block matrix (and vector) multiplication.
//---
return(matrix_c);
}
MQL5 example:
vector vector_a={0,1,2,3,4,5};
vector vector_b={0,1,2,3,4,5,6};
Print("vector_a.Outer\n",vector_a.Outer(vector_b));
Print("vector_a.Kron\n",vector_a.Kron(vector_b));
matrix matrix_a={{0,1,2},{3,4,5}};
matrix matrix_b={{0,1,2},{3,4,5},{6,7,8}};
Print("matrix_a.Outer\n",matrix_a.Outer(matrix_b));
Print("matrix_a.Kron\n",matrix_a.Kron(matrix_b));
/*
vector_a.Outer
[[0,0,0,0,0,0,0]
[0,1,2,3,4,5,6]
[0,2,4,6,8,10,12]
[0,3,6,9,12,15,18]
[0,4,8,12,16,20,24]
[0,5,10,15,20,25,30]]
vector_a.Kron
[[0,0,0,0,0,0,0,0,1,2,3,4,5,6,0,2,4,6,8,10,12,0,3,6,9,12,15,18,0,4,8,12,16,20,24,0,5,10,15,20,25
matrix_a.Outer
[[0,0,0,0,0,0,0,0,0]
[0,1,2,3,4,5,6,7,8]
[0,2,4,6,8,10,12,14,16]
[0,3,6,9,12,15,18,21,24]
[0,4,8,12,16,20,24,28,32]
[0,5,10,15,20,25,30,35,40]]
matrix_a.Kron
[[0,0,0,0,1,2,0,2,4]
[0,0,0,3,4,5,6,8,10]
[0,0,0,6,7,8,12,14,16]
[0,3,6,0,4,8,0,5,10]
[9,12,15,12,16,20,15,20,25]
[18,21,24,24,28,32,30,35,40]]
*/
Python example:
import numpy as np
A = np.arange(6)
B = np.arange(7)
print("np.outer")
print(np.outer(A, B))
print("np.kron")
print(np.kron(A, B))
A = np.arange(6).reshape(2, 3)
B = np.arange(9).reshape(3, 3)
print("np.outer")
print(np.outer(A, B))
print("np.kron")
np.outer
[[ 0 0 0 0 0 0 0]
[ 0 1 2 3 4 5 6]
[ 0 2 4 6 8 10 12]
[ 0 3 6 9 12 15 18]
[ 0 4 8 12 16 20 24]
[ 0 5 10 15 20 25 30]]
np.kron
[ 0 0 0 0 0 0 0 0 1 2 3 4 5 6 0 2 4 6 8 10 12 0 3 6
9 12 15 18 0 4 8 12 16 20 24 0 5 10 15 20 25 30]
np.outer
[[ 0 0 0 0 0 0 0 0 0]
[ 0 1 2 3 4 5 6 7 8]
[ 0 2 4 6 8 10 12 14 16]
[ 0 3 6 9 12 15 18 21 24]
[ 0 4 8 12 16 20 24 28 32]
[ 0 5 10 15 20 25 30 35 40]]
np.kron
[[ 0 0 0 0 1 2 0 2 4]
[ 0 0 0 3 4 5 6 8 10]
[ 0 0 0 6 7 8 12 14 16]
[ 0 3 6 0 4 8 0 5 10]
[ 9 12 15 12 16 20 15 20 25]
[18 21 24 24 28 32 30 35 40]]
CorrCoef
Compute the Pearson correlation coefficient (linear correlation coefficient).
matrix matrix::CorrCoef(
const bool rowvar=true // rows or cols vectors of observations
);
scalar vector::CorrCoef(
const vector& b // second vector
);
Return Value
Note
A simple algorithm for calculating the correlation coefficient of two vectors using MQL5:
ulong i;
double xmean=0;
double ymean=0;
for(i=0; i<n; i++)
{
if(!MathIsValidNumber(vector_x[i]))
return(0);
if(!MathIsValidNumber(vector_y[i]))
return(0);
xmean+=vector_x[i];
ymean+=vector_y[i];
}
xmean/=(double)n;
ymean/=(double)n;
double s=0;
double xv=0;
double yv=0;
double t1=0;
double t2=0;
//--- calculation
s=0;
for(i=0; i<n; i++)
{
t1=vector_x[i]-xmean;
t2=vector_y[i]-ymean;
xv+=t1*t1;
yv+=t2*t2;
s+=t1*t2;
}
//--- check
if(xv==0 || yv==0)
return(0);
//--- return result
return(s/(MathSqrt(xv)*MathSqrt(yv)));
}
MQL5 example:
vectorf vector_a={1,2,3,4,5};
vectorf vector_b={0,1,0.5,2,2.5};
Print("vectors correlation ",vector_a.CorrCoef(vector_b));
//---
matrixf matrix_a={{1,2,3,4,5},
{0,1,0.5,2,2.5}};
Print("matrix rows correlation\n",matrix_a.CorrCoef());
matrixf matrix_a2=matrix_a.Transpose();
Print("transposed matrix cols correlation\n",matrix_a2.CorrCoef(false));
matrixf matrix_a3={{1.0f, 2.0f, 3.0f, 4.0f, 5.0f},
{0.0f, 1.0f, 0.5f, 2.0f, 2.5f},
{0.1f, 1.0f, 2.0f, 1.0f, 0.3f}};
Print("rows correlation\n",matrix_a3.CorrCoef());
Print("cols correlation\n",matrix_a3.CorrCoef(false));
/*
vectors correlation 0.9149913787841797
matrix rows correlation
[[1,0.91499138]
[0.91499138,1]]
transposed matrix cols correlation
[[1,0.91499138]
[0.91499138,1]]
rows correlation
[[1,0.91499138,0.08474271]
[0.91499138,1,-0.17123166]
[0.08474271,-0.17123166,1]]
cols correlation
[[1,0.99587059,0.85375023,0.91129309,0.83773589]
[0.99587059,1,0.80295509,0.94491106,0.88385159]
[0.85375023,0.80295509,1,0.56362146,0.43088508]
[0.91129309,0.94491106,0.56362146,1,0.98827404]
[0.83773589,0.88385159,0.43088508,0.98827404,1]]
*/
Python example:
import numpy as np
va=[1,2,3,4,5]
vb=[0,1,0.5,2,2.5]
print("vectors correlation")
print(np.corrcoef(va,vb))
ma=np.zeros((2,5))
ma[0,:]=va
ma[1,:]=vb
print("matrix rows correlation")
print(np.corrcoef(ma))
print("transposed matrix cols correlation")
print(np.corrcoef(np.transpose(ma),rowvar=False))
print("")
ma1=[[1,2,3,4,5],[0,1,0.5,2,2.5],[0.1,1,0.2,1,0.3]]
print("rows correlation\n",np.corrcoef(ma1))
print("cols correlation\n",np.corrcoef(ma1,rowvar=False))
rows correlation
[[1. 0.91499142 0.1424941 ]
[0.91499142 1. 0.39657517]
[0.1424941 0.39657517 1. ]]
cols correlation
[[1. 0.99587059 0.98226063 0.91129318 0.83773586]
[0.99587059 1. 0.99522839 0.94491118 0.88385151]
[0.98226063 0.99522839 1. 0.97234063 0.92527551]
[0.91129318 0.94491118 0.97234063 1. 0.98827406]
[0.83773586 0.88385151 0.92527551 0.98827406 1. ]]
Cov
Compute the covariance matrix.
matrix matrix::Cov(
const bool rowvar=true // rows or cols vectors of observations
);
matrix vector::Cov(
const vector& b // second vector
);
Parameters
b
[in] S econd vector.
Note
A simple algorithm for calculating the covariance matrix of two vectors using MQL5:
matrix_x[i][j]-=t[i];
//--- syrk C=alpha*A^H*A+beta*C (beta=0 and not considered)
matrix_c=matrix::Zeros(m,m);
for(i=0; i<m; i++)
{
for(j=0; j<n; j++)
{
double v=matrix_x[i][j]/(n-1);
for(int i_=i; i_<m; i_++)
matrix_c[i][i_]+=v*matrix_x[i_][j];
}
}
//--- force symmetricity
for(i=0; i<m-1; i++)
for(j=i+1; j<m; j++)
matrix_c[j][i]=matrix_c[i][j];
//---
return(true);
}
MQL5 example:
matrix matrix_a={{3,-2.1},{1.1,-1},{0.12,4.3}};
Print("covariation cols\n",matrix_a.Cov(false));
Print("covariation rows\n",matrix_a.Cov());
vector vector_a=matrix_a.Col(0);
vector vector_b=matrix_a.Col(1);
Print("covariation vectors\n",vector_a.Cov(vector_b));
/*
covariation cols
[[2.144133333333333,-4.286]
[-4.286,11.71]]
covariation rows
[[13.005,5.355,-10.659]
[5.355,2.205,-4.389]
[-10.659,-4.389,8.736199999999998]]
covariation vectors
[[2.144133333333333,-4.286]
[-4.286,11.71]]
*/
Python example:
import numpy as np
matrix_a=np.array([[3,-2.1],[1.1,-1],[0.12,4.3]])
matrix_c=np.cov(matrix_a,rowvar=False)
print("covariation cols\n",matrix_c)
matrix_c2=np.cov(matrix_a)
print("covariation rows\n",matrix_c2)
vector_a=matrix_a[:,0]
vector_b=matrix_a[:,1]
matrix_c3=np.cov(vector_a,vector_b)
print("covariation vectors\n",matrix_c3)
covariation cols
[[ 2.14413333 -4.286 ]
[-4.286 11.71 ]]
covariation rows
[[ 13.005 5.355 -10.659 ]
[ 5.355 2.205 -4.389 ]
[-10.659 -4.389 8.7362]]
covariation vectors
[[ 2.14413333 -4.286 ]
[-4.286 11.71 ]]
Correlate
Compute the cross-correlation of two vectors.
vector vector::Correlate(
const vector& v, // vector
ENUM_VECTOR_CONVOLVE mode // mode
);
Parameters
v
[in] S econd vector.
mode
[in] The 'mode' parameter determines the linear convolution calculation mode. Value from the
ENUM _VECTOR_CONVOL VE enumeration.
Return Value
A simple algorithm for calculating the correlation coefficient of two vectors using MQL5:
return(c);
}
//+------------------------------------------------------------------+
//| |
//+------------------------------------------------------------------+
vector VectorCrossCorrelationSame(const vector& a,const vector& b)
{
int m=(int)a.Size();
int n=(int)b.Size();
int size=MathMax(m,n);
vector c=vector::Zeros(size);
return(c);
}
//+------------------------------------------------------------------+
//| |
//+------------------------------------------------------------------+
vector VectorCrossCorrelationValid(const vector& a,const vector& b)
{
int m=(int)a.Size();
int n=(int)b.Size();
int size=MathMax(m,n)-MathMin(m,n)+1;
vector c=vector::Zeros(size);
return(c);
}
MQL5 example:
vector a={1,2,3,4,5};
vector b={0,1,0.5};
Print("full\n",a.Correlate(b,VECTOR_CONVOLVE_FULL));
Print("same\n",a.Correlate(b,VECTOR_CONVOLVE_SAME));
Print("valid\n",a.Correlate(b,VECTOR_CONVOLVE_VALID));
Print("full\n",b.Correlate(a,VECTOR_CONVOLVE_FULL));
/*
full
[0.5,2,3.5,5,6.5,5,0]
same
[2,3.5,5,6.5,5]
valid
[3.5,5,6.5]
full
[0,5,6.5,5,3.5,2,0.5]
*/
Python example:
import numpy as np
a=[1,2,3,4,5]
b=[0,1,0.5]
print("full\n",np.correlate(a,b,'full'))
print("same\n",np.correlate(a,b,'same'));
print("valid\n",np.correlate(a,b,'valid'));
print("full\n",np.correlate(b,a,'full'))
full
[0.5 2. 3.5 5. 6.5 5. 0. ]
same
[2. 3.5 5. 6.5 5. ]
valid
[3.5 5. 6.5]
full
[0. 5. 6.5 5. 3.5 2. 0.5]
Convolve
R eturn the discrete, linear convolution of two vectors
vector vector::Convolve(
const vector& v, // vector
ENUM_VECTOR_CONVOLVE mode // mode
);
Parameters
v
[out] S econd vector.
mode
[in] The 'mode' parameter determines the linear convolution calculation mode
ENUM _VECTOR_CONVOL VE.
Return Value
int m=(int)a.Size();
int n=(int)b.Size();
int size=m+n-1;
vector c=vector::Zeros(size);
return(c);
}
//+------------------------------------------------------------------+
//| |
//+------------------------------------------------------------------+
vector VectorConvolutionSame(const vector& a,const vector& b)
{
if(a.Size()<b.Size())
return(VectorConvolutionSame(b,a));
int m=(int)a.Size();
int n=(int)b.Size();
int size=MathMax(m,n);
vector c=vector::Zeros(size);
return(c);
}
//+------------------------------------------------------------------+
//| |
//+------------------------------------------------------------------+
vector VectorConvolutionValid(const vector& a,const vector& b)
{
if(a.Size()<b.Size())
return(VectorConvolutionValid(b,a));
int m=(int)a.Size();
int n=(int)b.Size();
int size=MathMax(m,n)-MathMin(m,n)+1;
vector c=vector::Zeros(size);
return(c);
}
MQL5 example:
/*
full
[0,1,2.5,4,5.5,7,2.5]
same
[1,2.5,4,5.5,7]
valid
[2.5,4,5.5]
*/
Python example:
import numpy as np
a=[1,2,3,4,5]
b=[0,1,0.5]
print("full\n",np.convolve(a,b,'full'))
print("same\n",np.convolve(a,b,'same'));
print("valid\n",np.convolve(a,b,'valid'));
full
[0. 1. 2.5 4. 5.5 7. 2.5]
same
[1. 2.5 4. 5.5 7. ]
valid
[2.5 4. 5.5]
Matrix transformations
Matrix decomposition can be used in the following cases :
· as an intermediate step when solving systems of linear equations
· for matrix inversion
· when calculating determinants
· when finding eigenvalues and eigenvectors of a matrix
· when computing analytic functions of matrices
· when using the least s quares method
· in the numerical solution of differential equations
Different matrix decomposition types are used depending on the problem.
Function Action
Cholesky
Compute the Choles ky decomposition.
bool matrix::Cholesky(
matrix& L // matrix
);
Parameters
L key
[out] Lower triangular matrix.
Return Value
Note
R eturn the Choles k y decomposition, L * L.H , of the s quare matrix a, where L is lower-triangular and
.H is the conjugate transpose operator (which is the ordinary transpose if a is real-valued). a must
be Hermitian (symmetric if real-valued) and positive-definite. No checking is performed to verify
whether a is Hermitian or not. In addition, only the lower-triangular and diagonal elements of a are
used. Only L is actually returned.
Example
matrix_a.Cholesky(matrix_l);
Print("matrix_l\n", matrix_l);
Print("check\n", matrix_l.MatMul(matrix_l.Transpose()));
/*
matrix_a
[[5.7998084,-2.1825367]
[-2.1825367,9.85910595]]
matrix_l
[[2.408279136645086,0]
[-0.9062640068544704,3.006291985133859]]
check
[[5.7998084,-2.1825367]
[-2.1825367,9.85910595]]
*/
Eig
Compute the eigenvalues and right eigenvectors of a s quare matrix.
bool matrix::Eig(
matrix& eigen_vectors, // matrix of eigenvectors
vector& eigen_values // vector of eigenvalues
);
Parameters
eigen_vectors
[out] Matrix of vertical eigenvectors.
eigen_values
[out] Vector of eigenvalues.
Return Value
Example
#property script_show_inputs
//--- input parameters
input int InpSize1 =512;
input int InpSize2 =256;
input int InpSize3 =1024;
//+------------------------------------------------------------------+
//| Filling the test square invertible matrix |
//+------------------------------------------------------------------+
template<typename T>
void MatrixFill(matrix<T> &matrix_a)
{
ulong size_m=matrix_a.Rows();
ulong size_k=matrix_a.Cols();
T value=0.0;
//--- fill the matrix
for(ulong i=0; i<size_m; i++)
{
for(ulong j=0; j<size_k; j++)
{
if(i==j)
matrix_a[i][j]=T(1.0+i);
else
{
value+=1.0;
matrix_a[i][j]=value;
}
}
}
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
int OnStart()
{
int errors=0;
errors+=TestEigen<double>(InpSize1);
errors+=TestEigen<double>(InpSize2);
errors+=TestEigen<double>(InpSize3);
errors+=TestEigen<float>(InpSize1);
errors+=TestEigen<float>(InpSize2);
errors+=TestEigen<float>(InpSize3);
//---
Print("Test ", errors?"failed":"passed");
return(errors);
}
/*
Result
//+------------------------------------------------------------------+
//| Testing the Eig method |
//+------------------------------------------------------------------+
template<typename T>
int TestEigen(const int size_m)
{
int vectors=0;
matrix<T> matrix_a(size_m, size_m);
matrix<T> matrix_v(size_m, size_m);
vector<T> vector_e(size_m);
//--- populate the square matrix
MatrixFill(matrix_a);
//--- microseconds will be measured
ulong t1=GetMicrosecondCount();
//--- Eigen Solver
matrix_a.Eig(matrix_v, vector_e);
//--- measure
ulong t2=GetMicrosecondCount();
//--- check if A * v = lambda * v
for(ulong n=0; n<vector_e.Size(); n++)
{
vector<T> eigen_vector=matrix_v.Col(n);
vector<T> vector_c1 =eigen_vector*vector_e[n];
vector<T> vector_c2 =matrix_a.MatMul(eigen_vector);
//--- too many devisions, weaken the precision check down to 10th digit
ulong errors=vector_c1.CompareByDigits(vector_c2, sizeof(T)==sizeof(double) ? 10 : 5);
if(int(errors)<size_m/10)
vectors++;
}
double elapsed_time=double(t2-t1)/1000.0;
printf("Eigen solver of %s matrix %d x %d %s vectors=%d time=%.3f ms",
typename(T), size_m, size_m, vectors>0?"passed":"failed", vectors, elapsed_time);
return(vectors==0);
}
EigVals
Compute the eigenvalues of a general matrix.
bool matrix::EigVals(
vector& eigen_values // vector of eigenvalues
);
Parameters
eigen_values
[out] Vector of right eigenvalues.
Return Value
Note
The only difference between EigVals and Eig is that EigVals does not calculate eigenvectors, while it
only calculates eigenvalues.
LU
LU factorization of a matrix as the product of a lower triangular matrix and an upper triangular
matrix.
bool matrix::LU(
matrix& L, // lower triangular matrix
matrix& U // upper triangular matrix
);
Parameters
L key
[out] Lower triangular matrix.
U
[out] Upper triangular matrix.
Return Value
Example
matrix matrix_a={{1,2,3,4},
{5,2,6,7},
{8,9,3,10},
{11,12,14,4}};
matrix matrix_l,matrix_u;
//--- LU decomposition
matrix_a.LU(matrix_l,matrix_u);
Print("matrix_l\n",matrix_l);
Print("matrix_u\n",matrix_u);
//--- check if A = L * U
Print("check\n",matrix_l.MatMul(matrix_u));
/*
matrix_l
[[1,0,0,0]
[5,1,0,0]
[8,0.875,1,0]
[11,1.25,0.5904761904761905,1]]
matrix_u
[[1,2,3,4]
[0,-8,-9,-13]
[0,0,-13.125,-10.625]
[0,0,0,-17.47619047619047]]
check
[[1,2,3,4]
[5,2,6,7]
[8,9,3,10]
[11,12,14,4]]
*/
LUP
LUP factorization with partial pivoting, which refers to LU decomposition with row permutations only:
PA=LU.
bool LUP(
matrix& L, // lower triangular matrix
matrix& U, // upper triangular matrix
matrix& P // permutations matrix
);
Parameters
L key
[out] Lower triangular matrix.
U
[out] Upper triangular matrix.
P
[out] Permutations matrix
Return Value
Example
matrix matrix_a={{1,2,3,4},
{5,2,6,7},
{8,9,3,10},
{11,12,14,4}};
matrix matrix_l,matrix_u,matrix_p;
//--- LUP decomposition
matrix_a.LUP(matrix_l,matrix_u,matrix_p);
Print("matrix_l\n",matrix_l);
Print("matrix_u\n",matrix_u);
Print("matrix_p\n",matrix_p);
//--- check if P * A = L * U
Print("P * A\n",matrix_p.MatMul(matrix_a));
Print("L * U\n",matrix_l.MatMul(matrix_u));
/*
matrix_l
[[1,0,0,0]
[0.4545454545454545,1,0,0]
[0.7272727272727273,-0.07894736842105282,1,0]
[0.09090909090909091,-0.2631578947368421,-0.2262773722627738,1]]
matrix_u
[[11,12,14,4]
[0,-3.454545454545454,-0.3636363636363633,5.181818181818182]
[0,0,-7.210526315789473,7.500000000000001]
[0,0,0,6.697080291970803]]
matrix_p
[[0,0,0,1]
[0,1,0,0]
[0,0,1,0]
[1,0,0,0]]
P * A
[[11,12,14,4]
[5,2,6,7]
[8,9,3,10]
[1,2,3,4]]
L * U
[[11,12,14,4]
[5,2,6,7]
[8,9,3.000000000000001,10]
[1,2,3,4]]
*/
QR
Compute the qr factorization of a matrix.
bool QR(
matrix& Q, // matrix with orthonormal columns
matrix& R // upper-triangular matrix
);
Parameters
Q
[out] A matrix with orthonormal columns. W hen mode = 'complete' the result is an
orthogonal/unitary matrix depending on whether or not a is real/complex. The determinant may
be either +/- 1 in that case. In case the number of dimensions in the input array is greater than 2
then a stack of the matrices with above properties is returned.
R key
[out] Upper triangular matrix.
Return Value
Example
//--- A*x = b
matrix A = {{0, 1}, {1, 1}, {1, 1}, {2, 1}};
Print("A \n", A);
vector b = {1, 2, 2, 3};
Print("b \n", b);
//--- A = Q*R
matrix q, r;
A.QR(q, r);
Print("q \n", q);
Print("r \n", r);
matrix qr=q.MatMul(r);
Print("qr \n", qr);
/*
A
[[0,1]
[1,1]
[1,1]
[2,1]]
b
[1,2,2,3]
q
[[0.4082482904638631,-0.8164965809277259,-1.110223024625157e-16,-0.4082482904638631]
[0.4625425214347352,-0.03745747856526496,0.7041241452319315,0.5374574785652647]
[-0.5374574785652648,-0.03745747856526496,0.7041241452319316,-0.4625425214347352]
[-0.5749149571305296,-0.5749149571305299,-0.09175170953613698,0.5749149571305296]]
r
[[-1.224744871391589,-0.2415816237971962]
[-1.22474487139159,-1.466326495188786]
[1.224744871391589,1.316496580927726]
[1.224744871391589,0.2415816237971961]]
qr
[[-1.110223024625157e-16,1]
[1,0.9999999999999999]
[1,1]
[2,1]]
*/
SVD
S ingular Value Decomposition.
bool matrix::SVD(
matrix& U, // unitary matrix
matrix& V, // unitary matrix
vector& singular_values // singular values vector
);
Parameters
U
[out] Unitary matrix of order m, consisting of left singular vectors.
V
[out] Unitary matrix of order n, consisting of right singular vectors.
singular_values
[out] S ingular values
Return Value
Example
// check block
//--- U * singular diagonal * V = A
matrix matrix_s;
matrix_s.Diag(singular_values);
Print("matrix_s \n", matrix_s);
matrix matrix_vt=V.Transpose();
Print("matrix_vt \n", matrix_vt);
matrix matrix_usvt=(U.MatMul(matrix_s)).MatMul(matrix_vt);
Print("matrix_usvt \n", matrix_usvt);
matrix vt_V=matrix_vt.MatMul(V);
Print("vt_V \n", vt_V);
Print("V_vt \n", V.MatMul(matrix_vt));
/*
matrix a
[[-4,-3,-2,-1,0,1,2,3,4]]
matrix b
[[-4,-3,-2]
[-1,0,1]
[2,3,4]]
U
[[-0.7071067811865474,0.5773502691896254,0.408248290463863]
[-6.827109697437648e-17,0.5773502691896253,-0.8164965809277256]
[0.7071067811865472,0.5773502691896255,0.4082482904638627]]
V
[[0.5773502691896258,-0.7071067811865474,-0.408248290463863]
[0.5773502691896258,1.779939029415334e-16,0.8164965809277258]
[0.5773502691896256,0.7071067811865474,-0.408248290463863]]
singular_values = [7.348469228349533,2.449489742783175,3.277709923350408e-17]
matrix_s
[[7.348469228349533,0,0]
[0,2.449489742783175,0]
[0,0,3.277709923350408e-17]]
matrix_vt
[[0.5773502691896258,0.5773502691896258,0.5773502691896256]
[-0.7071067811865474,1.779939029415334e-16,0.7071067811865474]
[-0.408248290463863,0.8164965809277258,-0.408248290463863]]
matrix_usvt
[[-3.999999999999997,-2.999999999999999,-2]
[-0.9999999999999981,-5.977974170712231e-17,0.9999999999999974]
[2,2.999999999999999,3.999999999999996]]
errors=0
U_Ut
[[0.9999999999999993,-1.665334536937735e-16,-1.665334536937735e-16]
[-1.665334536937735e-16,0.9999999999999987,-5.551115123125783e-17]
[-1.665334536937735e-16,-5.551115123125783e-17,0.999999999999999]]
Ut_U
[[0.9999999999999993,-5.551115123125783e-17,-1.110223024625157e-16]
[-5.551115123125783e-17,0.9999999999999987,2.498001805406602e-16]
[-1.110223024625157e-16,2.498001805406602e-16,0.999999999999999]]
vt_V
[[1,-5.551115123125783e-17,0]
[-5.551115123125783e-17,0.9999999999999996,1.110223024625157e-16]
[0,1.110223024625157e-16,0.9999999999999996]]
V_vt
[[0.9999999999999999,1.110223024625157e-16,1.942890293094024e-16]
[1.110223024625157e-16,0.9999999999999998,1.665334536937735e-16]
[1.942890293094024e-16,1.665334536937735e-16,0.9999999999999996]
*/
}
Statistical methods
Methods for computing descriptive statistics of matrices and vectors.
Function Action
ArgMax
R eturn the index of the maximum value.
ulong vector::ArgMax();
ulong matrix::ArgMax();
vector matrix::ArgMax(
const int axis // axis
);
Parameters
axis
[in] Axis. 0 — horizontal axis, 1 — vertical axis.
Return Value
Example
matrix matrix_a={{10,3,2},{1,8,12},{6,5,4},{7,11,9}};
Print("matrix_a\n",matrix_a);
vector cols_max=matrix_a.ArgMax(0);
vector rows_max=matrix_a.ArgMax(1);
ulong matrix_max=matrix_a.ArgMax();
Print("cols_max=",cols_max);
Print("rows_max=",rows_max);
Print("max index ",matrix_max," max value ",matrix_a.Flat(matrix_max));
/*
matrix_a
[[10,3,2]
[1,8,12]
[6,5,4]
[7,11,9]]
cols_max=[0,3,1]
rows_max=[0,2,0,1]
max index 5 max value 12.0
*/
ArgMin
R eturn the index of the minimum value.
ulong vector::ArgMin();
ulong matrix::ArgMin();
vector matrix::ArgMin(
const int axis // axis
);
Parameters
axis
[in] Axis. 0 — horizontal axis, 1 — vertical axis.
Return Value
Example
matrix matrix_a={{10,3,2},{1,8,12},{6,5,4},{7,11,9}};
Print("matrix_a\n",matrix_a);
vector cols_min=matrix_a.ArgMin(0);
vector rows_min=matrix_a.ArgMin(1);
ulong matrix_min=matrix_a.ArgMin();
Print("cols_min=",cols_min);
Print("rows_min=",rows_min);
Print("min index ",matrix_min," min value ",matrix_a.Flat(matrix_min));
/*
matrix_a
[[10,3,2]
[1,8,12]
[6,5,4]
[7,11,9]]
cols_min=[1,0,0]
rows_min=[2,0,2,0]
min index 3 min value 1.0
*/
Max
R eturn the maximum value in a matrix/vector.
double vector::Max();
double matrix::Max();
vector matrix::Max(
const int axis // axis
);
Parameters
axis
[in] Axis. 0 — horizontal axis, 1 — vertical axis.
Return Value
Example
matrix matrix_a={{10,3,2},{1,8,12},{6,5,4},{7,11,9}};
Print("matrix_a\n",matrix_a);
vector cols_max=matrix_a.Max(0);
vector rows_max=matrix_a.Max(1);
double matrix_max=matrix_a.Max();
Print("cols_max=",cols_max);
Print("rows_max=",rows_max);
Print("max value ",matrix_max);
/*
matrix_a
[[10,3,2]
[1,8,12]
[6,5,4]
[7,11,9]]
cols_max=[10,11,12]
rows_max=[10,12,6,11]
max value 12.0
*/
Min
R eturn the minimum value in a matrix/vector.
double vector::Min();
double matrix::Min();
vector matrix::Min(
const int axis // axis
);
Parameters
axis
[in] Axis. 0 — horizontal axis, 1 — vertical axis.
Return Value
Example
matrix matrix_a={{10,3,2},{1,8,12},{6,5,4},{7,11,9}};
Print("matrix_a\n",matrix_a);
vector cols_min=matrix_a.Min(0);
vector rows_min=matrix_a.Min(1);
double matrix_min=matrix_a.Min();
Print("cols_min=",cols_min);
Print("rows_min=",rows_min);
Print("min value ",matrix_min);
/*
matrix_a
[[10,3,2]
[1,8,12]
[6,5,4]
[7,11,9]]
cols_min=[1,3,2]
rows_min=[2,1,4,7]
min value 1.0
*/
Ptp
R eturn the range of values of a matrix/vector or of the given matrix axis, equivalent to Max() - Min().
Ptp - Peak to peak.
double vector::Ptp();
double matrix::Ptp();
vector matrix::Ptp(
const int axis // axis
);
Parameters
axis
[in] Axis. 0 — horizontal axis, 1 — vertical axis.
Return Value
Example
matrix matrix_a={{10,3,2},{1,8,12},{6,5,4},{7,11,9}};
Print("matrix_a\n",matrix_a);
vector cols_ptp=matrix_a.Ptp(0);
vector rows_ptp=matrix_a.Ptp(1);
double matrix_ptp=matrix_a.Ptp();
Print("cols_ptp ",cols_ptp);
Print("rows_ptp ",rows_ptp);
Print("ptp value ",matrix_ptp);
/*
matrix_a
[[10,3,2]
[1,8,12]
[6,5,4]
[7,11,9]]
cols_ptp [9,8,10]
rows_ptp [8,11,2,4]
ptp value 11.0
*/
Sum
R eturn the sum of the matrix/vector elements which can also be performed for the given axis (axes).
double vector::Sum();
double matrix::Sum();
vector matrix::Sum(
const int axis // axis
);
Parameters
axis
[in] Axis. 0 — horizontal axis, 1 — vertical axis.
Return Value
S um of the matrix/vector elements which can also be performed for the given axis (axes).
Example
matrix matrix_a={{10,3,2},{1,8,12},{6,5,4},{7,11,9}};
Print("matrix_a\n",matrix_a);
vector cols_sum=matrix_a.Sum(0);
vector rows_sum=matrix_a.Sum(1);
double matrix_sum=matrix_a.Sum();
Print("cols_sum=",cols_sum);
Print("rows_sum=",rows_sum);
Print("sum value ",matrix_sum);
/*
matrix_a
[[10,3,2]
[1,8,12]
[6,5,4]
[7,11,9]]
cols_sum=[24,27,27]
rows_sum=[15,21,15,27]
sum value 78.0
*/
Prod
R eturn the product of the matrix/vector elements which can also be performed for the given axis.
double vector::Prod(
const double initial=1 // initial multiplier
);
double matrix::Prod(
const double initial=1 // initial multiplier
);
vector matrix::Prod(
const int axis, // axis
const double initial=1 // initial multiplier
);
Parameters
axis
[in] Axis. 0 — horizontal axis, 1 — vertical axis.
initial=1
[in] Initial multiplier.
Example
matrix matrix_a={{10,3,2},{1,8,12},{6,5,4},{7,11,9}};
Print("matrix_a\n",matrix_a);
vector cols_prod=matrix_a.Prod(0);
vector rows_prod=matrix_a.Prod(1);
double matrix_prod=matrix_a.Prod();
Print("cols_prod=",cols_prod);
cols_prod=matrix_a.Prod(0,0.1);
Print("cols_prod=",cols_prod);
Print("rows_prod=",rows_prod);
Print("prod value ",matrix_prod);
/*
matrix_a
[[10,3,2]
[1,8,12]
[6,5,4]
[7,11,9]]
cols_prod=[420,1320,864]
cols_prod=[42,132,86.40000000000001]
rows_prod=[60,96,120,693]
CumSum
R eturn the cumulative sum of matrix/vector elements, including those along the given axis.
vector vector::CumSum();
vector matrix::CumSum();
matrix matrix::CumSum(
const int axis // axis
);
Parameters
axis
[in] Axis. 0 — horizontal axis, 1 — vertical axis.
Return Value
Example
matrix matrix_a={{10,3,2},{1,8,12},{6,5,4},{7,11,9}};
Print("matrix_a\n",matrix_a);
matrix cols_cumsum=matrix_a.CumSum(0);
matrix rows_cumsum=matrix_a.CumSum(1);
vector cumsum_values=matrix_a.CumSum();
Print("cols_cumsum\n",cols_cumsum);
Print("rows_cumsum\n",rows_cumsum);
Print("cumsum values ",cumsum_values);
/*
matrix_a
[[10,3,2]
[1,8,12]
[6,5,4]
[7,11,9]]
cols_cumsum
[[10,3,2]
[11,11,14]
[17,16,18]
[24,27,27]]
rows_cumsum
[[10,13,15]
[1,9,21]
[6,11,15]
[7,18,27]]
cumsum values [10,13,15,16,24,36,42,47,51,58,69,78]
*/
CumProd
R eturn the cumulative product of matrix/vector elements, including those along the given axis.
vector vector::CumProd();
vector matrix::CumProd();
matrix matrix::CumProd(
const int axis // axis
);
Parameters
axis
[in] Axis. 0 — horizontal axis for each column (i.e., over the rows), 1 — vertical axis for each row
(i.e. over the columns)
Return Value
Example
matrix matrix_a={{10,3,2},{1,8,12},{6,5,4},{7,11,9}};
Print("matrix_a\n",matrix_a);
matrix cols_cumprod=matrix_a.CumProd(0);
matrix rows_cumprod=matrix_a.CumProd(1);
vector cumprod_values=matrix_a.CumProd();
Print("cols_cumprod\n",cols_cumprod);
Print("rows_cumprod\n",rows_cumprod);
Print("cumprod values ",cumprod_values);
/*
matrix_a
[[10,3,2]
[1,8,12]
[6,5,4]
[7,11,9]]
cols_cumprod
[[10,3,2]
[10,24,24]
[60,120,96]
[420,1320,864]]
rows_cumprod
[[10,30,60]
[1,8,96]
[6,30,120]
[7,77,693]]
cumprod values [10,30,60,60,480,5760,34560,172800,691200,4838400,53222400,479001600]
*/
Percentile
R eturn the specified percentile of values of matrix/vector elements or elements along the specified
axis.
double vector::Percentile(
const int percent //
);
double matrix::Percentile(
const int percent //
);
vector matrix::Percentile(
const int percent, //
const int axis // axis
);
Parameters
percent
[in] Percentiles to compute, which must be between 0 and 100 inclusive.
axis
[in] Axis. 0 — horizontal axis, 1 — vertical axis.
Return Value
Valid values of the 'percent' parameter are in the range [0, 100]. A linear algorithm is used to
calculate percentiles. The correct calculation of percentiles requires the sequence to be sorted.
Example
matrixf matrix_a={{1,2,3},{4,5,6},{7,8,9},{10,11,12}};
Print("matrix_a\n",matrix_a);
vectorf cols_percentile=matrix_a.Percentile(50,0);
vectorf rows_percentile=matrix_a.Percentile(50,1);
float matrix_percentile=matrix_a.Percentile(50);
Print("cols_percentile ",cols_percentile);
Print("rows_percentile ",rows_percentile);
Print("percentile value ",matrix_percentile);
/*
matrix_a
[[1,2,3]
[4,5,6]
[7,8,9]
[10,11,12]]
cols_percentile [5.5,6.5,7.5]
rows_percentile [2,5,8,11]
percentile value 6.5
*/
Quantile
R eturn the specified quantile of values of matrix/vector elements or elements along the specified
axis.
double vector::Quantile(
const double quantile // quantile
);
double matrix::Quantile(
const double quantile // quantile
);
vector matrix::Quantile(
const double quantile, // quantile
const int axis // axis
);
Parameters
quantile
[in] Quantile to compute, which must be between 0 and 1 inclusive.
axis
[in] Axis. 0 — horizontal axis, 1 — vertical axis.
Return Value
The 'quantile' parameter takes values in the range [0, 1]. A linear algorithm is used to calculate
quantiles. The correct calculation of quantiles requires the sequence to be sorted.
Example
matrixf matrix_a={{1,2,3},{4,5,6},{7,8,9},{10,11,12}};
Print("matrix_a\n",matrix_a);
vectorf cols_quantile=matrix_a.Quantile(0.5,0);
vectorf rows_quantile=matrix_a.Quantile(0.5,1);
float matrix_quantile=matrix_a.Quantile(0.5);
Print("cols_quantile ",cols_quantile);
Print("rows_quantile ",rows_quantile);
Print("quantile value ",matrix_quantile);
/*
matrix_a
[[1,2,3]
[4,5,6]
[7,8,9]
[10,11,12]]
cols_quantile [5.5,6.5,7.5]
rows_quantile [2,5,8,11]
quantile value 6.5
*/
Median
Compute the median of the matrix/vector elements.
double vector::Median();
double matrix::Median();
vector matrix::Median(
const int axis // axis
);
Parameters
axis
[in] Axis. 0 — horizontal axis, 1 — vertical axis.
Return Value
Note
The median is the middle value that separates the highest half of the array/vector elements from
the lowest half of elements. S ame as Quantile(0.5) and Percentile(50). The correct calculation of
median requires the sequence to be sorted.
Example
matrixf matrix_a={{1,2,3},{4,5,6},{7,8,9},{10,11,12}};
Print("matrix_a\n",matrix_a);
vectorf cols_median=matrix_a.Median(0);
vectorf rows_median=matrix_a.Median(1);
float matrix_median=matrix_a.Median();
Print("cols_median ",cols_median);
Print("rows_median ",rows_median);
Print("median value ",matrix_median);
/*
matrix_a
[[1,2,3]
[4,5,6]
[7,8,9]
[10,11,12]]
cols_median [5.5,6.5,7.5]
rows_median [2,5,8,11]
median value 6.5
*/
Mean
Compute the arithmetic mean of element values.
double vector::Mean();
double matrix::Mean();
vector matrix::Mean(
const int axis // axis
);
Parameters
axis
[in] Axis. 0 — horizontal axis, 1 — vertical axis.
Return Value
Example
matrixf matrix_a={{10,3,2},{1,8,12},{6,5,4},{7,11,9}};
Print("matrix_a\n",matrix_a);
vectorf cols_mean=matrix_a.Mean(0);
vectorf rows_mean=matrix_a.Mean(1);
float matrix_mean=matrix_a.Mean();
Print("cols_mean ",cols_mean);
Print("rows_mean ",rows_mean);
Print("mean value ",matrix_mean);
/*
matrix_a
[[10,3,2]
[1,8,12]
[6,5,4]
[7,11,9]]
cols_mean [6,6.75,6.75]
rows_mean [5,7,5,9]
mean value 6.5
*/
Average
Compute the weighted mean of matrix/vector values.
double vector::Average(
const vector& weigts // weights vector
);
double matrix::Average(
const matrix& weigts // weights matrix
);
vector matrix::Average(
const matrix& weigts, // weights matrix
const int axis // axis
);
Parameters
axis
[in] Axis. 0 — horizontal axis, 1 — vertical axis.
Return Value
Note
Example
matrixf matrix_a={{10,3,2},{1,8,12},{6,5,4},{7,11,9}};
matrixf matrix_w=matrixf::Ones(4,3);
Print("matrix_a\n",matrix_a);
vectorf cols_average=matrix_a.Average(matrix_w,0);
vectorf rows_average=matrix_a.Average(matrix_w,1);
float matrix_average=matrix_a.Average(matrix_w);
Print("cols_average ",cols_average);
Print("rows_average ",rows_average);
Print("average value ",matrix_average);
/*
matrix_a
[[10,3,2]
[1,8,12]
[6,5,4]
[7,11,9]]
cols_average [6,6.75,6.75]
rows_average [5,7,5,9]
average value 6.5
*/ value 6.5
Std
R eturn the standard deviation of values of matrix/vector elements or of elements along the given
axis.
double vector::Std();
double matrix::Std();
vector matrix::Std(
const int axis // axis
);
Parameters
axis
[in] Axis. 0 — horizontal axis, 1 — vertical axis.
Return Value
Note
The standard deviation is the s quare root of the average of the s quared deviations from the mean,
i. e., std = s qrt(mean(x)), where x = abs(a - a.mean())**2.
The average s quared deviation is typically calculated as x.sum() / N, where N = len(x).
Example
matrixf matrix_a={{10,3,2},{1,8,12},{6,5,4},{7,11,9}};
Print("matrix_a\n",matrix_a);
vectorf cols_std=matrix_a.Std(0);
vectorf rows_std=matrix_a.Std(1);
float matrix_std=matrix_a.Std();
Print("cols_std ",cols_std);
Print("rows_std ",rows_std);
Print("std value ",matrix_std);
/*
matrix_a
[[10,3,2]
[1,8,12]
[6,5,4]
[7,11,9]]
cols_std [3.2403703,3.0310888,3.9607449]
rows_std [3.5590262,4.5460606,0.81649661,1.6329932]
std value 3.452052593231201
*/
Var
Compute the variance of values of matrix/vector elements.
double vector::Var();
double matrix::Var();
vector matrix::Var(
const int axis // axis
);
Parameters
axis
[in] Axis. 0 — horizontal axis, 1 — vertical axis.
Return Value
Note
The variance is the average of the s quared deviations from the mean, i.e., var = mean(x), where x
= abs(a - a.mean())**2.
Example
matrixf matrix_a={{10,3,2},{1,8,12},{6,5,4},{7,11,9}};
Print("matrix_a\n",matrix_a);
vectorf cols_var=matrix_a.Var(0);
vectorf rows_var=matrix_a.Var(1);
float matrix_var=matrix_a.Var();
Print("cols_var ",cols_var);
Print("rows_var ",rows_var);
Print("var value ",matrix_var);
/*
matrix_a
[[10,3,2]
[1,8,12]
[6,5,4]
[7,11,9]]
cols_var [10.5,9.1875,15.6875]
rows_var [12.666667,20.666666,0.66666669,2.6666667]
var value 11.916666984558105
*/
LinearRegression
Calculate a vector/matrix with calculated linear regression values.
vector vector::LinearRegression();
matrix matrix::LinearRegression(
ENUM_MATRIX_AXIS axis=AXIS_NONE // axis along which regression is calculated
);
Parameters
axis
[in] S pecifying the axis along which the regression is calculated. ENUM _M AT R IX_AXIS enumeration
value (AXIS_HORZ — horizontal axis, AXIS_VERT — vertical axis).
Return Value
Note
Linear regression is calculated using the standard regression equation: y (x) = a * x + b, where a is
the line slope, while b is its Y axis shift.
Example:
#include <Graphics\Graphic.mqh>
//+------------------------------------------------------------------+
long chart=0;
string name="LinearRegression";
curved.LinesSmooth(true);
curved.LinesSmoothTension(1);
curved.LinesSmoothStep(10);
graphic.CurvePlotAll();
graphic.Update();
//--- clean up
graphic.Destroy();
ObjectDelete(chart,name);
ChartSetInteger(0,CHART_SHOW,true);
}
ENUM_MATRIX _AX IS
Enumeration for specifying the axis in all statistical functions for matrices.
ID Description
Feature methods
These methods enable the receiving of matrix features, such as :
· number of rows
· number of columns
· norm
· condition number
· determinant
· matrix rank
· trace
· spectrum
Function Action
Rows
R eturn the number of rows in a matrix.
ulong matrix::Rows()
Return Value
Integer.
Example
/*
matrix m
[[1,2,3,4]
[5,6,7,8]
[9,10,11,12]]
m.Rows()=3
m.Cols()=4
*/
Cols
R eturn the number of columns in a matrix.
ulong matrix::Cols()
Return Value
Integer.
Example
/*
matrix m
[[1,2,3,4]
[5,6,7,8]
[9,10,11,12]]
m.Cols()=4
m.Rows()=3
*/
Size
R eturn the size of vector.
ulong vector::Size()
Return Value
Integer.
Example
matrix m={{1,2,3,4,5,6,7,8,9,10,11,12}};
m.Reshape(3,4);
Print("matrix m\n",m);
vector v=m.Row(1);
Print("v.Size()=",v.Size());
Print("v=",v);
/*
matrix m
[[1,2,3,4]
[5,6,7,8]
[9,10,11,12]]
v.Size()=4
v=[5,6,7,8]
*/
Norm
R eturn matrix or vector norm.
double vector::Norm(
const ENUM_VECTOR_NORM norm, // vector norm
const int norm_p=2 // number of p-norm in case of VECTOR_NORM_P
);
double matrix::Norm(
const ENUM_MATRIX_NORM norm // matrix norm
);
Parameters
norm
[in] Norm order
Return Value
Note
· VECTOR_NOR M _I NF is the maximum absolute value among vector elements.
· VECTOR_NOR M _MINUS_INF is the minimum absolute value of a vector.
· VECTOR_NOR M _P is the P-norm of the vector. If norm_p=0, then this is the number of non-zero
vector elements. norm_p=1 is the sum of absolute values of vector elements. norm_p=2 is the
s quare root of the sum of s quares of vector element values. P-norm can be negative.
· M ATRIX_NORM _FROBENIUS is the s quare root of the sum of the s quares of the matrix element
values. The Frobenius norm and the vector P2-norm are consistent.
· M ATRIX_NORM _S PECTRAL is the maximum value of the matrix spectrum.
· M ATRIX_NORM _NUCLEAR is the sum of the singular values of the matrix.
· M ATRIX_NORM _INF is the maximum vector p1-norm among the vertical vectors of the matrix. The
matrix inf-norm and the vector inf-norm are consistent.
· M ATRIX_NORM _MINUS_INF is the minimum vector p1-norm among the vertical vectors of the
matrix.
· M ATRIX_NORM _P1 is the maximum vector p1-norm among horizontal matrix vectors.
· M ATRIX_NORM _MINUS_P1 is the minimum vector p1-norm among horizontal matrix vectors.
· M ATRIX_NORM _P2 is the highest singular value of the matrix.
· M ATRIX_NORM _MINUS_P2 is the lowest singular value of a matrix.
double norm=0.0;
//---
switch(norm_value)
{
case 0 :
for(i=0; i<v.Size(); i++)
if(v[i]!=0)
norm+=1.0;
break;
case 1 :
for(i=0; i<v.Size(); i++)
norm+=MathAbs(v[i]);
break;
case 2 :
for(i=0; i<v.Size(); i++)
norm+=v[i]*v[i];
norm=MathSqrt(norm);
break;
default :
for(i=0; i<v.Size(); i++)
norm+=MathPow(MathAbs(v[i]),norm_value);
norm=MathPow(norm,1.0/norm_value);
}
//---
return(norm);
}
MQL5 example:
/*
matrix a
[[-4,-3,-2,-1,0,1,2,3,4]]
matrix b
[[-4,-3,-2]
[-1,0,1]
[2,3,4]]
b.Norm(MATRIX_NORM_P2)=7.745966692414834
b.Norm(MATRIX_NORM_FROBENIUS)=7.745966692414834
b.Norm(MATRIX_NORM_INF)9.0
b.Norm(MATRIX_NORM_MINUS_INF)2.0
b.Norm(MATRIX_NORM_P1)=)7.0
b.Norm(MATRIX_NORM_MINUS_P1)=6.0
b.Norm(MATRIX_NORM_P2)=7.348469228349533
b.Norm(MATRIX_NORM_MINUS_P2)=1.857033188519056e-16
*/
Python example:
import numpy as np
from numpy import linalg as LA
a = np.arange(9) - 4
print("a \n",a)
b = a.reshape((3, 3))
print("b \n",b)
print("LA.norm(b)=",LA.norm(b))
print("LA.norm(b, 'fro')=",LA.norm(b, 'fro'))
print("LA.norm(b, np.inf)=",LA.norm(b, np.inf))
print("LA.norm(b, -np.inf)=",LA.norm(b, -np.inf))
print("LA.norm(b, 1)=",LA.norm(b, 1))
print("LA.norm(b, -1)=",LA.norm(b, -1))
print("LA.norm(b, 2)=",LA.norm(b, 2))
print("LA.norm(b, -2)=",LA.norm(b, -2))
a
[-4 -3 -2 -1 0 1 2 3 4]
b
[[-4 -3 -2]
[-1 0 1]
[ 2 3 4]]
LA.norm(b)= 7.745966692414834
LA.norm(b, 'fro')= 7.745966692414834
LA.norm(b, np.inf)= 9.0
LA.norm(b, -np.inf)= 2.0
LA.norm(b, 1)= 7.0
LA.norm(b, -1)= 6.0
LA.norm(b, 2)= 7.3484692283495345
LA.norm(b, -2)= 1.857033188519056e-16
Cond
Compute the condition number of a matrix.
double matrix::Cond(
const ENUM_MATRIX_NORM norm // matrix norm
);
Parameters
norm
[in] Order of the norm from ENUM _M ATRIX_NORM
Return Value
Note
The condition number of x is defined as the norm of x times the norm of the inverse of x [1]. The
norm can be the usual L2-norm (root-of-sum-of-s quares) or one of a number of other matrix norms.
The condition umber is the K value equal to the product of the matrix A norms and its inverse.
Matrices with a high condition number are called ill-conditioned. Those with a low condition number
are called well-conditioned. The inverse matrix is obtained using pseudo-inversion, so as not to be
limited by the condition of s quareness and non-singularity of the matrix.
An exception is the spectral condition number.
double MatrixCondSpectral(matrix& a)
{
double norm=0.0;
vector v=a.Spectrum();
if(v.Size()>0)
{
double max_norm=v[0];
double min_norm=v[0];
for(ulong i=1; i<v.Size(); i++)
{
double real=MathAbs(v[i]);
if(max_norm<real)
max_norm=real;
if(min_norm>real)
min_norm=real;
}
max_norm=MathSqrt(max_norm);
min_norm=MathSqrt(min_norm);
if(min_norm>0.0)
norm=max_norm/min_norm;
}
return(norm);
}
MQL5 example:
/*
matrix a
[[1,0,-1]
[0,1,0]
[1,0,1]]
a.Cond(MATRIX_NORM_P2)=1.414213562373095
a.Cond(MATRIX_NORM_FROBENIUS)=3.162277660168379
a.Cond(MATRIX_NORM_INF)=2.0
a.Cond(MATRIX_NORM_MINUS_INF)=0.9999999999999997
a.Cond(MATRIX_NORM_P1)=)2.0
a.Cond(MATRIX_NORM_MINUS_P1)=0.9999999999999998
a.Cond(MATRIX_NORM_P2)=1.414213562373095
a.Cond(MATRIX_NORM_MINUS_P2)=0.7071067811865472
*/
Python example:
import numpy as np
from numpy import linalg as LA
a = np.array([[1, 0, -1], [0, 1, 0], [1, 0, 1]])
print("a \n",a)
print("LA.cond(a)=",LA.cond(a))
print("LA.cond(a, 'fro')=",LA.cond(a, 'fro'))
print("LA.cond(a, np.inf)=",LA.cond(a, np.inf))
print("LA.cond(a, -np.inf)=",LA.cond(a, -np.inf))
print("LA.cond(a, 1)=",LA.cond(a, 1))
print("LA.cond(a, -1)=",LA.cond(a, -1))
a
[[ 1 0 -1]
[ 0 1 0]
[ 1 0 1]]
LA.cond(a)= 1.4142135623730951
LA.cond(a, 'fro')= 3.1622776601683795
LA.cond(a, np.inf)= 2.0
LA.cond(a, -np.inf)= 1.0
LA.cond(a, 1)= 2.0
LA.cond(a, -1)= 1.0
LA.cond(a, 2)= 1.4142135623730951
LA.cond(a, -2)= 0.7071067811865475
Det
Compute the determinant of a s quare invertible matrix.
double matrix::Det()
Return Value
Determinant of matrix.
Note
2nd and 3rd order matrix determinants are calculated according to the S arrus rule. d2=a11*a22-
a12*a21; d3=a11*a22*a33+a12*a23*a31+a13*a21*a32-a13*a22*a31-a11*a23*a32-a12*a21*a33
The determinant is calculated by the Gaussian method by reducing the matrix to an upper triangular
form. The determinant of an upper triangular matrix is equal to the product of the main diagonal
elements.
If at least one matrix row or column is zero, the determinant is zero.
If two or more matrix rows or columns are linearly dependent, its determinant is zero.
The determinant of a matrix is equal to the product of its eigenvalues.
MQL5 example:
matrix m={{1,2},{3,4}};
double det=m.Det();
Print("matrix m\n",m);
Print("det(m)=",det);
/*
matrix m
[[1,2]
[3,4]]
det(m)=-2.0
*/
Python example:
import numpy as np
a
[[1 2]
[3 4]]
np.linalg.det(a)
-2.0000000000000004
SLogDet
Compute the sign and logarithm of a matrix determinant.
double matrix::SLogDet(
int& sign // sign
);
Parameters
sign
[out] The sign of the determinant. If the sign is even, the determinant is positive.
Return Value
Note
The determinant is calculated by the Gaussian method by reducing the matrix to an upper triangular
form. The determinant of an upper triangular matrix is equal to the product of the main diagonal
elements. The logarithm of a product is equal to the sum of the logarithms. Therefore, in case of an
overflow when calculating the determinant, you can use the S LogDet method.
If the sign is even, the determinant is positive.
Example
Rank
R eturn matrix rank using the Gaussian method.
int Rank()
Return Value
R ank of matrix.
Note
The rank of a system of rows (or columns) of a matrix A that has m rows and n columns is the
maximum number of linearly independent rows (or columns). S everal rows (columns) are called
linearly independent if none of them can be expressed linearly in terms of others. The rank of the
row system is always equal to the rank of the column system. This value is called the rank of the
matrix.
MQL5 example:
/*
matrix a
[[1,0,0,0]
[0,1,0,0]
[0,0,1,0]
[0,0,0,1]]
a.Rank()=4
I
[[1,0,0,0]
[0,1,0,0]
[0,0,1,0]
[0,0,0,0]]
I.Rank()=3
b
[[1,1,1,1]]
b.Rank()=1
zeros
[[0]
[0]
[0]
[0]]
zeros.Rank()=0
*/
Python example:
import numpy as np
from numpy.linalg import matrix_rank
a=(np.eye(4)) # Full rank matrix
print("a \n", a)
print("matrix_rank(a)=",matrix_rank(a))
I=np.eye(4)
I[-1,-1] = 0. # rank deficient matrix
print("I \n",I)
print("matrix_rank(I)=",matrix_rank(I))
b=np.ones((4,))
print("b \n",b)
print("matrix_rank(b)=",matrix_rank(b)) # 1 dimension - rank 1 unless all 0
zeros=np.zeros((4,))
print("zeroes \n",zeros)
print("matrix_rank(zeros)=",matrix_rank(zeros))
a
[[1. 0. 0. 0.]
[0. 1. 0. 0.]
[0. 0. 1. 0.]
[0. 0. 0. 1.]]
matrix_rank(a)= 4
I
[[1. 0. 0. 0.]
[0. 1. 0. 0.]
[0. 0. 1. 0.]
[0. 0. 0. 0.]]
matrix_rank(I)= 3
b
[1. 1. 1. 1.]
matrix_rank(b)= 1
zeroes
[0. 0. 0. 0.]
matrix_rank(zeros)= 0
Trace
R eturn the sum along diagonals of the matrix.
double matrix::Trace()
Return Value
Note
MQL5 example:
/*
matrix a
[[0,1,2]
[3,4,5]
[6,7,8]]
a.Trace()
12.0
*/
Python example:
a = np.arange(9).reshape((3,3))
print('a \n',a)
print('np.trace(a) \n',np.trace(a))
a
[[0 1 2]
[3 4 5]
[6 7 8]]
np.trace(a)
12
Spectrum
Compute spectrum of a matrix as the set of its eigenvalues from the product AT*A.
vector matrix::Spectrum()
Return Value
Example
double MatrixCondSpectral(matrix& a)
{
double norm=0.0;
vector v=a.Spectrum();
if(v.Size()>0)
{
double max_norm=v[0];
double min_norm=v[0];
for(ulong i=1; i<v.Size(); i++)
{
double real=MathAbs(v[i]);
if(max_norm<real)
max_norm=real;
if(min_norm>real)
min_norm=real;
}
max_norm=MathSqrt(max_norm);
min_norm=MathSqrt(min_norm);
if(min_norm>0.0)
norm=max_norm/min_norm;
}
return(norm);
}
Function Action
Solve
S olve a linear matrix equation, or system of linear algebraic equations.
vector matrix::Solve(
const vector b // ordinate or 'dependent variable' values
);
Parameters
b
[in] Ordinate or 'dependent variable' values. (Vector of free terms).
Return Value
Note
If at least one matrix row or column is zero, the system has no solution.
If two or more matrix rows or columns are linearly dependent, the system has no solution.
Example
LstSq
R eturn the least-s quares solution of linear algebraic equations (for non-s quare or degenerate
matrices).
vector matrix::LstSq(
const vector b // ordinate or 'dependent variable' values
);
Parameters
b
[in] Ordinate or 'dependent variable' values. (Vector of free terms)
Return Value
Vector with solution to the system a * x = b. This is true only for systems that have an exact
solution.
Example
/*
x=[5.000000000000002,-4]
b1=[7.000000000000005,40.00000000000001,3.000000000000005]
*/
Inv
Compute the multiplicative inverse of a s quare invertible matrix by the Jordan-Gauss method.
matrix matrix::Inv()
Return Value
Note
The product of the original matrix and the inverse matrix is the identity matrix.
If at least one matrix row or column is zero, the inverse matrix cannot be obtained.
If two or more matrix rows or columns are linearly dependent, the inverse matrix cannot be
obtained.
Example
{
if(identity[i][j]!=value)
{
double diff=MathAbs(identity[i][j]-value);
//--- too many multiplications and devisions, so reduce the check accuracy
if(diff>1e-9)
errors++;
}
}
}
}
//---
double elapsed_time=double(t2-t1)/1000.0;
printf("Inversion of matrix %d x %d %s errors=%d time=%.3f ms",size_m,size_m,errors==0?"passe
return(errors);
}
PInv
Compute the pseudo-inverse of a matrix by the Moore-Penrose method.
matrix matrix::PInv()
Return Value
Example
Machine learning
These methods are used in machine learning.
The neural network activation function determines the output value of a neuron depending on the
weighted sum of inputs. The selection of the activation function has a big impact on the neural
network performance. Different model parts (layers) can use different activation functions.
In addition to all known activation functions, MQL5 also offers their derivatives. Function derivatives
enable an efficient update of model parameters based on the error received in learning.
A neural network aims at finding an algorithm that minimizes the error in learning, for which the loss
function is used. The value of the loss function indicates by how much the value predicted by the
model deviates from the real one. Different loss functions are used depending on the problem. For
example, Mean Squared Error (M SE) is used for regression problems, and Binary Cross-Entropy (BCE) is
used for binary classification purposes.
Function Action
Activation Compute activation function values and write them to the passed
vector/matrix
Derivative Compute activation function derivative values and write them to the
passed vector/matrix
Loss Compute loss function values and write them to the passed
vector/matrix
Loss Gradient Compute a vector or matrix of loss function gradients
R egressionMetric Compute the regression metric as the deviation error from the
regression line constructed on the specified data array
ConfusionMatrix Compute confusion matrix. The method is applied to the vector of
predicted values
ConfusionMatrixMultilabel Compute confusion matrix for each label. The method is applied to
the vector of predicted values
ClassificationMetric Compute the classification metric to evaluate the quality of the
predicted data compared to the true data The method is applied to
the vector of predicted values
ClassificationS core Compute the classification metric to evaluate the quality of the
predicted data compared to the true data
Example
This example demonstrates the training of a model using matrix operations. The model is trained for
the function (a + b + c)^2 / (a^2 + b^2 + c^2). W e input the initial data matrix, in which a, b and c are
contained in different columns. The function result is obtained at the model output.
matrix weights1, weights2, weights3; // matrices of weights
matrix output1, output2, result; // matrices of neural layer outputs
input int layer1 = 200; // the size of the first hidden layer
input int layer2 = 200; // the size of the second hidden layer
input int Epochs = 20000; // the number of training epochs
input double lr = 3e-6; // learning rate
input ENUM_ACTIVATION_FUNCTION ac_func = AF_SWISH; // activation function
//+------------------------------------------------------------------+
//| Script start function |
//+------------------------------------------------------------------+
void OnStart()
{
//---
int train = 1000; // training sample size
int test = 10; // test sample size
matrix m_data, m_target;
//--- generate a training sample
if(!CreateData(m_data, m_target, train))
return;
//--- train the model
if(!Train(m_data, m_target, Epochs))
return;
//--- generate a test sample
if(!CreateData(m_data, m_target, test))
return;
//--- test the model
Test(m_data, m_target);
}
//+------------------------------------------------------------------+
//| Sample generation method |
//+------------------------------------------------------------------+
bool CreateData(matrix &data, matrix &target, const int count)
{
//--- initialize the initial data and result matrices
if(!data.Init(count, 3) || !target.Init(count, 1))
return false;
//--- fill the initial data matrix with random values
data.Random(-10, 10);
//--- calculate the target values for the training sample
vector X1 = MathPow(data.Col(0) + data.Col(1) + data.Col(1), 2);
vector X2 = MathPow(data.Col(0), 2) + MathPow(data.Col(1), 2) + MathPow(data.Col(2), 2);
if(!target.Col(X1 / X2, 0))
return false;
//--- return result
return true;
}
//+------------------------------------------------------------------+
//| Model training method |
//+------------------------------------------------------------------+
bool Train(matrix &data, matrix &target, const int epochs = 10000)
{
//--- create the model
if(!CreateNet())
return false;
//--- train the model
for(int ep = 0; ep < epochs; ep++)
{
//--- feedforward pass
if(!FeedForward(data))
return false;
PrintFormat("Epoch %d, loss %.5f", ep, result.Loss(target, LOSS_MSE));
//--- backpropagation and update of weight matrix
if(!Backprop(data, target))
return false;
}
//--- return result
return true;
}
//+------------------------------------------------------------------+
//| Model creation method |
//+------------------------------------------------------------------+
bool CreateNet()
{
//--- initialize weight matrices
if(!weights1.Init(4, layer1) || !weights2.Init(layer1 + 1, layer2) || !weights3.Init(layer2 + 1,
return false;
//--- fill the weight matrices with random values
weights1.Random(-0.1, 0.1);
weights2.Random(-0.1, 0.1);
weights3.Random(-0.1, 0.1);
//--- return result
return true;
}
//+------------------------------------------------------------------+
//| Feedforward method |
//+------------------------------------------------------------------+
bool FeedForward(matrix &data)
{
//--- check the initial data size
if(data.Cols() != weights1.Rows() - 1)
return false;
//--- calculate the first neural layer
matrix temp = data;
if(!temp.Resize(temp.Rows(), weights1.Rows()) ||
!temp.Col(vector::Ones(temp.Rows()), weights1.Rows() - 1))
return false;
output1 = temp.MatMul(weights1);
//--- calculate the activation function
if(!output1.Activation(temp, ac_func))
return false;
//--- calculate the second neural layer
if(!temp.Resize(temp.Rows(), weights2.Rows()) ||
!temp.Col(vector::Ones(temp.Rows()), weights2.Rows() - 1))
return false;
output2 = temp.MatMul(weights2);
//--- calculate the activation function
if(!output2.Activation(temp, ac_func))
return false;
//--- calculate the third neural layer
if(!temp.Resize(temp.Rows(), weights3.Rows()) ||
!temp.Col(vector::Ones(temp.Rows()), weights3.Rows() - 1))
return false;
result = temp.MatMul(weights3);
//--- return result
return true;
}
//+------------------------------------------------------------------+
//| Backpropagation method |
//+------------------------------------------------------------------+
bool Backprop(matrix &data, matrix &target)
{
//--- check the size of the matrix of target values
if(target.Rows() != result.Rows() ||
target.Cols() != result.Cols())
return false;
//--- determine the deviation of calculated values from target
matrix loss = (target - result) * 2;
//--- propagate the gradient to the previous layer
matrix gradient = loss.MatMul(weights3.Transpose());
//--- update the wight matrix of the last layer
matrix temp;
if(!output2.Activation(temp, ac_func))
return false;
if(!temp.Resize(temp.Rows(), weights3.Rows()) ||
!temp.Col(vector::Ones(temp.Rows()), weights3.Rows() - 1))
return false;
weights3 = weights3 + temp.Transpose().MatMul(loss) * lr;
//--- adjust the error gradient by the derivative of the activation function
if(!output2.Derivative(temp, ac_func))
return false;
if(!gradient.Resize(gradient.Rows(), gradient.Cols() - 1))
return false;
loss = gradient * temp;
//--- propagate the gradient to a lower layer
gradient = loss.MatMul(weights2.Transpose());
//--- update the weight matrix of the second hidden layer
if(!output1.Activation(temp, ac_func))
return false;
if(!temp.Resize(temp.Rows(), weights2.Rows()) ||
!temp.Col(vector::Ones(temp.Rows()), weights2.Rows() - 1))
return false;
weights2 = weights2 + temp.Transpose().MatMul(loss) * lr;
//--- adjust the error gradient by the derivative of the activation function
if(!output1.Derivative(temp, ac_func))
return false;
if(!gradient.Resize(gradient.Rows(), gradient.Cols() - 1))
return false;
loss = gradient * temp;
//--- update the weight matrix of the first hidden layer
temp = data;
if(!temp.Resize(temp.Rows(), weights1.Rows()) ||
!temp.Col(vector::Ones(temp.Rows()), weights1.Rows() - 1))
return false;
weights1 = weights1 + temp.Transpose().MatMul(loss) * lr;
//--- return result
return true;
}
//+------------------------------------------------------------------+
//| Model testing method |
//+------------------------------------------------------------------+
bool Test(matrix &data, matrix &target)
{
//--- feedfarward on test data
if(!FeedForward(data))
return false;
//--- log the model calculation results and true values
PrintFormat("Test loss %.5f", result.Loss(target, LOSS_MSE));
ulong total = data.Rows();
for(ulong i = 0; i < total; i++)
PrintFormat("(%.2f + %.2f + %.2f)^2 / (%.2f^2 + %.2f^2 + %.2f^2) = Net %.2f, Target %.2f", d
data[i, 0], data[i, 1], data[i, 2], result[i, 0], target[i, 0]);
//--- return result
return true;
}
//+------------------------------------------------------------------+
Activation
Compute activation function values and write them to the passed vector/matrix.
bool vector::Activation(
vector& vect_out, // vector to get values
ENUM_ACTIVATION_FUNCTION activation, // activation function
... // additional parameters
);
bool matrix::Activation(
matrix& matrix_out, // matrix to get values
ENUM_ACTIVATION_FUNCTION activation // activation function
);
bool matrix::Activation(
matrix& matrix_out, // matrix to get values
ENUM_ACTIVATION_FUNCTION activation, // activation function
ENUM_MATRIX_AXIS axis, // axis
... // additional parameters
);
Parameters
vect_out/matrix_out
[out] Vector or matrix to get the computed values of the activation function.
activation
[in] Activation function from the ENUM _ACTIVATION_FUNCTION enumeration.
axis
[in] ENUM _M AT R IX_AXIS enumeration value (AXIS_HORZ — horizontal axis, AXIS_VER T — vertical
axis).
...
[in] Additional parameters required for some activation functions. If no parameters are specified,
default values are used.
Return Value
Additional Parameters
S ome activation functions accept additional parameters. If no parameters are specified, default
values are used
AF_LINEAR
double alpha=1.0
double beta=0.0
AF_SWISH
double beta=1.0
Note
In artificial neural networks, the activation function of a neuron determines the output signal, which
is defined by an input signal or a set of input signals. The selection of the activation function has a
big impact on the neural network performance. Different model parts (layers) can use different
activation functions.
x.Activation(y,AF_ELU);
Print(y);
x.Activation(y,AF_ELU,2.0);
Print(y);
Print("");
x.Activation(y,AF_LINEAR);
Print(y);
x.Activation(y,AF_LINEAR,2.0);
Print(y);
x.Activation(y,AF_LINEAR,2.0,5.0);
Print(y);
Print("");
x.Activation(y,AF_LRELU);
Print(y);
x.Activation(y,AF_LRELU,1.0);
Print(y);
x.Activation(y,AF_LRELU,0.1);
Print(y);
Print("");
x.Activation(y,AF_RELU);
Print(y);
x.Activation(y,AF_RELU,2.0,0.5);
Print(y);
x.Activation(y,AF_RELU,2.0,0.5,1.0);
Print(y);
Print("");
x.Activation(y,AF_SWISH);
Print(y);
x.Activation(y,AF_SWISH,2.0);
Print(y);
Print("");
x.Activation(y,AF_TRELU);
Print(y);
x.Activation(y,AF_TRELU,0.3);
Print(y);
Print("");
vector a=vector::Full(x.Size(),2.0);
x.Activation(y,AF_PRELU,a);
Print(y);
/* Results
[0.1,0.4,0.9,2,-0.993262053000915,0,-0.095162581964040]
[0.1,0.4,0.9,2,-1.986524106001829,0,-0.190325163928081]
[0.1,0.4,0.9,2,-5,0,-0.1]
[0.2,0.8,1.8,4,-10,0,-0.2]
[5.2,5.8,6.8,9,-5,5,4.8]
[0.1,0.4,0.9,2,-1.5,0,-0.03]
[0.1,0.4,0.9,2,-5,0,-0.1]
[0.1,0.4,0.9,2,-0.5,0,-0.01]
[0.1,0.4,0.9,2,0,0,0]
[0.2,0.8,0.9,2,-10,0,-0.2]
[-1.8,-1.2,0.9,2,-12,-2,-2.2]
[0.052497918747894,0.239475064044981,0.6398545523625035,1.761594155955765,-0.03346425462142428,0
[0.054983399731247,0.275989792451045,0.7723340415895611,1.964027580075817,-0.00022698934351217,0
[0,0,0,2,0,0,0]
[0,0.4,0.9,2,0,0,0]
[0.1,0.4,0.9,2,-10,0,-0.2]
*/
Derivative
Compute activation function derivative values and write them to the passed vector/matrix
bool vector::Derivative(
vector& vect_out, // vector to get values
ENUM_ACTIVATION_FUNCTION activation, // activation function
... // additional parameters
);
bool matrix::Derivative(
matrix& matrix_out, // matrix to get values
ENUM_ACTIVATION_FUNCTION activation, // activation function
);
bool matrix::Derivative(
matrix& matrix_out, // matrix to get values
ENUM_ACTIVATION_FUNCTION activation, // activation function
ENUM_MATRIX_AXIS axis, // axis
... // additional parameters
);
Parameters
vect_out/matrix_out
[out] Vector or matrix to get the computed values of the derivative of the activation function.
activation
[in] Activation function from the ENUM _ACTIVATION_FUNCTION enumeration.
axis
[in] ENUM _M AT R IX_AXIS enumeration value (AXIS_HORZ — horizontal axis, AXIS_VER T — vertical
axis).
...
[in] Additional parameters are the same as that of the activation functions. Only some activation
functions accept additional parameters. If no parameters are specified, default values are used.
Return Value
Note
Function derivatives enable an efficient update of model parameters based on the error received in
learning during the error backpropagation.
Loss
Compute the value of the loss function.
double vector::Loss(
const vector& vect_true, // vector of true values
ENUM_LOSS_FUNCTION loss, // loss function
... // additional parameter
);
double matrix::Loss(
const matrix& matrix_true, // matrix of true values
ENUM_LOSS_FUNCTION loss, // loss function
);
double matrix::Loss(
const matrix& matrix_true, // matrix of true values
ENUM_LOSS_FUNCTION loss, // loss function
ENUM_MATRIX_AXIS axis, // axis
... // additional parameter
);
Parameters
vect_true/matrix_true
[in] Vector or matrix of true values.
loss
[in] Loss function from the ENUM _LOSS_FUNCTION enumeration.
axis
[in] ENUM _M AT R IX_AXIS enumeration value (AXIS_HORZ — horizontal axis, AXIS_VER T — vertical
axis).
...
[in] Additional parameter 'delta' can only be used by the H ubert loss function (LOSS_HUBER)
Return Value
double value.
How the 'delta' parameter is used in the Hubert loss function (LOSS_HUBER)
double delta = 1.0;
double error = fabs(y - x);
if(error<delta)
loss = 0.5 * error^2;
else
Note
Aneural network aims at finding the algorithms that minimize the error on the training sample, for
which the loss function is used.
The value of the loss function indicates by how much the value predicted by the model deviates from
the real one.
Different lossfunctions are used depending on the problem. For example, Mean Squared Error (M SE)
is used for regression problems, and Binary Cross-Entropy (BCE) is used for binary classification
purposes.
/* Result
0.155
0.15125
*/
LossGradient
Compute a vector or matrix of loss function gradients.
vector vector::LossGradient(
const vector& vect_true, // vector of true values
ENUM_LOSS_FUNCTION loss, // loss function type
... // additional parameter
);
matrix matrix::LossGradient(
const matrix& matrix_true, // matrix of true values
ENUM_LOSS_FUNCTION loss, // loss function
);
matrix matrix::LossGradient(
const matrix& matrix_true, // matrix of true values
ENUM_LOSS_FUNCTION loss, // loss function
ENUM_MATRIX_AXIS axis, // axis
... // additional parameter
);
Parameters
vect_true/matrix_true
[in] Vector or matrix of true values.
loss
[in] Loss function from the ENUM _LOSS_FUNCTION enumeration.
axis
[in] ENUM _M AT R IX_AXIS enumeration value (AXIS_HORZ — horizontal axis, AXIS_VER T — vertical
axis).
...
[in] Additional parameter 'delta' can only be used by the H ubert loss function (LOSS_HUBER)
Return Value
Vector or matrix of loss function gradient values. The gradient is the partial derivative with respect
to dx (x is the predicted value) of the loss function at a given point.
Note
Gradients are used in neural networks to adjust the weight matrix weights during backpropagation,
when training the model.
Aneural network aims at finding the algorithms that minimize the error on the training sample, for
which the loss function is used.
Different lossfunctions are used depending on the problem. For example, Mean Squared Error (M SE)
is used for regression problems, and Binary Cross-Entropy (BCE) is used for binary classification
purposes.
matrixf y_true={{ 1, 2, 3, 4 },
{ 5, 6, 7, 8 },
{ 9,10,11,12 }};
matrixf y_pred={{ 1, 2, 3, 4 },
{11,10, 9, 8 },
{ 5, 6, 7,12 }};
matrixf loss_gradient =y_pred.LossGradient(y_true,LOSS_MAE);
matrixf loss_gradienth=y_pred.LossGradient(y_true,LOSS_MAE,AXIS_HORZ);
matrixf loss_gradientv=y_pred.LossGradient(y_true,LOSS_MAE,AXIS_VERT);
Print("loss gradients\n",loss_gradient);
Print("loss gradients on horizontal axis\n",loss_gradienth);
Print("loss gradients on vertical axis\n",loss_gradientv);
/* Result
loss gradients
[[0,0,0,0]
[0.083333336,0.083333336,0.083333336,0]
[-0.083333336,-0.083333336,-0.083333336,0]]
loss gradients on horizontal axis
[[0,0,0,0]
[0.33333334,0.33333334,0.33333334,0]
[-0.33333334,-0.33333334,-0.33333334,0]]
loss gradients on vertical axis
[[0,0,0,0]
[0.25,0.25,0.25,0]
[-0.25,-0.25,-0.25,0]]
*/
RegressionMetric
Compute the regression metric to evaluate the quality of the predicted data compared to the true data
double vector::RegressionMetric(
const vector& vector_true, // vector of true values
ENUM_REGRESSION_METRIC metric // metric type
);
double matrix::RegressionMetric(
const matrix& matrix_true, // matrix of true values
ENUM_REGRESSION_METRIC metric // metric type
);
vector matrix::RegressionMetric(
const matrix& matrix_true, // matrix of true values
ENUM_REGRESSION_METRIC metric, // metric type
int axis // axis
);
Parameters
vector_true/matrix_true
[in] Vector or matrix of true values.
metric
[in] Metric type from the ENUM _REGRESS ION_M ETRIC enumeration.
axis
[in] Axis. 0 — horizontal axis, 1 — vertical axis.
Return Value
The calculated metric which evaluates the quality of the predicted data compared to the true data.
Note
· REGRESS ION_M AE — mean absolute error which represents the absolute differences between
predicted values and corresponding true values
· REGRESS ION_M SE — mean s quare error which represents the s quared differences between
predicted values and corresponding true values
· REGRESS ION_R M SE — s quare root of M SE
· REGRESS ION_R2 - 1 — M SE(regression) / M SE(mean)
· REGRESS ION_M APE — M AE as a percentage
· REGRESS ION_M S PE — M SE as a percentage
· REGRESS ION_R M S L E — R M SE computed on a logarithmic scale
Example:
/* Result
mae=0.375
mse=0.5
r2=0.9486081370449679
*/
ConfusionMatrix
Compute confusion matrix. The method is applied to the vector of predicted values.
matrix vector::ConfusionMatrix(
const vector& vect_true // vector of true values
);
matrix vector::ConfusionMatrix(
const vector& vect_true, // vector of true values
uint label // label value
);
Parameters
vect_true
[in] Vector of true values.
label
[in] Label value for calculating the confusion matrix.
Return Value
Confusion matrix. If a label value is not specified, a multi-class confusion matrix is returned, where
each label is matched to each other label individually. If a label value is specified, a 2 x 2 matrix is
returned, in which the specified label is considered positive, while all other labels are negative (ovr,
one vs rest).
Note
Confusion matrix C is such that Cij is equal to the number of observations known to be in group i
and predicted to be in group j. Thus in binary classification, the count of true negatives (TN) is C00,
false negatives (FN) is C10, true positives (TP) is C11 and false positives (FP) is C01.
In other words, the matrix can be graphically represented as follows :
TN FP
FN TP
The sizes of the vector of true values and the vector of predicted values should be the same.
Example:
vector y_true={7,2,1,0,4,1,4,9,5,9,0,6,9,0,1,5,9,7,3,4,8,4,2,7,6,8,4,2,3,6};
vector y_pred={7,2,1,0,4,1,4,9,5,9,0,6,9,0,1,5,9,7,3,4,2,9,4,9,5,9,2,7,7,0};
matrix confusion=y_pred.ConfusionMatrix(y_true);
Print(confusion);
confusion=y_pred.ConfusionMatrix(y_true,0);
Print(confusion);
confusion=y_pred.ConfusionMatrix(y_true,1);
Print(confusion);
confusion=y_pred.ConfusionMatrix(y_true,2);
Print(confusion);
/*
[[3,0,0,0,0,0,0,0,0,0]
[0,3,0,0,0,0,0,0,0,0]
[0,0,1,0,1,0,0,1,0,0]
[0,0,0,1,0,0,0,1,0,0]
[0,0,1,0,3,0,0,0,0,1]
[0,0,0,0,0,2,0,0,0,0]
[1,0,0,0,0,1,1,0,0,0]
[0,0,0,0,0,0,0,2,0,1]
[0,0,1,0,0,0,0,0,0,1]
[0,0,0,0,0,0,0,0,0,4]]
[[26,1]
[0,3]]
[[27,0]
[0,3]]
[[25,2]
[2,1]]
*/
ConfusionMatrixMultilabel
Compute confusion matrix for each label. The method is applied to the vector of predicted values.
uint vector::ConfusionMatrixMultiLabel(
const vector& vect_true, // vector of true values
matrix& confusions[] // array of calculated confusion matrices
);
Parameters
vect_true
[in] Vector of true values.
confusions
[out] An array of 2 x 2 matrices with computed confusion matrices for each label.
Return Value
Note
The result array can be dynamic or static. If the array is static, then it must be no less in size than
the number of classes.
The sizes of the vector of true values and the vector of predicted values should be the same.
Example:
vector y_true={7,2,1,0,4,1,4,9,5,9,0,6,9,0,1,5,9,7,3,4,8,4,2,7,6,8,4,2,3,6};
vector y_pred={7,2,1,0,4,1,4,9,5,9,0,6,9,0,1,5,9,7,3,4,2,9,4,9,5,9,2,7,7,0};
matrix label_confusions[12];
uint res=y_pred.ConfusionMatrixMultiLabel(y_true,label_confusions);
Print("res=",res," size=",label_confusions.Size());
for(uint i=0; i<res; i++)
Print(label_confusions[i]);
/*
res=10 size=12
[[26,1]
[0,3]]
[[27,0]
[0,3]]
[[25,2]
[2,1]]
[[28,0]
[1,1]]
[[24,1]
[2,3]]
[[27,1]
[0,2]]
[[27,0]
[2,1]]
[[25,2]
[1,2]]
[[28,0]
[2,0]]
[[23,3]
[0,4]]
*/
ClassificationMetric
Compute the classification metric to evaluate the quality of the predicted data compared to the true
data. The method is applied to the vector of predicted values.
vector vector::ClassificationMetric(
const vector& vect_true, // vector of true values
ENUM_CLASSIFICATION_METRIC metric // metric type
);
vector vector::ClassificationMetric(
const vector& vect_true, // vector of true values
ENUM_CLASSIFICATION_METRIC metric // metric type
ENUM_AVERAGE_MODE mode // averaging mode
);
Parameters
vect_true
[in] Vector of true values.
metric
[in] Metric type from the ENUM _CL ASS IFICATION_M ET R IC enumeration. Values other than
CLASS IFICATION_TOP_K_ACCURACY, CLASS IFICATION_AVERAGE_PRECIS ION and
CLASS IFICATION_ROC_AUC (used in the ClassificationS core method) are applied.
mode
[in] Averaging mode from the ENUM _AVERAGE_MODE enumeration. Used for the
CLASS IFICATION_F1, CLASS IFICATION_JACCARD, CLASS IFICATION_PRECIS ION and
CLASS IFICATION_RECALL metrics.
Return Value
A vector containing the calculated metric. In the case of the AVERAGE_NONE averaging mode, the
vector contains metric values for each class without averaging. (For example, in case of the binary
classification, this would be two metrics for 'false' and 'true' respectively).
Note
In case of binary classification, we can input not only an n x 2 matrix, where the first column
contains probabilities for a negative label, and the second column contains probabilities for a
positive label, but also a matrix consisting of one column with positive probabilities. This is because
binary classification models can return either two probabilities or one probability for a positive label.
Example:
vector y_true={7,2,1,0,4,1,4,9,5,9,0,6,9,0,1,5,9,7,3,4,8,4,2,7,6,8,4,2,3,6};
vector y_pred={7,2,1,0,4,1,4,9,5,9,0,6,9,0,1,5,9,7,3,4,2,9,4,9,5,9,2,7,7,0};
vector accuracy=y_pred.ClassificationMetric(y_true,CLASSIFICATION_ACCURACY);
Print("accuracy=",accuracy);
vector balanced=y_pred.ClassificationMetric(y_true,CLASSIFICATION_BALANCED_ACCURACY);
Print("balanced=",balanced);
Print("");
vector f1_micro=y_pred.ClassificationMetric(y_true,CLASSIFICATION_F1,AVERAGE_MICRO);
Print("f1_micro=",f1_micro);
vector f1_macro=y_pred.ClassificationMetric(y_true,CLASSIFICATION_F1,AVERAGE_MACRO);
Print("f1_macro=",f1_macro);
vector f1_weighted=y_pred.ClassificationMetric(y_true,CLASSIFICATION_F1,AVERAGE_WEIGHTED);
Print("f1_weighted=",f1_weighted);
vector f1_none=y_pred.ClassificationMetric(y_true,CLASSIFICATION_F1,AVERAGE_NONE);
Print("f1_none=",f1_none);
Print("");
vector jaccard_micro=y_pred.ClassificationMetric(y_true,CLASSIFICATION_JACCARD,AVERAGE_MICRO);
Print("jaccard_micro=",jaccard_micro);
vector jaccard_macro=y_pred.ClassificationMetric(y_true,CLASSIFICATION_JACCARD,AVERAGE_MACRO);
Print("jaccard_macro=",jaccard_macro);
vector jaccard_weighted=y_pred.ClassificationMetric(y_true,CLASSIFICATION_JACCARD,AVERAGE_WEIGHT
Print("jaccard_weighted=",jaccard_weighted);
vector jaccard_none=y_pred.ClassificationMetric(y_true,CLASSIFICATION_JACCARD,AVERAGE_NONE);
Print("jaccard_none=",jaccard_none);
Print("");
vector precision_micro=y_pred.ClassificationMetric(y_true,CLASSIFICATION_PRECISION,AVERAGE_MICRO
Print("precision_micro=",precision_micro);
vector precision_macro=y_pred.ClassificationMetric(y_true,CLASSIFICATION_PRECISION,AVERAGE_MACRO
Print("precision_macro=",precision_macro);
vector precision_weighted=y_pred.ClassificationMetric(y_true,CLASSIFICATION_PRECISION,AVERAGE_WE
Print("precision_weighted=",precision_weighted);
vector precision_none=y_pred.ClassificationMetric(y_true,CLASSIFICATION_PRECISION,AVERAGE_NONE);
Print("precision_none=",precision_none);
Print("");
vector recall_micro=y_pred.ClassificationMetric(y_true,CLASSIFICATION_RECALL,AVERAGE_MICRO);
Print("recall_micro=",recall_micro);
vector recall_macro=y_pred.ClassificationMetric(y_true,CLASSIFICATION_RECALL,AVERAGE_MACRO);
Print("recall_macro=",recall_macro);
vector recall_weighted=y_pred.ClassificationMetric(y_true,CLASSIFICATION_RECALL,AVERAGE_WEIGHTED
Print("recall_weighted=",recall_weighted);
vector recall_none=y_pred.ClassificationMetric(y_true,CLASSIFICATION_RECALL,AVERAGE_NONE);
Print("recall_none=",recall_none);
Print("");
vector f1_bin=y_pred_bin.ClassificationMetric(y_true_bin,CLASSIFICATION_F1,AVERAGE_BINARY);
Print("f1_bin=",f1_bin);
vector jaccard_bin=y_pred_bin.ClassificationMetric(y_true_bin,CLASSIFICATION_JACCARD,AVERAGE_BIN
Print("jaccard_bin=",jaccard_bin);
vector precision_bin=y_pred_bin.ClassificationMetric(y_true_bin,CLASSIFICATION_PRECISION,AVERAGE
Print("precision_bin=",precision_bin);
vector recall_bin=y_pred_bin.ClassificationMetric(y_true_bin,CLASSIFICATION_RECALL,AVERAGE_BINAR
Print("recall_bin=",recall_bin);
/*
accuracy=[0.6666666666666666]
balanced=[0.6433333333333333]
f1_micro=[0.6666666666666666]
f1_macro=[0.6122510822510823]
f1_weighted=[0.632049062049062]
f1_none=[0.8571428571428571,1,0.3333333333333333,0.6666666666666666,0.6666666666666665,0.8,0.5,0.
jaccard_micro=[0.5]
jaccard_macro=[0.4921428571428572]
jaccard_weighted=[0.5056349206349205]
jaccard_none=[0.75,1,0.2,0.5,0.5,0.6666666666666666,0.3333333333333333,0.4,0,0.5714285714285714]
precision_micro=[0.6666666666666666]
precision_macro=[0.6571428571428571]
precision_weighted=[0.6706349206349207]
precision_none=[0.75,1,0.3333333333333333,1,0.75,0.6666666666666666,1,0.5,0,0.5714285714285714]
recall_micro=[0.6666666666666666]
recall_macro=[0.6433333333333333]
recall_weighted=[0.6666666666666666]
recall_none=[1,1,0.3333333333333333,0.5,0.6,1,0.3333333333333333,0.6666666666666666,0,1]
f1_bin=[0.4444444444444445]
jaccard_bin=[0.2857142857142857]
precision_bin=[0.5]
recall_bin=[0.4]
*/
ClassificationScore
Compute the classification metric to evaluate the quality of the predicted data compared to the true
data.
Unlik eother methods in the Machine Learning section, this one applies to the vector of true values
rather than the vector of predicted values.
vector vector::ClassificationScore(
const matrix& pred_scores, // matrix containing probability distribution for each
ENUM_CLASSIFICATION_METRIC metric // metric type
ENUM_AVERAGE_MODE mode // averaging mode
);
vector vector::ClassificationScore(
const matrix& pred_scores, // matrix containing probability distribution for each
ENUM_CLASSIFICATION_METRIC metric // metric type
int param // additional parameter
);
Parameters
pred_scores
[in] Amatrix containing a set of horizontal vectors with probabilities for each class. The number
of matrix rows should correspond to the size of the vector of true values.
metric
[in] Metric type from the ENUM _CLASS IFICATION_M ETRIC enumeration. The
CLASS IFICATION_TOP_K_ACCURACY, CLASS IFICATION_AVERAGE_PRECIS ION and
CLASS IFICATION_ROC_AUC values are used.
mode
[in] Averaging mode from the ENUM _AVERAGE_MODE enumeration. Used for the
CLASS IFICATION_AVERAGE_PRECIS ION and CLASS IFICATION_ROC_AUC metrics.
param
[in] In case of the CLASS IFICATION_TOP_K_ACCURACY metric, the integer K value should be
specified instead of the averaging mode.
Return Value
A vector containing the calculated metric. In the case of the AVERAGE_NONE averaging mode, the
vector contains metric values for each class without averaging. (For example, in case of the binary
classification, this would be two metrics for 'false' and 'true' respectively).
AVERAGE_MICR O — calculate metrics globally by counting the total true positives, false negatives
and false positives.
AVERAGE_M ACR O — calculate metrics for each label and find their unweighted mean. This does not
take label imbalance into account.
AVERAGE_WEIGH T ED — calculate metrics for each label and find their average weighted by support
(the number of true instances for each label).
Note
In case of binary classification, we can input not only an n x 2 matrix, where the first column
contains probabilities for a negative label, and the second column contains probabilities for a
positive label, but also a matrix consisting of one column with positive probabilities. This is because
binary classification models can return either two probabilities or one probability for a positive label.
Example:
vector y_true={7,2,1,0,4,1,4,9,5,9,0,6,9,0,1,5,9,7,3,4,8,4,2,7,6,8,4,2,3,6};
//vector y_pred={7,2,1,0,4,1,4,9,5,9,0,6,9,0,1,5,9,7,3,4,2,9,4,9,5,9,2,7,7,0};
vector top_k=y_true.ClassificationScore(y_scores,CLASSIFICATION_TOP_K_ACCURACY,1);
Print("top 1 accuracy score = ",top_k);
top_k=y_true.ClassificationScore(y_scores,CLASSIFICATION_TOP_K_ACCURACY,2);
Print("top 2 accuracy score = ",top_k);
vector y_true2={0, 1, 2, 2};
matrix y_score2={{0.5, 0.2, 0.2}, // 0 is in top 2
{0.3, 0.4, 0.2}, // 1 is in top 2
{0.2, 0.4, 0.3}, // 2 is in top 2
{0.7, 0.2, 0.1}}; // 2 isn't in top 2
top_k=y_true2.ClassificationScore(y_score2,CLASSIFICATION_TOP_K_ACCURACY,2);
Print("top k = ",top_k);
Print("");
vector ap_micro=y_true.ClassificationScore(y_scores,CLASSIFICATION_AVERAGE_PRECISION,AVERAGE_MIC
Print("average precision score micro = ",ap_micro);
vector ap_macro=y_true.ClassificationScore(y_scores,CLASSIFICATION_AVERAGE_PRECISION,AVERAGE_MAC
Print("average precision score macro = ",ap_macro);
vector ap_weighted=y_true.ClassificationScore(y_scores,CLASSIFICATION_AVERAGE_PRECISION,AVERAGE_
Print("average precision score weighted = ",ap_weighted);
vector ap_none=y_true.ClassificationScore(y_scores,CLASSIFICATION_AVERAGE_PRECISION,AVERAGE_NONE
Print("average precision score none = ",ap_none);
Print("");
vector area_micro=y_true.ClassificationScore(y_scores,CLASSIFICATION_ROC_AUC,AVERAGE_MICRO);
Print("roc auc score micro = ",area_micro);
vector area_macro=y_true.ClassificationScore(y_scores,CLASSIFICATION_ROC_AUC,AVERAGE_MACRO);
Print("roc auc score macro = ",area_macro);
vector area_weighted=y_true.ClassificationScore(y_scores,CLASSIFICATION_ROC_AUC,AVERAGE_WEIGHTED
Print("roc auc score weighted = ",area_weighted);
vector area_none=y_true.ClassificationScore(y_scores,CLASSIFICATION_ROC_AUC,AVERAGE_NONE);
Print("roc auc score none = ",area_none);
Print("");
{0.8, 0.2},
{0.2, 0.8}};
vector ap=y_true_bin.ClassificationScore(y_scores_bin,CLASSIFICATION_AVERAGE_PRECISION,AVERAGE_B
Print("average precision score binary = ",ap);
vector ap2=y_true_bin.ClassificationScore(y_score1_bin,CLASSIFICATION_AVERAGE_PRECISION,AVERAGE_
Print("average precision score binary = ",ap2);
vector ap3=y_true_bin.ClassificationScore(y_scores_bin,CLASSIFICATION_AVERAGE_PRECISION,AVERAGE_
Print("average precision score none = ",ap3);
Print("");
vector area=y_true_bin.ClassificationScore(y_scores_bin,CLASSIFICATION_ROC_AUC,AVERAGE_BINARY);
Print("roc auc score binary = ",area);
vector area2=y_true_bin.ClassificationScore(y_score1_bin,CLASSIFICATION_ROC_AUC,AVERAGE_BINARY);
Print("roc auc score binary = ",area2);
vector area3=y_true_bin.ClassificationScore(y_scores_bin,CLASSIFICATION_ROC_AUC,AVERAGE_NONE);
Print("roc auc score none = ",area3);
/*
top 1 accuracy score = [0.6666666666666666]
top 2 accuracy score = [1]
top k = [0.75]
Conversion Functions
This is a group of functions that provide conversion of data from one format into another.
The NormalizeDouble() function must be specially noted as it provides the necessary accuracy of the
price presentation. In trading operations, no unnormalized prices may be used if their accuracy even a
digit exceeds that required by the trade server.
Function Action
See also
Use of a Codepage
CharToString
Converting a symbol code into a one-character string.
string CharToString(
uchar char_code // numeric code of symbol
);
Parameters
char_code
[in] Code of ANS I symbol.
Return Value
CharArrayToString
It copies and converts part of array of uchar type into a returned string.
string CharArrayToString(
uchar array[], // array
int start=0, // starting position in the array
int count=-1 // number of symbols
uint codepage=CP_ACP // code page
);
Parameters
array[]
[in] Array of uchar type.
start=0
[in] Position from which copying starts. by default 0 is used.
count=-1
[in] Number of array elements for copying. Defines the length of a resulting string. Default value
is -1, which means copying up to the array end, or till terminal 0.
codepage=CP_ACP
[in]The value of the code page. There is a number of built-in constants for the most used code
pages.
Return Value
S tring.
See also
S tringToCharArray, S hortArrayToS tring, Use of a Codepage
CharArrayToStruct
Copy uchar type array to POD structure.
bool CharArrayToStruct(
void& struct_object, // structure
const uchar& char_array[], // array
uint start_pos=0 // starting position in the array
);
Parameters
struct_object
[in] R eference to any type of POD structure (containing only simple data types).
char_array[]
[in] uchar type array.
start_pos=0
[in] Position in the array, data copying starts from.
Return Value
StructToCharArray
Copy POD structure to uchar type array.
bool StructToCharArray(
const void& struct_object, // structure
uchar& char_array[], // array
uint start_pos=0 // starting position in the array
);
Parameters
struct_object
[in] R eference to any type of POD structure (containing only simple data types).
char_array[]
[in] uchar type array.
start_pos=0
[in] Position in the array, starting from which the copied data are added.
Return Value
W hen copying, the dynamic array automatically expands (ArrayResize) if there is not enough space.
If the array cannot be expanded up to the required value, the function returns an error.
See also
S tringToCharArray, S hortArrayToS tring,CharArrayToS truct, Use of a Codepage, FileW riteS truct,
Unions (union), MathS wap
ColorToARGB
The function converts color type into uint type to get ARGB representation of the color. ARGB color
format is used to generate a graphical resource, text display, as well as for CCanvas standard library
class.
uint ColorToARGB(
color clr, // converted color in color format
uchar alpha=255 // alpha channel managing color transparency
);
Parameters
clr
[in] Color value in color type variable.
alpha
[in] The value of the alpha channel used to receive the color in ARGB format. The value may be
set from 0 (a color of a foreground pixel does not change the display of an underlying one) up to
255 (a color of an underlying pixel is completely replaced by the foreground pixel's one). Color
transparency in percentage terms is calculated as (1-alpha/255)*100%. In other words, the lesser
value of the alpha channel leads to more transparent color.
Return Value
Presenting the color in ARGB format where Alfa, Red, Green, Blue (alpha channel, red, green, blue)
values are set in series in four uint type bytes.
Note
RGB is a basic and commonly used format for pixel color description on a screen in computer
graphics. Names of basic colors are used to set red, green and blue color components. Each
component is described by one byte specifying the color saturation in the range of 0 to 255 (0x00 to
0XFF in hexadecimal format). S ince the white color contains all colors, it is described as 0x FFFFFF,
that is, each one of three components is presented by the maximum value of 0xFF.
H owever, some tas ks require to specify the color transparency to describe the look of an image in
case it is covered by the color with some degree of transparency. The concept of alpha channel is
introduced for such cases. It is implemented as an additional component of RGB format. ARGB
format structure is shown below.
ARGB values are typically expressed using hexadecimal format with each pair of digits representing
the values of Alpha, Red, Green and Blue channels, respectively. For example, 80FFFF00 color
represents 50.2% opaque yellow. Initially, 0x80 sets 50.2% alpha value, as it is 50.2% of 0xFF value.
Then, the first FF pair defines the highest value of the red component; the next FF pair is like the
previous but for the green component; the final 00 pair represents the lowest value the blue
component can have (absence of blue). Combination of green and red colors yields yellow one. If the
alpha channel is not used, the entry can be reduced down to 6 RRGGBB digits, this is why the alpha
channel values are stored in the top bits of uint integer type.
Depending on the context, hexadecimal digits can be written with '0x' or '#' prefix, for example,
80FFFF00, 0x 80FFFF00 or #80FFFF00.
Example:
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- set transparency
uchar alpha=0x55; // 0x55 means 55/255=21.6 % of transparency
//--- derive conversion to ARGB for clrBlue color
PrintFormat("0x%.8X - clrBlue",clrBlue);
PrintFormat("0x%.8X - clrBlue ARGB with alpha=0x55 (transparency 21.6%%)",ColorToARGB(clrBlue,al
//--- derive conversion to ARGB for clrGreen color
PrintFormat("0x%.8X - clrGreen",clrGreen);
PrintFormat("0x%.8X - clrGreen ARGB with alpha=0x55 (transparency 21.6%%)",ColorToARGB(clrGreen,
//--- derive conversion to ARGB for clrRed color
PrintFormat("0x%.8X - clrRed",clrRed);
PrintFormat("0x%.8X - clrRed ARGB with alpha=0x55 (transparency 21.6%%)",ColorToARGB(clrRed,alph
}
See also
R esources, R esourceCreate(), TextOut(), color type, char, short, int and long types
ColorToString
It converts color value into string of "R,G,B" form.
string ColorToString(
color color_value, // color value
bool color_name // show color name or not
);
Parameters
color_value
[in] Color value in color type variable.
color_name
[in] R eturn color name if it is identical to one of predefined color constants.
Return Value
S tringpresentation of color as "R,G,B" , where R, G and B are decimal constants from 0 to 255
converted into a string. If the color_name=true parameter is set, it will try to convert color value
into color name.
Example:
See also
S tringToColor, ColorToARGB
DoubleToString
Converting numeric value into text string.
string DoubleToString(
double value, // number
int digits=8 // number of digits after decimal point
);
Parameters
value
[in] Value with a floating point.
digits
[in] Accuracy format. If the digits value is in the range between 0 and 16, a string presentation of
a number with the specified number of digits after the point will be obtained. If the digits value is
in the range between -1 and -16, a string representation of a number in the scientific format with
the specified number of digits after the decimal point will be obtained. In all other cases the string
value will contain 8 digits after the decimal point.
Return Value
See also
NormalizeDouble, S tringToDouble
EnumToString
Converting an enumeration value of any type to a text form.
string EnumToString(
any_enum value // any type enumeration value
);
Parameters
value
[in] Any type enumeration value.
Return Value
A string with a text representation of the enumeration. To get the error message call the
GetLastError() function.
Note
The function can set the following error values in the _LastError variable:
· ERR_I NT ERNAL _ERR OR – error of the execution environment
· ERR_NOT _ENOUGH_M EMORY – not enough memory to complete the operation
· ERR_I NVALI D_PARAM ET ER – can't allow the name of the enumeration value
Example:
//--- set the time interval equal to one year (12 months)
period=year;
Print(EnumToString(period)+"="+IntegerToString(period));
ENUM_ORDER_TYPE type=ORDER_TYPE_BUY;
Print(EnumToString(type)+"="+IntegerToString(type));
// Result:
// month=1
// quarter=3
// year=12
// ORDER_TYPE_BUY=0
// ENUM_ORDER_TYPE::-1=-1
}
See also
Enumerations, Input variables
IntegerToString
This function converts value of integer type into a string of a specified length and returns the obtained
string.
string IntegerToString(
long number, // number
int str_len=0, // length of result string
ushort fill_symbol=' ' // filler
);
Parameters
number
[in] Number for conversion.
str_len=0
[in] S tring length. If the resulting string length is larger than the specified one, the string is not
cut off. If it is smaller, filler symbols will be added to the left.
fill_symbol=' '
[in] Filler symbol. By default it is a space.
Return Value
S tring.
See also
S tringToInteger
ShortToString
It converts the symbol code (unicode) into one-symbol string and returns resulting string.
string ShortToString(
ushort symbol_code // symbol
);
Parameters
symbol_code
[in] S ymbol code. Instead of a symbol code you can use literal string containing a symbol or a
literal string with 2-byte hexadecimal code corresponding to the symbol from the Unicode table.
Return Value
S tring.
See also
S tringToCharArray, CharToS tring, S tringGetCharacter
ShortArrayToString
It copies part of array into a returned string.
string ShortArrayToString(
ushort array[], // array
int start=0, // starting position in the array
int count=-1 // number of symbols
);
Parameters
array[]
[in] Array of ushort type (analog of wchar_t type).
start=0
[in] Position, from which copying starts, Default - 0.
count=-1
[in] Number of array elements to copy. Defines the length of a resulting string. Default value is -
1, which means copying up to the array end, or till terminal 0.
Return Value
S tring.
See also
S tringToS hortArray, CharArrayToS tring, Use of a Codepage
TimeToString
Converting a value containing time in seconds elapsed since 01.01.1970 into a string of " yyyy.mm.dd
hh:mi" format.
string TimeToString(
datetime value, // number
int mode=TIME_DATE|TIME_MINUTES // output format
);
Parameters
value
[in] Time in seconds from 00:00 1970/01/01.
mode=TIME_DATE|TIME_MINUTES
[in] Additional data input mode. Can be one or combined flag:
TIM E_DATE gets result as " yyyy.mm.dd" ,
TIM E_MINUTES gets result as " hh:mi" ,
TIM E_SECONDS gets results as " hh:mi:ss " .
Return Value
S tring.
See also
S tringToTime, TimeToS truct
NormalizeDouble
R ounding floating point number to a specified accuracy.
double NormalizeDouble(
double value, // normalized number
int digits // number of digits after decimal point
);
Parameters
value
[in] Value with a floating point.
digits
[in] Accuracy format, number of digits after point (0-8).
Return Value
Calculated values of S topLoss, TakeProfit, and values of open prices for pending orders must be
normalized with the accuracy, the value of which can be obtained by Digits().
Please note that when output to Journal using the Print() function, a normalized number may contain
a greater number of decimal places than you expect. For example, for:
double a=76.671; // A normalized number with three decimal places
Print("Print(76.671)=",a); // Output as is
Print("DoubleToString(a,8)=",DoubleToString(a,8)); // Output with a preset accuracy
Print(76.671)=76.67100000000001
Example:
double pi=M_PI;
Print("pi = ",DoubleToString(pi,16));
double pi_3=NormalizeDouble(M_PI,3);
Print("NormalizeDouble(pi,3) = ",DoubleToString(pi_3,16))
;
double pi_8=NormalizeDouble(M_PI,8);
Print("NormalizeDouble(pi,8) = ",DoubleToString(pi_8,16));
double pi_0=NormalizeDouble(M_PI,0);
Print("NormalizeDouble(pi,0) = ",DoubleToString(pi_0,16));
/*
Result:
pi= 3.1415926535897931
NormalizeDouble(pi,3)= 3.1419999999999999
NormalizeDouble(pi,8)= 3.1415926499999998
NormalizeDouble(pi,0)= 3.0000000000000000
*/
See also
DoubleToS tring, R eal types (double, float), Typecasting
StringToCharArray
S ymbol-wise copies a string converted from Unicode to ANS I, to a selected place of array of uchar
type. It returns the number of copied elements.
int StringToCharArray(
string text_string, // source string
uchar& array[], // array
int start=0, // starting position in the array
int count=-1 // number of symbols
uint codepage=CP_ACP // code page
);
Parameters
text_string
[in] S tring to copy.
array[]
[out] Array of uchar type.
start=0
[in] Position from which copying starts. Default - 0.
count=-1
[in] Number of array elements to copy. Defines length of a resulting string. Default value is -1,
which means copying up to the array end, or till terminal 0. Terminal 0 will also be copied to the
recipient array, in this case the size of a dynamic array can be increased if necessary to the size of
the string. If the size of the dynamic array exceeds the length of the string, the size of the array
will not be reduced.
codepage=CP_ACP
[in] The value of the code page. For the most-used code pages provide appropriate constants.
Return Value
StringToColor
Converting "R,G,B" string or string with color name into color type value.
color StringToColor(
string color_string // string representation of color
);
Parameters
color_string
[in] S tring representation of a color of "R,G,B" type or name of one of predefined W eb-colors.
Return Value
Color value.
Example:
color str_color=StringToColor("0,127,0");
Print(str_color);
Print((string)str_color);
//--- change color a little
str_color=StringToColor("0,128,0");
Print(str_color);
Print((string)str_color);
See also
ColorToS tring, ColorToARGB
StringToDouble
The function converts string containing a symbol representation of number into number of double
type.
double StringToDouble(
string value // string
);
Parameters
value
[in] S tring containing a symbol representation of a number.
Return Value
StringToInteger
The function converts string containing a symbol representation of number into number of long
(integer) type.
long StringToInteger(
string value // string
);
Parameters
value
[in] S tring containing a number.
Return Value
StringToShortArray
The function symbol-wise copies a string into a specified place of an array of ushort type. It returns
the number of copied elements.
int StringToShortArray(
string text_string, // source string
ushort& array[], // array
int start=0, // starting position in the array
int count=-1 // number of symbols
);
Parameters
text_string
[in] S tring to copy
array[]
[out] Array of ushort type (analog of wchar_t type).
start=0
[in] Position, from which copying starts. Default - 0.
count=-1
[in] Number of array elements to copy. Defines length of a resulting string. Default value is -1,
which means copying up to the array end, or till terminal 0.Terminal 0 will also be copied to the
recipient array, in this case the size of a dynamic array can be increased if necessary to the size of
the string. If the size of the dynamic array exceeds the length of the string, the size of the array
will not be reduced.
Return Value
StringToTime
Transforms the string containing time and/or date in the " yyyy.mm.dd [hh:mi]" format into the
datetime type number.
datetime StringToTime(
const string time_string // date string
);
Parameters
time_string
[in] S tring in one of the specified formats :
· " yyyy.mm.dd [hh:mi]"
Return Value
datetime type value containing the number of seconds elapsed since 01.01.1970.
Note
Any sequence of space and tabulation characters between date and time is considered to be a single
space to avoid additional processing of the time_string before calling S tringToTime().
See also
TimeToS tring, TimeToS truct
StringFormat
The function formats obtained parameters and returns a string.
string StringFormat(
string format, // string with format description
... ... // parameters
);
Parameters
format
[in] S tring containing method of formatting. Formatting rules are the same as for the PrintFormat
function.
...
[in] Parameters, separated by a comma.
Return Value
S tring.
Example:
void OnStart()
{
//--- string variables
string output_string;
string temp_string;
string format_string;
//--- prepare the specification header
temp_string=StringFormat("Contract specification for %s:\n",_Symbol);
StringAdd(output_string,temp_string);
//--- int value output
int digits=(int)SymbolInfoInteger(_Symbol,SYMBOL_DIGITS);
temp_string=StringFormat(" SYMBOL_DIGITS = %d (number of digits after the decimal point)\n",
digits);
StringAdd(output_string,temp_string);
//--- double value output with variable number of digits after the decimal point
double point_value=SymbolInfoDouble(_Symbol,SYMBOL_POINT);
format_string=StringFormat(" SYMBOL_POINT = %%.%df (point value)\n",
digits);
temp_string=StringFormat(format_string,point_value);
StringAdd(output_string,temp_string);
//--- int value output
int spread=(int)SymbolInfoInteger(_Symbol,SYMBOL_SPREAD);
temp_string=StringFormat(" SYMBOL_SPREAD = %d (current spread in points)\n",
spread);
StringAdd(output_string,temp_string);
//--- int value output
int min_stop=(int)SymbolInfoInteger(_Symbol,SYMBOL_TRADE_STOPS_LEVEL);
temp_string=StringFormat(" SYMBOL_TRADE_STOPS_LEVEL = %d (minimal indention in points for Stop
min_stop);
StringAdd(output_string,temp_string);
//--- double value output without the fractional part
double contract_size=SymbolInfoDouble(_Symbol,SYMBOL_TRADE_CONTRACT_SIZE);
temp_string=StringFormat(" SYMBOL_TRADE_CONTRACT_SIZE = %.f (contract size)\n",
contract_size);
StringAdd(output_string,temp_string);
//--- double value output with default accuracy
double tick_size=SymbolInfoDouble(_Symbol,SYMBOL_TRADE_TICK_SIZE);
temp_string=StringFormat(" SYMBOL_TRADE_TICK_SIZE = %f (minimal price change)\n",
tick_size);
StringAdd(output_string,temp_string);
//--- determining the swap calculation mode
int swap_mode=(int)SymbolInfoInteger(_Symbol,SYMBOL_SWAP_MODE);
string str_swap_mode;
switch(swap_mode)
{
case SYMBOL_SWAP_MODE_DISABLED: str_swap_mode="SYMBOL_SWAP_MODE_DISABLED (no swaps)"; break;
case SYMBOL_SWAP_MODE_POINTS: str_swap_mode="SYMBOL_SWAP_MODE_POINTS (in points)"; break;
case SYMBOL_SWAP_MODE_CURRENCY_SYMBOL: str_swap_mode="SYMBOL_SWAP_MODE_CURRENCY_SYMBOL (in mo
case SYMBOL_SWAP_MODE_CURRENCY_MARGIN: str_swap_mode="SYMBOL_SWAP_MODE_CURRENCY_MARGIN (in mo
case SYMBOL_SWAP_MODE_CURRENCY_DEPOSIT: str_swap_mode="SYMBOL_SWAP_MODE_CURRENCY_DEPOSIT (in
case SYMBOL_SWAP_MODE_INTEREST_CURRENT: str_swap_mode="SYMBOL_SWAP_MODE_INTEREST_CURRENT (as
case SYMBOL_SWAP_MODE_INTEREST_OPEN: str_swap_mode="SYMBOL_SWAP_MODE_INTEREST_OPEN (as the sp
case SYMBOL_SWAP_MODE_REOPEN_CURRENT: str_swap_mode="SYMBOL_SWAP_MODE_REOPEN_CURRENT (by reop
case SYMBOL_SWAP_MODE_REOPEN_BID: str_swap_mode="SYMBOL_SWAP_MODE_REOPEN_BID (by reopening po
}
//--- string value output
temp_string=StringFormat(" SYMBOL_SWAP_MODE = %s\n",
str_swap_mode);
StringAdd(output_string,temp_string);
//--- double value output with default accuracy
double swap_long=SymbolInfoDouble(_Symbol,SYMBOL_SWAP_LONG);
margin_maintenance);
StringAdd(output_string,temp_string);
//--- int value output
int freeze_level=(int)SymbolInfoInteger(_Symbol,SYMBOL_TRADE_FREEZE_LEVEL);
temp_string=StringFormat(" SYMBOL_TRADE_FREEZE_LEVEL = %d (order freeze level in points)",
freeze_level);
StringAdd(output_string,temp_string);
Print(output_string);
Comment(output_string);
/* execution result
Contract specification for EURUSD:
SYMBOL_DIGITS = 5 (number of digits after the decimal point)
SYMBOL_POINT = 0.00001 (point value)
SYMBOL_SPREAD = 10 (current spread in points)
SYMBOL_TRADE_STOPS_LEVEL = 18 (minimal indention in points for Stop orders)
SYMBOL_TRADE_CONTRACT_SIZE = 100000 (contract size)
SYMBOL_TRADE_TICK_SIZE = 0.000010 (minimal price change)
SYMBOL_SWAP_MODE = SYMBOL_SWAP_MODE_POINTS (in points)
SYMBOL_SWAP_LONG = -0.700000 (buy order swap value)
SYMBOL_SWAP_SHORT = -1.000000 (sell order swap value)
SYMBOL_TRADE_MODE = SYMBOL_TRADE_MODE_FULL (no trade restrictions)
SYMBOL_VOLUME_MIN = 0.01 (minimal volume for a deal)
SYMBOL_VOLUME_STEP = 0.01 (minimal volume change step)
SYMBOL_VOLUME_MAX = 500 (maximal volume for a deal)
SYMBOL_TRADE_CALC_MODE = SYMBOL_CALC_MODE_FOREX (Forex)
SYMBOL_MARGIN_INITIAL = 0.00 (initial margin)
SYMBOL_MARGIN_MAINTENANCE = 0.00 (maintenance margin)
SYMBOL_TRADE_FREEZE_LEVEL = 0 (order freeze level in points)
*/
}
See also
PrintFormat, DoubleToS tring,ColorToS tring, TimeToS tring
Mathematical Functions
A set of mathematical and trigonometric functions.
Math functions were originally designed to perform relevant operations on scalar values. From this
build on, most of the functions can be applied to matrices and vectors. These include MathAbs,
MathArccos, MathArcsin, MathArctan, MathCeil, MathCos, MathExp, MathFloor, MathLog, MathLog10,
MathMod, MathPow, MathRound, MathS in, MathSqrt, MathTan, MathExpm1, MathLog1p, MathArccosh,
MathArcsinh, MathArctanh, MathCosh, MathS inh, and MathTanh. S uch operations imply element-wise
handling of matrices or vectors. Example:
//---
matrix a= {{1, 4}, {9, 16}};
Print("matrix a=\n",a);
a=MathSqrt(a);
Print("MatrSqrt(a)=\n",a);
/*
matrix a=
[[1,4]
[9,16]]
MatrSqrt(a)=
[[1,2]
[3,4]]
*/
For MathMod and MathPow, the second element can be either a scalar or a matrix/vector of the
appropriate size.
Function Action
Function Action
MathAbs
The function returns the absolute value (modulus) of the specified numeric value.
double MathAbs(
double value // numeric value
);
Parameters
value
[in] Numeric value.
Return Value
MathArccos
The function returns the arccosine of x within the range 0 to p in radians.
double MathArccos(
double val // -1<val<1
);
Parameters
val
[in] The val value between -1 and 1, the arc cosine of which is to be calculated.
Return Value
Arc cosine of a number in radians. If val is less than -1 or more than 1, the function returns NaN
(indeterminate value).
Note
MathArcsin
The function returns the arc sine of x within the range of -p /2 to p /2 radians.
double MathArcsin(
double val // -1<value<1
);
Parameters
val
[in] The val value between -1 and 1, the arc sine of which is to be calculated.
Return Value
Arc sine ofthe val number in radians within the range of -p /2 to p /2 radians. If val is less than -1
or more than 1, the function returns NaN (indeterminate value).
Note
MathArctan
The function returns the arc tangent of x. If x is equal to 0, the function returns 0.
double MathArctan(
double value // tangent
);
Parameters
value
[in] A number representing a tangent.
Return Value
MathArctan2
R eturn the angle (in radians) whose tangent is the quotient of two specified numbers.
double MathArctan2(
double y // The y coordinate of a point
double x // The x coordinate of a point
);
Parameters
y
[in] Y coordinate value.
x
[in] X coordinate value.
Return Value
MathArctan2 returns an angle, θ, within the range from -p to p radians, so that MathTan(θ)=y/x.
Please note as follows:
For points on the boundaries of the quadrants, the return value is the following:
· If y is 0 and x is not negative, θ = 0.
· If y is 0 and x is negative, θ = p .
· If y is positive and x is 0, θ = p /2.
· If y is negative and x is 0, θ = -p /2.
· If y is 0 and x is 0, θ = 0.
Note
Instead of the MathArctan2() function, you can use the atan2() function.
MathClassify
Determines the type of a real number and returns a result as a value from the ENUM _FP_CL ASS
enumeration
ENUM_FP_CLASS MathClassify(
double value // real number
);
Parameters
value
[in] The real number to be checked
Return Value
ID Description
Example:
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- test NaN
double nan=double("nan");
PrintFormat("Test NaN: %G is %s, MathIsValidNumber(NaN)=%s",
nan,
EnumToString(MathClassify(nan)),
(string)MathIsValidNumber(nan));
//--- test infinity
double inf=double("inf");
PrintFormat("Test Inf: %G is %s, MathIsValidNumber(inf)=%s",
inf,
EnumToString(MathClassify(inf)),
(string)MathIsValidNumber(inf));
//--- test normal value
double normal=1.2345e6;
PrintFormat("Test Normal: %G is %s, MathIsValidNumber(normal)=%s",
normal,
EnumToString(MathClassify(normal)),
(string)MathIsValidNumber(normal));
//--- test subnormal value
double sub_normal=DBL_MIN/2.0;
PrintFormat("Test Subnormal: %G is %s, MathIsValidNumber(sub_normal)=%s",
sub_normal,
EnumToString(MathClassify(sub_normal)),
(string)MathIsValidNumber(sub_normal));
//--- test zero value
double zero=0.0/(-1);
PrintFormat("Test Zero: %G is %s, MathIsValidNumber(zero)=%s",
zero,
EnumToString(MathClassify(zero)),
(string)MathIsValidNumber(zero));
}
/*
Result:
Test NaN: NAN is FP_NAN, MathIsValidNumber(NaN)=false
Test Inf: INF is FP_INFINITE, MathIsValidNumber(inf)=false
Test Normal: 1.2345E+06 is FP_NORMAL, MathIsValidNumber(normal)=true
Test Subnormal: 1.11254E-308 is FP_SUBNORMAL, MathIsValidNumber(sub_normal)=true
Test Zero: -0 is FP_ZERO, MathIsValidNumber(zero)=true
*/
//+------------------------------------------------------------------+
See also
R eal types (double, float), MathIs ValidNumber
MathCeil
The function returns integer numeric value closest from above.
double MathCeil(
double val // number
);
Parameters
val
[in] Numeric value.
Return Value
Numeric value representing the smallest integer that exceeds or equals to val.
Note
MathCos
The function returns the cosine of an angle.
double MathCos(
double value // number
);
Parameters
value
[in] Angle in radians.
Return Value
MathExp
The function returns the value of e raised to the power of d.
double MathExp(
double value // power for the number e
);
Parameters
value
[in] A number specifying the power.
Return Value
Anumber of double type. In case of overflow the function returns INF (infinity), in case of underflow
MathExp returns 0.
Note
MathFloor
The function returns integer numeric value closest from below.
double MathFloor(
double val // number
);
Parameters
val
[in] Numeric value.
Return Value
A numeric value representing the largest integer that is less than or equal to val.
Note
MathLog
The function returns a natural logarithm.
double MathLog(
double val // value to take the logarithm
);
Parameters
val
[in] Value logarithm of which is to be found.
Return Value
The natural logarithm of val in case of success. If val is negative, the function returns NaN
(undetermined value). If val is equal to 0, the function returns INF (infinity).
Note
MathLog
R eturns the logarithm of a number by base 10.
double MathLog10(
double val // number to take logarithm
);
Parameters
val
[in] Numeric value the common logarithm of which is to be calculated.
Return Value
The common logarithm in case of success. If val is negative, the function returns NaN
(undetermined value). If val is equal to 0, the function returns INF (infinity).
Note
MathMax
The function returns the maximal value of two values.
double MathMax(
double value1, // first value
double value2 // second value
);
Parameters
value1
[in] First numeric value.
value2
[in] S econd numeric value.
Return Value
Instead of MathMax() you can use fmax(). Functions fmax(), fmin(), MathMax(), MathMin() can
work with integer types without typecasting them to the type of double.
If parameters of different types are passed into a function, the parameter of the smaller type is
automatically cast to the larger type. The type of the return value corresponds to the larger type.
If data of the same type are passed, no casting is performed.
MathMin
The function returns the minimal value of two values.
double MathMin(
double value1, // first value
double value2 // second value
);
Parameters
value1
[in] First numeric value.
value2
[in] S econd numeric value.
Return Value
Instead of MathMin() you can use fmin(). Functions fmax(), fmin(), MathMax(), MathMin() can work
with integer types without typecasting them to the type of double.
If parameters of different types are passed into a function, the parameter of the smaller type is
automatically cast to the larger type. The type of the return value corresponds to the larger type.
If data of the same type are passed, no casting is performed.
MathMod
The function returns the real remainder of division of two numbers.
double MathMod(
double value, // dividend value
double value2 // divisor value
);
Parameters
value
[in] Dividend value.
value2
[in] Divisor value.
Return Value
The MathMod function calculates the real remainder f from expression val/y so that val = i * y + f ,
where i is an integer, f has the same sign as val, and the absolute value of f is less than the
absolute value of y.
Note
MathPow
The function raises a base to a specified power.
double MathPow(
double base, // base
double exponent // exponent value
);
Parameters
base
[in] Base.
exponent
[in] Exponent value.
Return Value
MathRand
R eturns a pseudorandom integer within the range of 0 to 32767.
int MathRand();
Return Value
Before the first call of the function, it's necessary to call MathS rand to set the generator of
pseudorandom numbers to the initial state.
Note
MathRound
The function returns a value rounded off to the nearest integer of the specified numeric value.
double MathRound(
double value // value to be rounded
);
Parameters
value
[in] Numeric value before rounding.
Return Value
MathSin
R eturns the sine of a specified angle.
double MathSin(
double value // argument in radians
);
Parameters
value
[in] Angle in radians.
Return Value
MathSqrt
R eturns the s quare root of a number.
double MathSqrt(
double value // positive number
);
Parameters
value
[in] Positive numeric value.
Return Value
Square root of value. If value is negative, MathSqrt returns NaN (indeterminate value).
Note
MathSrand
S ets the starting point for generating a series of pseudorandom integers.
void MathSrand(
int seed // initializing number
);
Parameters
seed
[in] S tarting number for the sequence of random numbers.
Return Value
No return value.
Note
The MathRand() function is used for generating a sequence of pseudorandom numbers. Call of
MathS rand() with a certain initializing number allows to always produces the same sequence of
pseudorandom numbers.
To ensure receipt of non-recurring sequence, use the call of MathS rand(GetTickCount()), since the
value of GetTickCount() increases from the moment of the start of the operating system and is not
repeated within 49 days, until the built-in counter of milliseconds overflows. Use of
MathS rand(TimeCurrent()) is not suitable, because the TimeCurrent() function returns the time of
the last tick, which can be unchanged for a long time, for example at the weekend.
Initialization of the random number generator using MathS rand() for indicators and Expert Advisors
is better performed in the OnInit() handler; it saves you from the following multiple restarts of the
generator in OnTick() and OnCalculate().
Instead of the MathS rand() function you can use the srand() function.
Example:
#property description "The indicator shows the central limit theorem, which states:"
#property description "The sum of a sufficiently large number of weakly dependent random variables,
#property description "having approximately equal magnitude (none of the summands dominates,"
#property description "or makes a determining contribution to the sum), has a distribution close to
#property indicator_separate_window
#property indicator_buffers 1
#property indicator_plots 1
//--- Properties of the graphical construction
#property indicator_label1 "Label"
#property indicator_type1 DRAW_HISTOGRAM
#property indicator_color1 clrRoyalBlue
#property indicator_style1 STYLE_SOLID
#property indicator_width1 5
//--- An input variable
input int sample_number=10;
//--- An indicator buffer to for drawing the distribution
double LabelBuffer[];
//--- A counter of ticks
double ticks_counter;
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
void OnInit()
{
//--- Binding an array and an indicator buffer
SetIndexBuffer(0,LabelBuffer,INDICATOR_DATA);
//--- turn the indicator buffer around from the present to the past
ArraySetAsSeries(LabelBuffer,true);
//--- Initialize the generator of random numbers
MathSrand(GetTickCount());
//--- Initialize the counter of ticks
ticks_counter=0;
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
//--- For a zero counter reset the indicator buffer
if(ticks_counter==0) ArrayInitialize(LabelBuffer,0);
//--- Increase the counter
ticks_counter++;
//--- We should periodically reset the counter ticks, to revive the distribution
if(ticks_counter>100)
{
Print("We've reset the indicator values, let's start filling the cells once again");
ticks_counter=0;
}
//--- Get a sample of random values as the sum of three numbers from 0 to 7
for(int i=0;i<sample_number;i++)
{
//--- Calculation of the index of the cell, where the random number falls as the sum of three
int rand_index=0;
//--- Get three random numbers from 0 to 7
for(int k=0;k<3;k++)
{
MathTan
The function returns a tangent of a number.
double MathTan(
double rad // argument in radians
);
Parameters
rad
[in] Angle in radians.
Return Value
Tangent of rad. If rad is greater than or equal to 263, or less than or equal to -263, a loss of
significance in the result occurs, in which case the function returns an indefinite number.
Note
MathIsValidNumber
It checks the correctness of a real number.
bool MathIsValidNumber(
double number // number to check
);
Parameters
number
[in] Checked numeric value.
Return Value
It returns true, if the checked value is an acceptable real number. If the checked value is a plus or
minus infinity, or " not a number" (NaN), the function returns false.
Example:
double abnormal=MathArcsin(2.0);
if(!MathIsValidNumber(abnormal)) Print("Attention! MathArcsin(2.0) = ",abnormal);
See also
R eal types (double, float)
MathExpm1
R eturns the value of the expression MathExp(x)-1.
double MathExpm1(
double value // power for the number e
);
Parameters
value
[in] The number specifying the power.
Return Value
A value of the double type. In case of overflow the function returns INF (infinity), in case of
underflow MathExpm1 returns 0.
Note
At values of x close to 0, the MathExpm1(x) function generates much more accurate values than the
MathExp(x)-1 function.
Instead of the MathExpm1() function you can use the expm1() function.
See also
R eal types (double, float)
MathLog1p
R eturns the value of the expression MathLog(1+x).
double MathLog1p(
double value // value to take the logarithm
);
Parameters
value
[in] The value, the logarithm of which is to be calculated.
Return Value
The natural logarithm of the value (value + 1) if successful. If value is < -1, the function returns NaN
(undefined value). If value is equal to -1, the function returns INF (infinity).
Note
At values
of x close to 0, the MathLog1p(x) function generates much more accurate values than the
MathLog(1+x) function.
Instead of the MathLog1p() function you can use the log1p() function.
See also
R eal types (double, float)
MathArccosh
R eturns the hyperbolic arccosine.
double MathArccosh(
double value // 1 <= value < ∞
);
Parameters
value
[in] The value, the hyperbolic arccosine of which is to be calculated.
Return Value
The hyperbolic arccosine of the number. If value is less than +1, the function returns NaN (undefined
value).
Note
Instead of the MathArccosh() function you can use the acosh() function.
See also
R eal types (double, float)
MathArcsinh
R eturns the hyperbolic arcsine.
double MathArcsinh(
double value // -∞ < value < +∞
);
Parameters
val
[in] The value, the hyperbolic arcsine of which is to be calculated.
Return Value
Instead of the MathArcsinh() function you can use the asinh() function.
See also
R eal types (double, float)
MathArctanh
R eturns the hyperbolic arctangent.
double MathArctanh(
double value // value in the range of -1 < value < 1
);
Parameters
value
[in] Number within the range of -1 < value < 1, which represents the tangent.
Return Value
Instead of the MathArctanh() function you can use the atanh() function.
MathCosh
R eturns the hyperbolic cosine of the number.
double MathCosh(
double value // number
);
Parameters
value
[in] Value.
Return Value
The hyperbolic cosine of the number, value within the range of +1 to positive infinity.
Note
Instead of the MathCosh() function you can use the cosh() function.
MathSinh
R eturns the hyperbolic sine of the number.
double MathSinh(
double value // number
);
Parameters
value
[in] Value.
Return Value
Instead of the MathS inh() function you can use the sinh() function.
MathTanh
R eturns the hyperbolic tangent of the number.
double MathTanh(
double value // number
);
Parameters
value
[in] Value.
Return Value
The hyperbolic tangent of the number, value within the range of -1 to +1.
Note
Instead of the MathTanh() function you can use the tanh() function.
See also
R eal types (double, float)
MathSwap
Change the order of bytes in the ushort type value.
ushort MathSwap(
ushort value // value
);
Parameters
value
[in] Value for changing the order of bytes.
Return Value
MathSwap
Change the order of bytes in the uint type value.
uint MathSwap(
uint value // value
);
Parameters
value
[in] Value for changing the order of bytes.
Return Value
MathSwap
Change the order of bytes in the ulong type value.
ulong MathSwap(
ulong value // value
);
Parameters
value
[in] Value for changing the order of bytes.
Return Value
String Functions
This is a group of functions intended for working with data of the string type.
Function Action
StringAdd
The function adds a substring to the end of a string.
bool StringAdd(
string& string_var, // string, to which we add
string add_substring // string, which is added
);
Parameters
string_var
[in][out] S tring, to which another one is added.
add_substring
[in] S tring that is added to the end of a source string.
Return Value
In case of success returns true, otherwise false. In order to get an error code, the GetLastError()
function should be called.
Example:
void OnStart()
{
long length=1000000;
string a="a",b="b",c;
//--- first method
uint start=GetTickCount(),stop;
long i;
for(i=0;i<length;i++)
{
c=a+b;
}
stop=GetTickCount();
Print("time for 'c = a + b' = ",(stop-start)," milliseconds, i = ",i);
{
StringConcatenate(c,a,b);
}
stop=GetTickCount();
Print("time for 'StringConcatenate(c,a,b)' = ",(stop-start)," milliseconds, i = ",i);
}
See also
S tringConcatenate, S tring S plit, S tring S ubstr
StringBufferLen
The function returns the size of buffer allocated for the string.
int StringBufferLen(
string string_var // string
)
Parameters
string_var
[in] S tring.
Return Value
The value 0 means that the string is constant and buffer size can't be changed. -1 means that the
string belongs to the client terminal, and modification of the buffer contents can have
indeterminate results.
Example:
void OnStart()
{
long length=1000;
string a="a",b="b";
//---
long i;
Print("before: StringBufferLen(a) = ",StringBufferLen(a),
" StringLen(a) = ",StringLen(a));
for(i=0;i<length;i++)
{
StringAdd(a,b);
}
Print("after: StringBufferLen(a) = ",StringBufferLen(a),
" StringLen(a) = ",StringLen(a));
}
See also
S tring Add, S tringInit, S tringLen, S tring Fill
StringCompare
The function compares two strings and returns the comparison result in form of an integer.
int StringCompare(
const string& string1, // the first string in the comparison
const string& string2, // the second string in the comparison
bool case_sensitive=true // case sensitivity mode selection for the comparison
);
Parameters
string1
[in] The first string.
string2
[in] The second string.
case_sensitive=true
[in] Case sensitivity mode selection. If it is true, then "A">" a" . If it is false, then "A"=" a" . By
default the value is equal to true.
Return Value
· -1 (minus one), if string1<string2
· 0 (zero), if string1=string2
· 1 (one), if string 1>string 2
Note
The strings are compared symbol by symbol, the symbols are compared in the alphabetic order in
accordance with the current code page.
Example:
void OnStart()
{
//--- what is larger - apple or home?
string s1="Apple";
string s2="home";
{
if(result2<0)PrintFormat("Case insensitive comparison: %s < %s",s1,s2);
else PrintFormat("Case insensitive comparison: %s = %s",s1,s2);
}
/* Result:
Case-sensitive comparison: Apple < home
Case insensitive comparison: Apple < home
*/
}
See also
S tring Type, CharToS tring(), S hortToS tring(), S tringToCharArray(), S tringToS hortArray(),
S tring GetCharacter(), Use of a Codepage
StringConcatenate
The function forms a string of passed parameters and returns the size of the formed string.
Parameters can be of any type. Number of parameters can't be less than 2 or more than 64.
int StringConcatenate(
string& string_var, // string to form
void argument1 // first parameter of any simple type
void argument2 // second parameter of any simple type
... // next parameter of any simple type
);
Parameters
string_var
[out] S tring that will be formed as a result of concatenation.
argumentN
[in] Any comma separated values. From 2 to 63 parameters of any simple type.
Return Value
R eturns
the string length, formed by concatenation of parameters transformed into string type.
Parameters are transformed into strings according to the same rules as in Print() and Comment().
See also
S tring Add, S tring S plit, S tring S ubstr
StringFill
It fills out a selected string by specified symbols.
bool StringFill(
string& string_var, // string to fill
ushort character // symbol that will fill the string
);
Parameters
string_var
[in][out] S tring, that will be filled out by the selected symbol.
character
[in] S ymbol, by which the string will be filled out.
Return Value
In case of success returns true, otherwise - false. To get the error code call GetLastError().
Note
Filling out a string at place means that symbols are inserted directly to the string without
transitional operations of new string creation or copying. This allows to save the operation time.
Example:
void OnStart()
{
string str;
StringInit(str,20,'_');
Print("str = ",str);
StringFill(str,0);
Print("str = ",str,": StringBufferLen(str) = ", StringBufferLen(str));
}
// Result
// str = ____________________
// str = : StringBufferLen(str) = 20
//
See also
S tring BufferLen, S tringLen, S tringInit
StringFind
S earch for a substring in a string.
int StringFind(
string string_value, // string in which search is made
string match_substring, // what is searched
int start_pos=0 // from what position search starts
);
Parameters
string_value
[in] S tring, in which search is made.
match_substring
[in] S earched substring.
start_pos=0
[in] Position in the string from which search is started.
Return Value
R eturns position number in a string, from which the searched substring starts, or -1, if the substring
is not found.
See also
S tring S ubstr, S tring GetCharacter, S tringLen, S tringLen
StringGetCharacter
R eturns value of a symbol, located in the specified position of a string.
ushort StringGetCharacter(
string string_value, // string
int pos // symbol position in the string
);
Parameters
string_value
[in] S tring.
pos
[in] Position of a symbol in the string. Can be from 0 to S tringLen(text) -1.
Return Value
S ymbol code or 0 in case of an error. To get the error code call GetLastError().
See also
S tring S etCharacter, S tring BufferLen, S tringLen, S tring Fill, S tringInit, S tringToCharArray,
S tringToS hortArray
StringInit
Initializes a string by specified symbols and provides the specified string size.
bool StringInit(
string& string_var, // string to initialize
int new_len=0, // required string length after initialization
ushort character=0 // symbol, by which the string will be filled
);
Parameters
string_var
[in][out] S tring that should be initialized and deinitialized.
new_len=0
[in] S tringlength after initialization. If length=0, it deinitializes the string, i.e. the string buffer
is cleared and the buffer address is zeroed.
character=0
[in] S ymbol to fill the string.
Return Value
In case of success returns true, otherwise - false. To get the error code call GetLastError().
Note
If character=0 and the length new_len>0, the buffer of the string of indicated length will be
distributed and filled by zeroes. The string length will be equal to zero, because the whole buffer is
filled out by string terminators.
Example:
void OnStart()
{
//---
string str;
StringInit(str,200,0);
Print("str = ",str,": StringBufferLen(str) = ",
StringBufferLen(str)," StringLen(str) = ",StringLen(str));
}
/* Result
str = : StringBufferLen(str) = 200 StringLen(str) = 0
*/
See also
S tring BufferLen, S tringLen
StringLen
R eturns the number of symbols in a string.
int StringLen(
string string_value // string
);
Parameters
string_value
[in] S tring to calculate length.
Return Value
StringSetLength
S ets a specified length (in characters) for a string.
bool StringSetLength(
string& string_var, // string
uint new_length // new string length
);
Parameters
string_var
[in][out] S tring, for which a new length in characters should be set.
new_capacity
[in] R equired stringlength in characters. If new_length is less than the current size, the excessive
characters are discarded.
Return Value
In case of successful execution, returns true, otherwise - false. To receive an error code, the
GetLastError() function should be called.
Note
TheS tringS etLength() function does not change the size of the buffer allocated for a string.
See also
S tringLen, S tring BufferLen, S tring R eserve S tringInit, S tring S etCharacter
StringReplace
It replaces all the found substrings of a string by a set sequence of symbols.
int StringReplace(
string& str, // the string in which substrings will be replaced
const string find, // the searched substring
const string replacement // the substring that will be inserted to the found positions
);
Parameters
str
[in][out] The string in which you are going to replace substrings.
find
[in] The desired substring to replace.
replacement
[in] The string that will be inserted instead of the found one.
Return Value
The function returns the number of replacements in case of success, otherwise -1. To get an error
code call the GetLastError() function.
Note
If the function has run successfully but no replacements have been made (the substring to replace
was not found), it returns 0.
The error can result from incorrect str or find parameters (empty or non-initialized string, see
S tringInit() ). Besides, the error occurs if there is not enough memory to complete the replacement.
Example:
string text="The quick brown fox jumped over the lazy dog.";
int replaced=StringReplace(text,"quick","slow");
replaced+=StringReplace(text,"brown","black");
replaced+=StringReplace(text,"fox","bear");
Print("Replaced: ", replaced,". Result=",text);
// Result
// Replaced: 3. Result=The slow black bear jumped over the lazy dog.
//
See also
S tring S etCharacter(), S tring S ubstr()
StringReserve
R eserves the buffer of a specified size for a string in memory.
bool StringReserve(
string& string_var, // string
uint new_capacity // buffer size for storing a string
);
Parameters
string_var
[in][out] S tring the buffer size should change the size for.
new_capacity
[in] Buffer size required for a string. If the new_capacity size is less than the string length, the
size of the current buffer does not change.
Return Value
In case of successful execution, returns true, otherwise - false. To receive an error code, the
GetLastError() function should be called.
Note
Generally, the string size is not equal to the size of the buffer meant for storing the string. W hen
creating a string, the appropriate buffer is usually allocated with a margin. The S tringReserve()
function allows managing the buffer size and specify the optimal size for future operations.
Unlik e S tringInit(), the S tringReserve() function does not change the string contents and does not fill
it with characters.
Example:
void OnStart()
{
string s;
//--- check the operation speed without using StringReserve
ulong t0=GetMicrosecondCount();
for(int i=0; i< 1024; i++)
s+=" "+(string)i;
ulong msc_no_reserve=GetMicrosecondCount()-t0;
s=NULL;
//--- now, let's do the same using StringReserve
StringReserve(s,1024 * 3);
t0=GetMicrosecondCount();
for(int i=0; i< 1024; i++)
s+=" "+(string)i;
ulong msc_reserve=GetMicrosecondCount()-t0;
//--- check the time
Print("Test with StringReserve passed for "+(string)msc_reserve+" msc");
Print("Test without StringReserve passed for "+(string)msc_no_reserve+" msc");
/* Result:
See also
S tring BufferLen, S tring S etLength, S tringInit, S tring S etCharacter
StringSetCharacter
R eturns copy of a string with a changed character in a specified position.
bool StringSetCharacter(
string& string_var, // string
int pos, // position
ushort character // character
);
Parameters
string_var
[in][out] S tring.
pos
[in] Position of a character in a string. Can be from 0 to S tringLen(text).
character
[in] S ymbol code Unicode.
Return Value
In case of success returns true, otherwise false. In order to get an error code, the GetLastError()
function should be called.
Note
If pos is less than string length and the symbol code value = 0, the string is cut off (but the buffer
size, distributed for the string remains unchanged). The string length becomes equal to pos.
If pos is equal to string length, the specified symbol is added at the string end, and the length is
enlarged by one.
Example:
void OnStart()
{
string str="0123456789";
Print("before: str = ",str,",StringBufferLen(str) = ",
StringBufferLen(str)," StringLen(str) = ",StringLen(str));
//--- add zero value in the middle
StringSetCharacter(str,6,0);
Print("after: str = ",str,",StringBufferLen(str) = ",
StringBufferLen(str)," StringLen(str) = ",StringLen(str));
//--- add symbol at the end
int size=StringLen(str);
StringSetCharacter(str,size,'+');
Print("addition: str = ",str,",StringBufferLen(str) = ",
StringBufferLen(str)," StringLen(str) = ",StringLen(str));
}
/* Result
before: str = 0123456789 ,StringBufferLen(str) = 0 StringLen(str) = 10
See also
S tring BufferLen, S tringLen, S tring Fill, S tringInit, CharToS tring, S hortToS tring, CharArrayToS tring,
S hortArrayToS tring
StringSplit
Gets substrings by a specified separator from the specified string, returns the number of substrings
obtained.
int StringSplit(
const string string_value, // A string to search in
const ushort separator, // A separator using which substrings will be searched
string & result[] // An array passed by reference to get the found substrings
);
Parameters
string_value
[in] The string from which you need to get substrings. The string will not change.
pos
[in] The code of the separator character. To get the code, you can use the S tringGetCharacter()
function.
result[]
[out] An array of strings where the obtained substrings are located.
Return Value
The number of substrings in the result[] array. If the separator is not found in the passed string,
only one source string will be placed in the array.
If string_value is empty or NULL, the function will return zero. In case of an error the function
returns -1. To get the error code, call the GetLastError() function.
Example:
See also
S tring R eplace(), S tring S ubstr(), S tringConcatenate()
StringSubstr
Extracts a substring from a text string starting from the specified position.
string StringSubstr(
string string_value, // string
int start_pos, // position to start with
int length=-1 // length of extracted string
);
Parameters
string_value
[in] S tring to extract a substring from.
start_pos
[in] Initial position of a substring. Can be from 0 to S tringLen(text) -1.
length=-1
[in]Length of an extracted substring. If the parameter value is equal to -1 or parameter isn't set,
the substring will be extracted from the indicated position till the string end.
Return Value
StringToLower
Transforms all symbols of a selected string into lowercase.
bool StringToLower(
string& string_var // string to process
);
Parameters
string_var
[in][out] S tring.
Return Value
In case of success returns true, otherwise - false. To get the error code call GetLastError().
See also
S tringToUpper, S tringTrimLeft, S tringTrimR ight
StringToUpper
Transforms all symbols of a selected string into capitals.
bool StringToUpper(
string& string_var // string to process
);
Parameters
string_var
[in][out] S tring.
Return Value
In case of success returns true, otherwise - false. To get the error code call GetLastError().
See also
S tringToLower, S tringTrimLeft, S tringTrimR ight
StringTrimLeft
The function cuts line feed characters, spaces and tabs in the left part of the string till the first
meaningful symbol. The string is modified at place.
int StringTrimLeft(
string& string_var // string to cut
);
Parameters
string_var
[in][out] S tring that will be cut from the left.
Return Value
StringTrimRight
The function cuts line feed characters, spaces and tabs in the right part of the string after the last
meaningful symbol. The string is modified at place.
int StringTrimRight(
string& string_var // string to cut
);
Parameters
string_var
[in][out] S tring that will be cut from the right.
Return Value
Function Action
TimeCurrent R eturnsthe last known server time (time of the last quote receipt) in
the datetime format
TimeTradeS erver R eturns the current calculation time of the trade server
TimeLocal R eturns the local computer time in datetime format
TimeGMT R eturns GMT in datetime format with the Daylight S aving Time by local
time of the computer, where the client terminal is running
TimeDaylightS avings R eturns the sign of Daylight S aving Time switch
TimeGMTOffset R eturns the current difference between GMT time and the local computer
time in seconds, taking into account DS T switch
TimeToS truct Converts a datetime value into a variable of M qlDateTime structure type
S tructToTime Converts a variable of M qlDateTime structure type into a datetime value
TimeCurrent
R eturns the last k nown server time, time of the last quote receipt for one of the symbols selected in
the " Market W atch" window. In the OnTick() handler, this function returns the time of the received
handled tick. In other cases (for example, call in handlers OnInit(), OnDeinit(), OnTimer() and so on)
this is the time of the last quote receipt for any symbol available in the " Market W atch" window, the
time shown in the title of this window. The time value is formed on a trade server and does not
depend on the time settings on your computer. There are 2 variants of the function.
Call without parameters
datetime TimeCurrent();
datetime TimeCurrent(
MqlDateTime& dt_struct // structure type variable
);
Parameters
dt_struct
[out] M qlDateTime structure type variable.
Return Value
If the M qlDateTime structure type variable has been passed as a parameter, it is filled accordingly.
To arrange high-resolution counters and timers, use the GetTickCount() function, which produces
values in milliseconds.
During testing in the strategy tester, TimeCurrent() is simulated according to historical data.
TimeTradeServer
R eturnsthe calculated current time of the trade server. Unlike TimeCurrent(), the calculation of the
time value is performed in the client terminal and depends on the time settings on your computer.
There are 2 variants of the function.
Call without parameters
datetime TimeTradeServer();
datetime TimeTradeServer(
MqlDateTime& dt_struct // Variable of structure type
);
Parameters
dt_struct
[out] Variable of structure type M qlDateTime.
Return Value
If the M qlDateTime structure type variable has been passed as a parameter, it is filled accordingly.
To arrange high-resolution counters and timers, use the GetTickCount() function, which produces
values in milliseconds.
During testing in the strategy tester, TimeTradeS erver() is simulated according to historical data
and always equal to TimeCurrent().
TimeLocal
R eturnsthe local time of a computer, where the client terminal is running. There are 2 variants of the
function.
Call without parameters
datetime TimeLocal();
datetime TimeLocal(
MqlDateTime& dt_struct // Variable of structure type
);
Parameters
dt_struct
[out] Variable of structure type M qlDateTime.
Return Value
If the M qlDateTime structure type variable has been passed as a parameter, it is filled accordingly.
To arrange high-resolution counters and timers, use the GetTickCount() function, which produces
values in milliseconds.
During testing in the strategy tester, TimeLocal() is always equal to TimeCurrent() simulated server
time.
TimeGMT
R eturns
the GMT, which is calculated taking into account the DS T switch by the local time on the
computer where the client terminal is running. There are 2 variants of the function.
Call without parameters
datetime TimeGMT();
datetime TimeGMT(
MqlDateTime& dt_struct // Variable of structure type
);
Parameters
dt_struct
[out] Variable of structure type M qlDateTime.
Return Value
If the M qlDateTime structure type variable has been passed as a parameter, it is filled accordingly.
To arrange high-resolution counters and timers, use the GetTickCount() function, which produces
values in milliseconds.
During testing in the strategy tester, TimeGMT() is always equal to TimeTradeS erver() simulated
server time.
TimeDaylightSavings
R eturnscorrection for daylight saving time in seconds, if the switch to summer time has been made.
It depends on the time settings of your computer.
int TimeDaylightSavings();
Return Value
TimeGMTOffset
R eturnsthe current difference between GMT time and the local computer time in seconds, taking into
account switch to winter or summer time. Depends on the time settings of your computer.
int TimeGMTOffset();
Return Value
The value of int type, representing the current difference between GMT time and the local time of
the computer TimeLocal in seconds.
TimeGMTOffset() = TimeGMT() - TimeLocal()
TimeToStruct
Converts a value of datetime type (number of seconds since 01.01.1970) into a structure variable
M qlDateTime.
bool TimeToStruct(
datetime dt, // date and time
MqlDateTime& dt_struct // structure for the adoption of values
);
Parameters
dt
[in] Date value to convert.
dt_struct
[out] Variable of structure type M qlDateTime.
Return Value
True if successful, otherwise false. To get information about the error, call the GetLastError()
function.
StructToTime
Converts a structure variable M qlDateTime into a value of datetime type and returns the resulting
value.
datetime StructToTime(
MqlDateTime& dt_struct // structure of the date and time
);
Parameters
dt_struct
[in] Variable of structure type M qlDateTime.
Return Value
The value of datetime type containing the number of seconds since 01.01.1970.
Account Information
Functions that return parameters of the current account.
Function Action
AccountInfoDouble
R eturns the value of the appropriate account property.
double AccountInfoDouble(
ENUM_ACCOUNT_INFO_DOUBLE property_id // Property identifier
);
Parameters
property_id
[in] Property identifier. The value can be one of the values of ENUM _ACCOUNT_INFO_DOUBLE.
Return Value
void OnStart()
{
//--- Show all the information available from the function AccountInfoDouble()
printf("ACCOUNT_BALANCE = %G",AccountInfoDouble(ACCOUNT_BALANCE));
printf("ACCOUNT_CREDIT = %G",AccountInfoDouble(ACCOUNT_CREDIT));
printf("ACCOUNT_PROFIT = %G",AccountInfoDouble(ACCOUNT_PROFIT));
printf("ACCOUNT_EQUITY = %G",AccountInfoDouble(ACCOUNT_EQUITY));
printf("ACCOUNT_MARGIN = %G",AccountInfoDouble(ACCOUNT_MARGIN));
printf("ACCOUNT_MARGIN_FREE = %G",AccountInfoDouble(ACCOUNT_MARGIN_FREE));
printf("ACCOUNT_MARGIN_LEVEL = %G",AccountInfoDouble(ACCOUNT_MARGIN_LEVEL));
printf("ACCOUNT_MARGIN_SO_CALL = %G",AccountInfoDouble(ACCOUNT_MARGIN_SO_CALL));
printf("ACCOUNT_MARGIN_SO_SO = %G",AccountInfoDouble(ACCOUNT_MARGIN_SO_SO));
}
See also
S ymbolInfoDouble, S ymbolInfoS tring, S ymbolInfoInteger, PrintFormat
AccountInfoInteger
R eturns the value of the appropriate account property.
long AccountInfoInteger(
ENUM_ACCOUNT_INFO_INTEGER property_id // Identifier of the property
);
Parameters
property_id
[in] Property identifier. The value can be one of the values of ENUM _ACCOUNT_INFO_INTEGER.
Return Value
void OnStart()
{
//--- Show all the information available from the function AccountInfoInteger()
printf("ACCOUNT_LOGIN = %d",AccountInfoInteger(ACCOUNT_LOGIN));
printf("ACCOUNT_LEVERAGE = %d",AccountInfoInteger(ACCOUNT_LEVERAGE));
bool thisAccountTradeAllowed=AccountInfoInteger(ACCOUNT_TRADE_ALLOWED);
bool EATradeAllowed=AccountInfoInteger(ACCOUNT_TRADE_EXPERT);
ENUM_ACCOUNT_TRADE_MODE tradeMode=(ENUM_ACCOUNT_TRADE_MODE)AccountInfoInteger(ACCOUNT_TRADE_MODE
ENUM_ACCOUNT_STOPOUT_MODE stopOutMode=(ENUM_ACCOUNT_STOPOUT_MODE)AccountInfoInteger(ACCOUNT_MARG
See also
Account Information
AccountInfoString
R eturns the value of the appropriate account property.
string AccountInfoString(
ENUM_ACCOUNT_INFO_STRING property_id // Property identifier
);
Parameters
property_id
[in] Property identifier. The value can be one of the values of ENUM _ACCOUNT_INFO_S TRING.
Return Value
void OnStart()
{
//--- Show all the information available from the function AccountInfoString()
Print("The name of the broker = ",AccountInfoString(ACCOUNT_COMPANY));
Print("Deposit currency = ",AccountInfoString(ACCOUNT_CURRENCY));
Print("Client name = ",AccountInfoString(ACCOUNT_NAME));
Print("The name of the trade server = ",AccountInfoString(ACCOUNT_SERVER));
}
See also
Account Information
State Checking
Functions that return parameters of the current state of the client terminal
Function Action
GetLastError
R eturns the contents of the system variable _LastError.
int GetLastError();
Return Value
R eturns the value of the last error that occurred during the execution of an mql5 program.
Note
After the function call, the contents of _LastError are not reset. To reset this variable, you need to
call ResetLastError().
See also
Trade S erver Return Codes
IsStopped
Checks the forced shutdown of an mql5 program.
bool IsStopped();
Return Value
R eturns true, if the _S topFlag system variable contains a value other than 0. A nonzero value is
written into _S topFlag, if a mql5 program has been commanded to complete its operation. In this
case, you must immediately terminate the program, otherwise the program will be completed
forcibly from the outside after 3 seconds.
UninitializeReason
R eturns the code of a reason for deinitialization.
int UninitializeReason();
Return Value
R eturnsthe value of _UninitReason which is formed before OnDeinit() is called. Value depends on
the reasons that led to deinitialization.
TerminalInfoInteger
R eturns the value of a corresponding property of the mql5 program environment.
int TerminalInfoInteger(
int property_id // identifier of a property
);
Parameters
property_id
[in]Identifier of a property. Can be one of the values of the ENUM _T ER MINAL _INFO_INT EGER
enumeration.
Return Value
TerminalInfoDouble
R eturns the value of a corresponding property of the mql5 program environment.
double TerminalInfoDouble(
int property_id // identifier of a property
);
Parameters
property_id
[in]Identifier of a property. Can be one of the values of the ENUM _T ER MINAL _INFO_DOUBL E
enumeration.
Return Value
TerminalInfoString
R eturns the value of a corresponding property of the mql5 program environment. The property must be
of string type.
string TerminalInfoString(
int property_id // identifier of a property
);
Parameters
property_id
[in]Identifier of a property. Can be one of the values of the ENUM _T ER MINAL _INFO_S T R ING
enumeration.
Return Value
MQLInfoInteger
R eturns the value of a corresponding property of a running mql5 program.
int MQLInfoInteger(
int property_id // identifier of a property
);
Parameters
property_id
[in] Identifier of a property. Can be one of values of the ENUM _MQL_INFO_INTEGER enumeration.
Return Value
MQLInfoString
R eturns the value of a corresponding property of a running mql5 program.
string MQLInfoString(
int property_id // Identifier of a property
);
Parameters
property_id
[in] Identifier of a property. Can be one of the ENUM _MQL_INFO_S TRING enumeration.
Return Value
Symbol
R eturns the name of a symbol of the current chart.
string Symbol();
Return Value
Value of the _S ymbol system variable, which stores the name of the current chart symbol.
Note
Unlik e Expert Advisors, indicators and scripts, services are not bound to a specific chart. Therefore,
S ymbol() returns an empty string ("" ) for a service.
Period
R eturns the current chart timeframe.
ENUM_TIMEFRAMES Period();
Return Value
The contents of the _Period variable that contains the value of the current chart timeframe. The
value can be one of the values of the ENUM _TIM EFRAM ES enumeration.
Note
Unlik e Expert Advisors, indicators and scripts, services are not bound to a specific chart. Therefore,
Period() returns 0 for a service.
See also
Digits
R eturns the number of decimal digits determining the accuracy of price of the current chart symbol.
int Digits();
Return Value
The value of the _Digits variable which stores the number of decimal digits determining the
accuracy of price of the current chart symbol.
Point
R eturns the point size of the current symbol in the quote currency.
double Point();
Return Value
The value of the _Point variable which stores the point size of the current symbol in the quote
currency.
Event Handling
The MQL5 language provides handling of certain predefined events. The functions for handling these
events should be defined in an MQL5 program: function name, return type, a set of parameters (if
any) and their types should strictly correspond to the description of an event handling function.
The client terminal event handler uses the return and parameter types to identify functions processing
an event. If a certain function has some parameters or a return type not corresponding to the
descriptions below, such a function cannot be used for handling an event.
Function Description
OnS tart The function is called when the S tart event occurs to perform
actions set in the script
OnInit The function is called in indicators and EAs when the Init event
occurs to initialize a launched MQL5 program
OnDeinit The function is called in indicators and EAs when the Deinit event
occurs to de-initialize a launched MQL5 program
OnTick The function is called in EAs when the NewTick event occurs to
handle a new quote
OnCalculate The function is called in indicators when the Calculate event occurs
to handle price data changes
OnTimer The function is called in indicators and EAs during the Timer
periodic event generated by the terminal at fixed time intervals
OnTrade The function is called in EAs during the Trade event generated at
the end of a trading operation on a trade server
OnTradeTransaction The function is called in EAs when the TradeTransaction event
occurs to process a trade request execution results
OnBookEvent The function is called in EAs when the BookEvent event occurs to
process changes in the market depth
OnChartEvent The function is called in indicators and EAs when the ChartEvent
event occurs to process chart changes made by a user or an MQL5
program
OnTester The function is called in EAs when the Tester event occurs to
perform necessary actions after testing an EA on history data
OnTesterInit The function is called in EAs when the TesterInit event occurs to
perform necessary actions before optimization in the strategy
tester
OnTesterDeinit The function is called in EAs when the TesterDeinit event occurs
after EA optimization in the strategy tester
OnTesterPass The function is called in EAs when the TesterPass even occurs to
handle an arrival of a new data frame during EA optimization in the
strategy tester
The client terminal sends incoming events to corresponding open charts. Also, events may be
generated by charts (chart events) or mql5 programs (custom events). Generating graphical object
creation/deletion events can be enabled/disabled by setting the CHART_EVENT_OBJECT_CREATE and
CHART_EVENT_OBJECT_DELETE chart properties. Each mql5 application and chart have their own
queue of events where all newly arrived events are placed.
A program gets events only from the chart it is running on. All events are handled one after another in
the order of their receipt. If the queue already contains the NewTick event or this event is in the
processing stage, then the new NewTick event is not added to mql5 application queue. S imilarly, if the
ChartEvent is already in an mql5 program queue or such an event is being handled, then a new event
of this type is not placed into a queue. Timer event handling is processed in the same way – if the
Timer event is already in the queue or is being handled, no new timer event is set into a queue.
Event queues have a limited but sufficient size, so the queue overflow is unlikely for a correctly
developed program. W hen the queue overflows, new events are discarded without being set into a
queue.
It is strongly recommended not to use infinite loops to handle events. Possible exceptions are scripts
handling a single S tart event.
Libraries do not handle any events.
OnStart
The function is called in scripts and services when the S tart event occurs. The function is intended for
one-time execution of actions implemented in a program. There are two function types.
The version that returns the result
int OnStart(void);
Return Value
Note
OnS tart() is the only function for handling events in scripts and services. No other events are sent to
these programs. In turn, the S tart event is not passed to EAs and custom indicators.
Sample script:
See also
Event handling functions, Program running, Client terminal events
OnInit
The function is called in indicators and EAs when the Init event occurs. It is used to initialize a running
MQL5 program. There are two function types.
The version that returns the result
int OnInit(void);
Return Value
Note
The Init event is generated immediately after loading an EA or an indicator. The event is not
generated for scripts. The OnInit() function is used to initialize an MQL5 program. If OnInit() has a
return value of int type, the non-zero return code means failed initialization and generates the
Deinit event with the REAS ON_INIT FAIL ED deinitialization reason code.
OnInit() function of void type always means successful initialization and is not recommended for
use.
For optimizing the EA inputs, it is recommended to use values from the ENUM _INIT_RETCODE
enumeration as a return code. These values are intended for establishing the optimization process
management, including selection of the most suitable test agents. It is possible to request data on
agent configuration and resources (number of cores, free memory amount, etc.) using the
TerminalInfoInteger() function during the EA initialization before launching the test. Based on the
obtained data, you can either allow using the test agent or ban it from optimizing the EA.
ID Description
ID Description
W hen this value is received, the strategy tester does not pass
this tas k to other agents for repeated execution.
INIT_AGENT_NOT_SUITABLE No program execution errors during initialization. However, for
some reasons, the agent is not suitable for conducting a test.
For example, there is not enough RAM, no OpenCL support,
etc.
After returning this code, the agent no longer receives tas k s
until the very end of this optimization.
available_memory_mb);
return (INIT_AGENT_NOT_SUITABLE);
}
}
//--- check for the indicator
indicator_handle=iCustom(_Symbol,_Period,"My_Indicator",ma_period);
if(indicator_handle==INVALID_HANDLE)
{
PrintFormat("Failed to generate My_Indicator handle. Error code %d",
GetLastError());
return (INIT_FAILED);
}
//--- EA initialization successful
return(INIT_SUCCEEDED);
}
See also
OnDeinit, Event handling functions, Program running, Client terminal events, Initialization of
variables, Creating and deleting objects
OnDeinit
The function is called in indicators and EAs when the Deinit event occurs. It is used to deinitialize a
running MQL5 program.
void OnDeinit(
const int reason // deinitialization reason code
);
Parameters
reason
[in] Deinitialization reason code.
Return Value
No return value
Note
Deinit event is generated for EAs and indicators in the following cases :
· before a re-initialization due to the change of a symbol or a chart period the mql5 program is
attached to;
· before a re-initialization due to the change of the inputs ;
· before unloading an mql5 program.
The reason parameter may have the following values :
Constant Value Description
case REASON_REMOVE:
text="Program "+__FILE__+" was removed from chart";break;
case REASON_TEMPLATE:
text="New template was applied to chart";break;
default:text="Another reason";
}
//---
return text;
}
See also
OnInit, Event handling functions, Program running, Client terminal events, Uninitialization reason
codes, Visibility scope and lifetime of variables, Creating and deleting objects
OnTick
The function is called in EAs when the NewTick event occurs to handle a new quote.
void OnTick(void);
Return Value
No return value
Note
The NewTick event is generated only for EAs upon receiving a new tick for a symbol of the chart the
EA is attached to. There is no point in defining the OnTick () function in a custom indicator or a
script since a NewTick event is not generated for them.
The Tick event is generated only for EAs, but this does not mean that EAs have to feature the
OnTick() function, since Timer, BookEvent and ChartEvent events are also generated for EAs in
addition to NewTick.
All events are handled one after another in the order of their receipt. If the queue already contains
the NewTick event or this event is in the processing stage, then the new NewTick event is not added
to mql5 application queue.
The NewTick event is generated regardless of whether auto trading is enabled (AutoTrading button).
Disabled auto trading means only a ban on sending trade requests from an EA. The EA operation is
not stopped.
Disablingauto trading by pressing the AutoTrading button does not interrupt the current execution
of the OnTick() function.
Example of the EA featuring its entire trading logic in the OnTick() function
//+------------------------------------------------------------------+
//| TradeByATR.mq5 |
//| Copyright 2018, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property description "Sample EA trading in the \"explosive\" candle direction"
#property description "\"Explosive\" candle has the body size exceeding k*ATR"
#property description "The \"revers\" parameter reverses the signal direction"
int atr_handle;
//--- here we will store the last ATR values and the candle body
double last_atr,last_body;
datetime lastbar_timeopen;
double trade_lot;
//+------------------------------------------------------------------+
//| Expert initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- initialize global variables
last_atr=0;
last_body=0;
//--- set the correct volume
double min_lot=SymbolInfoDouble(_Symbol,SYMBOL_VOLUME_MIN);
trade_lot=lots>min_lot? lots:min_lot;
//--- create ATR indicator handle
atr_handle=iATR(_Symbol,_Period,ATRperiod);
if(atr_handle==INVALID_HANDLE)
{
PrintFormat("%s: failed to create iATR, error code %d",__FUNCTION__,GetLastError());
return(INIT_FAILED);
}
//--- successful EA initialization
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Expert deinitialization function |
//+------------------------------------------------------------------+
void OnDeinit(const int reason)
{
//--- inform of the EA operation end code
Print(__FILE__,": Deinitialization reason code = ",reason);
}
//+------------------------------------------------------------------+
//| Expert tick function |
//+------------------------------------------------------------------+
void OnTick()
{
//--- trading signal
static int signal=0; // +1 means a buy signal, -1 means a sell signal
//--- check and close old positions opened more than 'holdbars' bars ago
ClosePositionsByBars(holdbars,slippage,EXPERT_MAGIC);
//--- check for a new bar
if(isNewBar())
{
//--- check for a signal presence
signal=CheckSignal();
}
//--- if a netting position is opened, skip the signal - wait till it closes
if(signal!=0 && PositionsTotal()>0 && (ENUM_ACCOUNT_MARGIN_MODE)AccountInfoInteger(ACCOUNT_MARGI
{
signal=0;
return; // exit the NewTick event handler and do not enter the market before a new bar appear
}
//--- for a hedging account, each position is held and closed separately
if(signal!=0)
{
//--- buy signal
if(signal>0)
{
PrintFormat("%s: Buy signal! Revers=%s",__FUNCTION__,string(revers));
if(Buy(trade_lot,slippage,EXPERT_MAGIC))
signal=0;
}
//--- sell signal
if(signal<0)
{
PrintFormat("%s: Sell signal! Revers=%s",__FUNCTION__,string(revers));
if(Sell(trade_lot,slippage,EXPERT_MAGIC))
signal=0;
}
}
//--- OnTick function end
}
//+------------------------------------------------------------------+
//| Check for a new trading signal |
//+------------------------------------------------------------------+
int CheckSignal()
{
//--- 0 means no signal
int res=0;
//--- get ATR value on a penultimate complete bar (the bar index is 2)
double atr_value[1];
if(CopyBuffer(atr_handle,0,2,1,atr_value)!=-1)
{
last_atr=atr_value[0];
//--- get data on the last closed bar to the MqlRates type array
MqlRates bar[1];
if(CopyRates(_Symbol,_Period,1,1,bar)!=-1)
{
//--- calculate the bar body size on the last complete bar
last_body=bar[0].close-bar[0].open;
//--- if the body of the last bar (with index 1) exceeds the previous ATR value (on the ba
if(MathAbs(last_body)>kATR*last_atr)
res=last_body>0?1:-1; // positive value for the upward candle
}
else
return (MarketOrder(ORDER_TYPE_BUY,volume,deviation,magicnumber));
}
//+------------------------------------------------------------------+
//| Sell at a market price with a specified volume |
//+------------------------------------------------------------------+
bool Sell(double volume,ulong deviation=10,ulong magicnumber=0)
{
//--- sell at a market price
return (MarketOrder(ORDER_TYPE_SELL,volume,deviation,magicnumber));
}
//+------------------------------------------------------------------+
//| Close positions by hold time in bars |
//+------------------------------------------------------------------+
void ClosePositionsByBars(int holdtimebars,ulong deviation=10,ulong magicnumber=0)
{
int total=PositionsTotal(); // number of open positions
//--- iterate over open positions
for(int i=total-1; i>=0; i--)
{
//--- position parameters
ulong position_ticket=PositionGetTicket(i); // position
string position_symbol=PositionGetString(POSITION_SYMBOL); // symbol
ulong magic=PositionGetInteger(POSITION_MAGIC); // position
datetime position_open=(datetime)PositionGetInteger(POSITION_TIME); // position
int bars=iBarShift(_Symbol,PERIOD_CURRENT,position_open)+1; // how many
//--- if a position's lifetime is already large, while MagicNumber and a symbol match
if(bars>holdtimebars && magic==magicnumber && position_symbol==_Symbol)
{
int digits=(int)SymbolInfoInteger(position_symbol,SYMBOL_DIGITS); // number o
double volume=PositionGetDouble(POSITION_VOLUME); // position
ENUM_POSITION_TYPE type=(ENUM_POSITION_TYPE)PositionGetInteger(POSITION_TYPE); // position
string str_type=StringSubstr(EnumToString(type),14);
StringToLower(str_type); // lower the text case for correct message formatting
PrintFormat("Close position #%d %s %s %.2f",
position_ticket,position_symbol,str_type,volume);
//--- set an order type and sending a trade request
if(type==POSITION_TYPE_BUY)
MarketOrder(ORDER_TYPE_SELL,volume,deviation,magicnumber,position_ticket);
else
MarketOrder(ORDER_TYPE_BUY,volume,deviation,magicnumber,position_ticket);
}
}
}
//+------------------------------------------------------------------+
//| Prepare and send a trade request |
//+------------------------------------------------------------------+
bool MarketOrder(ENUM_ORDER_TYPE type,double volume,ulong slip,ulong magicnumber,ulong pos_ticket=0
{
See also
Event handling functions, Program running, Client terminal events, OnTimer, OnBookEvent,
OnChartEvent
OnCalculate
The function is called in the indicators when the Calculate event occurs for processing price data
changes. There are two function types. Only one of them can be used within a single indicator.
Calculation based on data array
int OnCalculate(
const int rates_total, // price[] array size
const int prev_calculated, // number of handled bars at the previous call
const int begin, // index number in the price[] array meaningful data starts
const double& price[] // array of values for calculation
);
Parameters
rates_total
[in] S ize of
the price[] array or input series available to the indicator for calculation. In the second
function type, the parameter value corresponds to the number of bars on the chart it is launched
at.
prev_calculated
[in] Contains the value returned by the OnCalculate() function during the previous call. It is
designed to s kip the bars that have not changed since the previous launch of this function.
begin
[in] Index value in the price[] array meaningful data starts from. It allows you to s kip missing or
initial data, for which there are no correct values.
price[]
[in] Array of values for calculations. One of the price timeseries or a calculated indicator buffer
can be passed as the price[] array. Type of data passed for calculation can be defined using the
_AppliedTo predefined variable.
time{}
[in] Array with bar open time values.
open[]
[in] Array with Open price values.
high[]
[in] Array with H igh price values.
low[]
[in] Array with Low price values.
close[]
[in] Array with Close price values.
tick_volume[]
[in] Array with tick volume values.
volume[]
[in] Array with trade volume values.
spread[]
[in] Array with spread values for bars.
Return Value
int type value to be passed as the prev_calculated parameter during the next function call.
Note
If the OnCalculate() function is equal to zero, no indicator values are shown in the DataW indow of
the client terminal.
If the price data have been changed since the last call of the OnCalculate() function (a deeper
history has been loaded or gaps in the history have been filled), the value of the prev_calculated
input parameter is set to zero by the terminal itself.
To define the indexing direction in the time[], open[], high[], low[], close[], tick_volume[],
volume[] and spread[] arrays, call the A rrayGetA s S eries() function. In order not to depend on
defaults, call the ArrayS etAs S eries() function for the arrays to work with.
W hen using the first function type, a necessary timeseries or indicator is selected by a user as the
price[] array in the Parameters tab when launching the indicator. To do this, specify the necessary
element in the drop-down list of the "Apply to" field.
To get custom indicator values from other mql5 programs, the iCustom() function is used. It returns
the indicator handle for subsequent operations. It is also possible to specify the required price []
array or the handle of another indicator. This parameter should be passed the last in the list of input
variables of a custom indicator.
It is necessary to use the connection between the value returned by the OnCalculate() function and
the prev_calculated second input parameter. W hen calling the function, the prev_calculated
parameter contains the value returned by the OnCalculate() function during the previous call. This
makes it possible to implement resource-saving algorithms for calculating a custom indicator in
order to avoid repetitive calculations for the bars that have not changed since the previous launch of
this function.
Sample indicator
//+------------------------------------------------------------------+
//| OnCalculate_Sample.mq5 |
//| Copyright 2018, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property description "Sample Momentum indicator calculation"
See also
ArrayGetAs S eries, ArrayS etAs S eries, iCustom, Event handling functions, Program running, Client
terminal events, Access to timeseries and indicators
OnTimer
The function is called in EAs during the Timer event generated by the terminal at fixed time intervals.
void OnTimer(void);
Return Value
No return value
Note
The Timer event is periodically generated by the client terminal for an EA, which activated the timer
using the EventS etTimer() function. Usually, this function is called in the OnInit() function. W hen
the EA stops working, the timer should be eliminated using EventKillTimer(), which is usually called
in the OnDeinit() function.
Each Expert Advisor and each indicator work with its own timer receiving events solely from this
timer. During mql5 application shutdown, the timer is forcibly destroyed in case it has been created
but has not been disabled by EventKillTimer() function.
If you need to receive timer events more frequently than once per second, use
EventS etMillisecondTimer() for creating a high-resolution timer.
In general, when the timer period is reduced, the testing time is increased, as the handler of timer
events is called more often. W hen working in real-time mode, timer events are generated no more
than 1 time in 10-16 milliseconds due to hardware limitations.
Only one timer can be launched for each program. Each mql5 application and chart have their own
queue of events where all newly arrived events are placed. If the queue already contains Timer
event or this event is in the processing stage, then the new Timer event is not added to mql5
application queue.
Sample EA with the OnTimer() handler
//+------------------------------------------------------------------+
//| OnTimer_Sample.mq5 |
//| Copyright 2018, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property description "Example of using the timer for calculating the trading server time"
#property description "It is recommended to run the EA at the end of a trading week before the week
//+------------------------------------------------------------------+
//| Expert initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- create a timer with a 1 second period
EventSetTimer(1);
//---
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Expert deinitialization function |
//+------------------------------------------------------------------+
void OnDeinit(const int reason)
{
//--- destroy the timer after completing the work
EventKillTimer();
}
//+------------------------------------------------------------------+
//| Expert tick function |
//+------------------------------------------------------------------+
void OnTick()
{
//---
}
//+------------------------------------------------------------------+
//| Timer function |
//+------------------------------------------------------------------+
void OnTimer()
{
//--- time of the OnTimer() first call
static datetime start_time=TimeCurrent();
//--- trade server time during the first OnTimer() call
static datetime start_tradeserver_time=0;
//--- calculated trade server time
static datetime calculated_server_time=0;
//--- local PC time
datetime local_time=TimeLocal();
//--- current estimated trade server time
datetime trade_server_time=TimeTradeServer();
//--- if a server time is unknown for some reason, exit ahead of time
if(trade_server_time==0)
return;
//--- if the initial trade server value is not set yet
if(start_tradeserver_time==0)
{
start_tradeserver_time=trade_server_time;
//--- set a calculated value of a trade server
Print(trade_server_time);
calculated_server_time=trade_server_time;
}
else
{
//--- increase time of the OnTimer() first call
if(start_tradeserver_time!=0)
calculated_server_time=calculated_server_time+1;;
}
//---
string com=StringFormat(" Start time: %s\r\n",TimeToString(start_time,TIME_MINU
com=com+StringFormat(" Local time: %s\r\n",TimeToString(local_time,TIME_MINUTES
com=com+StringFormat("TimeTradeServer time: %s\r\n",TimeToString(trade_server_time,TIME_MINUTES|
com=com+StringFormat(" EstimatedServer time: %s\r\n",TimeToString(calculated_server_time,TIME_MI
//--- display values of all counters on the chart
Comment(com);
}
See also
EventS etTimer, EventS etMillisecondTimer, EventKillTimer, GetTick Count, GetMicrosecondCount,
Client terminal events
OnTrade
The function is called in EAs when the Trade event occurs. The function is meant for processing
changes in order, position and trade lists.
void OnTrade(void);
Return Value
No return value
Note
OnTrade() is called only for Expert Advisors. It is not used in indicators and scripts even if you add
there a function with the same name and type.
For any trade action (placing a pending order, opening/closing a position, placing stops, activating
pending orders, etc.), the history of orders and trades and/or the list of positions and current orders
is changed appropriately.
W hen handling an order, a trade server sends the terminal a message about the incoming Trade
event. To retrieve relevant data on orders and trades from history, it is necessary to perform a
trading history request using HistoryS elect() first.
The trade events are generated by the server in case of:
· changing active orders,
· changing positions,
· changing deals,
· changing trade history.
Each Trade event may appear as a result of one or several trade requests. Trade requests are sent
to the server using OrderS end() or OrderS endAsync(). Each request can lead to several trade events.
You cannot rely on the statement " One request - one Trade event" , since the processing of events
may be performed in several stages, and each operation may change the state of orders, positions
and the trade history.
OnTrade() handler is called after the appropriate OnTradeTransaction() calls. In general, there is no
exact correlation in the number of OnTrade () and OnTradeTransaction () calls. One OnTrade() call
corresponds to one or several OnTradeTransaction calls.
Sample EA with OnTrade() handler
//+------------------------------------------------------------------+
//| OnTrade_Sample.mq5 |
//| Copyright 2018, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
//--- set the limits of the trade history on the global scope
datetime start; // start date for trade history in cache
datetime end; // end date for trade history in cache
//--- global counters
int orders; // number of active orders
int positions; // number of open positions
int deals; // number of deals in the trade history cache
int history_orders; // number of orders in the trade history cache
bool started=false; // flag of counter relevance
//+------------------------------------------------------------------+
//| Expert initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//---
end=TimeCurrent();
start=end-days*PeriodSeconds(PERIOD_D1);
PrintFormat("Limits of the history to be loaded: start - %s, end - %s",
TimeToString(start),TimeToString(end));
InitCounters();
//---
return(0);
}
//+------------------------------------------------------------------+
//| initialization of position, order and trade counters |
//+------------------------------------------------------------------+
void InitCounters()
{
ResetLastError();
//--- load history
bool selected=HistorySelect(start,end);
if(!selected)
{
PrintFormat("%s. Failed to load history from %s to %s to cache. Error code: %d",
__FUNCTION__,TimeToString(start),TimeToString(end),GetLastError());
return;
}
//--- get the current value
orders=OrdersTotal();
positions=PositionsTotal();
deals=HistoryDealsTotal();
history_orders=HistoryOrdersTotal();
started=true;
Print("Counters of orders, positions and deals successfully initialized");
}
//+------------------------------------------------------------------+
//| Expert tick function |
//+------------------------------------------------------------------+
void OnTick()
{
if(started) SimpleTradeProcessor();
else InitCounters();
}
//+------------------------------------------------------------------+
//| called when a Trade event arrives |
//+------------------------------------------------------------------+
void OnTrade()
{
if(started) SimpleTradeProcessor();
else InitCounters();
}
//+------------------------------------------------------------------+
//| example of processing changes in trade and history |
//+------------------------------------------------------------------+
void SimpleTradeProcessor()
{
end=TimeCurrent();
ResetLastError();
//--- download trading history from the specified interval to the program cache
bool selected=HistorySelect(start,end);
if(!selected)
{
PrintFormat("%s. Failed to load history from %s to %s to cache. Error code: %d",
__FUNCTION__,TimeToString(start),TimeToString(end),GetLastError());
return;
}
//--- get the current values
int curr_orders=OrdersTotal();
int curr_positions=PositionsTotal();
int curr_deals=HistoryDealsTotal();
int curr_history_orders=HistoryOrdersTotal();
//--- check if the number of active orders has been changed
if(curr_orders!=orders)
{
//--- number of active orders has been changed
PrintFormat("Number of orders has been changed. Previous value is %d, current value is %d",
orders,curr_orders);
//--- update the value
orders=curr_orders;
}
//--- changes in the number of open positions
if(curr_positions!=positions)
{
//--- number of open positions has been changed
PrintFormat("Number of positions has been changed. Previous value is %d, current value is %d"
positions,curr_positions);
//--- update the value
positions=curr_positions;
}
//--- changes in the number of deals in the trade history cache
if(curr_deals!=deals)
{
//--- number of deals in the trade history cache has been changed
PrintFormat("Number of deals has been changed. Previous value is %d, current value is %d",
deals,curr_deals);
//--- update the value
deals=curr_deals;
}
//--- changes in the number of history orders in the trade history cache
if(curr_history_orders!=history_orders)
{
//--- number of history orders in the trade history cache has been changed
PrintFormat("Number of orders in history has been changed. Previous value is %d, current valu
history_orders,curr_history_orders);
//--- update the value
history_orders=curr_history_orders;
}
//--- checking if it is necessary to change the limits of the trade history to be requested in cach
CheckStartDateInTradeHistory();
}
//+------------------------------------------------------------------+
//| changing the start date for requesting the trade history |
//+------------------------------------------------------------------+
void CheckStartDateInTradeHistory()
{
//--- initial interval, if we were to start working right now
datetime curr_start=TimeCurrent()-days*PeriodSeconds(PERIOD_D1);
//--- make sure that the start limit of the trade history has not gone
//--- more than 1 day over the intended date
if(curr_start-start>PeriodSeconds(PERIOD_D1))
{
//--- correct the start date of history to be loaded in the cache
start=curr_start;
PrintFormat("New start limit of the trade history to be loaded: start => %s",
TimeToString(start));
//--- now reload the trade history for the updated interval
HistorySelect(start,end);
//--- correct the deal and order counters in history for further comparison
history_orders=HistoryOrdersTotal();
deals=HistoryDealsTotal();
}
}
//+------------------------------------------------------------------+
/* Sample output:
Limits of the history to be loaded: start - 2018.07.16 18:11, end - 2018.07.23 18:11
The counters of orders, positions and deals are successfully initialized
See also
OrderS end, OrderS endAsync, OnTradeTransaction, Client terminal events
OnTradeTransaction
The function is called in EAs when the TradeTransaction event occurs. The function is meant for
handling trade request execution results.
void OnTradeTransaction()
const MqlTradeTransaction& trans, // trade transaction structure
const MqlTradeRequest& request, // request structure
const MqlTradeResult& result // response structure
);
Parameters
trans
[in] M qlTradeTransaction type variable describing a transaction made on a trading account.
request
[in] M qlTradeRequest type variable describing a trade request that led to a transaction. It
contains the values for TRADE_TRANSACTION_REQUES T type transaction only.
result
[in] M qlTradeResult type variable containing an execution result of a trade request that led to a
transaction. It contains the values for TRADE_TRANSACTION_REQUES T type transaction only.
Return Value
No return value
Note
OnTradeTransaction() is called to handle the TradeTransaction event sent by the trade server to the
terminal in the following cases :
· sending a trade request from an MQL5 program using the OrderS end()/OrderS endAsync()
functions and its subsequent execution;
· sending a trade request manually via the GUI and its subsequent execution;
· activations of pending and stop orders on the server;
· performing operations on the trade server side.
Data on transaction type is contained in the type field of the trans variable. Types of trade
transactions are described in the ENUM _TRADE_TRANSACTION_TYPE enumeration:
· T RADE_T RANSACTION_ORDER_ADD – adding a new active order
· T RADE_T RANSACTION_ORDER_UPDAT E – changing an existing order
· T RADE_T RANSACTION_ORDER_DEL ET E – deleting an order from the list of active ones
· T RADE_T RANSACTION_DEAL _ADD – adding a deal to history
· T RADE_T RANSACTION_DEAL _UPDAT E – changing a deal in history
· T RADE_T RANSACTION_DEAL _DEL ET E – deleting a deal from history
· T RADE_T RANSACTION_H I S TORY_ADD – adding an order to history as a result of execution or
cancelation
· T RADE_T RANSACTION_H I S TORY_UPDAT E – changing an order in the order history
· T RADE_T RANSACTION_H I S TORY_DEL ET E – deleting an order from the order history
· T RADE_T RANSACTION_POS ITION – position change not related to a trade execution
TerminalInfoInteger(TERMINAL_PING_LAST)/1000.);
//---
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Expert tick function |
//+------------------------------------------------------------------+
void OnTick()
{
//---
}
//+------------------------------------------------------------------+
//| TradeTransaction function |
//+------------------------------------------------------------------+
void OnTradeTransaction(const MqlTradeTransaction &trans,
const MqlTradeRequest &request,
const MqlTradeResult &result)
{
//---
static int counter=0; // counter of OnTradeTransaction() calls
static uint lasttime=0; // time of the OnTradeTransaction() last call
//---
uint time=GetTickCount();
//--- if the last transaction was performed more than 1 second ago,
if(time-lasttime>1000)
{
counter=0; // then this is a new trade operation, an the counter can be reset
if(IS_DEBUG_MODE)
Print(" New trade operation");
}
lasttime=time;
counter++;
Print(counter,". ",__FUNCTION__);
//--- result of trade request execution
ulong lastOrderID =trans.order;
ENUM_ORDER_TYPE lastOrderType =trans.order_type;
ENUM_ORDER_STATE lastOrderState=trans.order_state;
//--- the name of the symbol, for which a transaction was performed
string trans_symbol=trans.symbol;
//--- type of transaction
ENUM_TRADE_TRANSACTION_TYPE trans_type=trans.type;
switch(trans.type)
{
case TRADE_TRANSACTION_POSITION: // position modification
{
ulong pos_ID=trans.position;
PrintFormat("MqlTradeTransaction: Position #%d %s modified: SL=%.5f TP=%.5f",
pos_ID,trans_symbol,trans.price_sl,trans.price_tp);
}
break;
case TRADE_TRANSACTION_REQUEST: // sending a trade request
PrintFormat("MqlTradeTransaction: TRADE_TRANSACTION_REQUEST");
break;
case TRADE_TRANSACTION_DEAL_ADD: // adding a trade
{
ulong lastDealID =trans.deal;
ENUM_DEAL_TYPE lastDealType =trans.deal_type;
double lastDealVolume=trans.volume;
//--- Trade ID in an external system - a ticket assigned by an exchange
string Exchange_ticket="";
if(HistoryDealSelect(lastDealID))
Exchange_ticket=HistoryDealGetString(lastDealID,DEAL_EXTERNAL_ID);
if(Exchange_ticket!="")
Exchange_ticket=StringFormat("(Exchange deal=%s)",Exchange_ticket);
}
break;
}
//--- order ticket
ulong orderID_result=result.order;
string retcode_result=GetRetcodeID(result.retcode);
if(orderID_result!=0)
PrintFormat("MqlTradeResult: order #%d retcode=%s ",orderID_result,retcode_result);
//---
}
//+------------------------------------------------------------------+
//| convert numeric response codes to string mnemonics |
//+------------------------------------------------------------------+
string GetRetcodeID(int retcode)
{
switch(retcode)
{
case 10004: return("TRADE_RETCODE_REQUOTE"); break;
case 10006: return("TRADE_RETCODE_REJECT"); break;
case 10007: return("TRADE_RETCODE_CANCEL"); break;
case 10008: return("TRADE_RETCODE_PLACED"); break;
case 10009: return("TRADE_RETCODE_DONE"); break;
case 10010: return("TRADE_RETCODE_DONE_PARTIAL"); break;
case 10011: return("TRADE_RETCODE_ERROR"); break;
case 10012: return("TRADE_RETCODE_TIMEOUT"); break;
case 10013: return("TRADE_RETCODE_INVALID"); break;
case 10014: return("TRADE_RETCODE_INVALID_VOLUME"); break;
case 10015: return("TRADE_RETCODE_INVALID_PRICE"); break;
case 10016: return("TRADE_RETCODE_INVALID_STOPS"); break;
case 10017: return("TRADE_RETCODE_TRADE_DISABLED"); break;
case 10018: return("TRADE_RETCODE_MARKET_CLOSED"); break;
case 10019: return("TRADE_RETCODE_NO_MONEY"); break;
case 10020: return("TRADE_RETCODE_PRICE_CHANGED"); break;
case 10021: return("TRADE_RETCODE_PRICE_OFF"); break;
case 10022: return("TRADE_RETCODE_INVALID_EXPIRATION"); break;
case 10023: return("TRADE_RETCODE_ORDER_CHANGED"); break;
case 10024: return("TRADE_RETCODE_TOO_MANY_REQUESTS"); break;
case 10025: return("TRADE_RETCODE_NO_CHANGES"); break;
case 10026: return("TRADE_RETCODE_SERVER_DISABLES_AT"); break;
case 10027: return("TRADE_RETCODE_CLIENT_DISABLES_AT"); break;
case 10028: return("TRADE_RETCODE_LOCKED"); break;
case 10029: return("TRADE_RETCODE_FROZEN"); break;
case 10030: return("TRADE_RETCODE_INVALID_FILL"); break;
case 10031: return("TRADE_RETCODE_CONNECTION"); break;
case 10032: return("TRADE_RETCODE_ONLY_REAL"); break;
case 10033: return("TRADE_RETCODE_LIMIT_ORDERS"); break;
case 10034: return("TRADE_RETCODE_LIMIT_VOLUME"); break;
case 10035: return("TRADE_RETCODE_INVALID_ORDER"); break;
case 10036: return("TRADE_RETCODE_POSITION_CLOSED"); break;
default:
return("TRADE_RETCODE_UNKNOWN="+IntegerToString(retcode));
break;
}
//---
}
See also
OrderS end, OrderS endAsync, OnTradeTransaction, Trade request structure, Trade transaction
structure, Trade transaction types, Trade operation types, Client terminal events
OnBookEvent
The function is called in indicators and EAs when the BookEvent event occurs. It is meant for handling
Depth of Mark et changes.
void OnBookEvent(
const string& symbol // symbol
);
Parameters
symbol
[in] Name of a symbol the BookEvent has arrived for
Return Value
No return value
Note
To get the BookEvent events for any symbol, simply subscribe to receive them for this symbol using
the MarketBookAdd() function. To cancel subscription for receiving the BookEvent for a certain
symbol, call the MarketBookRelease() function.
The BookEvent broadcasts within the entire chart. This means that if one application on a chart
subscribes to the BookEvent using the MarketBookAdd function, all other indicators and EAs
launched on the same chart and having the OnBookEvent() handler receive this event as well.
Therefore, it is necessary to analyze a symbol name passed to the OnBookEvent() handler as the
symbol parameter.
S eparate BookEvent counters sorted by symbols are provided for all applications running on the same
chart. This means that each chart may have multiple subscriptions to different symbols, and a
counter is provided for each symbol. S ubscribing and unsubscribing from BookEvent changes the
subscription counter for specified symbols only within one chart. In other words, there may be two
adjacent charts to the BookEvent for the same symbol but different subscription counter values.
The initial subscription counter value is zero. At each MarketBookAdd() call, the subscription counter
for a specified symbol on the chart is increased by one (chart symbol and symbol in MarketBookAdd()
do not have to match). W hen calling MarketBookRelease(), the counter of subscriptions for a
specified symbol within the chart is decreased by one. The BookEvent events for any symbol are
broadcast within the chart till the counter is equal to zero. Therefore, it is important that each
MQL5 program that contains MarketBookAdd () calls correctly unsubscribes from getting events for
each symbol using MarketBookRelease () at the end of its work. To achieve this, the number of
MarketBookAdd() and MarketBookRelease() calls should be even for each call during the entire MQL5
program lifetime. Using flags or custom subscription counters within the program allows you to
safely work with BookEvent events and prevents disabling subscriptions for getting this event in
third-party programs within the same chart.
BookEvent events are never s k ipped and are always placed into a queue even if handling the
previous BookEvent handling is not over yet.
Example
//+------------------------------------------------------------------+
//| OnBookEvent_Sample.mq5 |
//| Copyright 2018, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com/en/articles/2635"
#property version "1.00"
#property description "Example of measuring the market depth refresh rate using OnBookEvent()"
#property description "The code is taken from the article https://www.mql5.com/en/articles/2635"
//--- input parameters
input ulong ExtCollectTime =30; // test time in seconds
input ulong ExtSkipFirstTicks=10; // number of ticks skipped at start
//--- flag of subscription to BookEvent events
bool book_subscribed=false;
//--- array for accepting requests from the market depth
MqlBookInfo book[];
//+------------------------------------------------------------------+
//| Expert initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- show the start
Comment(StringFormat("Waiting for the first %I64u ticks to arrive",ExtSkipFirstTicks));
PrintFormat("Waiting for the first %I64u ticks to arrive",ExtSkipFirstTicks);
//--- enable market depth broadcast
if(MarketBookAdd(_Symbol))
{
book_subscribed=true;
PrintFormat("%s: MarketBookAdd(%s) function returned true",__FUNCTION__,_Symbol);
}
else
PrintFormat("%s: MarketBookAdd(%s) function returned false! GetLastError()=%d",__FUNCTION__,_
//--- successful initialization
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Deinitialize expert |
//+------------------------------------------------------------------+
void OnDeinit(const int reason)
{
//--- display deinitialization reason code
Print(__FUNCTION__,": Deinitialization reason code = ",reason);
//--- cancel subscription for getting market depth events
if(book_subscribed)
{
if(!MarketBookRelease(_Symbol))
PrintFormat("%s: MarketBookRelease(%s) returned false! GetLastError()=%d",_Symbol,GetLastE
else
book_subscribed=false;
}
//---
}
//+------------------------------------------------------------------+
//| BookEvent function |
//+------------------------------------------------------------------+
void OnBookEvent(const string &symbol)
{
static ulong starttime=0; // test start time
static ulong tickcounter=0; // market depth update counter
//--- work with depth market events only if we subscribed to them ourselves
if(!book_subscribed)
return;
//--- count updates only for a certain symbol
if(symbol!=_Symbol)
return;
//--- skip first ticks to clear the queue and to prepare
tickcounter++;
if(tickcounter<ExtSkipFirstTicks)
return;
//--- remember the start time
if(tickcounter==ExtSkipFirstTicks)
starttime=GetMicrosecondCount();
//--- request for the market depth data
MarketBookGet(symbol,book);
//--- when to stop?
ulong endtime=GetMicrosecondCount()-starttime;
ulong ticks =1+tickcounter-ExtSkipFirstTicks;
// how much time has passed in microseconds since the start of the test?
if(endtime>ExtCollectTime*1000*1000)
{
PrintFormat("%I64u ticks for %.1f seconds: %.1f ticks/sec ",ticks,endtime/1000.0/1000.0,ticks
ExpertRemove();
return;
}
//--- display the counters in the comment field
if(endtime>0)
Comment(StringFormat("%I64u ticks for %.1f seconds: %.1f ticks/sec ",ticks,endtime/1000.0/100
}
See also
MarketBookAdd, MarketBookRelease, MarketBookGet, OnTrade, OnTradeTransaction, OnTick, Event
handling functions, Program running, Client terminal events
OnChartEvent
The function is called in indicators and EAs when the ChartEvent event occurs. The function is meant
for handling chart changes made by a user or an MQL5 program.
void OnChartEvent()
const int id, // event ID
const long& lparam, // long type event parameter
const double& dparam, // double type event parameter
const string& sparam // string type event parameter
);
Parameters
id
[in] Event ID from the ENUM _CHART_EVENT enumeration.
lparam
[in] long type event parameter
dparam
[in] double type event parameter
sparam
[in] string type event parameter
Return Value
No return value
Note
There are 11 types of events that can be handled using the predefined OnChartEvent() function.
65535 IDs from CHAR T EVENT _CUS TOM to CHAR T EVENT _CUS TOM _L AS T inclusive are provided for
custom events. To generate a custom event, use the EventChartCustom() function.
S hort event description from
the ENUM _CHART_EVENT enumeration:
· CHARTEVENT_KEYDOWN — pressing a key on the keyboard when a chart window is in focus ;
· CHARTEVENT_MOUSE_MOVE — moving the mouse and mouse button clicks (if
CHART_EVENT_MOUSE_MOVE=true for a chart);
· CHARTEVENT_OBJECT_CREATE — create a graphical object (if
CHART_EVENT_OBJECT_CREATE=true for a chart);
· CHARTEVENT_OBJECT_CHANGE — change object properties via the properties dialog;
· CHARTEVENT_OBJECT_DELETE — delete a graphical object (if
CHART_EVENT_OBJECT_DELETE=true for a chart);
· CHARTEVENT_CLICK — clicking on a chart;
· CHARTEVENT_OBJECT_CLICK — mouse click on a graphical object belonging to a chart;
· CHARTEVENT_OBJECT_DRAG — dragging a graphical object with a mouse;
· CHARTEVENT_OBJECT_ENDEDIT — finish editing text in the Edit input box of a graphical object
(OBJ_EDIT);
· CHARTEVENT_CHART_CHANGE — change a chart;
· CHARTEVENT_CUS TOM+n — custom event ID, where n is within the range from 0 to 65535.
CHARTEVENT_CUS TOM _LAS T contains the last acceptable custom event ID
(CHARTEVENT_CUS TOM+65535).
All MQL5 programs work in threads other than the main thread of the application. The main
application thread is responsible for handling all W indows system messages and, in its turn,
generates W indows messages for its own application as a result of this handling. For example,
moving the mouse on a chart (W M _MOUSE_MOVE event) generates several system messages for
subsequent rendering of the application window, and also sends internal messages to experts and
indicators launched on the chart. A situation may occur, where the main application thread has not
yet processed the W M _PAINT system message (and therefore has not yet rendered the modified
chart), while an EA or an indicator has already received the mouse movement event. In this case,
the chart property CHART_FIRS T_VIS IBLE_BAR will be changed only after the chart is rendered.
Foreach event type, the inputs of the OnChartEvent() function have certain values necessary for
handling that event. The table lists events and values passed via the parameters.
//+------------------------------------------------------------------+
//| OnChartEvent_Sample.mq5 |
//| Copyright 2018, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property description "Sample chart event listener and custom events generator"
//--- service keys IDs
#define KEY_NUMPAD_5 12
#define KEY_LEFT 37
#define KEY_UP 38
#define KEY_RIGHT 39
#define KEY_DOWN 40
#define KEY_NUMLOCK_DOWN 98
#define KEY_NUMLOCK_LEFT 100
#define KEY_NUMLOCK_5 101
#define KEY_NUMLOCK_RIGHT 102
#define KEY_NUMLOCK_UP 104
//+------------------------------------------------------------------+
//| Expert initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- display the CHARTEVENT_CUSTOM constant value
Print("CHARTEVENT_CUSTOM=",CHARTEVENT_CUSTOM);
//---
Print("Launched the EA ",MQLInfoString(MQL5_PROGRAM_NAME));
//--- set the flag of receiving chart object creation events
ChartSetInteger(ChartID(),CHART_EVENT_OBJECT_CREATE,true);
//--- set the flag of receiving chart object removal events
ChartSetInteger(ChartID(),CHART_EVENT_OBJECT_DELETE,true);
//--- enabling mouse wheel scrolling messages
ChartSetInteger(0,CHART_EVENT_MOUSE_WHEEL,1);
//--- forced updating of chart properties ensures readiness for event processing
ChartRedraw();
//---
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Expert tick function |
//+------------------------------------------------------------------+
void OnTick()
{
//--- tick counter for generating a custom event
static int tick_counter=0;
//--- divide accumulated ticks by this value
int simple_number=113;
//---
tick_counter++;
//--- send a custom event if the tick counter is multiple of simple_number
if(tick_counter%simple_number==0)
{
//--- form custom event ID from 0 to 65535
ushort custom_event_id=ushort(tick_counter%65535);
//--- send a custom event with parameters filling
EventChartCustom(ChartID(),custom_event_id,tick_counter,SymbolInfoDouble(Symbol(),SYMBOL_BID)
//--- add to a log for analyzing the example results
Print(__FUNCTION__,": Sent a custom event ID=",custom_event_id);
}
//---
}
//+------------------------------------------------------------------+
//| ChartEvent function |
//+------------------------------------------------------------------+
void OnChartEvent(const int id,
const long &lparam,
const double &dparam,
const string &sparam)
{
//--- keypress
if(id==CHARTEVENT_KEYDOWN)
{
switch((int)lparam)
{
case KEY_NUMLOCK_LEFT: Print("Pressed KEY_NUMLOCK_LEFT"); break;
case KEY_LEFT: Print("Pressed KEY_LEFT"); break;
case KEY_NUMLOCK_UP: Print("Pressed KEY_NUMLOCK_UP"); break;
case KEY_UP: Print("Pressed KEY_UP"); break;
case KEY_NUMLOCK_RIGHT: Print("Pressed KEY_NUMLOCK_RIGHT"); break;
case KEY_RIGHT: Print("Pressed KEY_RIGHT"); break;
case KEY_NUMLOCK_DOWN: Print("Pressed KEY_NUMLOCK_DOWN"); break;
case KEY_DOWN: Print("Pressed KEY_DOWN"); break;
case KEY_NUMPAD_5: Print("Pressed KEY_NUMPAD_5"); break;
case KEY_NUMLOCK_5: Print("Pressed KEY_NUMLOCK_5"); break;
default: Print("Pressed unlisted key");
}
}
//--- left-clicking on a chart
if(id==CHARTEVENT_CLICK)
Print("Mouse click coordinates on a chart: x = ",lparam," y = ",dparam);
//--- clicking on a graphical object
if(id==CHARTEVENT_OBJECT_CLICK)
Print("Clicking a mouse button on an object named '"+sparam+"'");
//--- object removed
if(id==CHARTEVENT_OBJECT_DELETE)
Print("Removed object named ",sparam);
//--- object created
if(id==CHARTEVENT_OBJECT_CREATE)
Print("Created object named ",sparam);
//--- changed object
if(id==CHARTEVENT_OBJECT_CHANGE)
Print("Changed object named ",sparam);
//--- object moved or anchor point coordinates changed
if(id==CHARTEVENT_OBJECT_DRAG)
if(str_keys!="")
str_keys=", keys='"+StringSubstr(str_keys,0,StringLen(str_keys)-1)+"'";
PrintFormat("%s: X=%d, Y=%d, delta=%d%s",EnumToString(CHARTEVENT_MOUSE_WHEEL),x_cursor,y_curs
}
//--- event of resizing the chart or modifying the chart properties using the properties dialog win
if(id==CHARTEVENT_CHART_CHANGE)
Print("Changing the chart size or properties");
//--- custom event
if(id>CHARTEVENT_CUSTOM)
PrintFormat("Custom event ID=%d, lparam=%d, dparam=%G, sparam=%s",id,lparam,dparam,sparam);
}
//+------------------------------------------------------------------+
//| MouseState |
//+------------------------------------------------------------------+
string MouseState(uint state)
{
string res;
res+="\nML: " +(((state& 1)== 1)?"DN":"UP"); // mouse left
See also
EventChartCustom, Types of chart events, Event handling functions, Program running, Client
terminal events
OnTester
The function is called in Expert Advisors when the Tester event occurs to perform necessary actions
after testing.
double OnTester(void);
Return Value
The OnTester() function can be used only when testing EAs and is intended primarily for the
calculation of a value that is used as a 'Custom max' criterion when optimizing input parameters.
During the genetic optimization, sorting results within one generation is performed in descending
order. This means that the results with the highest value are deemed the best from the optimization
criterion point of view. The worst values for such sorting are placed at the end and are subsequently
discarded. Therefore, they do not take part in forming the next generation.
Thus, the OnTester() function allows you not only to create and save your own test results reports,
but also control the optimization process to find the best parameters of the trading strategy.
Below is an example of calculating the custom criterion optimization. The idea is to calculate the
linear regression of the balance graph. It is described in the article Optimizing a strategy using
balance graph and comparing results with "Balance + max S harpe Ratio" criterion.
//+------------------------------------------------------------------+
//| OnTester_Sample.mq5 |
//| Copyright 2018, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property description "Sample EA with the OnTester() handler"
#property description "As a custom optimization criterion, "
#property description "the ratio of the balance graph linear regression"
#property description "divided by the deviation mean-square error is returned"
//--- include the class for trading operations
#include <Trade\Trade.mqh>
//--- EA input parameters
input double Lots = 0.1; // Volume
input int Slippage = 10; // Allowable slippage
input int MovingPeriod = 80; // Moving average period
input int MovingShift = 6; // Moving average shift
//--- global variables
int IndicatorHandle=0; // indicator handle
bool IsHedging=false; // flag of the account
CTrade trade; // for performing trading operations
//---
MqlRates rt[2];
//--- trade only at the start of a new bar
if(CopyRates(_Symbol,_Period,0,2,rt)!=2)
{
Print("CopyRates of ",_Symbol," failed, no history");
return;
}
if(rt[1].tick_volume>1)
return;
//--- receive moving average values
double ma[1];
if(CopyBuffer(IndicatorHandle,0,1,1,ma)!=1)
{
Print("CopyBuffer from iMA failed, no data");
return;
}
//--- position has already been selected earlier using PositionSelect()
bool signal=false;
long type=PositionGetInteger(POSITION_TYPE);
//--- candle opened higher but closed below the moving average - close a short position
if(type==(long)POSITION_TYPE_SELL && rt[0].open>ma[0] && rt[0].close<ma[0])
signal=true;
//--- candle opened lower but closed above the moving average - close a long position
if(type==(long)POSITION_TYPE_BUY && rt[0].open<ma[0] && rt[0].close>ma[0])
signal=true;
//--- additional checks
if(signal)
{
if(TerminalInfoInteger(TERMINAL_TRADE_ALLOWED) && Bars(_Symbol,_Period)>100)
trade.PositionClose(_Symbol,Slippage);
}
//---
}
//+-------------------------------------------------------------------+
//| Select a position considering an account type: Netting or Hedging |
//+-------------------------------------------------------------------+
bool SelectPosition()
{
bool res=false;
//--- select a position for a Hedging account
if(IsHedging)
{
uint total=PositionsTotal();
for(uint i=0; i<total; i++)
{
string position_symbol=PositionGetSymbol(i);
if(_Symbol==position_symbol && EA_MAGIC==PositionGetInteger(POSITION_MAGIC))
{
res=true;
break;
}
}
}
//--- select a position for a Netting account
else
{
if(!PositionSelect(_Symbol))
return(false);
else
return(PositionGetInteger(POSITION_MAGIC)==EA_MAGIC); //---check Magic number
}
//--- execution result
return(res);
}
//+------------------------------------------------------------------+
//| Expert initialization function |
//+------------------------------------------------------------------+
int OnInit(void)
{
//--- set a trading type: Netting or Hedging
IsHedging=((ENUM_ACCOUNT_MARGIN_MODE)AccountInfoInteger(ACCOUNT_MARGIN_MODE)==ACCOUNT_MARGIN_MOD
//--- initialize an object for correct position control
trade.SetExpertMagicNumber(EA_MAGIC);
trade.SetMarginMode();
trade.SetTypeFillingBySymbol(Symbol());
trade.SetDeviationInPoints(Slippage);
//--- create Moving Average indicator
IndicatorHandle=iMA(_Symbol,_Period,MovingPeriod,MovingShift,MODE_SMA,PRICE_CLOSE);
if(IndicatorHandle==INVALID_HANDLE)
{
printf("Error creating iMA indicator");
return(INIT_FAILED);
}
//--- ok
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Expert tick function |
//+------------------------------------------------------------------+
void OnTick(void)
{
//--- if a position is already opened, check the closing condition
if(SelectPosition())
CheckForClose();
// check the position opening condition
CheckForOpen();
//---
}
//+------------------------------------------------------------------+
//| Tester function |
//+------------------------------------------------------------------+
double OnTester()
{
//--- custom criterion optimization value (the higher, the better)
double ret=0.0;
//--- get trade results to the array
double array[];
double trades_volume;
GetTradeResultsToArray(array,trades_volume);
int trades=ArraySize(array);
//--- if there are less than 10 trades, test yields no positive results
if(trades<10)
return (0);
//--- average result per trade
double average_pl=0;
for(int i=0;i<ArraySize(array);i++)
average_pl+=array[i];
average_pl/=trades;
//--- display the message for the single-test mode
if(MQLInfoInteger(MQL_TESTER) && !MQLInfoInteger(MQL_OPTIMIZATION))
PrintFormat("%s: Trades=%d, Average profit=%.2f",__FUNCTION__,trades,average_pl);
//--- calculate linear regression ratios for the profit graph
double a,b,std_error;
double chart[];
if(!CalculateLinearRegression(array,chart,a,b))
return (0);
//--- calculate the error of the chart deviation from the regression line
if(!CalculateStdError(chart,a,b,std_error))
return (0);
//--- calculate the ratio of trend profits to the standard deviation
ret=(std_error == 0.0) ? a*trades : a*trades/std_error;
//--- return custom criterion optimization value
return(ret);
}
//+------------------------------------------------------------------+
//| Get the array of profits/losses from deals |
//+------------------------------------------------------------------+
bool GetTradeResultsToArray(double &pl_results[],double &volume)
{
//--- request the complete trading history
if(!HistorySelect(0,TimeCurrent()))
return (false);
uint total_deals=HistoryDealsTotal();
volume=0;
//--- set the initial size of the array with a margin - by the number of deals in history
ArrayResize(pl_results,total_deals);
//--- counter of deals that fix the trading result - profit or loss
int counter=0;
ulong ticket_history_deal=0;
//--- go through all deals
for(uint i=0;i<total_deals;i++)
{
//--- select a deal
if((ticket_history_deal=HistoryDealGetTicket(i))>0)
{
ENUM_DEAL_ENTRY deal_entry =(ENUM_DEAL_ENTRY)HistoryDealGetInteger(ticket_history_deal,DE
long deal_type =HistoryDealGetInteger(ticket_history_deal,DEAL_TYPE);
double deal_profit =HistoryDealGetDouble(ticket_history_deal,DEAL_PROFIT);
double deal_volume =HistoryDealGetDouble(ticket_history_deal,DEAL_VOLUME);
//--- we are only interested in trading operations
if((deal_type!=DEAL_TYPE_BUY) && (deal_type!=DEAL_TYPE_SELL))
continue;
//--- only deals that fix profits/losses
if(deal_entry!=DEAL_ENTRY_IN)
{
//--- write the trading result to the array and increase the counter of deals
pl_results[counter]=deal_profit;
volume+=deal_volume;
counter++;
}
}
}
//--- set the final size of the array
ArrayResize(pl_results,counter);
return (true);
}
//+------------------------------------------------------------------+
//| Calculate the linear regression y=a*x+b |
//+------------------------------------------------------------------+
bool CalculateLinearRegression(double &change[],double &chartline[],
double &a_coef,double &b_coef)
{
//--- check for data sufficiency
if(ArraySize(change)<3)
return (false);
//--- create a chart array with an accumulation
int N=ArraySize(change);
ArrayResize(chartline,N);
chartline[0]=change[0];
for(int i=1;i<N;i++)
chartline[i]=chartline[i-1]+change[i];
//--- now, calculate regression ratios
double x=0,y=0,x2=0,xy=0;
for(int i=0;i<N;i++)
{
x=x+i;
y=y+chartline[i];
xy=xy+i*chartline[i];
x2=x2+i*i;
}
a_coef=(N*xy-x*y)/(N*x2-x*x);
b_coef=(y-a_coef*x)/N;
//---
return (true);
}
//+------------------------------------------------------------------+
//| Calculate mean-square deviation error for specified a and b |
//+------------------------------------------------------------------+
bool CalculateStdError(double &data[],double a_coef,double b_coef,double &std_err)
{
//--- sum of error squares
double error=0;
int N=ArraySize(data);
if(N<=2)
return (false);
for(int i=0;i<N;i++)
error+=MathPow(a_coef*i+b_coef-data[i],2);
std_err=MathSqrt(error/(N-2));
//---
return (true);
}
See also
OnTesterInit
The function is called in EAs when the TesterInit event occurs to perform necessary actions before
optimization in the strategy tester. There are two function types.
The version that returns the result
int OnTesterInit(void);
Return Value
int type value, zero means successful initialization of an EA launched on a chart before optimization
starts.
The OnTesterInit() call that returns the execution result is recommended for use since it not only
allows for program initialization, but also returns an error code in case of an early optimization stop.
R eturn of any value other than INIT _SUCCEEDED (0) means an error, no optimization is launched.
The version without a result return is left only for compatibility with old codes. Not recommended
for use
void OnTesterInit(void);
Note
The TesterInit event is generated before EA optimization in the strategy tester starts. At this
event, an EA having OnTesterDeInit() or OnTesterPass() event handler is automatically downloaded
on a separate terminal chart. It has the symbol and the period that have been specified in the
tester.
S uch an event receives the TesterInit, TesterDeinit and TesterPass events, but not Init, Deinit and
NewTick ones. Accordingly, all necessary logic for processing the results of each pass during
optimization should be implemented in the OnTesterInit (), OnTesterDeinit () and OnTesterPass ()
handlers.
The result of each single pass during a strategy optimization can be passed via a frame from the
OnTester () handler using the FrameAdd () function.
The OnTesterInit() function is used to initiate an Expert Advisor before start of optimization for
further processing of optimization results. It is always used together with the OnTesterDeinit()
handler.
The time for OnTesterInit() execution is limited. If it is exceeded, the EA is forcibly stopped, while
the optimization itself is canceled. A message is displayed in the tester journal:
TesterOnTesterInit works too long. Tester cannot be initialized.
The example is taken from OnTick. The OnTesterInit() handler is added for setting optimization
parameters :
//+------------------------------------------------------------------+
//| OnTesterInit_Sample.mq5 |
//| Copyright 2018, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
//+------------------------------------------------------------------+
void OnTesterDeinit()
{
//--- optimization duration
string log_message=StringFormat("%s: optimization took %d seconds",
__FUNCTION__,TimeLocal()-optimization_start);
PrintFormat(log_message);
report=report+"\r\n"+log_message;
Comment(report);
}
//+------------------------------------------------------------------+
//| Expert initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- initialize global variables
last_atr=0;
last_body=0;
//--- set the correct volume
double min_lot=SymbolInfoDouble(_Symbol,SYMBOL_VOLUME_MIN);
trade_lot=lots>min_lot? lots:min_lot;
//--- create ATR indicator handle
atr_handle=iATR(_Symbol,_Period,ATRperiod);
if(atr_handle==INVALID_HANDLE)
{
PrintFormat("%s: failed to create iATR, error code %d",__FUNCTION__,GetLastError());
return(INIT_FAILED);
}
//--- successful EA initialization
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Expert tick function |
//+------------------------------------------------------------------+
void OnTick()
{
//--- trading signal
static int signal=0; // +1 means a buy signal, -1 means a sell signal
//--- check and close old positions opened more than 'holdbars' bars ago
ClosePositionsByBars(holdbars,slippage,EXPERT_MAGIC);
//--- check for a new bar
if(isNewBar())
{
//--- check for a signal presence
signal=CheckSignal();
}
//--- if a netting position is opened, skip the signal - wait till it closes
if(signal!=0 && PositionsTotal()>0 && (ENUM_ACCOUNT_MARGIN_MODE)AccountInfoInteger(ACCOUNT_MARGI
{
signal=0;
return; // exit the NewTick event handler and do not enter the market before a new bar appear
}
//--- for a hedging account, each position is held and closed separately
if(signal!=0)
{
//--- buy signal
if(signal>0)
{
PrintFormat("%s: Buy signal! Revers=%s",__FUNCTION__,string(revers));
if(Buy(trade_lot,slippage,EXPERT_MAGIC))
signal=0;
}
//--- sell signal
if(signal<0)
{
PrintFormat("%s: Sell signal! Revers=%s",__FUNCTION__,string(revers));
if(Sell(trade_lot,slippage,EXPERT_MAGIC))
signal=0;
}
}
//--- OnTick function end
}
//+------------------------------------------------------------------+
//| Check for a new trading signal |
//+------------------------------------------------------------------+
int CheckSignal()
{
//--- 0 means no signal
int res=0;
//--- get ATR value on a penultimate complete bar (the bar index is 2)
double atr_value[1];
if(CopyBuffer(atr_handle,0,2,1,atr_value)!=-1)
{
last_atr=atr_value[0];
//--- get data on the last closed bar to the MqlRates type array
MqlRates bar[1];
if(CopyRates(_Symbol,_Period,1,1,bar)!=-1)
{
//--- calculate the bar body size on the last complete bar
last_body=bar[0].close-bar[0].open;
//--- if the body of the last bar (with index 1) exceeds the previous ATR value (on the ba
if(MathAbs(last_body)>kATR*last_atr)
res=last_body>0?1:-1; // positive value for the upward candle
}
else
PrintFormat("%s: Failed to receive the last bar! Error",__FUNCTION__,GetLastError());
}
else
//--- if a position's lifetime is already large, while MagicNumber and a symbol match
if(bars>holdtimebars && magic==magicnumber && position_symbol==_Symbol)
{
int digits=(int)SymbolInfoInteger(position_symbol,SYMBOL_DIGITS); // number o
double volume=PositionGetDouble(POSITION_VOLUME); // position
ENUM_POSITION_TYPE type=(ENUM_POSITION_TYPE)PositionGetInteger(POSITION_TYPE); // position
string str_type=StringSubstr(EnumToString(type),14);
StringToLower(str_type); // lower the text case for correct message formatting
PrintFormat("Close position #%d %s %s %.2f",
position_ticket,position_symbol,str_type,volume);
//--- set an order type and sending a trade request
if(type==POSITION_TYPE_BUY)
MarketOrder(ORDER_TYPE_SELL,volume,deviation,magicnumber,position_ticket);
else
MarketOrder(ORDER_TYPE_BUY,volume,deviation,magicnumber,position_ticket);
}
}
}
//+------------------------------------------------------------------+
//| Prepare and send a trade request |
//+------------------------------------------------------------------+
bool MarketOrder(ENUM_ORDER_TYPE type,double volume,ulong slip,ulong magicnumber,ulong pos_ticket=0
{
//--- declaring and initializing structures
MqlTradeRequest request={};
MqlTradeResult result={};
double price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
if(type==ORDER_TYPE_BUY)
price=SymbolInfoDouble(Symbol(),SYMBOL_ASK);
//--- request parameters
request.action =TRADE_ACTION_DEAL; // trading operation type
request.position =pos_ticket; // position ticket if closing
request.symbol =Symbol(); // symbol
request.volume =volume; // volume
request.type =type; // order type
request.price =price; // trade price
request.deviation=slip; // allowable deviation from the price
request.magic =magicnumber; // order MagicNumber
//--- send a request
if(!OrderSend(request,result))
{
//--- display data on failure
PrintFormat("OrderSend %s %s %.2f at %.5f error %d",
request.symbol,EnumToString(type),volume,request.price,GetLastError());
return (false);
}
//--- inform of a successful operation
PrintFormat("retcode=%u deal=%I64u order=%I64u",result.retcode,result.deal,result.order);
return (true);
}
See also
OnTesterDeinit
The function is called in EAs when the TesterDeinit event occurs after EA optimization.
void OnTesterDeinit(void);
Return Value
No return value
Note
The TesterDeinit event is generated after the end of EA optimization in the strategy tester.
An EA having OnTesterDeInit() or OnTesterPass() event handler is automatically downloaded on a
separate terminal chart during the optimization start. It has the symbol and the period that have
been specified in the tester. The function is designed for the final processing of all optimization
results.
Keep in mind that optimization frames sent by test agents using the FrameAdd() function may come
in bundles and take time to deliver. Therefore, not all frames, as well as TesterPass events, may
arrive and be processed in OnTesterPass() before the end of optimization. If you want to receive all
belated frames in OnTesterDeinit(), place the code block using the FrameNext() function.
See also
Testing trading strategies, W orking with optimization results, TesterS tatistics, OnTesterInit,
OnTesterPass, ParameterGetRange, ParameterS etRange
OnTesterPass
The function is called in EAs when the TesterPass event occurs for handling a new data frame during
EA optimization.
void OnTesterPass(void);
Return Value
No return value
Note
The TesterPass event is generated automatically when receiving a frame during an Expert Advisor
optimization in the strategy tester.
An EA having OnTesterDeInit() or OnTesterPass() event handler is automatically downloaded on a
separate terminal chart during the optimization start. It has the symbol and the period that have
been specified in the tester. The function is meant for handling frames received from test agents
during optimization. The frame containing test results should be sent from the OnTester() handler
using the FrameAdd() function.
Keep in mind that optimization frames sent by test agents using the FrameAdd() function may come
in bundles and take time to deliver. Therefore, not all frames, as well as TesterPass events, may
arrive and be processed in OnTesterPass() before the end of optimization. If you want to receive all
belated frames in OnTesterDeinit(), place the code block using the FrameNext() function.
After completing OnTesterDeinit() optimization, it is possible to sort all received frames again using
the FrameFirst()/FrameFilter and FrameNext() functions.
See also
Function Action
SymbolsTotal
R eturns the number of available (selected in Market W atch or all) symbols.
int SymbolsTotal(
bool selected // True - only symbols in MarketWatch
);
Parameters
selected
[in] R equest mode. Can be true or false.
Return Value
If the 'selected' parameter is true, the function returns the number of symbols selected in
MarketW atch. If the value is false, it returns the total number of all symbols.
SymbolExist
Checks if a symbol with a specified name exists.
bool SymbolExist(
const string name, // symbol name
bool& is_custom // custom symbol property
);
Parameters
name
[in] S ymbol name.
is_custom
[out] Custom symbol property set upon successful execution. If true, the detected symbol is a
custom one.
Return Value
If false, the symbol is not found among standard and custom ones.
See also
S ymbolsTotal, S ymbolS elect, Custom symbols
SymbolName
R eturns the name of a symbol.
string SymbolName(
int pos, // number in the list
bool selected // true - only symbols in MarketWatch
);
Parameters
pos
[in] Order number of a symbol.
selected
[in] R equest mode. If the value is true, the symbol is taken from the list of symbols selected in
MarketW atch. If the value is false, the symbol is taken from the general list.
Return Value
SymbolSelect
S elects a symbol in the Market W atch window or removes a symbol from the window.
bool SymbolSelect(
string name, // symbol name
bool select // add or remove
);
Parameters
name
[in] S ymbol name.
select
[in] S witch.If the value is false, a symbol should be removed from MarketW atch, otherwise a
symbol should be selected in this window. A symbol can't be removed if the symbol chart is open,
or there are open positions for this symbol.
Return Value
SymbolIsSynchronized
The function checks whether data of a selected symbol in the terminal are synchronized with data on
the trade server.
bool SymbolIsSynchronized(
string name, // symbol name
);
Parameters
name
[in] S ymbol name.
Return value
SymbolInfoDouble
R eturns the corresponding property of a specified symbol. There are 2 variants of the function.
1. Immediately returns the property value.
double SymbolInfoDouble(
string name, // symbol
ENUM_SYMBOL_INFO_DOUBLE prop_id // identifier of the property
);
2. R eturns
true or false depending on whether a function is successfully performed. In case of success,
the value of the property is placed into a recipient variable, passed by reference by the last
parameter.
bool SymbolInfoDouble(
string name, // symbol
ENUM_SYMBOL_INFO_DOUBLE prop_id, // identifier of the property
double& double_var // here we accept the property value
);
Parameters
name
[in] S ymbol name.
prop_id
[in] Identifier of a symbol property. The value can be one of the values of the
ENUM _SYM BOL _INFO_DOUBL E enumeration.
double_var
[out] Variable of double type receiving the value of the requested property.
Return Value
The value of double type. In case of execution failure, information about the error can be obtained
using GetLastError() function:
· 5040 – invalid string parameter for specifying a symbol name,
· 4301 – unk nown symbol (financial instrument),
· 4302 – symbol is not selected in " Mark et W atch" (not found in the list of available ones),
· 4303 – invalid identifier of a symbol property.
Note
It is recommended to use S ymbolInfoTick() if the function is used for getting information about the
last tick. It may well be that not a single quote has appeared yet since the terminal is connected to a
trading account. In such a case, the requested value will be indefinite.
In most cases, it is enough to use S ymbolInfoTick() function allowing a user to receive the values of
As k , Bid, Last, Volume and the time of the last tick's arrival during a single call.
The S ymbolInfoMarginRate() function provides data on the amount of charged margin depending on
the order type and direction.
Example:
void OnTick()
{
//--- obtain spread from the symbol properties
bool spreadfloat=SymbolInfoInteger(Symbol(),SYMBOL_SPREAD_FLOAT);
string comm=StringFormat("Spread %s = %I64d points\r\n",
spreadfloat?"floating":"fixed",
SymbolInfoInteger(Symbol(),SYMBOL_SPREAD));
//--- now let's calculate the spread by ourselves
double ask=SymbolInfoDouble(Symbol(),SYMBOL_ASK);
double bid=SymbolInfoDouble(Symbol(),SYMBOL_BID);
double spread=ask-bid;
int spread_points=(int)MathRound(spread/SymbolInfoDouble(Symbol(),SYMBOL_POINT));
comm=comm+"Calculated spread = "+(string)spread_points+" points";
Comment(comm);
}
SymbolInfoInteger
R eturns the corresponding property of a specified symbol. There are 2 variants of the function.
1. Immediately returns the property value.
long SymbolInfoInteger(
string name, // symbol
ENUM_SYMBOL_INFO_INTEGER prop_id // identifier of a property
);
2. R eturns
true or false depending on whether a function is successfully performed. In case of success,
the value of the property is placed into a recipient variable, passed by reference by the last
parameter.
bool SymbolInfoInteger(
string name, // symbol
ENUM_SYMBOL_INFO_INTEGER prop_id, // identifier of a property
long& long_var // here we accept the property value
);
Parameters
name
[in] S ymbol name.
prop_id
[in] Identifier of a symbol property. The value can be one of the values of the
ENUM _SYM BOL _INFO_INT EGER enumeration.
long_var
[out] Variable of the long type receiving the value of the requested property.
Return Value
The value of long type. In case of execution failure, information about the error can be obtained
using GetLastError() function:
· 5040 – invalid string parameter for specifying a symbol name,
· 4301 – unk nown symbol (financial instrument),
· 4302 – symbol is not selected in " Mark et W atch" (not found in the list of available ones),
· 4303 – invalid identifier of a symbol property.
Note
It is recommended to use S ymbolInfoTick() if the function is used for getting information about the
last tick. It may well be that not a single quote has appeared yet since the terminal is connected to a
trading account. In such a case, the requested value will be indefinite.
In most cases, it is enough to use S ymbolInfoTick() function allowing a user to receive the values of
As k , Bid, Last, Volume and the time of the last tick's arrival during a single call.
Example:
void OnTick()
{
//--- obtain spread from the symbol properties
bool spreadfloat=SymbolInfoInteger(Symbol(),SYMBOL_SPREAD_FLOAT);
string comm=StringFormat("Spread %s = %I64d points\r\n",
spreadfloat?"floating":"fixed",
SymbolInfoInteger(Symbol(),SYMBOL_SPREAD));
//--- now let's calculate the spread by ourselves
double ask=SymbolInfoDouble(Symbol(),SYMBOL_ASK);
double bid=SymbolInfoDouble(Symbol(),SYMBOL_BID);
double spread=ask-bid;
int spread_points=(int)MathRound(spread/SymbolInfoDouble(Symbol(),SYMBOL_POINT));
comm=comm+"Calculated spread = "+(string)spread_points+" points";
Comment(comm);
}
SymbolInfoString
R eturns the corresponding property of a specified symbol. There are 2 variants of the function.
1. Immediately returns the property value.
string SymbolInfoString(
string name, // Symbol
ENUM_SYMBOL_INFO_STRING prop_id // Property identifier
);
2. R eturns true or false, depending on the success of a function. If successful, the value of the
property is placed in a placeholder variable passed by reference in the last parameter.
bool SymbolInfoString(
string name, // Symbol
ENUM_SYMBOL_INFO_STRING prop_id, // Property identifier
string& string_var // here we accept the property value
);
Parameters
name
[in] S ymbol name.
prop_id
[in] Identifier of a symbol property. The value can be one of the values of the
ENUM _SYM BOL _INFO_S T R ING enumeration.
string_var
[out] Variable of the string type receiving the value of the requested property.
Return Value
The value of string type. In case of execution failure, information about the error can be obtained
using GetLastError() function:
· 5040 – invalid string parameter for specifying a symbol name,
· 4301 – unk nown symbol (financial instrument),
· 4302 – symbol is not selected in " Mark et W atch" (not found in the list of available ones),
· 4303 – invalid identifier of a symbol property.
Note
It is recommended to use S ymbolInfoTick() if the function is used for getting information about the
last tick. It may well be that not a single quote has appeared yet since the terminal is connected to a
trading account. In such a case, the requested value will be indefinite.
In most cases, it is enough to use S ymbolInfoTick() function allowing a user to receive the values of
As k , Bid, Last, Volume and the time of the last tick's arrival during a single call.
SymbolInfoMarginRate
R eturns the margin rates depending on the order type and direction.
bool SymbolInfoMarginRate(
string name, // symbol name
ENUM_ORDER_TYPE order_type, // order type
double& initial_margin_rate, // initial margin rate
double& maintenance_margin_rate // maintenance margin rate
);
Parameters
name
[in] S ymbol name.
order_type
[in] Order type.
initial_margin_rate
[in] A double type variable for receiving an initial margin rate. Initial margin is a security deposit
for 1 lot deal in the appropriate direction. Multiplying the rate by the initial margin, we receive the
amount of funds to be reserved on the account when placing an order of the specified type.
maintenance_margin_rate
[out] A double type variable for receiving a maintenance margin rate. Maintenance margin is a
minimum amount for maintaining an open position of 1 lot in the appropriate direction. Multiplying
the rate by the maintenance margin, we receive the amount of funds to be reserved on the
account after an order of the specified type is activated.
Return Value
SymbolInfoTick
The function returns current prices of a specified symbol in a variable of the M qlTick type.
bool SymbolInfoTick(
string symbol, // symbol name
MqlTick& tick // reference to a structure
);
Parameters
symbol
[in] S ymbol name.
tick
[out] Link to the structure of the M qlTick type, to which the current prices and time of the last
price update will be placed.
Return Value
SymbolInfoSessionQuote
Allowsreceiving time of beginning and end of the specified quoting sessions for a specified symbol
and day of week.
bool SymbolInfoSessionQuote(
string name, // symbol name
ENUM_DAY_OF_WEEK day_of_week, // day of the week
uint session_index, // session index
datetime& from, // time of the session beginning
datetime& to // time of the session end
);
Parameters
name
[in] S ymbol name.
ENUM_DAY_OF_WEEK
[in] Day of the week, value of enumeration ENUM _DAY_OF_WEEK.
uint
[in] Ordinal number of a session, whose beginning and end time we want to receive. Indexing of
sessions starts with 0.
from
[out] S ession beginning time in seconds from 00 hours 00 minutes, in the returned value date
should be ignored.
to
[out] S ession end time in seconds from 00 hours 00 minutes, in the returned value date should be
ignored.
Return Value
If data for the specified session, symbol and day of the week are received, returns true, otherwise
returns false.
See also
S ymbol Properties, TimeToS truct, Data S tructures
SymbolInfoSessionTrade
Allows receiving time of beginning and end of the specified trading sessions for a specified symbol and
day of week.
bool SymbolInfoSessionTrade(
string name, // symbol name
ENUM_DAY_OF_WEEK day_of_week, // day of the week
uint session_index, // session index
datetime& from, // session beginning time
datetime& to // session end time
);
Parameters
name
[in] S ymbol name.
ENUM_DAY_OF_WEEK
[in] Day of the week, value of enumeration ENUM _DAY_OF_WEEK.
uint
[in] Ordinal number of a session, whose beginning and end time we want to receive. Indexing of
sessions starts with 0.
from
[out] S ession beginning time in seconds from 00 hours 00 minutes, in the returned value date
should be ignored.
to
[out] S ession end time in seconds from 00 hours 00 minutes, in the returned value date should be
ignored.
Return value
If data for the specified session, symbol and day of the week are received, returns true, otherwise
returns false.
See also
S ymbol Properties, TimeToS truct, Data S tructures
MarketBookAdd
Provides opening of Depth of Market for a selected symbol, and subscribes for receiving notifications
of the DOM changes.
bool MarketBookAdd(
string symbol // symbol
);
Parameters
symbol
[in] The name of a symbol, whose Depth of Market is to be used in the Expert Advisor or script.
Return Value
Normally,this function must be called from the OnInit() function or in the class constructor. To
handle incoming alerts, in the Expert Advisor program must contain the function void
OnBookEvent(string& symbol).
See also
S tructure of Depth of Market, S tructures and Classes
MarketBookRelease
Provides closing of Depth of Market for a selected symbol, and cancels the subscription for receiving
notifications of the DOM changes.
bool MarketBookRelease(
string symbol // symbol
);
Parameters
symbol
[in] S ymbol name.
Return Value
Normally, this function must be called from the OnDeinit() function, if the corresponding
MarketBookAdd() function has been called in the OnInit() function. Or it must be called from the
class destructor, if the corresponding MarketBookAdd() function has been called from the class
constructor.
See also
S tructure of Depth of Market, S tructures and Classes
MarketBookGet
R eturns a structure array M qlBookInfo containing records of the Depth of Market of a specified symbol.
bool MarketBookGet(
string symbol, // symbol
MqlBookInfo& book[] // reference to an array
);
Parameters
symbol
[in] S ymbol name.
book[]
[in] R eferenceto an array of Depth of Market records. The array can be pre-allocated for a
sufficient number of records. If a dynamic array hasn't been pre-allocated in the operating
memory, the client terminal will distribute the array itself.
Return Value
MqlBookInfo priceArray[];
bool getBook=MarketBookGet(NULL,priceArray);
if(getBook)
{
int size=ArraySize(priceArray);
Print("MarketBookInfo for ",Symbol());
for(int i=0;i<size;i++)
{
Print(i+":",priceArray[i].price
+" Volume = "+priceArray[i].volume,
" type = ",priceArray[i].type);
}
}
else
{
Print("Could not get contents of the symbol DOM ",Symbol());
}
See also
S tructure of Depth of Market, S tructures and Classes
Function Action
CalendarCountryById
Get a country description by its ID.
bool CalendarCountryById(
const long country_id, // country ID
MqlCalendarCountry& country // variable for receiving a country description
);
Parameters
country_id
[in] Country ID (IS O 3166-1).
country
[out] M qlCalendarCountry type variable for receiving a country description.
Return Value
R eturns true if successful, otherwise - false. To get information about an error, call the
GetLastError() function. Possible errors :
· 4001 – ERR_I NT ERNAL _ERR OR(general runtime error),
· 5402 – ERR_CALENDAR_NO_DATA (country is not found),
· 5401 – ERR_CALENDAR_TIM EOUT (request time limit exceeded).
Example:
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- get the list of countries from the economic calendar
MqlCalendarCountry countries[];
int count=CalendarCountries(countries);
//--- check the result
if(count==0)
PrintFormat("CalendarCountries() returned 0! Error %d",GetLastError());
//--- if there are two or more countries
if(count>=2)
{
MqlCalendarCountry country;
//--- now get a country description by its ID
if(CalendarCountryById(countries[1].id, country))
{
//--- prepare a country description
string descr="id = "+IntegerToString(country.id)+"\n";
descr+=("name = " + country.name+"\n");
descr+=("code = " + country.code+"\n");
descr+=("currency = " + country.currency+"\n");
descr+=("currency_symbol = " + country.currency_symbol+"\n");
See also
CalendarCountries, CalendarEventByCountry
CalendarEventById
Get an event description by its ID.
bool CalendarEventById(
ulong event_id, // event ID
MqlCalendarEvent& event // variable for receiving an event description
);
Parameters
event_id
[in] Event ID.
event
[out] M qlCalendarEvent type variable for receiving an event description.
Return Value
R eturns true if successful, otherwise - false. To get information about an error, call the
GetLastError() function. Possible errors :
· 4001 – ERR_I NT ERNAL _ERR OR(general runtime error),
· 5402 – ERR_CALENDAR_NO_DATA (country is not found),
· 5401 – ERR_CALENDAR_TIM EOUT (request time limit exceeded).
Example:
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- country code for Germany (ISO 3166-1 Alpha-2)
string germany_code="DE";
//--- get Germany events
MqlCalendarEvent events[];
int events_count=CalendarEventByCountry(germany_code,events);
//--- display Germany events in the Journal
if(events_count>0)
{
PrintFormat("Germany events: %d",events_count);
ArrayPrint(events);
}
else
{
PrintFormat("Failed to receive events for the country code %s, error %d",
germany_code,GetLastError());
//--- script early completion
return;
}
//--- get description of the last event from the events[] array
MqlCalendarEvent event;
ulong event_id=events[events_count-1].id;
if(CalendarEventById(event_id,event))
{
MqlCalendarCountry country;
CalendarCountryById(event.country_id,country);
PrintFormat("Event description with event_id=%d received",event_id);
PrintFormat("Country: %s (country code = %d)",country.name,event.country_id);
PrintFormat("Event name: %s",event.name);
PrintFormat("Event code: %s",event.event_code);
PrintFormat("Event importance: %s",EnumToString((ENUM_CALENDAR_EVENT_IMPORTANCE)event.importa
PrintFormat("Event type: %s",EnumToString((ENUM_CALENDAR_EVENT_TYPE)event.type));
PrintFormat("Event sector: %s",EnumToString((ENUM_CALENDAR_EVENT_SECTOR)event.sector));
PrintFormat("Event frequency: %s",EnumToString((ENUM_CALENDAR_EVENT_FREQUENCY)event.frequency
PrintFormat("Event release mode: %s",EnumToString((ENUM_CALENDAR_EVENT_TIMEMODE)event.time_mo
PrintFormat("Event measurement unit: %s",EnumToString((ENUM_CALENDAR_EVENT_UNIT)event.unit));
PrintFormat("Number of decimal places: %d",event.digits);
PrintFormat("Event multiplier: %s",EnumToString((ENUM_CALENDAR_EVENT_MULTIPLIER)event.multipl
PrintFormat("Source URL: %s",event.source_url);
}
else
PrintFormat("Failed to get event description for event_d=%s, error %d",
event_id,GetLastError());
}
/*
Result:
Germany events: 50
[id] [type] [sector] [frequency] [time_mode] [country_id] [unit] [importance] [multipl
[ 0] 276010001 1 6 2 0 276 1 1
[ 1] 276010002 1 6 2 0 276 1 1
[ 2] 276010003 1 4 2 0 276 1 1
[ 3] 276010004 1 4 2 0 276 1 1
....
[47] 276500001 1 8 2 0 276 0 2
[48] 276500002 1 8 2 0 276 0 2
[49] 276500003 1 8 2 0 276 0 2
Event description with event_id=276500003 received
Country: Germany (country code = 276)
Event name: Markit Composite PMI
Event code: markit-composite-pmi
Event importance: CALENDAR_IMPORTANCE_MODERATE
Event type: CALENDAR_TYPE_INDICATOR
Event sector: CALENDAR_SECTOR_BUSINESS
Event frequency: CALENDAR_FREQUENCY_MONTH
Event release mode: CALENDAR_TIMEMODE_DATETIME
Event measurement unit: CALENDAR_UNIT_NONE
Number of decimal places: 1
Value multiplier: CALENDAR_MULTIPLIER_NONE
Source URL: https://www.markiteconomics.com
*/
See also
CalendarEventByCountry, CalendarEventByCurrency, CalendarValueById
CalendarValueById
Get an event value description by its ID.
bool CalendarValueById(
ulong value_id, // event value ID
MqlCalendarValue& value // variable for receiving an event value
);
Parameters
value_id
[in] Event value ID.
value
[out] M qlCalendarValue type variable for receiving an event description. S ee the example of
handling calendar events.
Return Value
R eturns true if successful, otherwise - false. To get information about an error, call the
GetLastError() function. Possible errors :
· 4001 – ERR_I NT ERNAL _ERR OR(general runtime error),
· 5402 – ERR_CALENDAR_NO_DATA (country is not found),
· 5401 – ERR_CALENDAR_TIM EOUT (request time limit exceeded).
Note
All functionsfor working with the economic calendar use the trade server time (TimeTradeS erver).
This means that the time in the M qlCalendarValue structure and the time inputs in the
CalendarValueHistoryByEvent/CalendarValueHistory functions are set in a trade server timezone,
rather than a user's local time.
The M qlCalendarValue structure provides methods for checking and setting values from the
actual_value, forecast_value, prev _value and revised_prev _value fields. If no value is specified, the
field stores LONG_MIN (-9223372036854775808).
Please note that the values stored in these field are multiplied by one million. It means that when
you receive values in M qlCalendarValue using functions CalendarValueById,
CalendarValueHistoryByEvent, CalendarValueHistory, CalendarValueLastByEvent and
CalendarValueLast, you should check if the field values are equal to LONG_MIN; if a value is
specified in a field, then you should divide the value by 1,000,000 in order to get the value. Another
method to get the values is to check and to get values using the functions of the M qlCalendarValue
structure.
Example:
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- country code for Japan (ISO 3166-1 Alpha-2)
string japan_code="JP";
//--- set the boundaries of the interval we take the events from
datetime date_from=D'01.01.2018'; // take all events from 2018
datetime date_to=0; // 0 means all known events, including the ones that have not
//--- get the array of the Japan event values
MqlCalendarValue values[];
int values_count=CalendarValueHistory(values,date_from,date_to,japan_code);
//--- move along the detected event values
if(values_count>0)
{
PrintFormat("Number of values for Japan events: %d",values_count);
//--- delete all "empty" values (actual_value==-9223372036854775808)
for(int i=values_count-1;i>=0;i--)
{
if(values[i].actual_value==-9223372036854775808)
ArrayRemove(values,i,1);
}
PrintFormat("Number of values after deleting empty ones: %d",ArraySize(values));
}
else
{
PrintFormat("Failed to receive events for the country code %s, error %d",
japan_code,GetLastError());
//--- script early completion
return;
}
//--- leave no more than 10 values in the values[] array
if(ArraySize(values)>10)
{
PrintFormat("Reduce the list of values to 10 and display them");
ArrayRemove(values,0,ArraySize(values)-10);
}
ArrayPrint(values);
//--- now let's display how to get an event value description based on the known value_id
for(int i=0;i<ArraySize(values);i++)
{
MqlCalendarValue value;
CalendarValueById(values[i].id,value);
PrintFormat("%d: value_id=%d value=%d impact=%s",
i,values[i].id,value.actual_value,EnumToString(ENUM_CALENDAR_EVENT_IMPACT(value.i
}
//---
}
/*
Result:
Number of values for Japan events: 1734
Number of values after deleting empty ones: 1017
Reduce the list of values to 10 and display them
See also
CalendarValueHistoryByEvent, CalendarValueHistory, CalendarValueLastByEvent, CalendarValueLast
CalendarCountries
Get the array of country names available in the Calendar.
int CalendarCountries(
MqlCalendarCountry& countries[] // array for receiving a list of Calendar countries' de
);
Parameters
countries[]
[out] An array of M qlCalendarCountry type for receiving all Calendar countries ' descriptions.
Return Value
Number of received descriptions. To get information about an error, call the GetLastError()
function. Possible errors :
· 4001 – ERR_I NT ERNAL _ERR OR (general runtime error),
· 5401 – ERR_CAL ENDAR_TIM EOUT (request time limit exceeded),
· 5400 – ERR_CAL ENDAR_MORE_DAT A (array size is insufficient for receiving descriptions of all
countries, only the ones that managed to fit in were received).
Example:
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- get the list of countries from the economic calendar
MqlCalendarCountry countries[];
int count=CalendarCountries(countries);
//--- display the array in the Journal
if(count>0)
ArrayPrint(countries);
else
PrintFormat("CalendarCountries() returned 0! Error %d",GetLastError());
/*
Result:
[id] [name] [code] [currency] [currency_symbol] [url_name] [reserved]
[ 0] 0 "Worldwide" "WW" "ALL" "" "worldwide" 0
[ 1] 999 "European Union" "EU" "EUR" "€" "european-union" 0
[ 2] 840 "United States" "US" "USD" "$" "united-states" 0
[ 3] 124 "Canada" "CA" "CAD" "$" "canada" 0
[ 4] 36 "Australia" "AU" "AUD" "$" "australia" 0
[ 5] 554 "New Zealand" "NZ" "NZD" "$" "new-zealand" 0
[ 6] 392 "Japan" "JP" "JPY" "Ґ" "japan" 0
[ 7] 156 "China" "CN" "CNY" "Ґ" "china" 0
[ 8] 826 "United Kingdom" "GB" "GBP" "Ј" "united-kingdom" 0
[ 9] 756 "Switzerland" "CH" "CHF" "₣" "switzerland" 0
See also
CalendarEventByCountry, CalendarCountryById
CalendarEventByCountry
Get the array of descriptions of all events available in the Calendar by a specified country code.
int CalendarEventByCountry(
string country_code, // country code name (ISO 3166-1 alpha-2)
MqlCalendarEvent& events[] // variable for receiving the description array
);
Parameters
country_code
[in] Country code name (IS O 3166-1 alpha-2)
events[]
[out] M qlCalendarEvent type array for receiving descriptions of all events for a specified country.
Return Value
Number of received descriptions. To get information about an error, call the GetLastError()
function. Possible errors :
· 4001 – ERR_I NT ERNAL _ERR OR (general runtime error),
· 4004 – ERR_NOT _ENOUGH_M EMORY (not enough memory for executing a request),
· 5401 – ERR_CAL ENDAR_TIM EOUT (request time limit exceeded),
· errors of failed execution of ArrayR esize()
Example:
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- country code for EU (ISO 3166-1 Alpha-2)
string EU_code="EU";
//--- get EU events
MqlCalendarEvent events[];
int events_count=CalendarEventByCountry(EU_code,events);
//--- display EU events in the Journal
if(events_count>0)
{
PrintFormat("EU events: %d",events_count);
ArrayPrint(events);
}
//---
}
/*
Result:
EU events: 56
[id] [type] [country_id] [unit] [importance] [multiplier] [digits] [event_code]
[ 0] 999010001 0 999 0 2 0 0 "ECB Non-monetary
*/
See also
CalendarCountries, CalendarCountryById
CalendarEventByCurrency
Get the array of descriptions of all events available in the Calendar by a specified currency.
int CalendarEventByCurrency(
const string currency, // country currency code name
MqlCalendarEvent& events[] // variable for receiving the description array
);
Parameters
currency
[in] Country currency code name.
events[]
[out] M qlCalendarEvent type array for receiving descriptions of all events for a specified currency.
Return Value
Number of received descriptions. To get information about an error, call the GetLastError()
function. Possible errors :
· 4001 – ERR_I NT ERNAL _ERR OR (general runtime error),
· 4004 – ERR_NOT _ENOUGH_M EMORY (not enough memory for executing a request),
· 5401 – ERR_CAL ENDAR_TIM EOUT (request time limit exceeded),
· errors of failed execution of ArrayR esize()
Example:
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- declare the array for receiving economic calendar events
MqlCalendarEvent events[];
//--- get EU currency events
int count = CalendarEventByCurrency("EUR",events);
Print("count = ", count);
//--- 10 events are sufficient for the current example
if(count>10)
ArrayResize(events,10);
//--- display events in the Journal
ArrayPrint(events);
}
/*
Result:
[id] [type] [country_id] [unit] [importance] [s
[0] 999010001 0 999 0 2 "https://www.ecb.europa.eu/home/html/index
[1] 999010002 0 999 0 2 "https://www.ecb.europa.eu/home/html/index
[2] 999010003 0 999 0 3 "https://www.ecb.europa.eu/home/html/index
See also
CalendarEventById, CalendarEventByCountry
CalendarValueHistoryByEvent
Get the array of values for all events in a specified time range by an event ID.
int CalendarValueHistoryByEvent(
ulong event_id, // event ID
MqlCalendarValue& values[], // array for value descriptions
datetime datetime_from, // left border of a time range
datetime datetime_to=0 // right border of a time range
);
Parameters
event_id
[in] Event ID.
values[]
[out] M qlCalendarValue type array for receiving event values. S ee the example of handling
calendar events.
datetime_from
[in] Initial date of a time range events are selected from by a specified ID, while datetime_from <
datetime_to.
datetime_to=0
[in] End date of a time range events are selected from by a specified ID. If the datetime_to is not
set (or is 0), all event values beginning from the specified datetime_from date in the Calendar
database are returned (including the values of future events).
Return Value
If successful, return the number of available values in the 'values ' array, otherwise -1. To get
information about an error, call the GetLastError() function. Possible errors :
· 4001 – ERR_I NT ERNAL _ERR OR (general runtime error),
· 4004 – ERR_NOT _ENOUGH_M EMORY (not enough memory for executing a request),
· 5401 – ERR_CAL ENDAR_TIM EOUT (request time limit exceeded),
· 5400 – ERR_CAL ENDAR_MORE_DAT A (array size is insufficient for receiving descriptions of all
values, only the ones that managed to fit in were received),
· errors of failed execution of ArrayR esize()
The M qlCalendarValue structure provides methods for checking and setting values from the
actual_value, forecast_value, prev _value and revised_prev _value fields. If no value is specified, the
field stores LONG_MIN (-9223372036854775808).
Please note that the values stored in these field are multiplied by one million. It means that when
you receive values in M qlCalendarValue using functions CalendarValueById,
CalendarValueHistoryByEvent, CalendarValueHistory, CalendarValueLastByEvent and
CalendarValueLast, you should check if the field values are equal to LONG_MIN; if a value is
specified in a field, then you should divide the value by 1,000,000 in order to get the value. Another
method to get the values is to check and to get values using the functions of the M qlCalendarValue
structure.
Note
All functionsfor working with the economic calendar use the trade server time (TimeTradeS erver).
This means that the time in the M qlCalendarValue structure and the time inputs in the
CalendarValueHistoryByEvent/CalendarValueHistory functions are set in a trade server timezone,
rather than a user's local time.
Example:
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- country code for EU (ISO 3166-1 Alpha-2)
string EU_code="EU";
//--- get EU events
MqlCalendarEvent events[];
int events_count=CalendarEventByCountry(EU_code,events);
//--- display EU events in the Journal
if(events_count>0)
{
PrintFormat("EU events: %d",events_count);
//--- reduce the event list, 10 events are sufficient for analysis
ArrayResize(events,10);
ArrayPrint(events);
}
//--- see that the "ECB Interest Rate Decision" event has event_id=999010007
ulong event_id=events[6].id; // the event's ID may change in the Calendar, so be sure to
string event_name=events[6].name; // name of a Calendar event
PrintFormat("Get values for event_name=%s event_id=%d",event_name,event_id);
//--- get all values of the "ECB Interest Rate Decision" event
MqlCalendarValue values[];
//--- set the boundaries of the interval we take the events from
datetime date_from=0; // take all events from the beginning of the available history
datetime date_to=D'01.01.2016'; // take events not older than 2016
if(CalendarValueHistoryByEvent(event_id,values,date_from,date_to))
{
PrintFormat("Received values for %s: %d",
event_name,ArraySize(values));
//--- reduce the value list, 10 events are sufficient for analysis
ArrayResize(values,10);
ArrayPrint(values);
}
else
{
PrintFormat("Error! Failed to get values for event_id=%d",event_id);
PrintFormat("Error code: %d",GetLastError());
}
}
//---
/*
Result:
EU events: 56
[id] [type] [sector] [frequency] [time_mode] [country_id] [unit] [importance] [multipli
[0] 999010001 0 5 0 0 999 0 2
[1] 999010002 0 5 0 0 999 0 2
[2] 999010003 0 5 0 0 999 0 3
[3] 999010004 0 5 0 0 999 0 3
[4] 999010005 0 5 0 0 999 0 2
[5] 999010006 1 5 0 0 999 1 3
[6] 999010007 1 5 0 0 999 1 3
[7] 999010008 0 5 0 0 999 0 2
[8] 999010009 1 5 0 0 999 2 2
[9] 999010010 0 5 0 0 999 0 2
Get values for event_name=ECB Interest Rate Decision event_id=999010007
Received ECB Interest Rate Decision event values: 102
[id] [event_id] [time] [period] [revision] [actual_value] [prev_valu
[0] 2776 999010007 2007.03.08 11:45:00 1970.01.01 00:00:00 0 3750000 42500
[1] 2777 999010007 2007.05.10 11:45:00 1970.01.01 00:00:00 0 3750000 37500
[2] 2778 999010007 2007.06.06 11:45:00 1970.01.01 00:00:00 0 4000000 37500
[3] 2779 999010007 2007.07.05 11:45:00 1970.01.01 00:00:00 0 4000000 40000
[4] 2780 999010007 2007.08.02 11:45:00 1970.01.01 00:00:00 0 4000000 40000
[5] 2781 999010007 2007.09.06 11:45:00 1970.01.01 00:00:00 0 4000000 40000
[6] 2782 999010007 2007.10.04 11:45:00 1970.01.01 00:00:00 0 4000000 40000
[7] 2783 999010007 2007.11.08 12:45:00 1970.01.01 00:00:00 0 4000000 40000
[8] 2784 999010007 2007.12.06 12:45:00 1970.01.01 00:00:00 0 4000000 40000
[9] 2785 999010007 2008.01.10 12:45:00 1970.01.01 00:00:00 0 4000000 40000
*/
See also
CalendarCountries, CalendarEventByCountry, CalendarValueHistory, CalendarEventById,
CalendarValueById
CalendarValueHistory
Get the array of values for all events in a specified time range with the ability to sort by country
and/or currency.
int CalendarValueHistory(
MqlCalendarValue& values[], // array for value descriptions
datetime datetime_from, // left border of a time range
datetime datetime_to=0 // right border of a time range
const string country_code=NULL, // country code name (ISO 3166-1 alpha-2)
const string currency=NULL // country currency code name
);
Parameters
values[]
[out] M qlCalendarValue type array for receiving event values. S ee the example of handling
calendar events.
datetime_from
[in] Initial date of a time range events are selected from by a specified ID, while datetime_from <
datetime_to .
datetime_to=0
[in] End date of a time range events are selected from by a specified ID. If the datetime_to is not
set (or is 0), all event values beginning from the specified datetime_from date in the Calendar
database are returned (including the values of future events).
country_code=NULL
[in] Country code name (IS O 3166-1 alpha-2)
currency=NULL
[in] Country currency code name.
Return Value
If successful, return the number of available values in the 'values ' array, otherwise -1. To get
information about an error, call the GetLastError() function. Possible errors :
· 4001 – ERR_I NT ERNAL _ERR OR (general runtime error),
· 4004 – ERR_NOT _ENOUGH_M EMORY (not enough memory for executing a request),
· 5401 – ERR_CAL ENDAR_TIM EOUT (request time limit exceeded),
· 5400 – ERR_CAL ENDAR_MORE_DAT A (array size is insufficient for receiving descriptions of all
values, only the ones that managed to fit in were received),
· errors of failed execution of ArrayR esize()
Note
All functionsfor working with the economic calendar use the trade server time (TimeTradeS erver).
This means that the time in the M qlCalendarValue structure and the time inputs in the
CalendarValueHistoryByEvent/CalendarValueHistory functions are set in a trade server timezone,
rather than a user's local time.
If the events[] array of fixed length was passed to the function and there was not enough space to
save the entire result, the ERR_CALENDAR_MORE_DATA (5400) error is activated.
If the datetime_to is not set (or is 0), all event values beginning from the specified datetime_from
date in the Calendar database are returned (including the values of future events).
For the country_code and currency filters, NULL and "" values are equivalent and mean the absence
of the filter.
For country_code, the code field of the M qlCalendarCountry structure, for example "US" , "RU" or
"EU" , should be used.
For currency, the currency field of the M qlCalendarCountry structure, for example "USD" , "RUB" or
"EUR" , should be used.
The filters are applied by conjunction, i.e. logical 'AND' is used to select only the values of events
both conditions (country and currency) are simultaneously met for.
The M qlCalendarValue structure provides methods for checking and setting values from the
actual_value, forecast_value, prev _value and revised_prev _value fields. If no value is specified, the
field stores LONG_MIN (-9223372036854775808).
Please note that the values stored in these field are multiplied by one million. It means that when
you receive values in M qlCalendarValue using functions CalendarValueById,
CalendarValueHistoryByEvent, CalendarValueHistory, CalendarValueLastByEvent and
CalendarValueLast, you should check if the field values are equal to LONG_MIN; if a value is
specified in a field, then you should divide the value by 1,000,000 in order to get the value. Another
method to get the values is to check and to get values using the functions of the M qlCalendarValue
structure.
Example:
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- country code for EU (ISO 3166-1 Alpha-2)
string EU_code="EU";
//--- get all EU event values
MqlCalendarValue values[];
//--- set the boundaries of the interval we take the events from
datetime date_from=D'01.01.2018'; // take all events from 2018
datetime date_to=0; // 0 means all known events, including the ones that have not
//--- request EU event history since 2018 year
if(CalendarValueHistory(values,date_from,date_to,EU_code))
{
PrintFormat("Received event values for country_code=%s: %d",
EU_code,ArraySize(values));
//--- decrease the size of the array for outputting to the Journal
ArrayResize(values,10);
//--- display event values in the Journal
ArrayPrint(values);
}
else
{
PrintFormat("Error! Failed to receive events for country_code=%s",EU_code);
PrintFormat("Error code: %d",GetLastError());
}
//---
}
/*
Result:
Received event values for country_code=EU: 1384
[id] [event_id] [time] [period] [revision] [actual_value] [prev_v
[0] 54215 999500001 2018.01.02 09:00:00 2017.12.01 00:00:00 3 60600000 60600
[1] 54221 999500002 2018.01.04 09:00:00 2017.12.01 00:00:00 3 56600000 56500
[2] 54222 999500003 2018.01.04 09:00:00 2017.12.01 00:00:00 3 58100000 58000
[3] 45123 999030005 2018.01.05 10:00:00 2017.11.01 00:00:00 0 600000 400
[4] 45124 999030006 2018.01.05 10:00:00 2017.11.01 00:00:00 0 2800000 2500
[5] 45125 999030012 2018.01.05 10:00:00 2017.12.01 00:00:00 1 900000 900
[6] 45126 999030013 2018.01.05 10:00:00 2017.12.01 00:00:00 1 1400000 1500
[7] 54953 999520001 2018.01.05 20:30:00 2018.01.02 00:00:00 0 127900000 92100
[8] 22230 999040003 2018.01.08 10:00:00 2017.12.01 00:00:00 0 9100000 8200
[9] 22231 999040004 2018.01.08 10:00:00 2017.12.01 00:00:00 0 18400000 16300
*/
See also
CalendarCountries, CalendarEventByCountry, CalendarValueHistoryByEvent, CalendarEventById,
CalendarValueById
CalendarValueLastByEvent
Get the array of event values by its ID since the Calendar database status with a specified change_id.
int CalendarValueLastByEvent(
ulong event_id, // event ID
ulong& change_id, // Calendar change ID
MqlCalendarValue& values[] // array for value descriptions
);
Parameters
event_id
[in] Event ID.
change_id
[in][out] Change ID.
values[]
[out] M qlCalendarValue type array for receiving event values. S ee the example of handling
calendar events.
Return Value
Number of received event values. To get information about an error, call the GetLastError()
function. Possible errors :
· 4001 – ERR_I NT ERNAL _ERR OR (general runtime error),
· 4004 – ERR_NOT _ENOUGH_M EMORY (not enough memory for executing a request),
· 5401 – ERR_CAL ENDAR_TIM EOUT (request time limit exceeded),
· 5400 – ERR_CAL ENDAR_MORE_DAT A (array size is insufficient for receiving descriptions of all
values, only the ones that managed to fit in were received),
· errors of failed execution of ArrayR esize()
Note
All functionsfor working with the economic calendar use the trade server time (TimeTradeS erver).
This means that the time in the M qlCalendarValue structure and the time inputs in the
CalendarValueHistoryByEvent/CalendarValueHistory functions are set in a trade server timezone,
rather than a user's local time.
If the events[] array of fixed length was passed to the function and there was not enough space to
save the entire result, the ERR_CALENDAR_MORE_DATA (5400) error is activated.
If change_id = 0 is passed to the function, the function always returns zero but the current calendar
database is returned to change_id.
The function returns the array for a specified news and a new change_id that can be used for
subsequent calls of the function to receive the new values of the news. Thus, it is possible to update
values for a specified news by calling this function with the last known change_id.
The M qlCalendarValue structure provides methods for checking and setting values from the
actual_value, forecast_value, prev _value and revised_prev _value fields. If no value is specified, the
field stores LONG_MIN (-9223372036854775808).
Please note that the values stored in these field are multiplied by one million. It means that when
you receive values in M qlCalendarValue using functions CalendarValueById,
CalendarValueHistoryByEvent, CalendarValueHistory, CalendarValueLastByEvent and
CalendarValueLast, you should check if the field values are equal to LONG_MIN; if a value is
specified in a field, then you should divide the value by 1,000,000 in order to get the value. Another
method to get the values is to check and to get values using the functions of the M qlCalendarValue
structure.
The sample EA listening for the Nonfarm payrolls report release:
}
//+------------------------------------------------------------------+
//| Timer function |
//+------------------------------------------------------------------+
void OnTimer()
{
//--- Calendar database change ID
static ulong calendar_change_id=0;
//--- first launch attribute
static bool first=true;
//--- event ID
static ulong event_id=0;
//--- event name
static string event_name=NULL;
//--- event value array
MqlCalendarValue values[];
//--- perform initialization - get the current calendar_change_id
if(first)
{
MqlCalendarEvent events[];
//--- country code for USA (ISO 3166-1 Alpha-2)
string USA_code="US";
//--- get events for USA
int events_count=CalendarEventByCountry(USA_code,events);
//--- position of a necessary event in the 'events' array
int event_pos=-1;
//--- display USA events in the Journal
if(events_count>0)
{
PrintFormat("%s: USA events: %d",__FUNCTION__,events_count);
for(int i=0;i<events_count;i++)
{
string event_name_low=events[i].name;
//--- change an event name to lower case
if(!StringToLower(event_name_low))
{
PrintFormat("StringToLower() returned %d error",GetLastError());
//--- exit the function ahead of time
return;
}
//--- look for the "Nonfarm Payrolls" event
if(StringFind(event_name_low,"nonfarm payrolls")!=-1)
{
//--- event found, remember its ID
event_id=events[i].id;
//--- write the "Nonfarm Payrolls" event name
event_name=events[i].name;
//--- remember the events' position in the 'events[]' array
event_pos=i;
//--- keep in mind that the Calendar features several events containing "nonfarm pay
PrintFormat("Event \"Nonfarm Payrolls\" found: event_id=%d event_name=%s",event_id,
//--- view all the events by commenting out the 'break' operator to better understan
break;
}
}
//--- reduce the list by deleting events after "Nonfarm Payrolls"
ArrayRemove(events,event_pos+1);
//--- leave 9 events before "Nonfarm Payrolls" for more convenient analysis
ArrayRemove(events,0,event_pos-9);
ArrayPrint(events);
}
else
{
PrintFormat("%s: CalendarEventByCountry(%s) returned 0 events, error code=%d",
USA_code,__FUNCTION__,GetLastError());
//--- operation completed in a failure, try again during the next call of the timer
return;
}
//--- get the Calendar database change ID for the specified event
if(CalendarValueLastByEvent(event_id,calendar_change_id,values)>0)
{
//--- this code block cannot be executed during the first launch but let's add it anyway
PrintFormat("%s: Received the Calendar database current ID: change_id=%d",
__FUNCTION__,calendar_change_id);
//--- set the flag and exit before the timer's next event
first=false;
return;
}
else
{
//--- data are not received (this is normal for the first launch), check for an error
int error_code=GetLastError();
if(error_code==0)
{
PrintFormat("%s: Received the Calendar database current ID: change_id=%d",
__FUNCTION__,calendar_change_id);
//--- set the flag and exit before the timer's next event
first=false;
//--- now we have the calendar_change_id value
return;
}
else
{
//--- and this is really an error
PrintFormat("%s: Failed to get values for event_id=%d",__FUNCTION__,event_id);
PrintFormat("Error code: %d",error_code);
//--- operation completed in a failure, try again during the next call of the timer
return;
}
}
}
//--- we have the last known value of the Calendar change ID (change_id)
ulong old_change_id=calendar_change_id;
//--- check for a new Nonfarm Payrolls event value
if(CalendarValueLastByEvent(event_id,calendar_change_id,values)>0)
{
*/
See also
CalendarValueLast, CalendarValueHistory, CalendarValueHistoryByEvent, CalendarValueById
CalendarValueLast
Get the array of values for all events with the ability to sort by country and/or currency since the
calendar database status with a specified change_id.
int CalendarValueLast(
ulong& change_id, // change ID
MqlCalendarValue& values[], // array for value descriptions
const string country_code=NULL, // country code name (ISO 3166-1 alpha-2)
const string currency=NULL // country currency code name
);
Parameters
change_id
[in][out] Change ID.
values[]
[out] M qlCalendarValue type array for receiving event values. S ee the example of handling
calendar events.
country_code=NULL
[in] Country code name (IS O 3166-1 alpha-2)
currency=NULL
[in] Country currency code name.
Return Value
Number of received event values. To get information about an error, call the GetLastError()
function. Possible errors :
· 4001 – ERR_I NT ERNAL _ERR OR (general runtime error),
· 4004 – ERR_NOT _ENOUGH_M EMORY (not enough memory for executing a request),
· 5401 – ERR_CAL ENDAR_TIM EOUT (request time limit exceeded),
· 5400 – ERR_CAL ENDAR_MORE_DAT A (array size is insufficient for receiving descriptions of all
values, only the ones that managed to fit in were received),
· errors of failed execution of ArrayR esize()
Note
All functionsfor working with the economic calendar use the trade server time (TimeTradeS erver).
This means that the time in the M qlCalendarValue structure and the time inputs in the
CalendarValueHistoryByEvent/CalendarValueHistory functions are set in a trade server timezone,
rather than a user's local time.
If the events[] array of fixed length was passed to the function and there was not enough space to
save the entire result, the ERR_CALENDAR_MORE_DATA (5400) error is activated.
If change_id = 0 is passed to the function, you will get the current change_id of the calendar
database to that parameter; and the function returns 0
For the country_code and currency filters, NULL and "" values are equivalent and mean the absence
of the filter.
For country_code, the code field of the M qlCalendarCountry structure, for example "US" , "RU" or
"EU" , should be used.
For currency, the currency field of the M qlCalendarCountry structure, for example "USD" , "RUB" or
"EUR" , should be used.
The filters are applied by conjunction, i.e. logical 'AND' is used to select only the values of events
both conditions (country and currency) are simultaneously met for
The function returns the array for a specified news and a new change_id that can be used for
subsequent calls of the function to receive the new values of the news. Thus, it is possible to update
values for a specified news by calling this function with the last known change_id.
The M qlCalendarValue structure provides methods for checking and setting values from the
actual_value, forecast_value, prev _value and revised_prev _value fields. If no value is specified, the
field stores LONG_MIN (-9223372036854775808).
Please note that the values stored in these field are multiplied by one million. It means that when
you receive values in M qlCalendarValue using functions CalendarValueById,
CalendarValueHistoryByEvent, CalendarValueHistory, CalendarValueLastByEvent and
CalendarValueLast, you should check if the field values are equal to LONG_MIN; if a value is
specified in a field, then you should divide the value by 1,000,000 in order to get the value. Another
method to get the values is to check and to get values using the functions of the M qlCalendarValue
structure.
The sample EA listening for the economic calendar events:
//+------------------------------------------------------------------+
void OnTick()
{
//---
}
//+------------------------------------------------------------------+
//| Timer function |
//+------------------------------------------------------------------+
void OnTimer()
{
//--- Calendar database change ID
static ulong calendar_change_id=0;
//--- first launch attribute
static bool first=true;
//--- event value array
MqlCalendarValue values[];
//--- perform initialization - get the current calendar_change_id
if(first)
{
//--- get the Calendar database change ID
if(CalendarValueLast(calendar_change_id,values)>0)
{
//--- this code block cannot be executed during the first launch but let's add it anyway
PrintFormat("%s: Received the Calendar database current ID: change_id=%d",
__FUNCTION__,calendar_change_id);
//--- set the flag and exit before the timer's next event
first=false;
return;
}
else
{
//--- data are not received (this is normal for the first launch), check for an error
int error_code=GetLastError();
if(error_code==0)
{
PrintFormat("%s: Received the Calendar database current ID: change_id=%d",
__FUNCTION__,calendar_change_id);
//--- set the flag and exit before the timer's next event
first=false;
//--- now we have the calendar_change_id value
return;
}
else
{
//--- and this is really an error
PrintFormat("%s: Failed to get events in CalendarValueLast. Error code: %d",
__FUNCTION__,error_code);
//--- operation completed in a failure, re-initialize during the next call of the timer
return;
}
}
}
//--- we have the last known value of the Calendar change ID (change_id)
ulong old_change_id=calendar_change_id;
//--- check if there are new Calendar events
if(CalendarValueLast(calendar_change_id,values)>0)
{
PrintFormat("%s: Received new Calendar events: %d",
__FUNCTION__,ArraySize(values));
//--- display data from the 'values' array in the Journal
ArrayPrint(values);
//--- display the values of the previous and new Calendar IDs in the Journal
PrintFormat("%s: Previous change_id=%d, new change_id=%d",
__FUNCTION__,old_change_id,calendar_change_id);
//--- display new events in the Journal
ArrayPrint(values);
/*
write your code that is to handle occurrence of events here
*/
}
//---
}
/*
Example of the listener operation:
OnTimer: Received the Calendar database current ID: change_id=33281792
OnTimer: Received new events for the Calendar: 1
[id] [event_id] [time] [period] [revision] [actual_value] [prev_val
[0] 91040 76020013 2019.03.20 15:30:00 1970.01.01 00:00:00 0 -5077000 -1913
OnTimer: Previous change_id=33281792, new change_id=33282048
[id] [event_id] [time] [period] [revision] [actual_value] [prev_val
[0] 91040 76020013 2019.03.20 15:30:00 1970.01.01 00:00:00 0 -5077000 -1913
OnTimer: Received new events for the Calendar: 1
[id] [event_id] [time] [period] [revision] [actual_value] [pr
[0] 91041 76020013 2019.03.27 15:30:00 1970.01.01 00:00:00 0 -9223372036854775808
OnTimer: Previous change_id=33282048, new change_id=33282560
[id] [event_id] [time] [period] [revision] [actual_value] [pr
[0] 91041 76020013 2019.03.27 15:30:00 1970.01.01 00:00:00 0 -9223372036854775808
*/
See also
CalendarValueLast, CalendarValueHistory, CalendarValueHistoryByEvent, CalendarValueById
It is historically accepted that an access to the price data in an array is performed from the end of the
data. Physically, the new data are always written at the array end, but the index of the array is always
equal to zero. The 0 index in the timeseries array denotes data of the current bar, i.e. the bar that
corresponds to the unfinished time interval in this timeframe.
A timeframe is the time period, during which a single price bar is formed. There are 21 predefined
standard timeframes.
Function Action
Function Action
Despite the fact that by using the ArrayS etAs S eries() function it is possible to set up in arrays access
to elements like that in timeseries, it should be remembered that the array elements are physically
stored in one and the same order - only indexing direction changes. To demonstrate this fact let's
perform an example:
datetime TimeAsSeries[];
//--- set access to the array like to a timeseries
ArraySetAsSeries(TimeAsSeries,true);
ResetLastError();
int copied=CopyTime(NULL,0,0,10,TimeAsSeries);
if(copied<=0)
{
Print("The copy operation of the open time values for last 10 bars has failed");
return;
}
Print("TimeCurrent =",TimeCurrent());
Print("ArraySize(Time) =",ArraySize(TimeAsSeries));
int size=ArraySize(TimeAsSeries);
for(int i=0;i<size;i++)
{
Print("TimeAsSeries["+i+"] =",TimeAsSeries[i]);
}
datetime ArrayNotSeries[];
ArraySetAsSeries(ArrayNotSeries,false);
ResetLastError();
copied=CopyTime(NULL,0,0,10,ArrayNotSeries);
if(copied<=0)
{
Print("The copy operation of the open time values for last 10 bars has failed");
return;
}
size=ArraySize(ArrayNotSeries);
for(int i=size-1;i>=0;i--)
{
Print("ArrayNotSeries["+i+"] =",ArrayNotSeries[i]);
}
As we see from the output, as the index of TimeAs S eries array increases, the time value of the index
decreases, i.e. we move from the present to the past. For the common array ArrayNotS eries the result
is different - as index grows, we move from past to present.
See Also
ArrayIs Dynamic, ArrayGetAs S eries, ArrayS etAs S eries, ArrayIs S eries
Each custom indicator must necessarily contain the OnCalculate() function, to which price data
required for calculating values in indicator buffers are passed. Indexing direction in these passed
arrays can be found out using function ArrayGetAs S eries().
Arrays passed to the function reflect price data, i.e. these arrays have the sign of a timeseries and
function ArrayIs S eries() will return true when checking these arrays. However, in any case indexing
direction should be checked only by function ArrayGetAs S eries().
In order not to be dependent on default values, ArrayS etAs S eries() should be unconditionally called for
the arrays you are going to work with, and set the required direction.
Default indexing direction of all arrays in Expert Advisors, indicators and scripts is left-to-right. If
necessary, in any mql5 program you can request timeseries values on any symbol and timeframe, as
well as values of indicators calculated on any symbol and timeframe.
Use functions Copy...() for these purposes :
· CopyBuffer – copy values of an indicator buffer to an array of double type;
· CopyRates – copy price history to an array of structures M qlRates ;
· CopyTime – copy Time values to an array of datetime type;
· CopyOpen – copy Open values to an array of double type;
· CopyHigh – copy High values to an array of double type;
· CopyLow – copy Low values to an array of double type;
· CopyClose – copy Close values to an array of double type;
· CopyTickVolume – copy tick volumes to an array of long type;
· CopyRealVolume – copy equity volumes to a long type array;
· CopyS pread – copy the spread history to an array of int type;
All these functions work in a similar way. Let's consider the data obtaining mechanism on the example
of CopyBuffer(). It is implied that the indexing direction of requested data is that of timeseries, and
the position with index 0 (zero) stores data of the current yet uncompleted bar. In order to get access
to these data we need to copy the necessary volume of data into the recipient array, e.g. into array
buffer.
W hen copying we need to specify the starting position in the source array, starting from which data
will be copied to the recipient array. In case of success, the specified number of elements will be
copied to the recipient array from the source array (from the indicator buffer in this case).
Irrespective of the indexing value set in the recipient array, copying is always performed as is shown
in the above figure.
If it is expected that price data will be handled in a loop with a large number of iterations, it is
advisable that you check the fact of forced program termination using the Is S topped() function:
int copied=CopyBuffer(ma_handle,// Indicator handle
0, // The index of the indicator buffer
0, // Start position for copying
number, // Number of values to copy
Buffer // The array that receives the values
);
if(copied<0) return;
int k=0;
while(k<copied && !IsStopped())
{
//--- Get the value for the k index
double value=Buffer[k];
// ...
// work with value
k++;
}
Example:
See also
Organizing Data Access
Before price data become available in the MetaTrader 5 terminal, they must be received and
processed. To receive data, connection to the MetaTrader 5 trade server must be established. Data
are received in the form of packed blocks of minute bars from the server upon the request of a
terminal.
The mechanism of server reference for data doesn't depend on how the request has been initiated - by
a user when navigating in a chart or in a program way in the MQL5 language.
Data received from a server are automatically unpacked and saved in the HCC intermediate format.
Data on each symbol are written into a separate folder:
terminal_directory\ bases \ server_name\ history\ symbol_name. For example, data on EURUSD received
Dataare written into files with .hcc extension. Each file stores data of minute bars for one year. For
example, the file named 2009.hcc in the EURUSD folder contains minute bars of EURUSD for year 2009.
These files are used for preparing price data for all timeframes and are not intended for direct access.
Intermediate HCC files are used as the data source for building price data for requested timeframes in
the HC format. Data of HC format are timeseries that are maximally prepared for a quick access. They
are created upon a request of a chart or a MQL5 program. The volume of data should not exceed the
value of the " Max bars in charts " parameter. Data are stored for further using in files with hc
extension.
To save resources, data on a timeframe are stored and saved in RAM only if necessary. If not called
for a long time, they are released from RAM and saved into a file. For each timeframe, data are
prepared regardless of whether there are ready data for other timeframes or not. Rules of forming and
accessing data are the same for all timeframes. I.e., despite the fact that the unit data stored in HCC
is one minute (M 1), the availability of HCC data doesn't mean the availability of data on M 1 timeframe
as HC in the same volume.
R eceipt of new data from a server calls automatic update of used price data in HC format of all
timeframes. It also leads to the recalculation of all indicators that implicitly use them as input data for
calculations.
The " Max bars in charts " parameter restricts number of bars in HC format available to charts,
indicators and mql5 programs. This is valid for all available timeframes and serves, first of all, to save
computer resources.
W hen setting a large value of this parameter, it should be remembered, that if deep history price data
for small timeframes are available, memory used for storing timeseries and indicator buffers can
become hundreds of megabytes and reach the RAM restriction for the client terminal program (2Gb for
32-bit applications of M S W indows).
Change of the " Max bars in charts " comes into effect after the client terminal is restarted. Change of
this parameter causes neither automatic referring to a server for additional data, nor forming of
additional bars of timeseries. Additional price data are requested from the server, and timeseries are
updated taking into account the new limitation, in case of either chart scroll to the area with no data,
or when data are requested by a mql5 program.
Volume of data requested from the server corresponds to the required number of bars of this
timeframe with the " Max bars in charts " parameter taken into account. The restriction set by this
parameter is not strict, and in some cases the number of available bars for a timeframe can be a little
more than the current parameter value.
Data Availability
Presence of data on HCC format or even in the prepared for using HC format does not always denote
the absolute availability of these data to be shown in a chart or to be used in MQL5 programs.
W hen accessing to price data or indicator values from a mql5 program it should be remembered that
their availability in a certain moment of time or starting from a certain moment of time is not
guaranteed. It is connected with the fact that with the purpose of saving resources, the full copy of
data necessary for a mql5 program isn't stored in MetaTrader 5; only direct access to the terminal
database is given.
The price history for all timeframes is built from common data of HCC format, and any update of data
from a server leads to the update of data for all timeframes and to the recalculation of indicators. Due
to this access to data can be closed, even if these data were available a moment ago.
S ince a
mql5 program can call data from any symbol and timeframe, there is a possibility that data of
a necessary timeseries are not formed yet in the terminal or the necessary price data aren't
synchronized with the trade server. In this case it's hard to predict the latency time.
Algorithms using " do-nothing" loops are not the best solution. The only exception in this case are
scripts, because they do not have any alternative algorithm choice due to not having event handling.
For custom indicators such algorithms, as well as any other " do-nothing " loops are strongly not
recommended, because they lead to termination of calculation of all indicators and any other handling
of price data of the symbol.
For Expert Advisors and indicators, it is better to use the event model of handling. If during handling
of OnTick() or OnCalculate() event, data receipt for the required timeseries failed, you should exit the
event handler, relying on the access availability during the next call of the handler.
timeframe doesn't matter, because, as it was mentioned above, price data are received from a trade
server as packed one minute data, from which any predefined timeseries is constructed then.
W rite all actions concerning data receipt as a separate function CheckLoadHistory(symbol, timeframe,
start_date):
int CheckLoadHistory(string symbol,ENUM_TIMEFRAMES period,datetime start_date)
{
}
The CheckLoadHistory() function is designed as a universal function that can be called from any
program (Expert Advisor, script or indicator); and therefore it requires three input parameters : symbol
name, period and start date to indicate the beginning of price history you need.
Insert necessary checks into the function code before requesting the missing history. First of all, we
should make sure that the symbol name and period value are correct:
if(symbol==NULL || symbol=="") symbol=Symbol();
if(period==PERIOD_CURRENT) period=Period();
Then let's make sure that the symbol is available in the MarketW atch window, i.e., the history for the
symbol will be available when sending a request to a trade server. If there is no such a symbol in
MarketW atch, add it using the S ymbolS elect() function.
if(!SymbolInfoInteger(symbol,SYMBOL_SELECT))
{f
if(GetLastError()==ERR_MARKET_UNKNOWN_SYMBOL) return(-1);
SymbolSelect(symbol,true);
}
Now we should receive the start date of the available history for the indicated symbol/period pair.
Perhaps, the value of the input parameter startdate, passed to CheckLoadHistory(), is within the
available history; then request to a trade server is not needed. In order to obtain the very first date
for the symbol-period as of the moment, the S eriesInfoInteger() function with the SERIES_FIRS TDATE
modifier is used.
SeriesInfoInteger(symbol,period,SERIES_FIRSTDATE,first_date);
if(first_date>0 && first_date<=start_date) return(1);
The next important check is checking the type of the program, from which the function is called. Note
that it is not desirable to send a request to update the timeseries from indicator with the same
period. The undesirability of requesting data on the same symbol-period as that of the indicator is
conditioned by the fact that update of history data is performed in the same thread where the
indicator operates. S o the possibility of deadlock occurrence is high. To check this use the
MQL5InfoInteger() function with the MQL5_PROGRAM _TYPE modifier.
if(MQL5InfoInteger(MQL5_PROGRAM_TYPE)==PROGRAM_INDICATOR && Period()==period && Symbol()==symbol
return(-4);
If all the checks have been passed successfully, make the last attempt to do without referring to the
trade server. First let's find out the start date, for which minute data in HCC format are available.
R equest this value using the S eriesInfoInteger() function with the SER IES_T ER MINAL _FIRS T DAT E
modifier and again compare it to the value of the start_date parameter.
if(SeriesInfoInteger(symbol,PERIOD_M1,SERIES_TERMINAL_FIRSTDATE,first_date))
{
//--- there is loaded data to build timeseries
if(first_date>0)
{
//--- force timeseries build
CopyTime(symbol,period,first_date+PeriodSeconds(period),1,times);
//--- check date
if(SeriesInfoInteger(symbol,period,SERIES_FIRSTDATE,first_date))
if(first_date>0 && first_date<=start_date) return(2);
}
}
If after all the checks the execution thread is still in the body of the CheckLoadHistory() function, it
means there is a necessity to request the missing price data from a trade server. First, return the
value of " Max bars in chart" using the TerminalInfoInteger() function:
int max_bars=TerminalInfoInteger(TERMINAL_MAXBARS);
W e'llneed it to prevent requesting extra data. Then find the very first date in the symbol history on
the trade server (regardless of the period) using already known function S eriesInfoInteger() with the
SER IES_SERVER_FIRS T DAT E modifier.
datetime first_server_date=0;
while(!SeriesInfoInteger(symbol,PERIOD_M1,SERIES_SERVER_FIRSTDATE,first_server_date) && !IsStopp
Sleep(5);
S ince the request is an asynchronous operation, the function is called in the loop with a small delay of
5 milliseconds until the first_server_date variable receives a value, or the loop execution is
terminated by a user (Is S topped() will return true in this case). Let's indicate a correct value of the
start date, starting from which we request price data from a trade server.
if(first_server_date>start_date) start_date=first_server_date;
if(first_date>0 && first_date<first_server_date)
Print("Warning: first server date ",first_server_date," for ",
symbol," does not match to first series date ",first_date);
If the start date first_server_date of the server is lower than the start date first_date of the symbol in
H CC format, the corresponding entry will be output in the journal.
Now we are ready to make a request to a trade server as king for missing price data. Make the request
in the form of a loop and start filling out its body:
while(!IsStopped())
{
//1. wait for synchronization between the re-built timeseries and intermediate history as HHC
//2. receive the current number of bars in this timeseries
// if bars is larger than Max_bars_in_chart, we can exit, work is over
//3. obtain the start date first_date in the re-built timeseries and compare it to start_date
// if first_date is lower than start_date, we can exit, work is over
//4. request from a server a new part of history - 100 bars starting from last available bar
}
The last fourth point is left - requesting history. W e can't refer to a server directly, but any Copy-
function automatically initiates request sending to a server, if the history in HCC format is not
enough. S ince the time of the very first start date in the first_date variable is the simple and natural
criterion to evaluate the request execution degree, then the easiest way is to use the CopyTime()
function.
W hen calling functions that copy any data from timeseries, it should be noted that the start parameter
(number of the bar, starting from which price data should be copied) must always be within the
available terminal history. If you have only 100 bars, it meaningless to try copying 300 bars starting
from the bar with the index 500. S uch a request will be understood as an erroneous and won't be
handled, i.e. no additional history will be loaded from a trade server.
That's why we'll copy bars in groups of 100 starting from the bar with the bars index. This will provide
the smooth loading of missing history from a trade server. Actually a little more than the requested
100 bars will be loaded, while server sends oversized history.
int copied=CopyTime(symbol,period,bars,100,times);
After the copying operation, we should analyze the number of copied elements. If the attempt fails,
then value of the copied will be equal to null and the value of the fail_cnt counter will be increased by
1. After 100 failing attempts, the operation of the function will be stopped.
int fail_cnt=0;
...
int copied=CopyTime(symbol,period,bars,100,times);
if(copied>0)
{
//--- check data
if(times[0]<=start_date) return(0); // the copied value is smaller, ready
if(bars+copied>=max_bars) return(-2); // bars are more than can be drawn in the chart, ready
fail_cnt=0;
}
else
{
//--- no more than 100 failing attempts in succession
fail_cnt++;
if(fail_cnt>=100) return(-5);
Sleep(10);
}
S o,
not only correct handling of the current situation at each moment of execution is implemented in
the function, but also the termination code is returned, that can be handled after calling the
CheckLoadHistory() function for getting additional information. For example, this way:
int res=CheckLoadHistory(InpLoadedSymbol,InpLoadedPeriod,InpStartDate);
switch(res)
{
case -1 : Print("Unknown symbol ",InpLoadedSymbol); break;
case -2 : Print("More requested bars than can be drawn in the chart"); break;
case -3 : Print("Execution stopped by user"); break;
case -4 : Print("Indicator mustn't load its own data"); break;
case -5 : Print("Loading failed"); break;
case 0 : Print("All data loaded"); break;
case 1 : Print("Already available data in timeseries are enough"); break;
case 2 : Print("Timeseries is built from available terminal data"); break;
default : Print("Execution result undefined");
}
The full code of the function can be found in the example of a script that shows the correct
organization of access to any data with the handling of request's results.
Code:
//+------------------------------------------------------------------+
//| TestLoadHistory.mq5 |
//| Copyright 2009, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "2009, MetaQuotes Software Corp."
#property link "https://www.mql5.com"
#property version "1.02"
#property script_show_inputs
//--- input parameters
input string InpLoadedSymbol="NZDUSD"; // Symbol to be load
input ENUM_TIMEFRAMES InpLoadedPeriod=PERIOD_H1; // Period to be loaded
input datetime InpStartDate=D'2006.01.01'; // Start date
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
Print("Start load",InpLoadedSymbol+","+GetPeriodName(InpLoadedPeriod),"from",InpStartDate);
//---
int res=CheckLoadHistory(InpLoadedSymbol,InpLoadedPeriod,InpStartDate);
switch(res)
{
case -1 : Print("Unknown symbol ",InpLoadedSymbol); break;
case -2 : Print("Requested bars more than max bars in chart"); break;
case -3 : Print("Program was stopped"); break;
case -4 : Print("Indicator shouldn't load its own data"); break;
case -5 : Print("Load failed"); break;
case 0 : Print("Loaded OK"); break;
case 1 : Print("Loaded previously"); break;
case 2 : Print("Loaded previously and built"); break;
default : Print("Unknown result");
}
//---
datetime first_date;
SeriesInfoInteger(InpLoadedSymbol,InpLoadedPeriod,SERIES_FIRSTDATE,first_date);
int bars=Bars(InpLoadedSymbol,InpLoadedPeriod);
Print("First date ",first_date," - ",bars," bars");
//---
}
//+------------------------------------------------------------------+
//| |
//+------------------------------------------------------------------+
int CheckLoadHistory(string symbol,ENUM_TIMEFRAMES period,datetime start_date)
{
datetime first_date=0;
datetime times[100];
//--- check symbol & period
if(symbol==NULL || symbol=="") symbol=Symbol();
if(period==PERIOD_CURRENT) period=Period();
//--- check if symbol is selected in the Market Watch
if(!SymbolInfoInteger(symbol,SYMBOL_SELECT))
{
if(GetLastError()==ERR_MARKET_UNKNOWN_SYMBOL) return(-1);
SymbolSelect(symbol,true);
}
//--- check if data is present
SeriesInfoInteger(symbol,period,SERIES_FIRSTDATE,first_date);
if(first_date>0 && first_date<=start_date) return(1);
//--- don't ask for load of its own data if it is an indicator
if(MQL5InfoInteger(MQL5_PROGRAM_TYPE)==PROGRAM_INDICATOR && Period()==period && Symbol()==symbol
return(-4);
//--- second attempt
if(SeriesInfoInteger(symbol,PERIOD_M1,SERIES_TERMINAL_FIRSTDATE,first_date))
{
//--- there is loaded data to build timeseries
if(first_date>0)
{
//--- force timeseries build
CopyTime(symbol,period,first_date+PeriodSeconds(period),1,times);
//--- check date
if(SeriesInfoInteger(symbol,period,SERIES_FIRSTDATE,first_date))
if(first_date>0 && first_date<=start_date) return(2);
}
}
//--- max bars in chart from terminal options
int max_bars=TerminalInfoInteger(TERMINAL_MAXBARS);
//--- load symbol history info
datetime first_server_date=0;
while(!SeriesInfoInteger(symbol,PERIOD_M1,SERIES_SERVER_FIRSTDATE,first_server_date) && !IsStopp
Sleep(5);
//--- fix start date for loading
if(first_server_date>start_date) start_date=first_server_date;
if(first_date>0 && first_date<first_server_date)
Print("Warning: first server date ",first_server_date," for ",symbol,
" does not match to first series date ",first_date);
//--- load data step by step
int fail_cnt=0;
while(!IsStopped())
{
//--- wait for timeseries build
while(!SeriesInfoInteger(symbol,period,SERIES_SYNCHRONIZED) && !IsStopped())
Sleep(5);
//--- ask for built bars
int bars=Bars(symbol,period);
if(bars>0)
{
if(bars>=max_bars) return(-2);
//--- ask for first date
if(SeriesInfoInteger(symbol,period,SERIES_FIRSTDATE,first_date))
if(first_date>0 && first_date<=start_date) return(0);
}
//--- copying of next part forces data loading
int copied=CopyTime(symbol,period,bars,100,times);
if(copied>0)
{
//--- check for data
if(times[0]<=start_date) return(0);
if(bars+copied>=max_bars) return(-2);
fail_cnt=0;
}
else
{
//--- no more than 100 failed attempts
fail_cnt++;
if(fail_cnt>=100) return(-5);
Sleep(10);
}
}
//--- stopped
return(-3);
}
//+------------------------------------------------------------------+
//| Returns string value of the period |
//+------------------------------------------------------------------+
string GetPeriodName(ENUM_TIMEFRAMES period)
{
if(period==PERIOD_CURRENT) period=Period();
//---
switch(period)
{
case PERIOD_M1: return("M1");
case PERIOD_M2: return("M2");
case PERIOD_M3: return("M3");
case PERIOD_M4: return("M4");
case PERIOD_M5: return("M5");
case PERIOD_M6: return("M6");
case PERIOD_M10: return("M10");
case PERIOD_M12: return("M12");
case PERIOD_M15: return("M15");
case PERIOD_M20: return("M20");
case PERIOD_M30: return("M30");
case PERIOD_H1: return("H1");
case PERIOD_H2: return("H2");
case PERIOD_H3: return("H3");
case PERIOD_H4: return("H4");
case PERIOD_H6: return("H6");
case PERIOD_H8: return("H8");
case PERIOD_H12: return("H12");
case PERIOD_D1: return("Daily");
case PERIOD_W1: return("Weekly");
case PERIOD_MN1: return("Monthly");
}
//---
return("unknown period");
}
SeriesInfoInteger
R eturns information about the state of historical data. There are 2 variants of function calls.
Directly returns the property value.
long SeriesInfoInteger(
string symbol_name, // symbol name
ENUM_TIMEFRAMES timeframe, // period
ENUM_SERIES_INFO_INTEGER prop_id, // property identifier
);
bool SeriesInfoInteger(
string symbol_name, // symbol name
ENUM_TIMEFRAMES timeframe, // period
ENUM_SERIES_INFO_INTEGER prop_id, // property ID
long& long_var // variable for getting info
);
Parameters
symbol_name
[in] S ymbol name.
timeframe
[in] Period.
prop_id
[in] Identifier of the requested property, value of the ENUM _SERIES_INFO_INTEGER enumeration.
long_var
[out] Variable to which the value of the requested property is placed.
Return Value
Example:
void OnStart()
{
//---
Print("Total number of bars for the symbol-period at this moment = ",
SeriesInfoInteger(Symbol(),Period(),SERIES_BARS_COUNT));
Print("The first date in the history for the symbol-period on the server = ",
(datetime)SeriesInfoInteger(Symbol(),Period(),SERIES_SERVER_FIRSTDATE));
Bars
R eturns the number of bars count in the history for a specified symbol and period. There are 2
variants of functions calls.
Request all of the history bars
int Bars(
string symbol_name, // symbol name
ENUM_TIMEFRAMES timeframe // period
);
Parameters
symbol_name
[in] S ymbol name.
timeframe
[in] Period.
start_time
[in] Bar time corresponding to the first element.
stop_time
[in] Bar time corresponding to the last element.
Return Value
If the start_time and stop_time parameters are defined, the function returns the number of bars in
the specified time interval, otherwise it returns the total number of bars.
Note
If data for the timeseries with specified parameters are not formed in the terminal by the time of
the Bars() function call, or data of the timeseries are not synchronized with a trade server by the
moment of the function call, the function returns a zero value.
W hen requesting the number of bars in a specified time interval, only bars with an open time falling
within the interval are considered. For example, if the current day of the week is S aturday and the
request is made for the number of W1 bars with start_time=last_tuesday and stop_time=last_friday,
the function will return 0 since the open time of a W1 timeframe is always S unday and not a single
W1 bar falls within the specified interval.
int bars=Bars(_Symbol,_Period);
if(bars>0)
{
Print("Number of bars in the terminal history for the symbol-period at the moment = ",bars);
}
else //no available bars
{
//--- data on the symbol might be not synchronized with data on the server
bool synchronized=false;
//--- loop counter
int attempts=0;
// make 5 attempts to wait for synchronization
while(attempts<5)
{
if(SeriesInfoInteger(Symbol(),0,SERIES_SYNCHRONIZED))
{
//--- synchronization done, exit
synchronized=true;
break;
}
//--- increase the counter
attempts++;
//--- wait 10 milliseconds till the next iteration
Sleep(10);
}
//--- exit the loop after synchronization
if(synchronized)
{
Print("Number of bars in the terminal history for the symbol-period at the moment = ",bars
Print("The first date in the terminal history for the symbol-period at the moment = ",
(datetime)SeriesInfoInteger(Symbol(),0,SERIES_FIRSTDATE));
Print("The first date in the history for the symbol on the server = ",
(datetime)SeriesInfoInteger(Symbol(),0,SERIES_SERVER_FIRSTDATE));
}
//--- synchronization of data didn't happen
else
{
Print("Failed to get number of bars for ",_Symbol);
}
}
Print("Number of bars: ",n); // Output: "Number of bars: 8", H2 bar is considered in the calcula
n=Bars(_Symbol,PERIOD_D1,date1,date2);
Print("Number of bars: ",n); // Output: "Number of bars: 1", since an open time of a single D1 (
n=Bars(_Symbol,PERIOD_W1,date2,date3);
Print("Number of bars: ",n); // Output: "Number of bars: 0", since not a single W1 bar open time
See also
Event H andling Functions
BarsCalculated
R eturns the number of calculated data for the specified indicator.
int BarsCalculated(
int indicator_handle, // indicator handle
);
Parameters
indicator_handle
[in] The indicator handle, returned by the corresponding indicator function.
Return Value
R eturns the amount of calculated data in the indicator buffer or -1 in the case of error (data not
calculated yet)
Note
The function is useful when it's necessary to get the indicator data immediately after its creation
(indicator handle is available).
Example:
void OnStart()
{
double Ups[];
//--- set timeseries ordering for the arrays
ArraySetAsSeries(Ups,true);
//--- create handle for the Fractal Indicator
int FractalsHandle=iFractals(NULL,0);
//--- reset the error code
ResetLastError();
//--- try to copy the indicator values
int i,copied=CopyBuffer(FractalsHandle,0,0,1000,Ups);
if(copied<=0)
{
Sleep(50);
for(i=0;i<100;i++)
{
if(BarsCalculated(FractalsHandle)>0)
break;
Sleep(50);
}
copied=CopyBuffer(FractalsHandle,0,0,1000,Ups);
if(copied<=0)
{
Print("Failed to copy upper fractals. Error = ",GetLastError(),
"i = ",i," copied = ",copied);
return;
}
else
Print("Upper fractals copied",
"i = ",i," copied = ",copied);
}
else Print("Upper fractals copied. ArraySize = ",ArraySize(Ups));
}
IndicatorCreate
The function returns the handle of a specified technical indicator created based on the array of
parameters of M qlParam type.
int IndicatorCreate(
string symbol, // symbol name
ENUM_TIMEFRAMES period, // timeframe
ENUM_INDICATOR indicator_type, // indicator type from the enumeration ENUM_
int parameters_cnt=0, // number of parameters
const MqlParam& parameters_array[]=NULL, // array of parameters
);
Parameters
symbol
[in] Name of a symbol, on data of which the indicator is calculated. NULL means the current
symbol.
period
[in]The value of the timeframe can be one of values of the ENUM _TIM EFRAM ES enumeration, 0
means the current timeframe.
indicator_type
[in] Indicator type, can be one of values of the ENUM _INDICATOR enumeration.
parameters_cnt
[in]The number of parameters passed in the parameters _array[] array. The array elements have a
special structure type M qlParam. By default, zero - parameters are not passed. If you specify a
non-zero number of parameters, the parameter parameters_array is obligatory. You can pass no
more than 64 parameters.
parameters_array[]=NULL
[in] An array of M qlParam type, whose elements contain the type and value of each input
parameter of a technical indicator.
Return Value
R eturns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.
Note
If the indicator handle of IND_CUS TOM type is created, the type field of the first element of the
array of input parameters parameters_array must have the TYPE_S TRING value of the
ENUM _DAT AT YPE enumeration, and the string_value field of the first element must contain the
name of the custom indicator. The custom indicator must be compiled (file with EX5 extension) and
located in the directory MQL5/Indicators of the client terminal or in a subdirectory.
Indicators that require testing are defined automatically from the call of the iCustom() function, if
the corresponding parameter is set through a constant string. For all other cases (use of the
IndicatorCreate() function or use of a non-constant string in the parameter that sets the indicator
name) the property #property tester_indicator is required:
#property tester_indicator "indicator_name.ex5"
If the first form of the call is used in a custom indicator, you can additionally indicate as the last
parameter on what data it will be calculated when passing input parameters. If the "Apply to"
parameter is not specified explicitly, the default calculation is based on the PRICE_CLOSE values.
Example:
void OnStart()
{
MqlParam params[];
int h_MA,h_MACD;
//--- create iMA("EURUSD",PERIOD_M15,8,0,MODE_EMA,PRICE_CLOSE);
ArrayResize(params,4);
//--- set ma_period
params[0].type =TYPE_INT;
params[0].integer_value=8;
//--- set ma_shift
params[1].type =TYPE_INT;
params[1].integer_value=0;
//--- set ma_method
params[2].type =TYPE_INT;
params[2].integer_value=MODE_EMA;
//--- set applied_price
params[3].type =TYPE_INT;
params[3].integer_value=PRICE_CLOSE;
//--- create MA
h_MA=IndicatorCreate("EURUSD",PERIOD_M15,IND_MA,4,params);
//--- create iMACD("EURUSD",PERIOD_M15,12,26,9,h_MA);
ArrayResize(params,4);
//--- set fast ma_period
params[0].type =TYPE_INT;
params[0].integer_value=12;
//--- set slow ma_period
params[1].type =TYPE_INT;
params[1].integer_value=26;
//--- set smooth period for difference
params[2].type =TYPE_INT;
params[2].integer_value=9;
//--- set indicator handle as applied_price
params[3].type =TYPE_INT;
params[3].integer_value=h_MA;
//--- create MACD based on moving average
h_MACD=IndicatorCreate("EURUSD",PERIOD_M15,IND_MACD,4,params);
//--- use indicators
//--- . . .
//--- release indicators (first h_MACD)
IndicatorRelease(h_MACD);
IndicatorRelease(h_MA);
}
IndicatorParameters
Based on the specified handle,returns the number of input parameters of the indicator, as well as the
values and types of the parameters.
int IndicatorParameters(
int indicator_handle, // indicator handle
ENUM_INDICATOR& indicator_type, // a variable for receiving the indicator type
MqlParam& parameters[] // an array for receiving parameters
);
Parameters
indicator_handle
[in] The handle of the indicator, for which you need to know the number of parameters its is
calculated on.
indicator_type
[out] A variable if the ENUM _INDICATOR type, into which the indicator type will be written.
parameters[]
[out] Adynamic array for receiving values of the M qlParam type, into which the list of indicator
parameters will be written. The array size is returned by the IndicatorParameters() function.
Return Value
The number of input parameters of the indicator with the specified handle. In case of an error
returns -1. For more details about the error call the GetLastError() function.
Example:
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- The number of windows on the chart (at least one main window is always present)
int windows=(int)ChartGetInteger(0,CHART_WINDOWS_TOTAL);
//--- Go through the chart windows
for(int w=0;w<windows;w++)
{
//--- The number of indicators in this window/subwindow
int total=ChartIndicatorsTotal(0,w);
//--- Take all indicators in the window
for(int i=0;i<total;i++)
{
//--- Get the short name of the indicator
string name=ChartIndicatorName(0,w,i);
//--- Get the indicator handle
int handle=ChartIndicatorGet(0,w,name);
//--- Add to log
See also
ChartIndicatorGet()
IndicatorRelease
The function removes an indicator handle and releases the calculation block of the indicator, if it's not
used by anyone else.
bool IndicatorRelease(
int indicator_handle // indicator handle
);
Return Value
The function allows removing an indicator handle, if it's no longer needed, thus saving memory. The
handle is removed immediately, the calculation block is deleted in some time (if it's not called
anymore).
W hen work ing in the strategy tester, the IndicatorRelease() function is not executed.
Example:
//+------------------------------------------------------------------+
//| Test_IndicatorRelease.mq5 |
//| Copyright 2010, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "2010, MetaQuotes Software Corp."
#property link "https://www.mql5.com"
#property version "1.00"
//--- input parameters
input int MA_Period=15;
input int MA_shift=0;
input ENUM_MA_METHOD MA_smooth=MODE_SMA;
input ENUM_APPLIED_PRICE price=PRICE_CLOSE;
//--- will store indicator handle
int MA_handle=INVALID_HANDLE;
//+------------------------------------------------------------------+
//| Expert initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- create indicator handle
MA_handle=iMA(Symbol(),0,MA_Period,MA_shift,MA_smooth,PRICE_CLOSE);
//--- delete global variable
if(GlobalVariableCheck("MA_value"))
GlobalVariableDel("MA_value");
//---
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
CopyBuffer
Gets data of a specified buffer of a certain indicator in the necessary quantity.
Counting of elements of copied data (indicator buffer with the index buffer_num) from the starting
position is performed from the present to the past, i.e., starting position of 0 means the current bar
(indicator value for the current bar).
W hen copying the yet unknown amount of data, it is recommended to use a dynamic array as a
buffer[] recipient buffer, because the CopyBuffer() function tries to allocate the size of the receiving
array to the size of the copied data. If an indicator buffer (array that is pre-allocated for storing
indicator values by the S etIndexBufer() function) is used as the buffer[] recipient array, partial copying
is allowed. An example can be found in the Awesome_Oscillator.mql5 custom indicator in the standard
terminal package.
If you need to make a partial copy of the indicator values into another array (non-indicator buffer),
you should use an intermediate array, to which the desired number is copied. After that conduct the
element-wise copying of the required number of values into the required places of a receiving array
from this intermediate one.
If you know the amount of data you need to copy, it should better be done to a statically allocated
buffer, in order to prevent the allocation of excessive memory.
No matter what is the property of the target array - as _series =true or as _series =false. Data will be
copied so that the oldest element will be located at the start of the physical memory allocated for the
array. There are 3 variants of function calls.
Call by the first position and the number of required elements
int CopyBuffer(
int indicator_handle, // indicator handle
int buffer_num, // indicator buffer number
int start_pos, // start position
int count, // amount to copy
double buffer[] // target array to copy
);
Parameters
indicator_handle
[in] The indicator handle, returned by the corresponding indicator function.
buffer_num
[in] The indicator buffer number.
start_pos
[in] The position of the first element to copy.
count
[in] Data count to copy.
start_time
[in] Bar time, corresponding to the first element.
stop_time
[in] Bar time, corresponding to the last element.
buffer[]
[out] Array of double type.
Return Value
W hen requesting data from the indicator, if requested timeseries are not yet built or they need to
be downloaded from the server, the function will immediately return -1, but the process of
downloading/building will be initiated.
W hen requesting data from an Expert Advisor or script, downloading from the server will be
initiated, if the terminal does not have these data locally, or building of a required timeseries will
start, if data can be built from the local history but they are not ready yet. The function will return
the amount of data that will be ready by the moment of timeout expiration.
Example:
//+------------------------------------------------------------------+
//| TestCopyBuffer3.mq5 |
//| Copyright 2009, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "2009, MetaQuotes Software Corp."
#property link "https://www.mql5.com"
#property version "1.00"
#property indicator_separate_window
#property indicator_buffers 1
#property indicator_plots 1
//---- plot MA
#property indicator_label1 "MA"
#property indicator_type1 DRAW_LINE
#property indicator_color1 clrRed
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
//--- input parameters
input bool AsSeries=true;
input int period=15;
input ENUM_MA_METHOD smootMode=MODE_EMA;
input ENUM_APPLIED_PRICE price=PRICE_CLOSE;
input int shift=0;
//--- indicator buffers
double MABuffer[];
int ma_handle;
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- indicator buffers mapping
SetIndexBuffer(0,MABuffer,INDICATOR_DATA);
Print("Parameter AsSeries = ",AsSeries);
Print("Indicator buffer after SetIndexBuffer() is a timeseries = ",
ArrayGetAsSeries(MABuffer));
//--- set short indicator name
IndicatorSetString(INDICATOR_SHORTNAME,"MA("+period+")"+AsSeries);
//--- set AsSeries (depends on input parameter)
ArraySetAsSeries(MABuffer,AsSeries);
Print("Indicator buffer after ArraySetAsSeries(MABuffer,true); is a timeseries = ",
ArrayGetAsSeries(MABuffer));
//---
ma_handle=iMA(Symbol(),0,period,shift,smootMode,price);
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
//--- check if all data calculated
if(BarsCalculated(ma_handle)<rates_total) return(0);
//--- we can copy not all data
int to_copy;
if(prev_calculated>rates_total || prev_calculated<=0) to_copy=rates_total;
else
{
to_copy=rates_total-prev_calculated;
//--- last value is always copied
to_copy++;
}
//--- try to copy
if(CopyBuffer(ma_handle,0,0,to_copy,MABuffer)<=0) return(0);
//--- return value of prev_calculated for next call
return(rates_total);
}
//+------------------------------------------------------------------+
The above example illustrates how an indicator buffer is filled out with the values of another indicator
buffer from the indicator on the same symbol/period.
S ee a detailed example of history requesting data in section Methods of Object Binding. The script
available in that section shows how to get the values of indicator iFractals on the last 1000 bars and
how to display the last 10 up and 10 down fractals on the chart. A similar technique can be used for all
indicators that have missing data and that are usually drawn using the following styles :
· DRAW_SECTION,
· DRAW_ARR OW ,
· DRAW_ZI GZAG,
· DRAW_COLOR_SECTION,
· DRAW_COLOR_ARR OW ,
· DRAW_COLOR_ZI GZAG.
See also
CopyRates
Gets history data of M qlRates structure of a specified symbol-period in specified quantity into the
rates _array array. The elements ordering of the copied data is from present to the past, i.e., starting
position of 0 means the current bar.
W hen copying the yet unknown amount of data, it is recommended to use dynamic array as a target
array, because if the requested data count is less (or more) than the length of the target array,
function tries to reallocate the memory so that the requested data fit entirely.
If you know the amount of data you need to copy, it should better be done to a statically allocated
buffer, in order to prevent the allocation of excessive memory.
No matter what is the property of the target array - as _series =true or as _series =false. Data will be
copied so that the oldest element will be located at the start of the physical memory allocated for the
array. There are 3 variants of function calls.
Call by the first position and the number of required elements
int CopyRates(
string symbol_name, // symbol name
ENUM_TIMEFRAMES timeframe, // period
int start_pos, // start position
int count, // data count to copy
MqlRates rates_array[] // target array to copy
);
Parameters
symbol_name
[in] S ymbol name.
timeframe
[in] Period.
start_time
[in] Bar time for the first element to copy.
start_pos
[in] The start position for the first element to copy.
count
[in] Data count to copy.
stop_time
[in] Bar time, corresponding to the last element to copy.
rates_array[]
[out] Array of M qlRates type.
Return Value
If the whole interval of requested data is out of the available data on the server, the function
returns -1. If data outside TERMINAL_M AXBARS (maximal number of bars on the chart) is requested,
the function will also return -1.
W hen requesting data from the indicator, if requested timeseries are not yet built or they need to
be downloaded from the server, the function will immediately return -1, but the process of
downloading/building will be initiated.
W hen requesting data from an Expert Advisor or script, downloading from the server will be
initiated, if the terminal does not have these data locally, or building of a required timeseries will
start, if data can be built from the local history but they are not ready yet. The function will return
the amount of data that will be ready by the moment of timeout expiration, but history downloading
will continue, and at the next similar request the function will return more data.
W hen requesting data by the start date and the number of required elements, only data whose date
is less than (earlier) or equal to the date specified will be returned. It means, the open time of any
bar, for which value is returned (volume, spread, value on the indicator buffer, prices Open, High,
Low, Close or open time Time) is always less or equal to the specified one.
W hen requesting data in a specified range of dates, only data from this interval will be returned.
The interval is set and counted up to seconds. It means, the open time of any bar, for which value is
returned (volume, spread, value on the indicator buffer, prices Open, High, Low, Close or open time
Time) is always within the requested interval.
Thus, if the current day is S aturday, at the attempt to copy data on a week timeframe specifying
start_time=Last_Tuesday and stop_time=Last_Friday the function will return 0, because the open
time on a week timeframe is always S unday, but one week bar does not fall into the specified
interval.
If you need to return value corresponding to the current uncompleted bar, you can use the first form
of call specifying start_pos =0 and count=1.
Example:
void OnStart()
{
//---
MqlRates rates[];
ArraySetAsSeries(rates,true);
int copied=CopyRates(Symbol(),0,0,100,rates);
if(copied>0)
{
Print("Bars copied: "+copied);
string format="open = %G, high = %G, low = %G, close = %G, volume = %d";
string out;
int size=fmin(copied,10);
for(int i=0;i<size;i++)
{
out=i+":"+TimeToString(rates[i].time);
out=out+" "+StringFormat(format,
rates[i].open,
rates[i].high,
rates[i].low,
rates[i].close,
rates[i].tick_volume);
Print(out);
}
}
else Print("Failed to get history data for the symbol ",Symbol());
}
S ee a detailed example of requesting history data in section Methods of Object Binding. The script
available in that section shows how to get the values of indicator iFractals on the last 1000 bars and
how to display the last 10 up and 10 down fractals on the chart. A similar technique can be used for all
indicators that have missing data and that are usually drawn using the following styles :
· DRAW_SECTION,
· DRAW_ARR OW ,
· DRAW_ZI GZAG,
· DRAW_COLOR_SECTION,
· DRAW_COLOR_ARR OW ,
· DRAW_COLOR_ZI GZAG.
See also
S tructures and Classes, TimeToS tring, S tringFormat
CopySeries
Gets the synchronized timeseries from the M qlRates structure for the specified symbol-period and the
specified amount. The data is received into the specified set of arrays. Elements are counted down
from the present to the past, which means that the starting position equal to 0 means the current bar.
If the data amount to be copied is unknown, it is recommended to use the dynamic array for the
receiving arrays, since if the data amount exceeds what an array can contain, this can cause the
attempt to redistribute the array to fit all of the requested data.
If you need to copy a predetermined amount of data, it is recommended to use a statistically allocated
buffer to avoid unnecessary memory reallocation.
The property of the receiving array — as _series =true or as _series =false — will be ignored: during
copying, the oldest timeseries element will be copied to the beginning of the physical memory
allocated for the array.
int CopySeries(
string symbol_name, // symbol name
ENUM_TIMEFRAMES timeframe, // period
int start_pos, // start position
int count, // amount to copy
ulong rates_mask, // combination of flags to specify the requested series
void& array1[], // array to receive the data of the first copies timeseries
void& array2[] // array to receive the data of the second copied timeseries
...
);
Parameters
symbol_name
[in] S ymbol.
timeframe
[in] Period.
start_pos
[in] First copied element index.
count
[in] Number of copied elements.
rates_mask
[in] A combination of flags from the ENUM _COPY_RATES enumeration.
array1, array2,...
[out] Array of the appropriate type to receive the timeseries from the M qlRates structure. The
order of the arrays passed to the function must match the order of the fields in the M qlRates
structure.
Return Value
If the entire interval of the requested data is beyond the data available on the server, the function
returns -1. If the requested data is beyond TERMINAL_M AXBARS (the maximum number of bars on
the chart), the function also returns -1.
W hen requesting data from an indicator, the function immediately returns -1 if requested
timeseries are not constructed yet or they should be downloaded from the server. However, this will
initiate data download/constructing itself.
W hen requesting data from an Expert Advisor or a script, download from the server is initiated if
the terminal does not have the appropriate data locally, or construction of the necessary timeseries
starts if the data can be constructed from the local history but they are not ready yet. The function
returns the amount of data that is ready by the time the timeout expires, however the history
download continues, and the function returns more data during the next similar request.
The CopyS eries function allows obtaining only the necessary timeseries into different specified arrays
during one call, while all of timeseries data will be synchronized. This means that all values in the
resulting arrays at a certain index N will belong to the same bar on the specified S ymbol/Timeframe
pair. Therefore, there is no need for the programmer to ensure the synchronization of all received
timeseries by the bar opening time.
Unlik eCopyRates, which returns the full set of timeseries as an M qlRates array, the CopyS eries
function allows the programmer to get only the required timeseries as separate arrays. This can be
done by specifying a combination of flags to select the type of timeseries. The order of the arrays
passed to the function must match the order of the fields in the M qlRates structure:
struct MqlRates
{
datetime time; // period start time
double open; // open price
double high; // high price for the period
double low; // low price for the period
double close; // close price
long tick_volume; // tick volume
int spread; // spread
long real_volume; // exchange volume
}
Thus, if you need to get the values of the time, close and real_volume timeseries for the last 100 bars
of the current S ymbol/Timeframe, you should use the following call:
datetime time[];
double close[];
long volume[];
CopySeries(NULL,0,0,100,COPY_RATES_TIME|COPY_RATES_CLOSE|COPY_RATES_VOLUME_REAL,time,close,volume);
Mind the order of the arrays " time, close, volume" — it must match the order of the fields in the
M qlRates structure. The order of values in the rates_mask does not matter. The mas k could be as
follows :
COPY_RATES_VOLUME_REAL|COPY_RATES_TIME|COPY_RATES_CLOSE
Example:
ArrayPrint(close);
//--- now also request open prices; use float array for close prices
ResetLastError();
int res2=CopySeries(NULL, PERIOD_CURRENT, 0, InpCount,
COPY_RATES_TIME|COPY_RATES_CLOSE|COPY_RATES_OPEN, time2, open, closef);
PrintFormat("2. CopySeries returns %d values. Error code=%d", res2, GetLastError());
ArrayPrint(closef);
//--- Compare the received data
if((res1==res2) && (time1[0]==time2[0]))
{
Print(" | Time | Open | Close double | Close float |");
for(int i=0; i<10; i++)
{
PrintFormat("%d | %s | %.5f | %.5f | %.5f |",
i, TimeToString(time1[i]), open[i], close[i], closef[i]);
}
}
//--- Result
1. CopySeries returns 20 values. Error code=0
[ 0] 1.06722 1.06733 1.06653 1.06520 1.06573 1.06649 1.06694 1.06675 1.06684 1.06604
[10] 1.06514 1.06557 1.06456 1.06481 1.06414 1.06394 1.06364 1.06386 1.06239 1.06247
2. CopySeries returns 20 values. Error code=0
[ 0] 1.06722 1.06733 1.06653 1.06520 1.06573 1.06649 1.06694 1.06675 1.06684 1.06604
[10] 1.06514 1.06557 1.06456 1.06481 1.06414 1.06394 1.06364 1.06386 1.06239 1.06247
| Time | Open | Close double | Close float |
0 | 2023.03.01 17:00 | 1.06660 | 1.06722 | 1.06722 |
1 | 2023.03.01 18:00 | 1.06722 | 1.06733 | 1.06733 |
2 | 2023.03.01 19:00 | 1.06734 | 1.06653 | 1.06653 |
3 | 2023.03.01 20:00 | 1.06654 | 1.06520 | 1.06520 |
4 | 2023.03.01 21:00 | 1.06520 | 1.06573 | 1.06573 |
5 | 2023.03.01 22:00 | 1.06572 | 1.06649 | 1.06649 |
6 | 2023.03.01 23:00 | 1.06649 | 1.06694 | 1.06694 |
7 | 2023.03.02 00:00 | 1.06683 | 1.06675 | 1.06675 |
8 | 2023.03.02 01:00 | 1.06675 | 1.06684 | 1.06684 |
9 | 2023.03.02 02:00 | 1.06687 | 1.06604 | 1.06604 |
//---
}
See also
S tructures and classes, CopyRates
CopyTime
The function gets to time_array history data of bar opening time for the specified symbol-period pair
in the specified quantity. It should be noted that elements ordering is from present to past, i.e.,
starting position of 0 means the current bar.
W hen copying the yet unknown amount of data, it is recommended to use dynamic array as a target
array, because if the requested data count is less (or more) than the length of the target array,
function tries to reallocate the memory so that the requested data fit entirely.
If you know the amount of data you need to copy, it should better be done to a statically allocated
buffer, in order to prevent the allocation of excessive memory.
No matter what is the property of the target array - as _series =true or as _series =false. Data will be
copied so that the oldest element will be located at the start of the physical memory allocated for the
array. There are 3 variants of function calls.
Call by the first position and the number of required elements
int CopyTime(
string symbol_name, // symbol name
ENUM_TIMEFRAMES timeframe, // period
int start_pos, // start position
int count, // data count to copy
datetime time_array[] // target array to copy open times
);
Parameters
symbol_name
[in] S ymbol name.
timeframe
[in] Period.
start_pos
[in] The start position for the first element to copy.
count
[in] Data count to copy.
start_time
[in] The start time for the first element to copy.
stop_time
[in] Bar time corresponding to the last element to copy.
time_array[]
[out] Array of datetime type.
Return Value
If the whole interval of requested data is out of the available data on the server, the function
returns -1. If data outside TERMINAL_M AXBARS (maximal number of bars on the chart) is requested,
the function will also return -1.
W hen requesting data from the indicator, if requested timeseries are not yet built or they need to
be downloaded from the server, the function will immediately return -1, but the process of
downloading/building will be initiated.
W hen requesting data from an Expert Advisor or script, downloading from the server will be
initiated, if the terminal does not have these data locally, or building of a required timeseries will
start, if data can be built from the local history but they are not ready yet. The function will return
the amount of data that will be ready by the moment of timeout expiration, but history downloading
will continue, and at the next similar request the function will return more data.
W hen requesting data by the start date and the number of required elements, only data whose date
is less than (earlier) or equal to the date specified will be returned. It means, the open time of any
bar, for which value is returned (volume, spread, value on the indicator buffer, prices Open, High,
Low, Close or open time Time) is always less or equal to the specified one.
W hen requesting data in a specified range of dates, only data from this interval will be returned.
The interval is set and counted up to seconds. It means, the open time of any bar, for which value is
returned (volume, spread, value on the indicator buffer, prices Open, High, Low, Close or open time
Time) is always within the requested interval.
Thus, if the current day is S aturday, at the attempt to copy data on a week timeframe specifying
start_time=Last_Tuesday and stop_time=Last_Friday the function will return 0, because the open
time on a week timeframe is always S unday, but one week bar does not fall into the specified
interval.
If you need to return value corresponding to the current uncompleted bar, you can use the first form
of call specifying start_pos =0 and count=1.
S ee a detailed example of requesting history data in section Methods of Object Binding. The script
available in that section shows how to get the values of indicator iFractals on the last 1000 bars and
how to display the last 10 up and 10 down fractals on the chart. A similar technique can be used for all
indicators that have missing data and that are usually drawn using the following styles :
· DRAW_SECTION,
· DRAW_ARR OW ,
· DRAW_ZI GZAG,
· DRAW_COLOR_SECTION,
· DRAW_COLOR_ARR OW ,
· DRAW_COLOR_ZI GZAG.
CopyOpen
The function gets into open_array the history data of bar open prices for the selected symbol-period
pair in the specified quantity. It should be noted that elements ordering is from present to past, i.e.,
starting position of 0 means the current bar.
W hen copying the yet unknown amount of data, it is recommended to use dynamic array as a target
array, because if the requested data count is less (or more) than the length of the target array,
function tries to reallocate the memory so that the requested data fit entirely.
If you know the amount of data you need to copy, it should better be done to a statically allocated
buffer, in order to prevent the allocation of excessive memory.
No matter what is the property of the target array - as _series =true or as _series =false. Data will be
copied so that the oldest element will be located at the start of the physical memory allocated for the
array. There are 3 variants of function calls.
Call by the first position and the number of required elements
int CopyOpen(
string symbol_name, // symbol name
ENUM_TIMEFRAMES timeframe, // period
int start_pos, // start position
int count, // data count to copy
double open_array[] // target array to copy open prices
);
Parameters
symbol_name
[in] S ymbol name.
timeframe
[in] Period.
start_pos
[in] The start position for the first element to copy.
count
[in] Data count to copy.
start_time
[in] The start time for the first element to copy.
stop_time
[in] The start time for the last element to copy.
open_array[]
[out] Array of double type.
Return Value
If the whole interval of requested data is out of the available data on the server, the function
returns -1. If data outside TERMINAL_M AXBARS (maximal number of bars on the chart) is requested,
the function will also return -1.
W hen requesting data from the indicator, if requested timeseries are not yet built or they need to
be downloaded from the server, the function will immediately return -1, but the process of
downloading/building will be initiated.
W hen requesting data from an Expert Advisor or script, downloading from the server will be
initiated, if the terminal does not have these data locally, or building of a required timeseries will
start, if data can be built from the local history but they are not ready yet. The function will return
the amount of data that will be ready by the moment of timeout expiration, but history downloading
will continue, and at the next similar request the function will return more data.
W hen requesting data by the start date and the number of required elements, only data whose date
is less than (earlier) or equal to the date specified will be returned. It means, the open time of any
bar, for which value is returned (volume, spread, value on the indicator buffer, prices Open, High,
Low, Close or open time Time) is always less or equal to the specified one.
W hen requesting data in a specified range of dates, only data from this interval will be returned.
The interval is set and counted up to seconds. It means, the open time of any bar, for which value is
returned (volume, spread, value on the indicator buffer, prices Open, High, Low, Close or open time
Time) is always within the requested interval.
Thus, if the current day is S aturday, at the attempt to copy data on a week timeframe specifying
start_time=Last_Tuesday and stop_time=Last_Friday the function will return 0, because the open
time on a week timeframe is always S unday, but one week bar does not fall into the specified
interval.
If you need to return value corresponding to the current uncompleted bar, you can use the first form
of call specifying start_pos =0 and count=1.
S ee a detailed example of requesting history data in section Methods of Object Binding. The script
available in that section shows how to get the values of indicator iFractals on the last 1000 bars and
how to display the last 10 up and 10 down fractals on the chart. A similar technique can be used for all
indicators that have missing data and that are usually drawn using the following styles :
· DRAW_SECTION,
· DRAW_ARR OW ,
· DRAW_ZI GZAG,
· DRAW_COLOR_SECTION,
· DRAW_COLOR_ARR OW ,
· DRAW_COLOR_ZI GZAG.
CopyHigh
The function gets into high_array the history data of highest bar prices for the selected symbol-period
pair in the specified quantity. It should be noted that elements ordering is from present to past, i.e.,
starting position of 0 means the current bar.
W hen copying the yet unknown amount of data, it is recommended to use dynamic array as a target
array, because if the requested data count is less (or more) than the length of the target array,
function tries to reallocate the memory so that the requested data fit entirely.
If you know the amount of data you need to copy, it should better be done to a statically allocated
buffer, in order to prevent the allocation of excessive memory.
No matter what is the property of the target array - as _series =true or as _series =false. Data will be
copied so that the oldest element will be located at the start of the physical memory allocated for the
array. There are 3 variants of function calls.
Call by the first position and the number of required elements
int CopyHigh(
string symbol_name, // symbol name
ENUM_TIMEFRAMES timeframe, // period
int start_pos, // start position
int count, // data count to copy
double high_array[] // target array to copy
);
Parameters
symbol_name
[in] S ymbol name.
timeframe
[in] Period.
start_pos
[in] The start position for the first element to copy.
count
[in] Data count to copy.
start_time
[in] The start time for the first element to copy.
stop_time
[in] Bar time, corresponding to the last element to copy.
high_array[]
[out] Array of double type.
Return Value
If the whole interval of requested data is out of the available data on the server, the function
returns -1. If data outside TERMINAL_M AXBARS (maximal number of bars on the chart) is requested,
the function will also return -1.
W hen requesting data from the indicator, if requested timeseries are not yet built or they need to
be downloaded from the server, the function will immediately return -1, but the process of
downloading/building will be initiated.
W hen requesting data from an Expert Advisor or script, downloading from the server will be
initiated, if the terminal does not have these data locally, or building of a required timeseries will
start, if data can be built from the local history but they are not ready yet. The function will return
the amount of data that will be ready by the moment of timeout expiration, but history downloading
will continue, and at the next similar request the function will return more data.
W hen requesting data by the start date and the number of required elements, only data whose date
is less than (earlier) or equal to the date specified will be returned. It means, the open time of any
bar, for which value is returned (volume, spread, value on the indicator buffer, prices Open, High,
Low, Close or open time Time) is always less or equal to the specified one.
W hen requesting data in a specified range of dates, only data from this interval will be returned.
The interval is set and counted up to seconds. It means, the open time of any bar, for which value is
returned (volume, spread, value on the indicator buffer, prices Open, High, Low, Close or open time
Time) is always within the requested interval.
Thus, if the current day is S aturday, at the attempt to copy data on a week timeframe specifying
start_time=Last_Tuesday and stop_time=Last_Friday the function will return 0, because the open
time on a week timeframe is always S unday, but one week bar does not fall into the specified
interval.
If you need to return value corresponding to the current uncompleted bar, you can use the first form
of call specifying start_pos =0 and count=1.
Example:
#property description "An example for output of the High[i] and Low[i]"
#property description "for a random chosen bars"
double High[],Low[];
//+------------------------------------------------------------------+
//| Get Low for specified bar index |
//+------------------------------------------------------------------+
double iLow(string symbol,ENUM_TIMEFRAMES timeframe,int index)
{
double low=0;
ArraySetAsSeries(Low,true);
int copied=CopyLow(symbol,timeframe,0,Bars(symbol,timeframe),Low);
if(copied>0 && index<copied) low=Low[index];
return(low);
}
//+------------------------------------------------------------------+
//| Get the High for specified bar index |
//+------------------------------------------------------------------+
double iHigh(string symbol,ENUM_TIMEFRAMES timeframe,int index)
{
double high=0;
ArraySetAsSeries(High,true);
int copied=CopyHigh(symbol,timeframe,0,Bars(symbol,timeframe),High);
if(copied>0 && index<copied) high=High[index];
return(high);
}
//+------------------------------------------------------------------+
//| Expert tick function |
//+------------------------------------------------------------------+
void OnTick()
{
//--- on every tick we output the High and Low values for the bar with index,
//--- that is equal to the second, on which tick arrived
datetime t=TimeCurrent();
int sec=t%60;
printf("High[%d] = %G Low[%d] = %G",
sec,iHigh(Symbol(),0,sec),
sec,iLow(Symbol(),0,sec));
}
S ee adetailed example of requesting history data in the Methods of Object Binding section. The script
available in that section shows how to get the values of indicator iFractals on the last 1000 bars and
how to display the last 10 up and 10 down fractals on the chart. A similar technique can be used for all
indicators that have missing data and that are usually drawn using the following styles :
· DRAW_SECTION,
· DRAW_ARR OW ,
· DRAW_ZI GZAG,
· DRAW_COLOR_SECTION,
· DRAW_COLOR_ARR OW ,
· DRAW_COLOR_ZI GZAG.
CopyLow
The function gets into low_array the history data of minimal bar prices for the selected symbol-period
pair in the specified quantity. It should be noted that elements ordering is from present to past, i.e.,
starting position of 0 means the current bar.
W hen copying the yet unknown amount of data, it is recommended to use dynamic array as a target
array, because if the requested data count is less (or more) than the length of the target array,
function tries to reallocate the memory so that the requested data fit entirely.
If you know the amount of data you need to copy, it should better be done to a statically allocated
buffer, in order to prevent the allocation of excessive memory.
No matter what is the property of the target array - as _series =true or as _series =false. Data will be
copied so that the oldest element will be located at the start of the physical memory allocated for the
array. There are 3 variants of function calls.
Call by the first position and the number of required elements
int CopyLow(
string symbol_name, // symbol name
ENUM_TIMEFRAMES timeframe, // period
int start_pos, // start position
int count, // data count to copy
double low_array[] // target array to copy
);
Parameters
symbol_name
[in] S ymbol.
timeframe
[in] Period.
start_pos
[in] The start position for the first element to copy.
count
[in] Data count to copy.
start_time
[in] Bar time, corresponding to the first element to copy.
stop_time
[in] Bar time, corresponding to the last element to copy.
low_array[]
[out] Array of double type.
Return Value
If the whole interval of requested data is out of the available data on the server, the function
returns -1. If data outside TERMINAL_M AXBARS (maximal number of bars on the chart) is requested,
the function will also return -1.
W hen requesting data from the indicator, if requested timeseries are not yet built or they need to
be downloaded from the server, the function will immediately return -1, but the process of
downloading/building will be initiated.
W hen requesting data from an Expert Advisor or script, downloading from the server will be
initiated, if the terminal does not have these data locally, or building of a required timeseries will
start, if data can be built from the local history but they are not ready yet. The function will return
the amount of data that will be ready by the moment of timeout expiration, but history downloading
will continue, and at the next similar request the function will return more data.
W hen requesting data by the start date and the number of required elements, only data whose date
is less than (earlier) or equal to the date specified will be returned. It means, the open time of any
bar, for which value is returned (volume, spread, value on the indicator buffer, prices Open, High,
Low, Close or open time Time) is always less or equal to the specified one.
W hen requesting data in a specified range of dates, only data from this interval will be returned.
The interval is set and counted up to seconds. It means, the open time of any bar, for which value is
returned (volume, spread, value on the indicator buffer, prices Open, High, Low, Close or open time
Time) is always within the requested interval.
Thus, if the current day is S aturday, at the attempt to copy data on a week timeframe specifying
start_time=Last_Tuesday and stop_time=Last_Friday the function will return 0, because the open
time on a week timeframe is always S unday, but one week bar does not fall into the specified
interval.
If you need to return value corresponding to the current uncompleted bar, you can use the first form
of call specifying start_pos =0 and count=1.
S ee a detailed example of requesting history data in section Methods of Object Binding. The script
available in that section shows how to get the values of indicator iFractals on the last 1000 bars and
how to display the last 10 up and 10 down fractals on the chart. A similar technique can be used for all
indicators that have missing data and that are usually drawn using the following styles :
· DRAW_SECTION,
· DRAW_ARR OW ,
· DRAW_ZI GZAG,
· DRAW_COLOR_SECTION,
· DRAW_COLOR_ARR OW ,
· DRAW_COLOR_ZI GZAG.
See also
CopyHigh
CopyClose
The function gets into close_array the history data of bar close prices for the selected symbol-period
pair in the specified quantity. It should be noted that elements ordering is from present to past, i.e.,
starting position of 0 means the current bar.
W hen copying the yet unknown amount of data, it is recommended to use dynamic array as a target
array, because if the requested data count is less (or more) than the length of the target array,
function tries to reallocate the memory so that the requested data fit entirely.
If you know the amount of data you need to copy, it should better be done to a statically allocated
buffer, in order to prevent the allocation of excessive memory.
No matter what is the property of the target array - as _series =true or as _series =false. Data will be
copied so that the oldest element will be located at the start of the physical memory allocated for the
array. There are 3 variants of function calls.
Call by the first position and the number of required elements
int CopyClose(
string symbol_name, // symbol name
ENUM_TIMEFRAMES timeframe, // period
int start_pos, // start position
int count, // data count to copy
double close_array[] // target array to copy
);
Parameters
symbol_name
[in] S ymbol name.
timeframe
[in] Period.
start_pos
[in] The start position for the first element to copy.
count
[in] Data count to copy.
start_time
[in] The start time for the first element to copy.
stop_time
[in] Bar time, corresponding to the last element to copy.
close_array[]
[out] Array of double type.
Return Value
If the whole interval of requested data is out of the available data on the server, the function
returns -1. If data outside TERMINAL_M AXBARS (maximal number of bars on the chart) is requested,
the function will also return -1.
W hen requesting data from the indicator, if requested timeseries are not yet built or they need to
be downloaded from the server, the function will immediately return -1, but the process of
downloading/building will be initiated.
W hen requesting data from an Expert Advisor or script, downloading from the server will be
initiated, if the terminal does not have these data locally, or building of a required timeseries will
start, if data can be built from the local history but they are not ready yet. The function will return
the amount of data that will be ready by the moment of timeout expiration, but history downloading
will continue, and at the next similar request the function will return more data.
W hen requesting data by the start date and the number of required elements, only data whose date
is less than (earlier) or equal to the date specified will be returned. It means, the open time of any
bar, for which value is returned (volume, spread, value on the indicator buffer, prices Open, High,
Low, Close or open time Time) is always less or equal to the specified one.
W hen requesting data in a specified range of dates, only data from this interval will be returned.
The interval is set and counted up to seconds. It means, the open time of any bar, for which value is
returned (volume, spread, value on the indicator buffer, prices Open, High, Low, Close or open time
Time) is always within the requested interval.
Thus, if the current day is S aturday, at the attempt to copy data on a week timeframe specifying
start_time=Last_Tuesday and stop_time=Last_Friday the function will return 0, because the open
time on a week timeframe is always S unday, but one week bar does not fall into the specified
interval.
If you need to return value corresponding to the current uncompleted bar, you can use the first form
of call specifying start_pos =0 and count=1.
S ee a detailed example of history data requesting in section Methods of Object Binding. The script
available in that section shows how to get the values of indicator iFractals on the last 1000 bars and
how to display the last 10 up and 10 down fractals on the chart. A similar technique can be used for all
indicators that have missing data and that are usually drawn using the following styles :
· DRAW_SECTION,
· DRAW_ARR OW ,
· DRAW_ZI GZAG,
· DRAW_COLOR_SECTION,
· DRAW_COLOR_ARR OW ,
· DRAW_COLOR_ZI GZAG.
CopyTickVolume
The function gets into volume_array the history data of tick volumes for the selected symbol-period
pair in the specified quantity. It should be noted that elements ordering is from present to past, i.e.,
starting position of 0 means the current bar.
W hen copying the yet unknown amount of data, it is recommended to use dynamic array as a target
array, because if the requested data count is less (or more) than the length of the target array,
function tries to reallocate the memory so that the requested data fit entirely.
If you know the amount of data you need to copy, it should better be done to a statically allocated
buffer, in order to prevent the allocation of excessive memory.
No matter what is the property of the target array - as _series =true or as _series =false. Data will be
copied so that the oldest element will be located at the start of the physical memory allocated for the
array. There are 3 variants of function calls.
Call by the first position and the number of required elements
int CopyTickVolume(
string symbol_name, // symbol name
ENUM_TIMEFRAMES timeframe, // period
int start_pos, // start position
int count, // data count to copy
long volume_array[] // target array for tick volumes
);
Parameters
symbol_name
[in] S ymbol name.
timeframe
[in] Period.
start_pos
[in] The start position for the first element to copy.
count
[in] Data count to copy.
start_time
[in] The start time for the first element to copy.
stop_time
[in] Bar time, corresponding to the last element to copy.
volume_array[]
[out] Array of long type.
Return Value
If the whole interval of requested data is out of the available data on the server, the function
returns -1. If data outside TERMINAL_M AXBARS (maximal number of bars on the chart) is requested,
the function will also return -1.
W hen requesting data from the indicator, if requested timeseries are not yet built or they need to
be downloaded from the server, the function will immediately return -1, but the process of
downloading/building will be initiated.
W hen requesting data from an Expert Advisor or script, downloading from the server will be
initiated, if the terminal does not have these data locally, or building of a required timeseries will
start, if data can be built from the local history but they are not ready yet. The function will return
the amount of data that will be ready by the moment of timeout expiration, but history downloading
will continue, and at the next similar request the function will return more data.
W hen requesting data by the start date and the number of required elements, only data whose date
is less than (earlier) or equal to the date specified will be returned. It means, the open time of any
bar, for which value is returned (volume, spread, value on the indicator buffer, prices Open, High,
Low, Close or open time Time) is always less or equal to the specified one.
W hen requesting data in a specified range of dates, only data from this interval will be returned.
The interval is set and counted up to seconds. It means, the open time of any bar, for which value is
returned (volume, spread, value on the indicator buffer, prices Open, High, Low, Close or open time
Time) is always within the requested interval.
Thus, if the current day is S aturday, at the attempt to copy data on a week timeframe specifying
start_time=Last_Tuesday and stop_time=Last_Friday the function will return 0, because the open
time on a week timeframe is always S unday, but one week bar does not fall into the specified
interval.
If you need to return value corresponding to the current uncompleted bar, you can use the first form
of call specifying start_pos =0 and count=1.
Example:
#property indicator_separate_window
#property indicator_buffers 1
#property indicator_plots 1
//---- plot TickVolume
#property indicator_label1 "TickVolume"
#property indicator_type1 DRAW_HISTOGRAM
#property indicator_color1 C'143,188,139'
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
//--- input parameters
input int bars=3000;
//--- indicator buffers
double TickVolumeBuffer[];
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
void OnInit()
{
//--- indicator buffers mapping
SetIndexBuffer(0,TickVolumeBuffer,INDICATOR_DATA);
IndicatorSetInteger(INDICATOR_DIGITS,0);
//---
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
S ee a detailed example of history data requesting in section Methods of Object Binding. The script
available in that section shows how to get the values of indicator iFractals on the last 1000 bars and
how to display the last 10 up and 10 down fractals on the chart. A similar technique can be used for all
indicators that have missing data and that are usually drawn using the following styles :
· DRAW_SECTION,
· DRAW_ARR OW ,
· DRAW_ZI GZAG,
· DRAW_COLOR_SECTION,
· DRAW_COLOR_ARR OW ,
· DRAW_COLOR_ZI GZAG.
CopyRealVolume
The function gets into volume_array the history data of trade volumes for the selected symbol-period
pair in the specified quantity. It should be noted that elements ordering is from present to past, i.e.,
starting position of 0 means the current bar.
W hen copying the yet unknown amount of data, it is recommended to use dynamic array as a target
array, because if the requested data count is less (or more) than the length of the target array,
function tries to reallocate the memory so that the requested data fit entirely.
If you know the amount of data you need to copy, it should better be done to a statically allocated
buffer, in order to prevent the allocation of excessive memory.
No matter what is the property of the target array - as _series =true or as _series =false. Data will be
copied so that the oldest element will be located at the start of the physical memory allocated for the
array. There are 3 variants of function calls.
Call by the first position and the number of required elements
int CopyRealVolume(
string symbol_name, // symbol name
ENUM_TIMEFRAMES timeframe, // period
int start_pos, // start position
int count, // data count to copy
long volume_array[] // target array for volumes values
);
Parameters
symbol_name
[in] S ymbol name.
timeframe
[in] Period.
start_pos
[in] The start position for the first element to copy.
count
[in] Data count to copy.
start_time
[in] The start time for the first element to copy.
stop_time
[in] Bar time, corresponding to the last element to copy.
volume_array[]
[out] Array of long type.
Return Value
If the whole interval of requested data is out of the available data on the server, the function
returns -1. If data outside TERMINAL_M AXBARS (maximal number of bars on the chart) is requested,
the function will also return -1.
W hen requesting data from the indicator, if requested timeseries are not yet built or they need to
be downloaded from the server, the function will immediately return -1, but the process of
downloading/building will be initiated.
W hen requesting data from an Expert Advisor or script, downloading from the server will be
initiated, if the terminal does not have these data locally, or building of a required timeseries will
start, if data can be built from the local history but they are not ready yet. The function will return
the amount of data that will be ready by the moment of timeout expiration, but history downloading
will continue, and at the next similar request the function will return more data.
W hen requesting data by the start date and the number of required elements, only data whose date
is less than (earlier) or equal to the date specified will be returned. It means, the open time of any
bar, for which value is returned (volume, spread, value on the indicator buffer, prices Open, High,
Low, Close or open time Time) is always less or equal to the specified one.
W hen requesting data in a specified range of dates, only data from this interval will be returned.
The interval is set and counted up to seconds. It means, the open time of any bar, for which value is
returned (volume, spread, value on the indicator buffer, prices Open, High, Low, Close or open time
Time) is always within the requested interval.
Thus, if the current day is S aturday, at the attempt to copy data on a week timeframe specifying
start_time=Last_Tuesday and stop_time=Last_Friday the function will return 0, because the open
time on a week timeframe is always S unday, but one week bar does not fall into the specified
interval.
If you need to return value corresponding to the current uncompleted bar, you can use the first form
of call specifying start_pos =0 and count=1.
S ee an example of history data requesting in section Methods of Object Binding. The script available
in that section shows how to get the values of indicator iFractals on the last 1000 bars and how to
display the last 10 up and 10 down fractals on the chart. A similar technique can be used for all
indicators that have missing data and that are usually drawn using the following styles :
· DRAW_SECTION,
· DRAW_ARR OW ,
· DRAW_ZI GZAG,
· DRAW_COLOR_SECTION,
· DRAW_COLOR_ARR OW ,
· DRAW_COLOR_ZI GZAG.
CopySpread
The function gets into spread_array the history data of spread values for the selected symbol-period
pair in the specified quantity. It should be noted that elements ordering is from present to past, i.e.,
starting position of 0 means the current bar.
W hen copying the yet unknown amount of data, it is recommended to use dynamic array as a target
array, because if the requested data count is less (or more) than the length of the target array,
function tries to reallocate the memory so that the requested data fit entirely.
If you know the amount of data you need to copy, it should better be done to a statically allocated
buffer, in order to prevent the allocation of excessive memory.
No matter what is the property of the target array - as _series =true or as _series =false. Data will be
copied so that the oldest element will be located at the start of the physical memory allocated for the
array. There are 3 variants of function calls.
Call by the first position and the number of required elements
int CopySpread(
string symbol_name, // symbol name
ENUM_TIMEFRAMES timeframe, // period
int start_pos, // start position
int count, // data count to copy
int spread_array[] // target array for spread values
);
Parameters
symbol_name
[in] S ymbol name.
timeframe
[in] Period.
start_pos
[in] The start position for the first element to copy.
count
[in] Data count to copy.
start_time
[in] The start time for the first element to copy.
stop_time
[in] Bar time, corresponding to the last element to copy.
spread_array[]
[out] Array of int type.
Return Value
If the whole interval of requested data is out of the available data on the server, the function
returns -1. If data outside TERMINAL_M AXBARS (maximal number of bars on the chart) is requested,
the function will also return -1.
W hen requesting data from the indicator, if requested timeseries are not yet built or they need to
be downloaded from the server, the function will immediately return -1, but the process of
downloading/building will be initiated.
W hen requesting data from an Expert Advisor or script, downloading from the server will be
initiated, if the terminal does not have these data locally, or building of a required timeseries will
start, if data can be built from the local history but they are not ready yet. The function will return
the amount of data that will be ready by the moment of timeout expiration, but history downloading
will continue, and at the next similar request the function will return more data.
W hen requesting data by the start date and the number of required elements, only data whose date
is less than (earlier) or equal to the date specified will be returned. It means, the open time of any
bar, for which value is returned (volume, spread, value on the indicator buffer, prices Open, High,
Low, Close or open time Time) is always less or equal to the specified one.
W hen requesting data in a specified range of dates, only data from this interval will be returned.
The interval is set and counted up to seconds. It means, the open time of any bar, for which value is
returned (volume, spread, value on the indicator buffer, prices Open, High, Low, Close or open time
Time) is always within the requested interval.
Thus, if the current day is S aturday, at the attempt to copy data on a week timeframe specifying
start_time=Last_Tuesday and stop_time=Last_Friday the function will return 0, because the open
time on a week timeframe is always S unday, but one week bar does not fall into the specified
interval.
If you need to return value corresponding to the current uncompleted bar, you can use the first form
of call specifying start_pos =0 and count=1.
Example:
#property indicator_separate_window
#property indicator_buffers 1
#property indicator_plots 1
//---- plot Spread
#property indicator_label1 "Spread"
#property indicator_type1 DRAW_HISTOGRAM
#property indicator_color1 clrRed
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
//--- input parameters
input int bars=3000;
//--- indicator buffers
double SpreadBuffer[];
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
void OnInit()
{
//--- indicator buffers mapping
SetIndexBuffer(0,SpreadBuffer,INDICATOR_DATA);
IndicatorSetInteger(INDICATOR_DIGITS,0);
//---
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
S ee an example of history data requesting in section Methods of Object Binding. The script available
in that section shows how to get the values of indicator iFractals on the last 1000 bars and how to
display the last 10 up and 10 down fractals on the chart. A similar technique can be used for all
indicators that have missing data and that are usually drawn using the following styles :
· DRAW_SECTION,
· DRAW_ARR OW ,
· DRAW_ZI GZAG,
· DRAW_COLOR_SECTION,
· DRAW_COLOR_ARR OW ,
· DRAW_COLOR_ZI GZAG.
CopyTicks
The function receives ticks in the M qlTick format into ticks _array. In this case, ticks are indexed from
the past to the present, i.e. the 0 indexed tick is the oldest one in the array. For tick analysis, check
the flags field, which shows what exactly has changed in the tick.
int CopyTicks(
string symbol_name, // Symbol name
MqlTick& ticks_array[], // Tick receiving array
uint flags=COPY_TICKS_ALL, // The flag that determines the type of received ticks
ulong from=0, // The date from which you want to request ticks
uint count=0 // The number of ticks that you want to receive
);
Parameters
symbol_name
[in] S ymbol.
ticks_array
[out] An array of the M qlTick type for receiving ticks.
flags
[in] A flag to define the type of the requested ticks. COPY_TICKS_INFO – ticks with Bid and/or As k
changes, COPY_TICKS_TRADE – ticks with changes in Last and Volume, COPY_TICKS_ALL – all ticks.
For any type of request, the values of the previous tick are added to the remaining fields of the
M qlTick structure.
from
[in] The date from which you want to request ticks. In milliseconds since 1970.01.01. If from=0,
the last count ticks will be returned.
count
[in] The number of requested ticks. If the 'from' and 'count' parameters are not specified, all
available recent ticks (but not more than 2000) will be written to ticks _array[].
Returned value
The CopyTicks() function allows requesting and analyzing all received ticks. The first call of
CopyTicks() initiates synchronization of the symbol's tick database stored on the hard dis k. If the
local database does not provide all the requested ticks, then missing ticks will be automatically
downloaded from the trade server. Ticks beginning with the from date specified in CopyTicks() till
the current moment will be synchronized. After that, all ticks arriving for this symbol will be added
to the tick database thus keeping it in the synchronized state.
If the from and count parameters are not specified, all available recent ticks (but not more than
2000) will be written to ticks_array[]. The flags parameter allows specifying the type of required
ticks.
COPY_TICKS_INFO – ticks with Bid and/or As k price changes are returned. Data of other fields will
also be added. For example, if only the Bid has changed, the ask and volume fields will be filled with
last known values. To find out exactly what has changed, analyze the flags field, which will have the
value of TICK_FLAG_BID and/or TICK_FLAG_ASK. If a tick has zero values of the Bid and As k prices,
and the flags show that these data have changed (flags =TICK_FLAG_BID|TICK_FLAG_ASK), this
means that the order book (Market Depth) is empty. In other words, there are no buy and sell
orders.
COPY_TICKS_TRADE – ticks with the Last price and volume changes are returned. Data of other
fields will also be added, i.e. last known values of Bid and As k will be specified in the appropriate
fields. To find out exactly what has changed, analyze the flags field, which will have the
TICK_FLAG_LAS T and TICK_FLAG_VOLUM E value.
COPY_TICKS_ALL – all ticks with any change are returned. Unchanged fields will be filled with last
k nown values.
Call of CopyTicks() with the COPY_TICKS_ALL flag immediately returns all ticks from the request
interval, while calls in other modes require some time to process and select ticks, therefore they do
not provide significant speed advantage.
W hen requesting ticks (either COPY_TICKS_INFO or COPY_TICKS_TRADE), every tick contains full
price information as of the time of the tick (bid, ask, last and volume). This feature is provided for
an easier analysis of the trade state at the time of each tick, so there is no need to request a deep
tick history and search for the values of other fields.
In indicators, the CopyTicks() function returns the result: when called from an indicator,
CopyTick() immediately returns all available ticks of a symbol, and will launch synchronization of the
tick database, if available data is not enough. All indicators in one symbol operate in one common
thread, so the indicator cannot wait for the completion of synchronization. After synchronization,
CopyTicks() will return all requested ticks during the next call. In indicators, the OnCalculate()
function is called after the arrival of each tick.
CopyTicks() can wait for the result for 45 seconds in Expert Advisors and scripts: as distinct
from indicators, every Expert Advisor and script operate in a separate thread, and therefore can
wait 45 seconds till the completion of synchronization. If the required amount of ticks fails to be
synchronized during this time, CopyTicks() will return available ticks by timeout and will continue
synchronization. OnTick() in Expert Advisor is not a handler of every tick, it only notifies an Expert
Advisor about changes in the mark et. It can be a batch of changes : the terminal can simultaneously
make a few ticks, but OnTick() will be called only once to notify the EA of the latest market state.
The rate of data return: the terminal stores in the fast access cache 4,096 last tick s for each
instrument (65,536 ticks for symbols with a running Market Depth). If requested ticks for the
current trading session are beyond the cache, CopyTicks() calls the ticks stored in the terminal
memory. These requests require more time for execution. The slowest requests are those
requesting ticks for other days, since the data is read from the dis k in this case.
Example:
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//---
int attempts=0; // Count of attempts
bool success=false; // The flag of a successful copying of ticks
MqlTick tick_array[]; // Tick receiving array
MqlTick lasttick; // To receive last tick data
SymbolInfoTick(_Symbol,lasttick);
//--- Make 3 attempts to receive ticks
while(attempts<3)
{
//--- Measuring start time before receiving the ticks
uint start=GetTickCount();
//--- Requesting the tick history since 1970.01.01 00:00.001 (parameter from=1 ms)
int received=CopyTicks(_Symbol,tick_array,COPY_TICKS_ALL,1,getticks);
if(received!=-1)
{
//--- Showing information about the number of ticks and spent time
PrintFormat("%s: received %d ticks in %d ms",_Symbol,received,GetTickCount()-start);
//--- If the tick history is synchronized, the error code is equal to zero
if(GetLastError()==0)
{
success=true;
break;
}
else
PrintFormat("%s: Ticks are not synchronized yet, %d ticks received for %d ms. Error=%d"
_Symbol,received,GetTickCount()-start,_LastError);
}
//--- Counting attempts
attempts++;
//--- A one-second pause to wait for the end of synchronization of the tick database
Sleep(1000);
}
//--- Receiving the requested ticks from the beginning of the tick history failed in three attempts
if(!success)
{
PrintFormat("Error! Failed to receive %d ticks of %s in three attempts",getticks,_Symbol);
return;
}
int ticks=ArraySize(tick_array);
//--- Showing the time of the first tick in the array
datetime firstticktime=tick_array[ticks-1].time;
PrintFormat("Last tick time = %s.%03I64u",
TimeToString(firstticktime,TIME_DATE|TIME_MINUTES|TIME_SECONDS),tick_array[ticks-1].
//--- Show the time of the last tick in the array
datetime lastticktime=tick_array[0].time;
PrintFormat("First tick time = %s.%03I64u",
TimeToString(lastticktime,TIME_DATE|TIME_MINUTES|TIME_SECONDS),tick_array[0].time_ms
//---
MqlDateTime today;
datetime current_time=TimeCurrent();
TimeToStruct(current_time,today);
PrintFormat("current_time=%s",TimeToString(current_time));
today.hour=0;
today.min=0;
today.sec=0;
datetime startday=StructToTime(today);
datetime endday=startday+24*60*60;
if((ticks=CopyTicksRange(_Symbol,tick_array,COPY_TICKS_ALL,startday*1000,endday*1000))==-1)
{
PrintFormat("CopyTicksRange(%s,tick_array,COPY_TICKS_ALL,%s,%s) failed, error %d",
_Symbol,TimeToString(startday),TimeToString(endday),GetLastError());
return;
}
ticks=MathMax(100,ticks);
//--- Showing the first 100 ticks of the last day
int counter=0;
for(int i=0;i<ticks;i++)
{
datetime time=tick_array[i].time;
if((time>=startday) && (time<endday) && counter<100)
{
counter++;
PrintFormat("%d. %s",counter,GetTickDescription(tick_array[i]));
}
}
//--- Showing the first 100 deals of the last day
counter=0;
for(int i=0;i<ticks;i++)
{
datetime time=tick_array[i].time;
if((time>=startday) && (time<endday) && counter<100)
{
if(((tick_array[i].flags&TICK_FLAG_BUY)==TICK_FLAG_BUY) || ((tick_array[i].flags&TICK_FLAG
{
counter++;
PrintFormat("%d. %s",counter,GetTickDescription(tick_array[i]));
}
}
}
}
//+------------------------------------------------------------------+
//| Returns the string description of a tick |
//+------------------------------------------------------------------+
string GetTickDescription(MqlTick &tick)
{
string desc=StringFormat("%s.%03d ",
TimeToString(tick.time),tick.time_msc%1000);
//--- Checking flags
bool buy_tick=((tick.flags&TICK_FLAG_BUY)==TICK_FLAG_BUY);
bool sell_tick=((tick.flags&TICK_FLAG_SELL)==TICK_FLAG_SELL);
bool ask_tick=((tick.flags&TICK_FLAG_ASK)==TICK_FLAG_ASK);
bool bid_tick=((tick.flags&TICK_FLAG_BID)==TICK_FLAG_BID);
bool last_tick=((tick.flags&TICK_FLAG_LAST)==TICK_FLAG_LAST);
bool volume_tick=((tick.flags&TICK_FLAG_VOLUME)==TICK_FLAG_VOLUME);
//--- Checking trading flags in a tick first
if(buy_tick || sell_tick)
{
//--- Forming an output for the trading tick
desc=desc+(buy_tick?StringFormat("Buy Tick: Last=%G Volume=%d ",tick.last,tick.volume):"");
desc=desc+(sell_tick?StringFormat("Sell Tick: Last=%G Volume=%d ",tick.last,tick.volume):"");
desc=desc+(ask_tick?StringFormat("Ask=%G ",tick.ask):"");
desc=desc+(bid_tick?StringFormat("Bid=%G ",tick.ask):"");
desc=desc+"(Trade tick)";
}
else
{
//--- Form a different output for an info tick
desc=desc+(ask_tick?StringFormat("Ask=%G ",tick.ask):"");
desc=desc+(bid_tick?StringFormat("Bid=%G ",tick.ask):"");
desc=desc+(last_tick?StringFormat("Last=%G ",tick.last):"");
desc=desc+(volume_tick?StringFormat("Volume=%d ",tick.volume):"");
desc=desc+"(Info tick)";
}
//--- Returning tick description
return desc;
}
//+------------------------------------------------------------------+
/* Example of the output
Si-12.16: received 11048387 ticks in 4937 ms
Last tick time = 2016.09.26 18:32:59.775
First tick time = 2015.06.18 09:45:01.000
1. 2016.09.26 09:45.249 Ask=65370 Bid=65370 (Info tick)
2. 2016.09.26 09:47.420 Ask=65370 Bid=65370 (Info tick)
3. 2016.09.26 09:50.893 Ask=65370 Bid=65370 (Info tick)
4. 2016.09.26 09:51.827 Ask=65370 Bid=65370 (Info tick)
5. 2016.09.26 09:53.810 Ask=65370 Bid=65370 (Info tick)
6. 2016.09.26 09:54.491 Ask=65370 Bid=65370 (Info tick)
7. 2016.09.26 09:55.913 Ask=65370 Bid=65370 (Info tick)
8. 2016.09.26 09:59.350 Ask=65370 Bid=65370 (Info tick)
9. 2016.09.26 09:59.678 Bid=65370 (Info tick)
10. 2016.09.26 10:00.000 Sell Tick: Last=65367 Volume=3 (Trade tick)
See also
S ymbolInfoTick , S tructure for Current Prices, OnTick()
CopyTicksRange
The function receives ticks in the M qlTick format within the specified date range to ticks _array.
Indexing goes from the past to the present meaning that a tick with the index 0 is the oldest one in
the array. For tick analysis, check the flags field, which shows what exactly has changed.
int CopyTicksRange(
const string symbol_name, // symbol name
MqlTick& ticks_array[], // tick receiving array
uint flags=COPY_TICKS_ALL, // flag that defines the type of the ticks that are rece
ulong from_msc=0, // date, starting from which ticks are requested
ulong to_msc=0 // date, up to which ticks are requested
);
Parameters
symbol_name
[in] S ymbol.
ticks_array
[out] M qlTick static or dynamic array for receiving tick s. If the static array cannot hold all the
ticks from the requested time interval, the maximum possible amount of ticks is received. In this
case, the function generates the error ERR_HIS TORY_S M ALL_BUFFER (4407) .
flags
[in] A flag to define the type of the requested ticks. COPY_TICKS_INFO – ticks with Bid and/or As k
changes, COPY_TICKS_TRADE – ticks with changes in Last and Volume, COPY_TICKS_ALL – all ticks.
For any type of request, the values of the previous tick are added to the remaining fields of the
M qlTick structure.
from_msc
[in] The date, from which you want to request ticks. In milliseconds since 1970.01.01. If the
from_msc parameter is not specified, ticks from the beginning of the history are sent. Ticks with
the time >= from_msc are sent.
to_msc
[in] The date, up to which you want to request ticks. In milliseconds since 01.01.1970. Ticks with
the time <= to_msc are sent. If the to_msc parameter is not specified, all ticks up to the end of
the history are sent.
Return Value
The number of copied tick or -1 in case of an error. GetLastError() is able to return the following
errors :
· ERR_H I S TORY_TIM EOUT – tick s synchronization waiting time is up, the function has sent all it
had.
· ERR_H I S TORY_S M ALL _BUFFER – static buffer is too small. Only the amount the array can store has
been sent.
· ERR_NOT _ENOUGH_M EMORY – insufficient memory for receiving a history from the specified
range to the dynamic tick array. Failed to allocate enough memory for the tick array.
Note
The CopyTicks Range() function is used for requesting ticks strictly from a specified range, for
example, from a certain day in history. At the same time, CopyTicks() allows specifying only a start
date, for example – receive all ticks from the beginning of the month till the current moment.
See also
S ymbolInfoTick , S tructure for Current Prices, OnTick, CopyTicks
iBars
R eturns the number of bars of a corresponding symbol and period, available in history.
int iBars(
const string symbol, // Symbol
ENUM_TIMEFRAMES timeframe // Period
);
Parameters
symbol
[in] The symbol name of the financial instrument. NULL means the current symbol.
timeframe
[in] Period. It can be one of the values of the ENUM _TIM EFRAM ES enumeration. 0 means the
current chart period.
Return Value
The number of bars of a corresponding symbol and period, available in history, but no more than
allowed by the " Max bars in chart" parameter in platform settings.
Example:
See also
Bars
iBarShift
S earch bar by time. The function returns the index of the bar corresponding to the specified time.
int iBarShift(
const string symbol, // Symbol
ENUM_TIMEFRAMES timeframe, // Period
datetime time, // Time
bool exact=false // Mode
);
Parameters
symbol
[in] The symbol name of the financial instrument. NULL means the current symbol.
timeframe
[in]Period. It can be one of the values of the ENUM _TIM EFRAM ES enumeration. PERIOD_CURRENT
means the current chart period.
time
[in] Time value to search for.
exact=false
[in] A return value, in case the bar with the specified time is not found. If exact=false, iBarShift
returns the index of the nearest bar, the Open time of which is less than the specified time
(time_open<time). If such a bar is not found (history before the specified time is not available),
then the function returns -1. If exact=true, iBarS hift does not search for a nearest bar but
immediately returns -1.
Return Value
The index of the bar corresponding to the specified time. If the bar corresponding to the specified
time is not found (there is a gap in the history), the function returns -1 or the index of the nearest
bar (depending on the 'exact' parameter).
Example:
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- The date is on Sunday
datetime time=D'2002.04.25 12:00';
string symbol="GBPUSD";
ENUM_TIMEFRAMES tf=PERIOD_H1;
bool exact=false;
//--- If there is no bar at the specified time, iBarShift will return the index of the nearest bar
int bar_index=iBarShift(symbol,tf,time,exact);
//--- Check the error code after the call of iBarShift()
int error=GetLastError();
if(error!=0)
{
PrintFormat("iBarShift(): GetLastError=%d - The requested date %s "+
"for %s %s is not found in the available history",
error,TimeToString(time),symbol,EnumToString(tf));
return;
}
//--- The iBarShift() function was executed successfully, return a result for exact=false
PrintFormat("1. %s %s %s(%s): bar index is %d (exact=%s)",
symbol,EnumToString(tf),TimeToString(time),
DayOfWeek(time),bar_index,string(exact));
datetime bar_time=iTime(symbol,tf,bar_index);
PrintFormat("Time of bar #%d is %s (%s)",
bar_index,TimeToString(bar_time),DayOfWeek(bar_time));
//--- Request the index of the bar with the specified time; if there is no bar -1 will be returned
exact=true;
bar_index=iBarShift(symbol,tf,time,exact);
//--- The iBarShift() function was executed successfully, return a result for exact=true
PrintFormat("2. %s %s %s (%s):bar index is %d (exact=%s)",
symbol,EnumToString(tf),TimeToString(time)
,DayOfWeek(time),bar_index,string(exact));
}
//+------------------------------------------------------------------+
//| Returns the name of the day of the week |
//+------------------------------------------------------------------+
string DayOfWeek(const datetime time)
{
MqlDateTime dt;
string day="";
TimeToStruct(time,dt);
switch(dt.day_of_week)
{
case 0: day=EnumToString(SUNDAY);
break;
case 1: day=EnumToString(MONDAY);
break;
case 2: day=EnumToString(TUESDAY);
break;
case 3: day=EnumToString(WEDNESDAY);
break;
case 4: day=EnumToString(THURSDAY);
break;
case 5: day=EnumToString(FRIDAY);
break;
default:day=EnumToString(SATURDAY);
break;
}
//---
return day;
}
//+------------------------------------------------------------------+
/* Execution result
1. GBPUSD PERIOD_H1 2018.06.10 12:00(SUNDAY): bar index is 64 (exact=false)
Time of bar #64 is 2018.06.08 23:00 (FRIDAY)
2. GBPUSD PERIOD_H1 2018.06.10 12:00 (SUNDAY):bar index is -1 (exact=true)
*/
iClose
R eturns the Close price of the bar (indicated by the 'shift' parameter) on the corresponding chart.
double iClose(
const string symbol, // Symbol
ENUM_TIMEFRAMES timeframe, // Period
int shift // Shift
);
Parameters
symbol
[in] The symbol name of the financial instrument. NULL means the current symbol.
timeframe
[in] Period. It can be one of the values of the ENUM _TIM EFRAM ES enumeration. 0 means the
current chart period.
shift
[in] The index of the received value from the timeseries (backward shift by specified number of
bars relative to the current bar).
Return Value
The Close price of the bar (indicated by the 'shift' parameter) on the corresponding chart or 0 in case
of an error. For error details, call the GetLastError() function.
Note
The function always returns actual data. For this purpose it performs a request to the timeseries for
the specified symbol/period during each call. This means that if there is no ready data during the
first function call, some time may be taken to prepare the result.
The function does not store previous calls results, and there is no local cache for quick value return.
Example:
Comment(Symbol(),",",EnumToString(Period()),"\n",
See also
CopyClose, CopyRates
iHigh
R eturns the High price of the bar (indicated by the 'shift' parameter) on the corresponding chart.
double iHigh(
const string symbol, // Symbol
ENUM_TIMEFRAMES timeframe, // Period
int shift // Shift
);
Parameters
symbol
[in] The symbol name of the financial instrument. NULL means the current symbol.
timeframe
[in] Period. It can be one of the values of the ENUM _TIM EFRAM ES enumeration. 0 means the
current chart period.
shift
[in] The index of the received value from the timeseries (backward shift by specified number of
bars relative to the current bar).
Return Value
The High price of the bar (indicated by the 'shift' parameter) on the corresponding chart or 0 in case
of an error. For error details, call the GetLastError() function.
Note
The function always returns actual data. For this purpose it performs a request to the timeseries for
the specified symbol/period during each call. This means that if there is no ready data during the
first function call, some time may be taken to prepare the result.
The function does not store previous calls results, and there is no local cache for quick value return.
Example:
Comment(Symbol(),",",EnumToString(Period()),"\n",
See also
CopyHigh, CopyRates
iHighest
R eturns the index of the highest value found on the corresponding chart (shift relative to the current
bar).
int iHighest(
const string symbol, // Symbol
ENUM_TIMEFRAMES timeframe, // Period
ENUM_SERIESMODE type, // Timeseries identifier
int count=WHOLE_ARRAY, // Number of elements
int start=0 // Index
);
Parameters
symbol
[in] The symbol, on which the search will be performed. NULL means the current symbol.
timeframe
[in] Period. It can be one of the values of the ENUM _TIM EFRAM ES enumeration. 0 means the
current chart period.
type
[in] The identifier of the timeseries, in which the search will be performed. Can be equal to any
value from ENUM _SERIES MODE.
count=WHOLE_ARRAY
[in] The number of elements in the timeseries (from the current bar towards index increasing
direction), among which the search should be performed.
start=0
[in] The index (shift relative to the current bar) of the initial bar, from which search for the
highest value begins. Negative values are ignored and replaced with a zero value.
Return Value
The index of the highest value found on the corresponding chart (shift relative to the current bar) or
-1 in case of an error. For error details, call the GetLastError() function.
Example:
double val;
//--- Calculation of the highest Close value among 20 consecutive bars
//--- From index 4 to index 23 inclusive, on the current timeframe
int val_index=iHighest(NULL,0,MODE_CLOSE,20,4);
if(val_index!=-1)
val=High[val_index];
else
PrintFormat("iHighest() call error. Error code=%d",GetLastError());
iLow
R eturns the Low price of the bar (indicated by the 'shift' parameter) on the corresponding chart.
double iLow(
const string symbol, // Symbol
ENUM_TIMEFRAMES timeframe, // Period
int shift // Shift
);
Parameters
symbol
[in] The symbol name of the financial instrument. NULL means the current symbol.
timeframe
[in] Period. It can be one of the values of the ENUM _TIM EFRAM ES enumeration. 0 means the
current chart period.
shift
[in] The index of the received value from the timeseries (backward shift by specified number of
bars relative to the current bar).
Return Value
The Low price of the bar (indicated by the 'shift' parameter) on the corresponding chart or 0 in case
of an error. For error details, call the GetLastError() function.
Note
The function always returns actual data. For this purpose it performs a request to the timeseries for
the specified symbol/period during each call. This means that if there is no ready data during the
first function call, some time may be taken to prepare the result.
The function does not store previous calls results, and there is no local cache for quick value return.
Example:
Comment(Symbol(),",",EnumToString(Period()),"\n",
See also
CopyLow, CopyRates
iLowest
R eturns the index of the smallest value found on the corresponding chart (shift relative to the current
bar).
int iLowest(
const string symbol, // Symbol
ENUM_TIMEFRAMES timeframe, // Period
ENUM_SERIESMODE type, // Timeseries identifier
int count=WHOLE_ARRAY, // Number of elements
int start=0 // Index
);
Parameters
symbol
[in] The symbol, on which the search will be performed. NULL means the current symbol.
timeframe
[in] Period. It can be one of the values of the ENUM _TIM EFRAM ES enumeration. 0 means the
current chart period.
type
[in] The identifier of the timeseries, in which the search will be performed. Can be equal to any
value from ENUM _SERIES MODE.
count=WHOLE_ARRAY
[in] The number of elements in the timeseries (from the current bar towards index increasing
direction), among which the search should be performed.
start=0
[in] The index (shift relative to the current bar) of the initial bar, from which search for the
lowest value begins. Negative values are ignored and replaced with a zero value.
Return Value
The index of the lowest value found on the corresponding chart (shift relative to the current bar) or
-1 in case of an error. For error details, call the GetLastError() function.
Example:
double val;
//--- Search for a bar with the lowest value of the real volume among 15 consecutive bars
//--- From index 10 to index 24 inclusive, on the current timeframe
int val_index=iLowest(NULL,0,MODE_REAL_VOLUME,15,10);
if(val_index!=-1)
val=Low[val_index];
else
PrintFormat("iLowest() call error. Error code=%d",GetLastError());
iOpen
R eturns the Open price of the bar (indicated by the 'shift' parameter) on the corresponding chart.
double iOpen(
const string symbol, // Symbol
ENUM_TIMEFRAMES timeframe, // Period
int shift // Shift
);
Parameters
symbol
[in] The symbol name of the financial instrument. NULL means the current symbol.
timeframe
[in] Period. It can be one of the values of the ENUM _TIM EFRAM ES enumeration. 0 means the
current chart period.
shift
[in] The index of the received value from the timeseries (backward shift by specified number of
bars relative to the current bar).
Return Value
The Open price of the bar (indicated by the 'shift' parameter) on the corresponding chart or 0 in case
of an error. For error details, call the GetLastError() function.
Note
The function always returns actual data. For this purpose it performs a request to the timeseries for
the specified symbol/period during each call. This means that if there is no ready data during the
first function call, some time may be taken to prepare the result.
The function does not store previous calls results, and there is no local cache for quick value return.
Example:
Comment(Symbol(),",",EnumToString(Period()),"\n",
See also
CopyOpen, CopyRates
iTime
R eturns the opening time of the bar (indicated by the 'shift' parameter) on the corresponding chart.
datetime iTime(
const string symbol, // Symbol
ENUM_TIMEFRAMES timeframe, // Period
int shift // Shift
);
Parameters
symbol
[in] The symbol name of the financial instrument. NULL means the current symbol.
timeframe
[in] Period. It can be one of the values of the ENUM _TIM EFRAM ES enumeration. 0 means the
current chart period.
shift
[in] The index of the received value from the timeseries (backward shift by specified number of
bars relative to the current bar).
Return Value
The opening time of the bar (indicated by the 'shift' parameter) on the corresponding chart or 0 in
case of an error. For error details, call the GetLastError() function.
Note
The function always returns actual data. For this purpose it performs a request to the timeseries for
the specified symbol/period during each call. This means that if there is no ready data during the
first function call, some time may be taken to prepare the result.
The function does not store previous calls results, and there is no local cache for quick value return.
Example:
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- The date is on Sunday
datetime time=D'2018.06.10 12:00';
string symbol="GBPUSD";
ENUM_TIMEFRAMES tf=PERIOD_H1;
bool exact=false;
//--- there is no bar at the specified time, iBarShift will return the index of the nearest bar
int bar_index=iBarShift(symbol,tf,time,exact);
PrintFormat("1. %s %s %s(%s): bar index is %d (exact=%s)",
symbol,EnumToString(tf),TimeToString(time),DayOfWeek(time),bar_index,string(exact));
datetime bar_time=iTime(symbol,tf,bar_index);
See also
CopyTime, CopyRates
iTickVolume
R eturns the tick volume of the bar (indicated by the 'shift' parameter) on the corresponding chart.
long iTickVolume(
const string symbol, // Symbol
ENUM_TIMEFRAMES timeframe, // Period
int shift // Shift
);
Parameters
symbol
[in] The symbol name of the financial instrument. NULL means the current symbol.
timeframe
[in] Period. It can be one of the values of the ENUM _TIM EFRAM ES enumeration. 0 means the
current chart period.
shift
[in] The index of the received value from the timeseries (backward shift by specified number of
bars relative to the current bar).
Return Value
The tick volume of the bar (indicated by the 'shift' parameter) on the corresponding chart or 0 in
case of an error. For error details, call the GetLastError() function.
Note
The function always returns actual data. For this purpose it performs a request to the timeseries for
the specified symbol/period during each call. This means that if there is no ready data during the
first function call, some time may be taken to prepare the result.
The function does not store previous calls results, and there is no local cache for quick value return.
Example:
Comment(Symbol(),",",EnumToString(Period()),"\n",
See also
CopyTickVolume, CopyRates
iRealVolume
R eturns the real volume of the bar (indicated by the 'shift' parameter) on the corresponding chart.
long iRealVolume(
const string symbol, // Symbol
ENUM_TIMEFRAMES timeframe, // Period
int shift // Shift
);
Parameters
symbol
[in] The symbol name of the financial instrument. NULL means the current symbol.
timeframe
[in] Period. It can be one of the values of the ENUM _TIM EFRAM ES enumeration. 0 means the
current chart period.
shift
[in] The index of the received value from the timeseries (backward shift by specified number of
bars relative to the current bar).
Return Value
The real volume of the bar (indicated by the 'shift' parameter) on the corresponding chart or 0 in
case of an error. For error details, call the GetLastError() function.
Note
The function always returns actual data. For this purpose it performs a request to the timeseries for
the specified symbol/period during each call. This means that if there is no ready data during the
first function call, some time may be taken to prepare the result.
The function does not store previous calls results, and there is no local cache for quick value return.
Example:
Comment(Symbol(),",",EnumToString(Period()),"\n",
See also
CopyRealVolume, CopyRates
iVolume
R eturns the tick volume of the bar (indicated by the 'shift' parameter) on the corresponding chart.
long iVolume(
const string symbol, // Symbol
ENUM_TIMEFRAMES timeframe, // Period
int shift // Shift
);
Parameters
symbol
[in] The symbol name of the financial instrument. NULL means the current symbol.
timeframe
[in] Period. It can be one of the values of the ENUM _TIM EFRAM ES enumeration. 0 means the
current chart period.
shift
[in] The index of the received value from the timeseries (backward shift by specified number of
bars relative to the current bar).
Return Value
The tick volume of the bar (indicated by the 'shift' parameter) on the corresponding chart or 0 in
case of an error. For error details, call the GetLastError() function.
Note
The function always returns actual data. For this purpose it performs a request to the timeseries for
the specified symbol/period during each call. This means that if there is no ready data during the
first function call, some time may be taken to prepare the result.
The function does not store previous calls results, and there is no local cache for quick value return.
Example:
Comment(Symbol(),",",EnumToString(Period()),"\n",
See also
CopyTickVolume, CopyRates
iSpread
R eturns the spread value of the bar (indicated by the 'shift' parameter) on the corresponding chart.
long iSpread(
const string symbol, // Symbol
ENUM_TIMEFRAMES timeframe, // Period
int shift // Shift
);
Parameters
symbol
[in] The symbol name of the financial instrument. NULL means the current symbol.
timeframe
[in] Period. It can be one of the values of the ENUM _TIM EFRAM ES enumeration. 0 means the
current chart period.
shift
[in] The index of the received value from the timeseries (backward shift by specified number of
bars relative to the current bar).
Return Value
The S pread value of the bar (indicated by the 'shift' parameter) on the corresponding chart or 0 in
case of an error. For error details, call the GetLastError() function.
Note
The function always returns actual data. For this purpose it performs a request to the timeseries for
the specified symbol/period during each call. This means that if there is no ready data during the
first function call, some time may be taken to prepare the result.
The function does not store previous calls results, and there is no local cache for quick value return.
Example:
Comment(Symbol(),",",EnumToString(Period()),"\n",
See also
CopyS pread, CopyRates
Custom symbols
Functions for creating and editing the custom symbol properties.
W hen connecting the terminal to a certain trade server, a user is able to work with time series of the
financial symbols provided by a broker. Available financial symbols are displayed as a list in the Market
W atch window. A separate group of functions allows receiving data on the symbol properties, trading
sessions and market depth updates.
The group of functions described in this section allows creating custom symbols. To do this, users are
able to apply the trade server's existing symbols, text files or external data sources.
Function Action
CustomS ymbolCreate Create a custom symbol with the specified name in the
specified group
CustomS ymbolDelete Delete a custom symbol with the specified name
CustomS ymbolS etInteger S et the integer type property value for a custom symbol
CustomS ymbolS etDouble S et the real type property value for a custom symbol
CustomS ymbolS etS tring S et the string type property value for a custom symbol
CustomS ymbolS etMarginRate S et the margin rates depending on the order type and direction
for a custom symbol
CustomS ymbolS etS essionQuote S et the start and end time of the specified quotation session
for the specified symbol and week day
CustomS ymbolS etS essionTrade S et the start and
end time of the specified trading session for
the specified symbol and week day
CustomRates Delete Delete all bars from the price history of the custom symbol in
the specified time interval
CustomRates Replace Fully replacethe price history of the custom symbol within the
specified time interval with the data from the M qlRates type
array
CustomRates Update Add missing bars to the custom symbol history and replace
existing data with the ones from the M qlRates type array
CustomTicks Add Adds data from an array of the M qlTick type to the price
history of a custom symbol. The custom symbol must be
selected in the Market W atch window
CustomTicks Delete Delete all ticks from the price history of the custom symbol in
the specified time interval
CustomTicks Replace Fully replacethe price history of the custom symbol within the
specified time interval with the data from the M qlTick type
array
CustomBookAdd Passes the status of the Depth of Market for a custom symbol
CustomSymbolCreate
Creates a custom symbol with the specified name in the specified group.
bool CustomSymbolCreate(
const string symbol_name, // custom symbol name
const string symbol_path="", // name of a group a symbol is to be created in
const string symbol_origin=NULL // name of a symbol used as a basis to create a custom sym
);
Parameters
symbol_name
[in] Custom symbol name. It should not contain groups or subgroups the symbol is located in.
symbol_path=""
[in] The group name a symbol is located in.
symbol_origin=NULL
[in] Name of a symbol the properties of a created custom symbol are to be copied from. After
creating a custom symbol, any property value can be changed to a necessary one using the
appropriate functions.
Return Value
true – success, otherwise – false. To get information about the error, call the GetLastError()
function.
Note
All customsymbols are created in the special Custom section. If a group name is not specified (the
symbol_path parameter in the CustomS ymbolCreate function contains an empty string or NULL), a
custom symbol is generated in the Custom section root. Here we can draw an analogy with the file
system, where groups and subgroups can be viewed as folders and subfolders
The symbol and group names may only contain Latin letters without punctuation, spaces or special
characters (may only contain " ." , "_" , "&" and "#" ). It is not recommended to use characters <, >, :,
" , /, |, ?, *.
The custom symbol name should be unique regardless of a group name it is created in. If a symbol
with the same name already exists, the CustomS ymbolCreate() function returns 'false', while the
subsequent GetLastError() call returns the error 5300 (ERR_NOT_CUS TOM _SYM BOL) or 5304
(ERR_CUS TOM _SYM BOL_EXIS T).
The length of the symbol name should not exceed 31 characters. Otherwise, CustomS ymbolCreate()
returns 'false' and the error 5302 – ERR_CUS TOM _SYM BOL_NAM E_LONG is activated.
The symbol_path parameter can be set in two ways :
· only a group name without a name of the custom symbol, for example – " CFD\\ Metals " . It is best
to use this option to avoid errors.
· or <group> name + groups separator "\\" +<custom symbol name>, for example – " CFD\\ Metals \
\Platinum" . In this case, the group name should end with the exact name of the custom symbol. In
case of a mismatch, the custom symbol is still created, but not in the intended group. For
example, if symbol_path=" CFD\\Metals \\Platinum" and symbol_name=" platinum" (register error),
then a custom symbol named " platinum" is created in the " Custom\CFD\Metals \Platinum" group.
The S ymbolInfoGetS tring(" platinum" ,SYM BOL _PAT H ) function returns the
" Custom\CFD\Metals \Platinum\platinum" value.
Note that the SYM BOL _PAT H property returns the path with the symbol name at the end. Therefore,
it cannot be copied without changes if you want to create a custom symbol in the exact same group.
In this case, it is necessary to cut the symbol name in order not to get the result described above.
If a non-existent symbol is set as the symbol_origin parameter, then the custom symbol is created
empty as if the symbol_origin parameter is not set. The error 4301 –
ERR_M ARKET _UNKNOWN_SYM BOL is activated in that case.
The symbol_path parameter length should not exceed 127 characters considering " Custom\\" , "\\"
groups separators and the symbol name if it is specified at the end.
See also
S ymbolName, S ymbolS elect, CustomS ymbolDelete
CustomSymbolDelete
Deletes a custom symbol with the specified name.
bool CustomSymbolDelete(
const string symbol_name // custom symbol name
);
Parameters
symbol
[in] Custom symbol name. It should not match the name of an already existing symbol.
Return Value
true – success, otherwise – false. To get information about the error, call the GetLastError()
function.
Note
The custom symbol displayed in the Market W atch or the one a chart is opened for cannot be
deleted.
See also
S ymbolName, S ymbolS elect, CustomS ymbolCreate
CustomSymbolSetInteger
S ets the integer type property value for a custom symbol.
bool CustomSymbolSetInteger(
const string symbol_name, // symbol name
ENUM_SYMBOL_INFO_INTEGER property_id, // property ID
long property_value // property value
);
Parameters
symbol_name
[in] Custom symbol name.
property_id
[in] S ymbol property ID. The value can be one of the values of the ENUM _SYM BOL_INFO_INTEGER
enumeration.
property_value
[in] A long type variable containing the property value.
Return Value
true – success, otherwise – false. To get information about the error, call the GetLastError()
function.
Note
The minute and tick history of the custom symbol is completely removed if any of these properties is
changed in the symbol specification:
· SYM BOL _CHAR T _MODE – price type for constructing bars (Bid or Last)
· SYM BOL _DI GIT S – number of digits after the decimal point to display the price
Afterdeleting the custom symbol history, the terminal attempts to create a new history using the
updated properties. The same happens when the custom symbol properties are changed manually.
See also
S ymbolInfoInteger
CustomSymbolSetDouble
S ets the real type property value for a custom symbol.
bool CustomSymbolSetDouble(
const string symbol_name, // symbol name
ENUM_SYMBOL_INFO_DOUBLE property_id, // property ID
double property_value // property value
);
Parameters
symbol_name
[in] Custom symbol name.
property_id
[in] S ymbol
property ID. The value can be one of the values of the ENUM _SYM BOL_INFO_DOUBLE
enumeration.
property_value
[in] A double type variable containing the property value.
Return Value
true – success, otherwise – false. To get information about the error, call the GetLastError()
function.
Note
The minute and tick history of the custom symbol is completely removed if any of these properties is
changed in the symbol specification:
· SYM BOL _POI NT – one point value
· SYM BOL _T RADE_TICK_S I ZE – value of a tick that specifies the minimum allowable price change
· SYM BOL _T RADE_TICK_VAL UE – one-tick price change value for a profitable position
Afterdeleting the custom symbol history, the terminal attempts to create a new history using the
updated properties. The same happens when the custom symbol properties are changed manually.
See also
S ymbolInfoDouble
CustomSymbolSetString
S ets the string type property value for a custom symbol.
bool CustomSymbolSetString(
const string symbol_name, // symbol name
ENUM_SYMBOL_INFO_STRING property_id, // property ID
string property_value // property value
);
Parameters
symbol_name
[in] Custom symbol name.
property_id
[in] S ymbolproperty ID. The value can be one of the values of the ENUM _SYM BOL_INFO_S TRING
enumeration.
property_value
[in] A string type variable containing the property value.
Return Value
true – success, otherwise – false. To get information about the error, call the GetLastError()
function.
Note
The minute and tick history of the custom symbol is completely removed if the SYM BOL_FORM ULA
property (setting the equation for the custom symbol price construction) is changed in the symbol
specification. After deleting the custom symbol history, the terminal attempts to create a new
history using the new equation. The same happens when the custom symbol equation is changed
manually.
See also
S ymbolInfoS tring
CustomSymbolSetMarginRate
S ets the margin rates depending on the order type and direction for a custom symbol.
bool CustomSymbolSetMarginRate(
const string symbol_name, // symbol name
ENUM_ORDER_TYPE order_type, // order type
double initial_margin_rate, // initial margin rate
double maintenance_margin_rate // maintenance margin rate
);
Parameters
symbol_name
[in] Custom symbol name.
order_type
[in] Order type.
initial_margin_rate
[in] A double type variable with an initial margin rate. Initial margin is a security deposit for 1 lot
deal in the appropriate direction. Multiplying the rate by the initial margin, we receive the amount
of funds to be reserved on the account when placing an order of the specified type.
maintenance_margin_rate
[in] A double type variable with a maintenance margin rate. Maintenance margin is a minimum
amount for maintaining an open position of 1 lot in the appropriate direction. Multiplying the rate
by the maintenance margin, we receive the amount of funds to be reserved on the account after
an order of the specified type is activated.
Return Value
true – success, otherwise – false. To get information about the error, call the GetLastError()
function.
See also
S ymbolInfoMarginR ate
CustomSymbolSetSessionQuote
S ets the start and end time of the specified quotation session for the specified symbol and week day.
bool CustomSymbolSetSessionQuote(
const string symbol_name, // symbol name
ENUM_DAY_OF_WEEK day_of_week, // week day
uint session_index, // session index
datetime from, // session start time
datetime to // session end time
);
Parameters
symbol_name
[in] Custom symbol name.
ENUM_DAY_OF_WEEK
[in] W eek day, value from the ENUM _DAY_OF_WEEK enumeration.
uint
[in] Index of the session, for which start and end times are to be set. S ession indexing starts
from 0.
from
[in] S ession start time in seconds from 00:00, data value in the variable is ignored.
to
[in] S ession end time in seconds from 00:00, data value in the variable is ignored.
Return Value
true – success, otherwise – false. To get information about the error, call the GetLastError()
function.
Note
If the session with the specified session_index already exists, the function simply edits the
beginning and end of the session.
If zero start and end parameters have been passed for the session (from=0 and to=0), the
appropriate session with the session_index is deleted, while the session indexing is shifted
downwards.
S essions can be added only sequentially. In other words, you can add session_index=1 only if the
session with the index 0 already exists. If this rule is broken, a new session is not created, while the
function itself returns 'false'.
See also
S ymbolInfoS essionQuote, S ymbol info, TimeToS truct, Date structure
CustomSymbolSetSessionTrade
S ets the start and end time of the specified trading session for the specified symbol and week day.
bool CustomSymbolSetSessionTrade(
const string symbol_name, // symbol name
ENUM_DAY_OF_WEEK day_of_week, // week day
uint session_index, // session index
datetime from, // session start time
datetime to // session end time
);
Parameters
symbol_name
[in] Custom symbol name.
ENUM_DAY_OF_WEEK
[in] W eek day, value from the ENUM _DAY_OF_WEEK enumeration.
uint
[in] Index of the session, for which start and end times are to be set. S ession indexing starts
from 0.
from
[in] S ession start time in seconds from 00:00, data value in the variable is ignored.
to
[in] S ession end time in seconds from 00:00, data value in the variable is ignored.
Return Value
true – success, otherwise – false. To get information about the error, call the GetLastError()
function.
Note
If the session with the specified session_index already exists, the function simply edits the
beginning and end of the session.
If zero start and end parameters have been passed for the session (from=0 and to=0), the
appropriate session with the session_index is deleted, while the session indexing is shifted
downwards.
S essions can be added only sequentially. In other words, you can add session_index=1 only if the
session with the index 0 already exists. If this rule is broken, a new session is not created, while the
function itself returns 'false'.
See also
S ymbolInfoS essionTrade, S ymbol info, TimeToS truct, Date structure
CustomRatesDelete
Deletes all bars from the price history of the custom symbol in the specified time interval.
int CustomRatesDelete(
const string symbol, // symbol name
datetime from, // start date
datetime to // end date
);
Parameters
symbol
[in] Custom symbol name.
from
[in] Time of the first bar in the price history within the specified range to be removed.
to
[in] Time of the last bar in the price history within the specified range to be removed.
Return Value
See also
CustomRates Replace, CustomRates Update, CopyRates
CustomRatesReplace
Fullyreplaces the price history of the custom symbol within the specified time interval with the data
from the M qlRates type array.
int CustomRatesReplace(
const string symbol, // symbol name
datetime from, // start date
datetime to, // end date
const MqlRates& rates[], // array for the data to be applied to a custom symbol
uint count=WHOLE_ARRAY // number of the rates[] array elements to be used
);
Parameters
symbol
[in] Custom symbol name.
from
[in] Time of the first bar in the price history within the specified range to be updated.
to
[in] Time of the last bar in the price history within the specified range to be updated.
rates[]
[in] Array of the M qlRates type history data for M 1.
count=WHOLE_ARRAY
[in] Number of the rates[] array elements to be used for replacement. WHOLE_ARRAY means that
all rates[] array elements should be used for replacement.
Return Value
If the bar from the rates[] array goes beyond the specified range, it is ignored. If such a bar is
already present in the price history and enters the given range, it is replaced. All other bars in the
current price history outside the specified range remain unchanged. The rates[] array data should be
correct regarding OHLC prices, while the bars opening time should correspond to the M 1 timeframe.
See also
CustomRates Delete, CustomRates Update, CopyRates
CustomRatesUpdate
Adds missing bars to the custom symbol history and replaces existing data with the ones from the
M qlRates type array.
int CustomRatesUpdate(
const string symbol, // custom symbol name
const MqlRates& rates[], // array for the data to be applied to a custom symbol
uint count=WHOLE_ARRAY // number of the rates[] array elements to be used
);
Parameters
symbol
[in] Custom symbol name.
rates[]
[in] Array of the M qlRates type history data for M 1.
count=WHOLE_ARRAY
[in] Number of the rates[] array elements to be used for update. WH OL E_ARRAY means that all
rates[] array elements should be used.
Return Value
If there is no bar from the rates[] array in the current custom symbol history, it is added. If such a
bar already exists, it is replaced. All other bars in the current price history remain unchanged. The
rates[] array data should be correct regarding O H LC prices, while the bars opening time should
See also
CustomRates Replace, CustomRates Delete, CopyRates
CustomTicksAdd
Adds data from an array of the M qlTick type to the price history of a custom symbol. The custom
symbol must be selected in the Market W atch window.
int CustomTicksAdd(
const string symbol, // Symbol name
const MqlTick& ticks[], // The array with tick data that should be applied to the c
uint count=WHOLE_ARRAY // number of the ticks[] array elements to be used
);
Parameters
symbol
[in] The name of the custom symbol.
ticks[]
[in] An array of tick data of the M qlTick type arranged in order of time from earlier data to more
recent ones, i.e. ticks [k].time_msc <= ticks [n].time_msc, if k<n.
count=WHOLE_ARRAY
[in] Number of the ticks[] array elements to be used for adding. WH OL E_ARRAY means that all
ticks[] array elements should be used.
Return Value
The CustomTicks Add function only works for custom symbols opened in the Market W atch window. If
the symbol is not selected in Market W atch, then you should add ticks using CustomTicks Replace.
The CustomTicks Add function allows transmitting ticks as if they are delivered from the broker's
server. Data are sent to the Market W atch window instead of being written directly to the tick
database. The terminal then saves ticks from the Market W atch to a database. If the amount of
data transmitted during one function call is large, the behavior of the function changes in order to
reduce resource usage. If more than 256 ticks are passed, data is divided into two parts. The first,
i.e. the larger part is written directly to the tick database (as it is done in CustomTicks Replace).
The second part containing 128 ticks is passed to the Market W atch window, from which the
terminal saves the ticks to a database.
The M qlTick structure has two fields with the time value: time (the tick time in seconds) and
time_msc (the tick time in milliseconds), which are counted from January 1, 1970. These fields in
the added ticks are processed in the following order:
1. If ticks [k].time_msc!=0, we use it to fill the ticks [k].time field, i.e.
ticks [k].time=ticks [k].time_msc/1000 (integer division) is set for the tick
2. If tick s [k].time_msc==0 and tick s [k].time!=0, time in milliseconds is obtained by multiplying by
1000, i.e. tick s [k].time_msc=tick s [k].time*1000
3. If tick s [k].time_msc==0 and tick s [k].time==0, the current trade server time up to a millisecond
as of the moment of CustomTicks Add call is written to these fields.
If the value of ticks [k].bid, ticks [k].as k, ticks [k].last or ticks [k].volume is greater than zero, a
combination of appropriate flags is written to the ticks [k].flags field:
· TICK_FL AG_BI D – the tick has changed the bid price
· TICK_FL AG_ASK – the tick has changed the as k price
· TICK_FL AG_L AS T – the tick has changed the last deal price
· TICK_FL AG_VOL UM E – the tick has changed the volume
If the value of a field is less than or equal to zero, the corresponding flag is not written to the
ticks [k].flags field.
Flags TICK_FLAG_BUY and TICK_FLAG_SELL are not added to the history of a custom symbol.
See also
CustomRates Delete, CustomRates Update, CustomTicks Replace, CopyTicks, CopyTicks Range
CustomTicksDelete
Deletes all ticks from the price history of the custom symbol in the specified time interval.
int CustomTicksDelete(
const string symbol, // symbol name
long from_msc, // start date
long to_msc // end date
);
Parameters
symbol
[in] Custom symbol name.
from_msc
[in] Time of the first tick in the price history within the specified range to be removed. Time in
milliseconds since 01.01.1970.
to_msc
[in] Time of the last tick in the price history within the specified range to be removed. Time in
milliseconds since 01.01.1970.
Return Value
See also
CustomRates Delete, CustomRates Update, CustomTicks Replace, CopyTicks, CopyTicks Range
CustomTicksReplace
Fullyreplaces the price history of the custom symbol within the specified time interval with the data
from the M qlTick type array.
int CustomTicksReplace(
const string symbol, // symbol name
long from_msc, // start date
long to_msc, // end date
const MqlTick& ticks[], // array for the data to be applied to a custom symbol
uint count=WHOLE_ARRAY // number of the ticks[] array elements to be used
);
Parameters
symbol
[in] Custom symbol name.
from_msc
[in] Time of the first tick in the price history within the specified range to be removed. Time in
milliseconds since 01.01.1970.
to_msc
[in] Time of the last tick in the price history within the specified range to be removed. Time in
milliseconds since 01.01.1970.
ticks[]
[in] Array of the M qlTick type tick data ordered in time in ascending order.
count=WHOLE_ARRAY
[in] Number of the ticks[] array elements to be used for replacement in the specified time
interval. WHOLE_ARRAY means that all ticks[] array elements should be used.
Return Value
S inceseveral ticks may often have the same time up to a millisecond in a stream of quotes
(accurate tick time is stored in the time_msc field of the M qlTick structure), the
CustomTicks Replace function does not automatically sort out the ticks[] array elements by time.
Therefore, the array of ticks must be pre-arranged in time ascending order.
The ticks are replaced consecutively, day after day, until the time specified in to_msc or until an
error occurs. The first day from the specified range is processed followed by the next one, etc. As
soon as the mismatch between the tick time and the ascending (non-descending) order is detected,
the tick replacement stops on the current day. All ticks from the previous days are successfully
replaced, while the current day (at the moment of a wrong tick) and all the remaining days in the
specified interval remain unchanged.
If the ticks[] array contains no tick data for any day (generally, any time interval), a " hole"
corresponding to the missing data appears in the custom symbol history after the tick data from
ticks[] are applied. In other words, the call of CustomTicks Replace with missing ticks is
equivalent to deleting part of the tick history, as if CustomTicks Delete with the " hole" interval is
called.
If the tick database has no data for the specified time interval, CustomTicks Replace will add to the
database ticks form the ticks [] array.
The CustomTicks Replace function works directly with the tick database.
See also
CustomRates Delete, CustomRates Update, CustomTicks Delete, CopyTicks, CopyTicks Range
CustomBookAdd
Passes the status of the Depth of Market for a custom symbol. The function allows broadcasting the
Depth of Mark et as if the prices arrive from a brok er's server.
bool CustomBookAdd(
const string symbol, // symbol name
const MqlBookInfo& books[] // array with descriptions of the Depth of Market element
uint count=WHOLE_ARRAY // number of elements to be used
);
Parameters
symbol
[in] Custom symbol name.
books[]
[in] The array of M qlBookInfo type data fully describing the Depth of Market status — all buy and
sell requests. The passed Depth of Market status completely replaces the previous one.
count=WHOLE_ARRAY
[in] The number of 'books ' array elements to be passed to the function. The entire array is used
by default.
Return Value
true – success, otherwise – false. To get information about the error, call the GetLastError()
function.
Note
The CustomBookAdd function works only for custom symbols the Depth of Market is opened for — via
the platform interface or the MarketBookAdd function.
W hen throwing the Depth of Market in, the symbol's Bid and As k prices are not updated. You should
control the change of the best prices and throw in the ticks using CustomTicks Add.
The function verifies the accuracy of transmitted data: the type, price and volume must be
indicated for each element. Furthermore, M qlBookInfo.volume and M qlBookInfo.volume_real must
not be zero or negative; if both volumes are negative, this will be considered an error. You can
specify any of the volumes or both of them: the one that is indicated or is positive will be used:
volume=-1 && volume_real=2 — volume_real=2 will be used,
a volume=3 && volume_real=0 — volume=3 will be used.
The M qlBookInfo.volume_real extended accuracy volume has a higher priority over the regular
M qlBookInfo.volume. If both values are specified for the Depth of Market element, the volume_real
one is used.
The order of the M qlBookInfo elements in the 'books ' array does not matter. W hen saving the data,
the terminal sorts them by price on its own.
W hen saving data, the "Book depth" (SYM BOL_TICKS_BOOKDEPTH) parameter of the recipient
custom symbol is checked. If the number of sell requests exceeds this value in the passed Depth of
Market, the excess levels are discarded. The same is true for buy requests.
S ample filling of the 'books ' array:
books[0].type=BOOK_TYPE_SELL;
books[0].price=1.14337;
books[0].volume=100;
books[1].type=BOOK_TYPE_SELL;
books[1].price=1.14330;
books[1].volume=50;
books[2].type=BOOK_TYPE_SELL;
books[2].price=1.14335;
books[2].volume=40;
books[3].type=BOOK_TYPE_SELL;
books[3].price=1.14333;
books[3].volume=10;
books[4].type=BOOK_TYPE_BUY;
books[4].price=1.14322;
books[4].volume=10;
books[5].type=BOOK_TYPE_BUY;
books[5].price=1.14320;
books[5].volume=90;
books[6].type=BOOK_TYPE_BUY;
books[6].price=1.14319;
books[6].volume=100;
books[7].type=BOOK_TYPE_BUY;
books[7].price=1.14318;
books[7].volume=10;
Example:
//+------------------------------------------------------------------+
//| Expert initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- enable the Depth of Market for a symbol we are to retrieve data from
MarketBookAdd(Symbol());
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Expert deinitialization function |
//+------------------------------------------------------------------+
void OnDeinit(const int reason)
{
}
//+------------------------------------------------------------------+
//| Tick function |
//+------------------------------------------------------------------+
void OnTick(void)
{
MqlTick ticks[];
ArrayResize(ticks,1);
//--- copy the current prices from the common symbol to the custom one
if(SymbolInfoTick(Symbol(),ticks[0]))
{
string symbol_name=Symbol()+".SYN";
CustomTicksAdd(symbol_name,ticks);
}
}
//+------------------------------------------------------------------+
//| Book function |
//+------------------------------------------------------------------+
void OnBookEvent(const string &book_symbol)
{
//--- copy the current Depth of Market status from the common symbol to the custom one
if(book_symbol==Symbol())
{
MqlBookInfo book_array[];
if(MarketBookGet(Symbol(),book_array))
{
string symbol_name=Symbol()+".SYN";
CustomBookAdd(symbol_name,book_array);
}
}
}
//+------------------------------------------------------------------+
See also
MarketBookAdd, CustomTicks Add, OnBookEvent
Chart Operations
Functions for setting chart properties (ChartS etInteger, ChartS etDouble, ChartS etS tring) are
asynchronous and are used for sending update commands to a chart. If these functions are executed
successfully, the command is included in the common queue of the chart events. Chart property
changes are implemented along with handling of the events queue of this chart.
Thus, do not expect an immediate update of the chart after calling asynchronous functions. Use the
ChartRedraw() function to forcedly update the chart appearance and properties.
Function Action
Function Action
ChartIndicatorAdd Adds an indicator with the specified handle into a specified chart
window
ChartIndicatorDelete R emoves an indicator with a specified name from the specified chart
window
ChartIndicatorGet R eturnsthe handle of the indicator with the specified short name in
the specified chart window
ChartIndicatorName R eturns the short name of the indicator by the number in the
indicators list on the specified chart window
ChartIndicatorsTotal R eturns the number of all indicators applied to the specified chart
window.
ChartW indowOnDropped R eturns the number (index) of the chart subwindow the Expert
Advisor or script has been dropped to
ChartPriceOnDropped R eturns the price coordinate of the chart point the Expert Advisor or
script has been dropped to
ChartTimeOnDropped R eturns the time coordinate of the chart point the Expert Advisor or
script has been dropped to
ChartXOnDropped R eturns the X coordinate of the chart point the Expert Advisor or
script has been dropped to
ChartYOnDropped R eturns the Y coordinate of the chart point the Expert Advisor or
script has been dropped to
ChartS etS ymbolPeriod Changes the symbol value and a period of the specified chart
ChartS creenS hot Provides a screenshot of the chart of its current state in a GIF, PNG
or BMP format depending on specified extension
ChartApplyTemplate
Appliesa specific template from a specified file to the chart. The command is added to chart
messages queue and will be executed after processing of all previous commands.
bool ChartApplyTemplate(
long chart_id, // Chart ID
const string filename // Template file name
);
Parameters
chart_id
[in] Chart ID. 0 means the current chart.
filename
[in] The name of the file containing the template.
Return Value
R eturnstrue if the command has been added to chart queue, otherwise false. To get an information
about the error, call the GetLastError() function.
Note
The Expert Advisor will be unloaded and will not be able to continue operating in case of successful
loading of a new template to the chart it is attached to.
W hen applying the template to the chart, trade permissions may be limited due to security reasons :
Live trading permission cannot be extended for the Expert Advisors launched by
applying the template using ChartApplyTemplate() function.
If the mql5-program calling ChartApplyTemplate() function has no permission to trade, the Expert
Advisor launched via the template will also not be able to trade regardless of the template settings.
If the mql5-program calling ChartApplyTemplate() function has permission to trade, while there is no
such permission in the template settings, the Expert Advisor launched via the template will not be
able to trade.
Using Templates
The resources of the MQL5 language allow setting multiple chart properties, including colors using the
ChartS etInteger() function:
· Chart background color;
· Color of the axes, scale and the OHLC line;
· Grid color;
· Color of volumes and position open levels ;
· Color of the up bar, shadow and edge of a bullish candlestick;
· Color of the down bar, shadow and edge of a bearish candlestick;
· Color of the chart line and Doji candlesticks ;
For example:
//--- search for a template in terminal_data_directory\MQL5\
ChartApplyTemplate(0,"\\first_template.tpl"))
//--- search for a template in directory_of_EX5_file\, then in folder terminal_data_directory\Profi
ChartApplyTemplate(0,"second_template.tpl"))
//--- search for a template in directory_of_EX5_file\My_templates\, then in folder terminal_directo
ChartApplyTemplate(0,"My_templates\\third_template.tpl"))
Templates are not resources, they cannot be included into an executable EX5 file.
Example:
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- example of applying template, located in \MQL5\Files
if(FileIsExist("my_template.tpl"))
{
Print("The file my_template.tpl found in \Files'");
//--- apply template
if(ChartApplyTemplate(0,"\\Files\\my_template.tpl"))
{
Print("The template 'my_template.tpl' applied successfully");
//--- redraw chart
ChartRedraw();
}
else
Print("Failed to apply 'my_template.tpl', error code ",GetLastError());
}
else
{
Print("File 'my_template.tpl' not found in "
+TerminalInfoString(TERMINAL_PATH)+"\\MQL5\\Files");
}
}
See also
R esources
ChartSaveTemplate
S aves current chart settings in a template with a specified name.
bool ChartSaveTemplate(
long chart_id, // Chart ID
const string filename // Filename to save the template
);
Parameters
chart_id
[in] Chart ID. 0 means the current chart.
filename
[in] The filename to save the template. The " .tpl" extension will be added to the filename
automatically; there is no need to specify it. The template is saved in
data_folder \Profiles \Templates \ and can be used for manual application in the terminal. If a
template with the same filename already exists, the contents of this file will be overwritten.
Return Value
If successful, the function returns true, otherwise it returns false. To get information about the
error, call the GetLastError() function.
Note
Using templates, you can save chart settings with all applied indicators and graphical objects, to
then apply it to another chart.
Example:
//+------------------------------------------------------------------+
//| Test_ChartSaveTemplate.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property script_show_inputs
//--- input parameters
input string symbol="GBPUSD"; // The symbol of a new chart
input ENUM_TIMEFRAMES period=PERIOD_H3; // The timeframe of a new chart
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- First attach indicators to the chart
int handle;
//--- Prepare the indicator for use
ChartApplyTemplate(new_chart,"StdDevChannelOnZigzag");
}
Sleep(10000);
}
//+------------------------------------------------------------------+
//| Creates a zigzag handle and ensures readiness of its data |
//+------------------------------------------------------------------+
bool PrepareZigzag(string sym,ENUM_TIMEFRAMES tf,int &h)
{
ResetLastError();
//--- The Zigzag indicator must be located in terminal_data_folder\MQL5\Examples
h=iCustom(sym,tf,"Examples\\Zigzag");
if(h==INVALID_HANDLE)
{
PrintFormat("%s: Failed to create the handle of the Zigzag indicator. Error code %d",
__FUNCTION__,GetLastError());
return false;
}
//--- When creating an indicator handle, it requires time to calculate values
int k=0; // The number of attempts to wait for the indicator calculation
//--- Wait for the calculation in a loop, pausing to 50 milliseconds if the calculation is not yet
while(BarsCalculated(h)<=0)
{
k++;
//--- Show the number of attempts
PrintFormat("%s: k=%d",__FUNCTION__,k);
//--- Wait 50 milliseconds to wait until the indicator is calculated
Sleep(50);
//--- If more than 100 attempt, then something is wrong
if(k>100)
{
//--- Report a problem
PrintFormat("Failed to calculate the indicator for %d attempts!");
//--- Terminate the program operation
return false;
}
}
//--- Everything is ready, the indicator is created and values are calculated
return true;
}
//+------------------------------------------------------------------+
//| Searches for the last 2 zigzag fractures and places to arrays |
//+------------------------------------------------------------------+
bool GetLastTwoFractures(double &get_values[],datetime &get_times[],int handle)
{
double values[]; // An array for the values of the zigzag
datetime times[]; // An array to get time
int size=100; // Size of the array
ResetLastError();
return true;
}
See also
ChartApplyTemplate(), Resources
ChartWindowFind
The function returns the number of a subwindow where an indicator is drawn. There are 2 variants of
the function.
1. The function searches in the indicated chart for the subwindow with the specified " short name" of
the indicator (the short name is displayed in the left top part of the subwindow), and it returns the
subwindow number in case of success.
int ChartWindowFind(
long chart_id, // chart identifier
string indicator_shortname // short indicator name, see INDICATOR_SHORTNAME
2. The function must be called from a custom indicator. It returns the number of the subwindow where
the indicator is working.
int ChartWindowFind();
Parameters
chart_id
[in] Chart ID. 0 denotes the current chart.
indicator_shortname
[in] S hort name of the indicator.
Return Value
S ubwindow number in case of success. In case of failure the function returns -1.
Note
If the second variant of the function (without parameters) is called from a script or Expert Advisor,
the function returns -1.
Don't mix up the short name of an indicator and a file name, which is specified when an indicator is
created using iCustom() and IndicatorCreate() functions. If the indicator's short name is not set
explicitly, then the name of the file containing the source code of the indicator, is specified in it
during compilation.
It is important to correctly form the short name of an indicator, which is recorded in the
INDICATOR_SHORTNAM E property using the IndicatorS etS tring() function. It is recommended that
the short name contains values of the indicator's input parameters, because the indicator deleted
from a chart in the ChartIndicatorDelete() function is identified by its short name.
Example:
#property script_show_inputs
//--- input parameters
input string shortname="MACD(12,26,9)";
//+------------------------------------------------------------------+
//| Returns number of the chart window with this indicator |
//+------------------------------------------------------------------+
int GetIndicatorSubWindowNumber(long chartID=0,string short_name="")
{
int window=-1;
//---
if((ENUM_PROGRAM_TYPE)MQL5InfoInteger(MQL5_PROGRAM_TYPE)==PROGRAM_INDICATOR)
{
//--- the function is called from the indicator, name is not required
window=ChartWindowFind();
}
else
{
//--- the function is called from an Expert Advisor or script
window=ChartWindowFind(0,short_name);
if(window==-1) Print(__FUNCTION__+"(): Error = ",GetLastError());
}
//---
return(window);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//---
int window=GetIndicatorSubWindowNumber(0,shortname);
if(window!=-1)
Print("Indicator "+shortname+" is in the window #"+(string)window);
else
Print("Indicator "+shortname+" is not found. window = "+(string)window);
}
See also
ObjectCreate(), ObjectFind()
ChartTimePriceToXY
Converts the coordinates of a chart from the time/price representation to the X and Y coordinates.
bool ChartTimePriceToXY(
long chart_id, // Chart ID
int sub_window, // The number of the subwindow
datetime time, // Time on the chart
double price, // Price on the chart
int& x, // The X coordinate for the time on the chart
int& y // The Y coordinates for the price on the chart
);
Parameters
chart_id
[in] Chart ID. 0 means the current chart.
sub_window
[in] The number of the chart subwindow. 0 means the main chart window.
time
[in] The time value on the chart, for which the value in pixels along the X axis will be received.
The origin is in the upper left corner of the main chart window.
price
[in] The price value on the chart, for which the value in pixels along the Y axis will be received.
The origin is in the upper left corner of the main chart window.
x
[out] The variable, into which the conversion of time to X will be received.
y
[out] The variable, into which the conversion of price to Y will be received.
Return Value
R eturns true if successful, otherwise false. To get information about the error, call the
GetLastError() function.
See also
ChartXYToTimePrice()
ChartXYToTimePrice
Converts the X and Y coordinates on a chart to the time and price values.
bool ChartXYToTimePrice(
long chart_id, // Chart ID
int x, // The X coordinate on the chart
int y, // The Y coordinate on the chart
int& sub_window, // The number of the subwindow
datetime& time, // Time on the chart
double& price // Price on the chart
);
Parameters
chart_id
[in] Chart ID. 0 means the current chart.
x
[in] The X coordinate.
y
[in] The Y coordinate.
sub_window
[out] The variable, into which the chart subwindow number will be written. 0 means the main
chart window.
time
[out] The time value on the chart, for which the value in pixels along the X axis will be received.
The origin is in the upper left corner of the main chart window.
price
[out] The price value on the chart, for which the value in pixels along the Y axis will be received.
The origin is in the upper left corner of the main chart window.
Return Value
R eturns true if successful, otherwise false. To get information about the error, call the
GetLastError() function.
Example:
//+------------------------------------------------------------------+
//| ChartEvent function |
//+------------------------------------------------------------------+
void OnChartEvent(const int id,
const long &lparam,
const double &dparam,
const string &sparam)
{
//--- Show the event parameters on the chart
See also
ChartTimePriceToXY()
ChartOpen
Opens a new chart with the specified symbol and period.
long ChartOpen(
string symbol, // Symbol name
ENUM_TIMEFRAMES period // Period
);
Parameters
symbol
[in] Chart symbol. NULL means the symbol of the current chart (the Expert Advisor is attached
to).
period
[in] Chart period (timeframe). Can be one of the ENUM _TIM EFRAM ES values. 0 means the current
chart period.
Return Value
The maximum possible number of simultaneously open charts in the terminal can't exceed the
CHARTS_M AX value.
ChartFirst
R eturns the ID of the first chart of the client terminal.
long ChartFirst();
Return Value
Chart ID.
ChartNext
R eturns the chart ID of the chart next to the specified one.
long ChartNext(
long chart_id // Chart ID
);
Parameters
chart_id
[in] Chart ID. 0 does not mean the current chart. 0 means " return the first chart ID" .
Return Value
Chart ID. If this is the end of the chart list, it returns -1.
Example:
ChartClose
Closes the specified chart.
bool ChartClose(
long chart_id=0 // Chart ID
);
Parameters
chart_id=0
[in] Chart ID. 0 means the current chart.
Return Value
ChartSymbol
R eturns the symbol name for the specified chart.
string ChartSymbol(
long chart_id=0 // Chart ID
);
Parameters
chart_id=0
[in] Chart ID. 0 means the current chart.
Return Value
ChartPeriod
R eturns the timeframe period of specified chart.
ENUM_TIMEFRAMES ChartPeriod(
long chart_id=0 // Chart ID
);
Parameters
chart_id=0
[in] Chart ID. 0 means the current chart.
Return Value
The function returns one of the ENUM _TIM EFRAM ES values. If chart does not exist, it returns 0.
ChartRedraw
This function calls a forced redrawing of a specified chart.
void ChartRedraw(
long chart_id=0 // Chart ID
);
Parameters
chart_id=0
[in] Chart ID. 0 means the current chart.
Note
ChartSetDouble
S etsa value for a corresponding property of the specified chart. Chart property should be of a double
type. The command is added to chart messages queue and will be executed after processing of all
previous commands.
bool ChartSetDouble(
long chart_id, // Chart ID
ENUM_CHART_PROPERTY_DOUBLE prop_id, // Property ID
double value // Value
);
Parameters
chart_id
[in] Chart ID. 0 means the current chart.
prop_id
[in] Chart property ID. Can be one of the ENUM _CHAR T _PR OPER T Y_DOUBL E values (except the
read-only properties).
value
[in] Property value.
Return Value
R eturnstrue if the command has been added to chart queue, otherwise false. To get an information
about the error, call the GetLastError() function.
Note
The function is asynchronous, which means that the function does not wait for the execution of the
command, which has been successfully added to the queue of specified the chart. Instead, it
immediately returns control. The property will only change after the handling of the appropriate
command from the chart queue. To immediately execute commands from the chart queue, call the
ChartRedraw function.
If you want to immediately change several chart properties at once, then the corresponding
functions (ChartS etS tring, ChartS etDouble, ChartS etS tring) should be executed in one code block,
after which you should call ChartRedraw once.
To check the command execution result, you can use a function, which requests the specified chart
property (ChartGetInteger, ChartGetDouble, ChartS etS tring). However, note that these functions
are synchronous and wait for execution results.
ChartSetInteger
S ets a value for a corresponding property of the specified chart. Chart property must be
datetime, int, color, bool or char. The command is added to chart messages queue and will be
executed after processing of all previous commands.
bool ChartSetInteger(
long chart_id, // Chart ID
ENUM_CHART_PROPERTY_INTEGER prop_id, // Property ID
long value // Value
);
Parameters
chart_id
[in] Chart ID. 0 means the current chart.
prop_id
[in] Chart property ID. It can be one of the ENUM _CHART_PROPERTY_INTEGER value (except the
read-only properties).
sub_window
[in] Number
of the chart subwindow. For the first case, the default value is 0 (main chart
window). The most of the properties do not require a subwindow number.
value
[in] Property value.
Return Value
R eturnstrue if the command has been added to chart queue, otherwise false. To get an information
about the error, call the GetLastError() function.
Note
The function is asynchronous, which means that the function does not wait for the execution of the
command, which has been successfully added to the queue of specified the chart. Instead, it
immediately returns control. The property will only change after the handling of the appropriate
command from the chart queue. To immediately execute commands from the chart queue, call the
ChartRedraw function.
If you want to immediately change several chart properties at once, then the corresponding
functions (ChartS etS tring, ChartS etDouble, ChartS etS tring) should be executed in one code block,
after which you should call ChartRedraw once.
To check the command execution result, you can use a function, which requests the specified chart
property (ChartGetInteger, ChartGetDouble, ChartS etS tring). However, note that these functions
are synchronous and wait for execution results.
Example:
//+------------------------------------------------------------------+
//| Expert initialization function |
//+------------------------------------------------------------------+
void OnInit()
{
//--- Enabling events of mouse movements on the chart window
ChartSetInteger(0,CHART_EVENT_MOUSE_MOVE,1);
//--- Forced updating of chart properties ensures readiness for event processing
ChartRedraw();
}
//+------------------------------------------------------------------+
//| MouseState |
//+------------------------------------------------------------------+
string MouseState(uint state)
{
string res;
res+="\nML: " +(((state& 1)== 1)?"DN":"UP"); // mouse left
res+="\nMR: " +(((state& 2)== 2)?"DN":"UP"); // mouse right
res+="\nMM: " +(((state&16)==16)?"DN":"UP"); // mouse middle
res+="\nMX: " +(((state&32)==32)?"DN":"UP"); // mouse first X key
res+="\nMY: " +(((state&64)==64)?"DN":"UP"); // mouse second X key
res+="\nSHIFT: "+(((state& 4)== 4)?"DN":"UP"); // shift key
res+="\nCTRL: " +(((state& 8)== 8)?"DN":"UP"); // control key
return(res);
}
//+------------------------------------------------------------------+
//| ChartEvent function |
//+------------------------------------------------------------------+
void OnChartEvent(const int id,const long &lparam,const double &dparam,const string &sparam)
{
if(id==CHARTEVENT_MOUSE_MOVE)
Comment("POINT: ",(int)lparam,",",(int)dparam,"\n",MouseState((uint)sparam));
}
ChartSetString
S etsa value for a corresponding property of the specified chart. Chart property must be of the string
type. The command is added to chart messages queue and will be executed after processing of all
previous commands.
bool ChartSetString(
long chart_id, // Chart ID
ENUM_CHART_PROPERTY_STRING prop_id, // Property ID
string str_value // Value
);
Parameters
chart_id
[in] Chart ID. 0 means the current chart.
prop_id
[in] Chart property ID. Its value can be one of the ENUM _CHAR T _PR OPER T Y_S T R ING values
(except the read-only properties).
str_value
[in] Property value string. S tring length cannot exceed 2045 characters (extra characters will be
truncated).
Return Value
R eturnstrue if the command has been added to chart queue, otherwise false. To get an information
about the error, call the GetLastError() function.
Note
ChartS etS tring can be used for a comment output on the chart instead of the Comment function.
The function is asynchronous, which means that the function does not wait for the execution of the
command, which has been successfully added to the queue of specified the chart. Instead, it
immediately returns control. The property will only change after the handling of the appropriate
command from the chart queue. To immediately execute commands from the chart queue, call the
ChartRedraw function.
If you want to immediately change several chart properties at once, then the corresponding
functions (ChartS etS tring, ChartS etDouble, ChartS etS tring) should be executed in one code block,
after which you should call ChartRedraw once.
To check the command execution result, you can use a function, which requests the specified chart
property (ChartGetInteger, ChartGetDouble, ChartS etS tring). However, note that these functions
are synchronous and wait for execution results.
Example:
void OnTick()
{
//---
double Ask,Bid;
int Spread;
Ask=SymbolInfoDouble(Symbol(),SYMBOL_ASK);
Bid=SymbolInfoDouble(Symbol(),SYMBOL_BID);
Spread=SymbolInfoInteger(Symbol(),SYMBOL_SPREAD);
string comment=StringFormat("Выводим цены:\nAsk = %G\nBid = %G\nSpread = %d",
Ask,Bid,Spread);
ChartSetString(0,CHART_COMMENT,comment);
}
See also
Comment, ChartGetS tring
ChartGetDouble
R eturnsthe value of a corresponding property of the specified chart. Chart property must be of double
type. There are 2 variants of the function calls.
1. R eturns the property value directly.
double ChartGetDouble(
long chart_id, // Chart ID
ENUM_CHART_PROPERTY_DOUBLE prop_id, // Property ID
int sub_window=0 // subwindow number, if necessary
);
2. R eturns true or false, depending on the success of a function. If successful, the value of the
property is placed in a target variable double_var passed by reference.
bool ChartGetDouble(
long chart_id, // Chart ID
ENUM_CHART_PROPERTY_DOUBLE prop_id, // Property ID
int sub_window, // Subwindow number
double& double_var // Target variable for the chart property
);
Parameters
chart_id
[in] Chart ID. 0 means the current chart.
prop_id
[in] Chart property ID. This value can be one of the ENUM _CHART_PROPERTY_DOUBLE values.
sub_window
[in] Number of the chart subwindow. For the first case, the default value is 0 (main chart
window). The most of the properties do not require a subwindow number.
double_var
[out] Target variable of double type for the requested property.
Return Value
The function is synchronous, which means that it waits for the execution of all the commands that
have been added to the chart queue prior to its call.
Example:
void OnStart()
{
double priceMin=ChartGetDouble(0,CHART_PRICE_MIN,0);
double priceMax=ChartGetDouble(0,CHART_PRICE_MAX,0);
Print("CHART_PRICE_MIN =",priceMin);
Print("CHART_PRICE_MAX =",priceMax);
}
ChartGetInteger
R eturnsthe value of a corresponding property of the specified chart. Chart property must be of
datetime, int or bool type. There are 2 variants of the function calls.
1. R eturns the property value directly.
long ChartGetInteger(
long chart_id, // Chart ID
ENUM_CHART_PROPERTY_INTEGER prop_id, // Property ID
int sub_window=0 // subwindow number, if necessary
);
2. R eturns true or false, depending on the success of a function. If successful, the value of the
property is placed in a target variable long_var passed by reference.
bool ChartGetInteger(
long chart_id, // Chart ID
ENUM_CHART_PROPERTY_INTEGER prop_id, // Property ID
int sub_window=0 // subwindow number
long& long_var // Target variable for the property
);
Parameters
chart_id
[in] Chart ID. 0 means the current chart.
prop_id
[in] Chart property ID. This value can be one of the ENUM _CHAR T _PR OPER T Y_INT EGER values.
sub_window
[in] Number of the chart subwindow. For the first case, the default value is 0 (main chart
window). The most of the properties do not require a subwindow number.
long_var
[out] Target variable of long type for the requested property.
Return Value
The function is synchronous, which means that it waits for the execution of all the commands that
have been added to the chart queue prior to its call.
Example:
void OnStart()
{
int height=ChartGetInteger(0,CHART_HEIGHT_IN_PIXELS,0);
int width=ChartGetInteger(0,CHART_WIDTH_IN_PIXELS,0);
Print("CHART_HEIGHT_IN_PIXELS =",height,"pixels");
Print("CHART_WIDTH_IN_PIXELS =",width,"pixels");
}
ChartGetString
R eturnsthe value of a corresponding property of the specified chart. Chart property must be of string
type. There are 2 variants of the function call.
1. R eturns the property value directly.
string ChartGetString(
long chart_id, // Chart ID
ENUM_CHART_PROPERTY_STRING prop_id // Property ID
);
2. R eturns true or false, depending on the success of a function. If successful, the value of the
property is placed in a target variable string_var passed by reference.
bool ChartGetString(
long chart_id, // Chart ID
ENUM_CHART_PROPERTY_STRING prop_id, // Property ID
string& string_var // Target variable for the property
);
Parameters
chart_id
[in] Chart ID. 0 means the current chart.
prop_id
[in] Chart property ID. This value can be one of the ENUM _CHAR T _PR OPER T Y_S T R ING values.
string_var
[out] Target variable of string type for the requested property.
Return Value
ChartGetS tring can be used for reading comments plotted on the chart using the Comment or
ChartS etS tring functions.
The function is synchronous, which means that it waits for the execution of all the commands that
have been added to the chart queue prior to its call.
Example:
void OnStart()
{
ChartSetString(0,CHART_COMMENT,"Test comment.\nSecond line.\nThird!");
ChartRedraw();
Sleep(1000);
string comm=ChartGetString(0,CHART_COMMENT);
Print(comm);
}
See also
Comment, ChartS etS tring
ChartNavigate
Performs shift of the specified chart by the specified number of bars relative to the specified position
in the chart.
bool ChartNavigate(
long chart_id, // Chart ID
ENUM_CHART_POSITION position, // Position
int shift=0 // Shift value
);
Parameters
chart_id
[in] Chart ID. 0 means the current chart.
position
[in] Chart position to perform a shift. Can be one of the ENUM _CHART_POS ITION values.
shift=0
[in] Number of bars to shift the chart. Positive value means the right shift (to the end of chart),
negative value means the left shift (to the beginning of chart). The zero shift can be used to
navigate to the beginning or end of chart.
Return Value
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- get handle of the current chart
long handle=ChartID();
string comm="";
if(handle>0) // if successful, additionally set up the chart
{
//--- disable auto scroll
ChartSetInteger(handle,CHART_AUTOSCROLL,false);
//--- set a shift from the right chart border
ChartSetInteger(handle,CHART_SHIFT,true);
//--- draw candlesticks
ChartSetInteger(handle,CHART_MODE,CHART_CANDLES);
//--- set the display mode for tick volumes
ChartSetInteger(handle,CHART_SHOW_VOLUMES,CHART_VOLUME_TICK);
Comment(comm);
//--- scroll 10 bars to the right of the history start
ChartNavigate(handle,CHART_BEGIN,10);
//--- get the number of the first bar visible on the chart (numeration like in timeseries)
long first_bar=ChartGetInteger(0,CHART_FIRST_VISIBLE_BAR,0);
//--- add line feed character
comm=comm+"\r\n";
//--- add to comment
comm=comm+"The first bar on the chart is number "+IntegerToString(first_bar)+"\r\n";
//--- show comment
Comment(comm);
//--- wait 5 seconds to see how the chart moves
Sleep(5000);
ChartID
R eturns the ID of the current chart.
long ChartID();
Return Value
ChartIndicatorAdd
Adds an indicator with the specified handle into a specified chart window. Indicator and chart should
be generated on the same symbol and time frame.
bool ChartIndicatorAdd(
long chart_id, // chart ID
int sub_window // number of the sub-window
int indicator_handle // handle of the indicator
);
Parameters
chart_id
[in] Chart ID. 0 means the current chart.
sub_window
[in]The number of the chart sub-window. 0 means the main chart window. To add an indicator in
a new window, the parameter must be one greater than the index of the last existing window, i.e.
equal to CHART_W INDOWS_TOTAL. If the value of the parameter is greater than
CHART_W INDOWS_TOTAL, a new window will not be created, and the indicator will not be added.
indicator_handle
[in] The handle of the indicator.
Return Value
The function returns true in case of success, otherwise it returns false. In order to obtain
information about the error, call the GetLastError() function. Error 4114 means that a chart and an
added indicator differ by their symbol or time frame.
Note
If an indicator that should be drawn in a separate subwindow (for example, built-in iM ACD or a
custom indicator with specified #property indicator_separate_window property) is applied to the
main chart window, it may not be visible though it will still be present in the list of indicators. This
means that the scale of the indicator is different from the scale of the price chart, and applied
indicator's values do not fit in the displayed range of the price chart. In this case, GetLastError()
returns zero code indicating the absence of an error. The values of such " invisible" indicator can be
seen in Data W indow and received from other MQL5 applications.
Example:
#property description "Expert Advisor demonstrating the work with ChartIndicatorAdd() function."
#property description "After launching on the chart (and receiving the error in Journal), open"
#property description "the Expert Advisor's properties and specify correct <symbol> and <period> pa
#property description "MACD indicator will be added on the chart."
int indicator_handle=INVALID_HANDLE;
//+------------------------------------------------------------------+
//| Expert initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//---
indicator_handle=iMACD(symbol,period,fast_ema_period,slow_ema_period,signal_period,apr);
//--- try to add the indicator on the chart
if(!AddIndicator())
{
//--- AddIndicator() function refused to add the indicator on the chart
int answer=MessageBox("Do you want to add MACD on the chart anyway?",
"Incorrect symbol and/or time frame for adding the indicator",
MB_YESNO // "Yes" and "No" selection buttons will be shown
);
//--- if a user still insists on incorrect usage of ChartIndicatorAdd()
if(answer==IDYES)
{
//--- first of all, a Journal entry will be made about that
PrintFormat("Attention! %s: Trying to add MACD(%s/%s) indicator on %s/%s chart. Receiving
__FUNCTION__,symbol,EnumToString(period),_Symbol,EnumToString(_Period));
//--- receive the number of a new subwindow, to which we will try to add the indicator
int subwindow=(int)ChartGetInteger(0,CHART_WINDOWS_TOTAL);
//--- now make an attempt resulting in error
if(!ChartIndicatorAdd(0,subwindow,indicator_handle))
PrintFormat("Failed to add MACD indicator on %d chart window. Error code %d",
subwindow,GetLastError());
}
}
//---
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Expert tick function |
//+------------------------------------------------------------------+
void OnTick()
{
// Expert Advisor performs nothing
}
//+------------------------------------------------------------------+
//| Function for checking and adding the indicator on the chart |
//+------------------------------------------------------------------+
bool AddIndicator()
{
//--- displayed message
string message;
//--- check if the indicator symbol and chart symbol match each other
if(symbol!=_Symbol)
{
message="Displaying the use of Demo_ChartIndicatorAdd() function:";
message=message+"\r\n";
message=message+"Unable to add the indicator calculated on another symbol on the chart.";
message=message+"\r\n";
message=message+"Specify the chart symbol in Expert Advisor's property - "+_Symbol+".";
Alert(message);
//--- premature exit, the indicator will not be added on the chart
return false;
}
//--- check if the indicator's and chart's time frames match each other
if(period!=_Period)
{
message="Unable to add the indicator calculated on another time frame on the chart.";
message=message+"\r\n";
message=message+"Specify the chart time frame in Expert Advisor properties - "+EnumToString(_
Alert(message);
//--- premature exit, the indicator will not be added on the chart
return false;
}
//--- all checks completed, symbol and indicator time frame match the chart
if(indicator_handle==INVALID_HANDLE)
{
Print(__FUNCTION__," Creating MACD indicator");
indicator_handle=iMACD(symbol,period,fast_ema_period,slow_ema_period,signal_period,apr);
if(indicator_handle==INVALID_HANDLE)
{
Print("Failed to create MACD indicator. Error code ",GetLastError());
}
}
//--- reset the error code
ResetLastError();
//--- apply the indicator to the chart
Print(__FUNCTION__," Adding MACD indicator on the chart");
Print("MACD is generated on ",symbol,"/",EnumToString(period));
//--- receive the number of a new subwindow, to which MACD indicator is added
int subwindow=(int)ChartGetInteger(0,CHART_WINDOWS_TOTAL);
PrintFormat("Adding MACD indicator on %d chart window",subwindow);
if(!ChartIndicatorAdd(0,subwindow,indicator_handle))
{
PrintFormat("Failed to add MACD indicator on %d chart window. Error code %d",
subwindow,GetLastError());
}
//--- Indicator added successfully
return(true);
}
See Also
ChartIndicatorDelete(), ChartIndicatorName(), ChartIndicatorsTotal(), iCustom(), IndicatorCreate()
ChartIndicatorDelete
R emoves an indicator with a specified name from the specified chart window.
bool ChartIndicatorDelete(
long chart_id, // chart id
int sub_window // number of the subwindow
const string indicator_shortname // short name of the indicator
);
Parameters
chart_id
[in] Chart ID. 0 denotes the current chart.
sub_window
[in] Number of the chart subwindow. 0 denotes the main chart subwindow.
const indicator_shortname
[in] The short name of the indicator which is set in the INDICATOR_SHORTNAM E property with the
IndicatorS etS tring() function. To get the short name of an indicator use the ChartIndicatorName()
function.
Return Value
R eturns true in case of successful deletion of the indicator. Otherwise it returns false. To get error
details use the GetLastError() function.
Note
If two indicators with identical short names exist in the chart subwindow, the first one in a row will
be deleted.
If other indicators on this chart are based on the values of the indicator that is being deleted, such
indicators will also be deleted.
Do not confuse the indicator short name and the file name that is specified when creating an
indicator using functions iCustom() and IndicatorCreate(). If the short name of an indicator is not
set explicitly, then the name of the file containing the source code of the indicator will be specified
during compilation.
Deletion ofan indicator from a chart doesn't mean that its calculation part will be deleted from the
terminal memory. To release the indicator handle use the IndicatorRelease() function.
The indicator's short name should be formed correctly. It will be written to the
INDICATOR_SHORTNAM E property using the IndicatorS etS tring() function. It is recommended that
the short name should contain values of all the input parameters of the indicator, because the
indicator to be deleted from the chart by the ChartIndicatorDelete() function is identified by the
short name.
Example of deleting an indicator after initialization has failed:
//+------------------------------------------------------------------+
//| Demo_ChartIndicatorDelete.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property indicator_separate_window
#property indicator_buffers 1
#property indicator_plots 1
//--- plot Histogram
#property indicator_label1 "Histogram"
#property indicator_type1 DRAW_HISTOGRAM
#property indicator_color1 clrRed
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
//--- input parameters
input int first_param=1;
input int second_param=2;
input int third_param=3;
input bool wrong_init=true;
//--- indicator buffers
double HistogramBuffer[];
string shortname;
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
int res=INIT_SUCCEEDED;
//--- Link the HistogramBuffer array to the indicator buffer
SetIndexBuffer(0,HistogramBuffer,INDICATOR_DATA);
//--- Construct a short indicator name based on input parameters
shortname=StringFormat("Demo_ChartIndicatorDelete(%d,%d,%d)",
first_param,second_param,third_param);
IndicatorSetString(INDICATOR_SHORTNAME,shortname);
//--- If forced completion of an indicator is set, return a non-zero value
if(wrong_init) res=INIT_FAILED;
return(res);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
See also
ChartIndicatorAdd(), ChartIndicatorName(), ChartIndicatorsTotal(), iCustom(), IndicatorCreate(),
IndicatorS etS tring()
ChartIndicatorGet
R eturns the handle of the indicator with the specified short name in the specified chart window.
int ChartIndicatorGet(
long chart_id, // Chart ID
int sub_window // The number of the subwindow
const string indicator_shortname // Short name of the indicator
);
Parameters
chart_id
[in] Chart ID. 0 means the current chart.
sub_window
[in] The number of the chart subwindow. 0 means the main chart window.
const indicator_shortname
[in] The short name if the indicator, which is set in the INDICATOR_SHORTNAM E property using
the IndicatorS etS tring() function. To get the short name of an indicator, use the
ChartIndicatorName() function.
Return Value
The indicator handle obtained using the ChartIndicatorGet() function increases the internal indicator
usage counter. The terminal runtime system keeps all indicators, whose counter is greater than
zero, loaded. Therefore, the indicator handle that is no longer needed should be immediately and
explicitly released using IndicatorRelease() in the same program that received it, as shown in the
example below. Otherwise, it will be impossible to find the “abandoned” handle and release it from
another program correctly.
W hen creating an indicator, be careful forming its short name, which is written in the
INDICATOR_SHORTNAM E property using the IndicatorS etS tring() function. It is recommended that a
short name should contain the values of input parameters of the indicator, since the indicator is
identified in the ChartIndicatorGet() function based on its short name.
Another way to identify the indicator is to get a list of its parameters for a given handle using the
IndicatorParameters() function and then to analyze the obtained values.
Example:
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- The number of windows on the chart (at least one main window is always present)
int windows=(int)ChartGetInteger(0,CHART_WINDOWS_TOTAL);
See also
ChartIndicatorAdd(), ChartIndicatorName(), ChartIndicatorsTotal(), IndicatorParameters()
ChartIndicatorName
R eturns the short name of the indicator by the number in the indicators list on the specified chart
window.
string ChartIndicatorName(
long chart_id, // chart id
int sub_window // number of the subwindow
int index // index of the indicator in the list of indicators added to the chart subw
);
Parameters
chart_id
[in] Chart ID. 0 denotes the current chart.
sub_window
[in] Number of the chart subwindow. 0 denotes the main chart subwindow.
index
[in] the index of the indicator in the list of indicators. The numeration of indicators start with
zero, i.e. the first indicator in the list
has the 0 index. To obtain the number of indicators in the
list use the ChartIndicatorsTotal() function.
Return Value
The short name of the indicator which is set in the INDICATOR_SHORTNAM E property with the
IndicatorS etS tring() function. To get error details use the GetLastError() function.
Note
Do not confuse the indicator short name and the file name that is specified when creating an
indicator using functions iCustom() and IndicatorCreate(). If the short name of an indicator is not
set explicitly, then the name of the file containing the source code of the indicator will be specified
during compilation.
The indicator's short name should be formed correctly. It will be written to the
INDICATOR_SHORTNAM E property using the IndicatorS etS tring() function. It is recommended that
the short name should contain values of all the input parameters of the indicator, because the
indicator to be deleted from the chart by the ChartIndicatorDelete() function is identified by the
short name.
See also
ChartIndicatorAdd(), ChartIndicatorDelete(), ChartIndicatorsTotal(), iCustom(), IndicatorCreate(),
IndicatorS etS tring()
ChartIndicatorsTotal
R eturns the number of all indicators applied to the specified chart window.
int ChartIndicatorsTotal(
long chart_id, // chart id
int sub_window // number of the subwindow
);
Parameters
chart_id
[in] Chart ID. 0 denotes the current chart.
sub_window
[in] Number of the chart subwindow. 0 denotes the main chart subwindow.
Return Value
The number of indicators in the specified chart window. To get error details use the GetLastError()
function.
Note
The function allows going searching through all the indicators attached to the chart. The number of
all the windows of the chart can be obtained from the CHART_W INDOWS_TOTAL property using the
ChartGetInteger() function.
See also
ChartIndicatorAdd(), ChartIndicatorDelete(), iCustom(), IndicatorCreate(), IndicatorS etS tring()
ChartWindowOnDropped
R eturns the number (index) of the chart subwindow the Expert Advisor or script has been dropped to.
0 means the main chart window.
int ChartWindowOnDropped();
Return Value
int myWindow=ChartWindowOnDropped();
int windowsTotal=ChartGetInteger(0,CHART_WINDOWS_TOTAL);
Print("Script is running on the window #"+myWindow+
". Total windows on the chart "+ChartSymbol()+":",windowsTotal);
See also
ChartPriceOnDropped, ChartTimeOnDropped, ChartXOnDropped, ChartYOnDropped
ChartPriceOnDropped
R eturnsthe price coordinate corresponding to the chart point the Expert Advisor or script has been
dropped to.
double ChartPriceOnDropped();
Return Value
double p=ChartPriceOnDropped();
Print("ChartPriceOnDropped() = ",p);
See also
ChartXOnDropped, ChartYOnDropped
ChartTimeOnDropped
R eturnsthe time coordinate corresponding to the chart point the Expert Advisor or script has been
dropped to.
datetime ChartTimeOnDropped();
Return Value
datetime t=ChartTimeOnDropped();
Print("Script was dropped on the "+t);
See also
ChartXOnDropped, ChartYOnDropped
ChartXOnDropped
R eturns the X coordinate of the chart point the Expert Advisor or script has been dropped to.
int ChartXOnDropped();
Return Value
int X=ChartXOnDropped();
int Y=ChartYOnDropped();
Print("(X,Y) = ("+X+","+Y+")");
See also
ChartW indowOnDropped, ChartPriceOnDropped, ChartTimeOnDropped
ChartYOnDropped
R eturns the Y coordinateof the chart point the Expert Advisor or script has been dropped to.
int ChartYOnDropped();
Return Value
ChartSetSymbolPeriod
Changes the symbol and period of the specified chart. The function is asynchronous, i.e. it sends the
command and does not wait for its execution completion. The command is added to chart messages
queue and will be executed after processing of all previous commands.
bool ChartSetSymbolPeriod(
long chart_id, // Chart ID
string symbol, // Symbol name
ENUM_TIMEFRAMES period // Period
);
Parameters
chart_id
[in] Chart ID. 0 means the current chart.
symbol
[in] Chart symbol. NULL value means the current chart symbol (Expert Advisor is attached to)
period
[in] Chart period (timeframe). Can be one of the ENUM _TIM EFRAM ES values. 0 means the current
chart period.
Return Value
R eturnstrue if the command has been added to chart queue, otherwise false. To get an information
about the error, call the GetLastError() function.
Note
The symbol/period change leads to the re-initialization of the Expert Advisor attached to a chart.
The call of ChartS etS ymbolPeriod with the same symbol and timeframe can be used to update the
chart (similar to the terminal's Refresh command). In its turn, the chart update triggers re-
calculation of the indicators attached to it. Thus, you are able to calculate an indicator on the chart
even if there are no ticks (e.g., on weekends).
See also
ChartS ymbol, ChartPeriod
ChartScreenShot
The function provides a screenshot of the chart in its current state in the GIF, PNG or BMP format
depending on specified extension.
bool ChartScreenShot(
long chart_id, // Chart ID
string filename, // Symbol name
int width, // Width
int height, // Height
ENUM_ALIGN_MODE align_mode=ALIGN_RIGHT // Alignment type
);
Parameters
chart_id
[in] Chart ID. 0 means the current chart.
filename
[in] S creenshot file name. Cannot exceed 63 characters. S creenshot files are placed in the \Files
directory.
width
[in] S creenshot width in pixels.
height
[in] S creenshot height in pixels.
align_mode=ALIGN_RIGHT
[in] Output mode of a narrow screenshot. A value of the ENUM _ALIGN_MODE enumeration.
ALIGN_R IGH T means align to the right margin (the output from the end). ALIGN_L EFT means Left
justify.
Return Value
If you need to take a screenshot from a chart from a certain position, first it's necessary to position
the graph using the ChartNavigate() function. If the horizontal size of the screenshot is smaller than
the chart window, either the right part of the chart window, or its left part is output, depending on
the align_mode settings.
Example:
#property description "The Expert Advisor demonstrates how to create a series of screenshots of the
#property description "chart using the ChartScreenShot() function. For convenience, the file name i
#property description "shown on the chart. The height and width of images is defined through macros
}
//+------------------------------------------------------------------+
//| ChartEvent function |
//+------------------------------------------------------------------+
void OnChartEvent(const int id,
const long &lparam,
const double &dparam,
const string &sparam)
{
//--- Show the name of the function, call time and event identifier
Print(__FUNCTION__,TimeCurrent()," id=",id," mode=",mode);
//--- Handle the CHARTEVENT_CLICK event ("A mouse click on the chart")
if(id==CHARTEVENT_CLICK)
{
//--- Initial shift from the chart edge
int pos=0;
//--- Operation with the left chart edge
if(mode>0)
{
//--- Scroll the chart to the left edge
ChartNavigate(0,CHART_BEGIN,pos);
for(int i=0;i<pictures;i++)
{
//--- Prepare a text to show on the chart and a file name
string name="ChartScreenShot"+"CHART_BEGIN"+string(pos)+".gif";
//--- Show the name on the chart as a comment
Comment(name);
//--- Save the chart screenshot in a file in the terminal_directory\MQL5\Files\
if(ChartScreenShot(0,name,WIDTH,HEIGHT,ALIGN_LEFT))
Print("We've saved the screenshot ",name);
//---
pos+=bars_shift;
//--- Give the user time to look at the new part of the chart
Sleep(3000);
//--- Scroll the chart from the current position bars_shift bars to the right
ChartNavigate(0,CHART_CURRENT_POS,bars_shift);
}
//--- Change the mode to the opposite
mode*=-1;
}
else // Operation with the right chart edge
{
//--- Scroll the chart to the right edge
ChartNavigate(0,CHART_END,pos);
for(int i=0;i<pictures;i++)
{
//--- Prepare a text to show on the chart and a file name
string name="ChartScreenShot"+"CHART_END"+string(pos)+".gif";
//--- Show the name on the chart as a comment
Comment(name);
//--- Save the chart screenshot in a file in the terminal_directory\MQL5\Files\
if(ChartScreenShot(0,name,WIDTH,HEIGHT,ALIGN_RIGHT))
Print("We've saved the screenshot ",name);
//---
pos+=bars_shift;
//--- Give the user time to look at the new part of the chart
Sleep(3000);
//--- Scroll the chart from the current position bars_shift bars to the right
ChartNavigate(0,CHART_CURRENT_POS,-bars_shift);
}
//--- Change the mode to the opposite
mode*=-1;
}
} // End of CHARTEVENT_CLICK event handling
//--- End of the OnChartEvent() handler
}
See also
ChartNavigate(), Resources
Trade Functions
This is the group of functions intended for managing trading activities.
Before you proceed to study the trade functions of the platform, you must have a clear understanding
of the basic terms: order, deal and position:
· An order is an instruction given to a broker to buy or sell a financial instrument. There are two main
types of orders : Market and Pending. In addition, there are special Take Profit and S top Loss levels.
· A deal is the commercial exchange (buying or selling) of a financial security. Buying is executed at
the demand price (As k), and S ell is performed at the supply price (Bid). A deal can be opened as a
result of market order execution or pending order triggering. Note that in some cases, execution of
an order can result in several deals.
· A position is a trade obligation, i.e. the number of bought or sold contracts of a financial
instrument. A long position is financial security bought expecting the security price go higher. A
short position is an obligation to supply a security expecting the price will fall in future.
General information about trading operations is available in the client terminal help.
Trading functions can be used in Expert Advisors and scripts. Trading functions can be called only if in
the properties of the Expert Advisor or script the "Allow live trading" checkbox is enabled.
Trading can be allowed or prohibited depending on various factors described in the Trade Permission
section.
Function Action
OrderCalcMargin Calculates the margin required for the specified order type, in the
deposit currency
OrderCalcProfit Calculates the profit based on the parameters passed, in the deposit
currency
OrderCheck Checks if there are enough funds to execute the required trade
operation.
OrderS end S ends trade requests to a server
OrderS endAsync Asynchronously sends trade requests without waiting for the trade
response of the trade server
PositionsTotal R eturns the number of open positions
PositionGetS ymbol R eturns the symbol corresponding to the open position
PositionS elect Chooses an open position for further working with it
PositionS electByTicket S elects a position to work with by the ticket number specified in it
PositionGetDouble R eturns the requested property of an open position (double)
PositionGetInteger R eturns the requested property of an open position (datetime or int)
PositionGetS tring R eturns the requested property of an open position (string)
Function Action
PositionGetTicket R eturnsthe ticket of the position with the specified index in the list
of open positions
OrdersTotal R eturns the number of orders
OrderGetTicket R eturn the tick et of a corresponding order
OrderS elect S elects a order for further working with it
OrderGetDouble R eturns the requested property of the order (double)
OrderGetInteger R eturns the requested property of the order (datetime or int)
OrderGetS tring R eturns the requested property of the order (string)
H istoryS elect R etrieves the history of transactions and orders for the specified
period of the server time
H istoryS electByPosition R equests the history of deals with a specified position identifier.
H istoryOrderS elect S elects an order in the history for further working with it
H istoryOrdersTotal R eturns the number of orders in the history
H istoryOrderGetTick et R eturn order ticket of a corresponding order in the history
H istoryOrderGetDouble R eturns the requested property of an order in the history (double)
H istoryOrderGetInteger R eturns the requested property of an order in the history (datetime
or int)
H istoryOrderGetS tring R eturns the requested property of an order in the history (string)
H istoryDealS elect S electsa deal in the history for further calling it through appropriate
functions
H istoryDealsTotal R eturns the number of deals in the history
H istoryDealGetTick et R eturns a ticket of a corresponding deal in the history
H istoryDealGetDouble R eturns the requested property of a deal in the history (double)
H istoryDealGetInteger R eturns the requested property of a deal in the history (datetime or
int)
H istoryDealGetS tring R eturns the requested property of a deal in the history (string)
OrderCalcMargin
The function calculates the margin required for the specified order type, on the current account, in the
current market environment not taking into account current pending orders and open positions. It
allows the evaluation of margin for the trade operation planned. The value is returned in the account
currency.
bool OrderCalcMargin(
ENUM_ORDER_TYPE action, // type of order
string symbol, // symbol name
double volume, // volume
double price, // open price
double& margin // variable for obtaining the margin value
);
Parameters
action
[in] The order type, can be one of the values of the ENUM _ORDER_TYPE enumeration.
symbol
[in] S ymbol name.
volume
[in] Volume of the trade operation.
price
[in] Open price.
margin
[out] The variable, to which the value of the required margin will be written in case the function
is successfully executed. The calculation is performed as if there were no pending orders and open
positions on the current account. The margin value depends on many factors, and can differ in
different market environments.
Return Value
The function returns true in case of success ; otherwise it returns false. In order to obtain
information about the error, call the GetLastError() function.
See also
OrderS end(), Order Properties, Trade Operation Types
OrderCalcProfit
The function calculates the profit for the current account, in the current market conditions, based on
the parameters passed. The function is used for pre-evaluation of the result of a trade operation. The
value is returned in the account currency.
bool OrderCalcProfit(
ENUM_ORDER_TYPE action, // type of the order (ORDER_TYPE_BUY or ORDER_TYPE_SELL)
string symbol, // symbol name
double volume, // volume
double price_open, // open price
double price_close, // close price
double& profit // variable for obtaining the profit value
);
Parameters
action
[in] Type of the order, can be one of the two values of the ENUM _ORDER_T YPE enumeration:
ORDER_TYPE_BUY or ORDER_TYPE_SELL.
symbol
[in] S ymbol name.
volume
[in] Volume of the trade operation.
price_open
[in] Open price.
price_close
[in] Close price.
profit
[out] The variable, to which the calculated value of the profit will be written in case the function
is successfully executed. The estimated profit value depends on many factors, and can differ in
different market environments.
Return Value
The function returns true in case of success ; otherwise it returns false. If an invalid order type is
specified, the function will return false. In order to obtain information about the error, call
GetLastError().
See also
OrderS end(), Order Properties, Trade Operation Types
OrderCheck
The OrderCheck() function checks if there are enough money to execute a required trade operation.
The check results are placed to the fields of the M qlTradeCheckResult structure.
bool OrderCheck(
MqlTradeRequest& request, // request structure
MqlTradeCheckResult& result // result structure
);
Parameters
request
[in] Pointer to the structure of the M qlTradeRequest type, which describes the required trade
action.
result
[in,out] Pointer to the structure of the M qlTradeCheckResult type, to which the check result will
be placed.
Return Value
If funds are not enough for the operation, or parameters are filled out incorrectly, the function
returns false. In case of a successful basic check of structures (check of pointers), it returns true.
However, this is not an indication that the requested trade operation is sure to be successfully
executed . For a more detailed description of the function execution result, analyze the fields of the
result structure.
In order to obtain information about the error, call the GetLastError() function.
See also
OrderS end(), Trade Operation Types, Trade Request S tructure, S tructure of Request Check Results,
S tructure of a Trade R equest R esult
OrderSend
The OrderS end() function is used for executing trade operations by sending requests to a trade server.
bool OrderSend(
MqlTradeRequest& request, // query structure
MqlTradeResult& result // structure of the answer
);
Parameters
request
[in] Pointer to a structure of M qlTradeRequest type describing the trade activity of the client.
result
[in,out] Pointer to a structure of M qlTradeResult type describing the result of trade operation in
case of a successful completion (if true is returned).
Return Value
In case of a successful basic check of structures (index checking) returns true. However, this is not
a sign of successful execution of a trade operation. For a more detailed description of the
function execution result, analyze the fields of result structure.
Note
The trade requests go through several stages of checking on a trade server. First of all, it checks if
all the required fields of the request parameter are filled out correctly. If there are no errors, the
server accepts the order for further processing. If the order is successfully accepted by the trade
server, the OrderS end() function returns true.
It is recommended to check the request before sending it to a trade server. To check requests, use
the OrderCheck() function. It checks if there are enough funds to execute the trade operation, and
returns many useful parameters in the results of trade request checking:
· return code containing information about errors in the check ed request;
· balance value that will appear after the trade operation is executed;
· equity value that will appear after the trade operation is executed;
· floating point value that will appear after the trade operation is executed;
· margin required for the trade operation;
· amount of free equity that will remain after the execution of the trade operation;
· the margin level that will be set after the trade operation is executed;
· comment to the reply code, error description.
W hen sending a mark et order (M qlTradeR equest.action=T RADE_ACTION_DEAL), the successful result
of the OrderS end() function does not mean that the order has been executed (appropriate trades
have been performed). In this case, 'true' means only that the order has been successfully placed in
the trading system for further execution. The trade server can fill in the deal or order field values in
the returned result structure, if it is aware of these data when forming a response to an OrderS end()
call. Generally, event(s) of executing trades corresponding to an order may happen after sending a
response to the OrderS end() call. Therefore, for any type of a trade request, when receiving the
OrderS end() execution result, we should first check the retcode trade server response code and the
retcode_external external system response code (if necessary) available in the obtained result
structure.
Each accepted order is stored on the trade server awaiting processing until one of the conditions for
its execution occurs :
· expiration,
· appearance of an opposite request,
· order execution when the execution price appears,
· a request to cancel the order is received.
At the moment of the order processing, the trade server sends to the terminal a message about the
occurrence of the Trade event, which can be processed by the OnTrade() function.
The result of executing the trade request on a server sent by OrderS end() function can be tracked by
OnTradeTransaction handler. It should be noted that OnTradeTransaction handler will be called
several times when executing one trade request.
For example, when sending a market buy order, it is handled, an appropriate buy order is created
for the account, the order is then executed and removed from the list of the open ones, then it is
added to the orders history, an appropriate deal is added to the history and a new position is
created. OnTradeTransaction function will be called for each of these events.
Example:
See also
Trade Operation Types, Trade Request S tructure, S tructure of Request Check Results, S tructure of a
Trade Request Result
OrderSendAsync
The OrderS endAsync() function is used for conducting asynchronous trade operations without waiting
for the trade server's response to a sent request. The function is designed for high-frequency trading,
when under the terms of the trading algorithm it is unacceptable to waste time waiting for a response
from the server.
bool OrderSendAsync(
MqlTradeRequest& request, // Request structure
MqlTradeResult& result // Response structure
);
Parameters
request
[in] A pointer to a structure of the M qlTradeRequest type that describes the trade action of the
client.
result
[in,out] A pointer to a structure of the M qlTradeResult type that describes the result of a trade
operation in case of successful execution of the function (if true is returned).
Return Value
R eturns true if the request is sent to a trade server. In case the request is not sent, it returns false.
In case the request is sent, in the result variable the response code contains
TRADE_RETCODE_PLACED value (code 10008) – " order placed" . S uccessful execution means only the
fact of sending, but does not give any guarantee that the request has reached the trade server and
has been accepted for processing. W hen processing the received request, a trade server sends a
reply to a client terminal notifying of change in the current state of positions, orders and deals,
which leads to the generation of the Trade event.
The result of executing the trade request on a server sent by OrderS endAsync() function can be
tracked by OnTradeTransaction handler. It should be noted that OnTradeTransaction handler will be
called several times when executing one trade request.
For example, when sending a market buy order, it is handled, an appropriate buy order is created
for the account, the order is then executed and removed from the list of the open ones, then it is
added to the orders history, an appropriate deal is added to the history and a new position is
created. OnTradeTransaction function will be called for each of these events. To get such a data,
the function parameters should be analyzed:
· trans - this parameter gets M qlTradeTransaction structure describing a trade transaction applied
to a trade account;
· request - this parameter gets M qlTradeR equest structure describing the trade request resulted in
a trade transaction;
· result - this parameter gets M qlTradeR esult structure describing a trade request execution result.
Note
In terms of purposes and parameters, the function is similar to OrderS end(), but unlike it, it is
asynchronous, i.e. does not hold the program operation while waiting for the function execution
result. You can compare the rate of trade operations of these two functions using the sample Expert
Advisor.
Example:
PrintFormat("Sell %s %G lot",_Symbol,volume_min);
SellAsync(volume_min);
//--- unpress the button
ObjectSetInteger(0,"Sell",OBJPROP_STATE,false);
}
ChartRedraw();
}
//---
}
//+------------------------------------------------------------------+
//| Returns the text description of a transaction |
//+------------------------------------------------------------------+
string TransactionDescription(const MqlTradeTransaction &trans,
const bool detailed=true)
{
//--- prepare a string for returning from the function
string desc=EnumToString(trans.type)+"\r\n";
//--- all possible data is added in detailed mode
if(detailed)
{
desc+="Symbol: "+trans.symbol+"\r\n";
desc+="Deal ticket: "+(string)trans.deal+"\r\n";
desc+="Deal type: "+EnumToString(trans.deal_type)+"\r\n";
desc+="Order ticket: "+(string)trans.order+"\r\n";
desc+="Order type: "+EnumToString(trans.order_type)+"\r\n";
desc+="Order state: "+EnumToString(trans.order_state)+"\r\n";
desc+="Order time type: "+EnumToString(trans.time_type)+"\r\n";
desc+="Order expiration: "+TimeToString(trans.time_expiration)+"\r\n";
desc+="Price: "+StringFormat("%G",trans.price)+"\r\n";
desc+="Price trigger: "+StringFormat("%G",trans.price_trigger)+"\r\n";
desc+="Stop Loss: "+StringFormat("%G",trans.price_sl)+"\r\n";
desc+="Take Profit: "+StringFormat("%G",trans.price_tp)+"\r\n";
desc+="Volume: "+StringFormat("%G",trans.volume)+"\r\n";
}
//--- return a received string
return desc;
}
//+------------------------------------------------------------------+
//| Returns the text description of the trade request |
//+------------------------------------------------------------------+
string RequestDescription(const MqlTradeRequest &request,
const bool detailed=true)
{
//--- prepare a string for returning from the function
string desc=EnumToString(request.action)+"\r\n";
//--- add all available data in detailed mode
if(detailed)
{
desc+="Symbol: "+request.symbol+"\r\n";
if(ObjectGetInteger(0,"Buy",OBJPROP_TYPE)!=OBJ_BUTTON)
ObjectDelete(0,"Buy");
}
else
ObjectCreate(0,"Buy",OBJ_BUTTON,0,0,0); // create "Buy" button
//--- configure "Buy" button
ObjectSetInteger(0,"Buy",OBJPROP_CORNER,CORNER_RIGHT_UPPER);
ObjectSetInteger(0,"Buy",OBJPROP_XDISTANCE,100);
ObjectSetInteger(0,"Buy",OBJPROP_YDISTANCE,50);
ObjectSetInteger(0,"Buy",OBJPROP_XSIZE,70);
ObjectSetInteger(0,"Buy",OBJPROP_YSIZE,30);
ObjectSetString(0,"Buy",OBJPROP_TEXT,"Buy");
ObjectSetInteger(0,"Buy",OBJPROP_COLOR,clrRed);
//--- check presence of the object named "Sell"
if(ObjectFind(0,"Sell")>=0)
{
//--- if the found object is not a button, delete it
if(ObjectGetInteger(0,"Sell",OBJPROP_TYPE)!=OBJ_BUTTON)
ObjectDelete(0,"Sell");
}
else
ObjectCreate(0,"Sell",OBJ_BUTTON,0,0,0); // create "Sell" button
//--- configure "Sell" button
ObjectSetInteger(0,"Sell",OBJPROP_CORNER,CORNER_RIGHT_UPPER);
ObjectSetInteger(0,"Sell",OBJPROP_XDISTANCE,100);
ObjectSetInteger(0,"Sell",OBJPROP_YDISTANCE,100);
ObjectSetInteger(0,"Sell",OBJPROP_XSIZE,70);
ObjectSetInteger(0,"Sell",OBJPROP_YSIZE,30);
ObjectSetString(0,"Sell",OBJPROP_TEXT,"Sell");
ObjectSetInteger(0,"Sell",OBJPROP_COLOR,clrBlue);
//--- perform forced update of the chart to see the buttons immediately
ChartRedraw();
//---
}
//+------------------------------------------------------------------+
//| Buy using OrderSendAsync() asynchronous function |
//+------------------------------------------------------------------+
void BuyAsync(double volume)
{
//--- prepare the request
MqlTradeRequest req={};
req.action =TRADE_ACTION_DEAL;
req.symbol =_Symbol;
req.magic =MagicNumber;
req.volume =0.1;
req.type =ORDER_TYPE_BUY;
req.price =SymbolInfoDouble(req.symbol,SYMBOL_ASK);
req.deviation =10;
req.comment ="Buy using OrderSendAsync()";
MqlTradeResult res={};
if(!OrderSendAsync(req,res))
{
Print(__FUNCTION__,": error ",GetLastError(),", retcode = ",res.retcode);
}
//---
}
//+------------------------------------------------------------------+
//| Sell using OrderSendAsync() asynchronous function |
//+------------------------------------------------------------------+
void SellAsync(double volume)
{
//--- prepare the request
MqlTradeRequest req={};
req.action =TRADE_ACTION_DEAL;
req.symbol =_Symbol;
req.magic =MagicNumber;
req.volume =0.1;
req.type =ORDER_TYPE_SELL;
req.price =SymbolInfoDouble(req.symbol,SYMBOL_BID);
req.deviation =10;
req.comment ="Sell using OrderSendAsync()";
MqlTradeResult res={};
if(!OrderSendAsync(req,res))
{
Print(__FUNCTION__,": error ",GetLastError(),", retcode = ",res.retcode);
}
//---
}
//+------------------------------------------------------------------+
PositionsTotal
R eturns the number of open positions.
int PositionsTotal();
Return Value
For the " netting " interpretation of positions (ACCOUNT_M ARGIN_MODE_RETAIL_NETTING and
ACCOUNT _M ARGIN_MODE_EXCHANGE), only one position can exist for a symbol at any moment of
time. This position is a result of one or more deals. Do not confuse positions with valid pending
orders, which are also displayed on the Trading tab of the Toolbox window.
If individual positions are allowed (ACCOUNT_M ARGIN_MODE_RETAIL_HEDGING), multiple positions
can be open for one symbol.
See also
PositionGetS ymbol(), PositionS elect(), Position Properties
PositionGetSymbol
R eturns the symbol corresponding to the open position and automatically selects the position for
further working with it using functions PositionGetDouble, PositionGetInteger, PositionGetS tring.
string PositionGetSymbol(
int index // Number in the list of positions
);
Parameters
index
[in] Number of the position in the list of open positions.
Return Value
Value of the string type. If the position was not found, an empty string will be returned. To get an
error code, call the GetLastError() function.
Note
For the " netting " interpretation of positions (ACCOUNT_M ARGIN_MODE_RETAIL_NETTING and
ACCOUNT _M ARGIN_MODE_EXCHANGE), only one position can exist for a symbol at any moment of
time. This position is a result of one or more deals. Do not confuse positions with valid pending
orders, which are also displayed on the Trading tab of the Toolbox window.
If individual positions are allowed (ACCOUNT_M ARGIN_MODE_RETAIL_HEDGING), multiple positions
can be open for one symbol.
See also
PositionsTotal(), PositionS elect(), Position Properties
PositionSelect
Chooses an open position for further working with it. Returns true if the function is successfully
completed. Returns false in case of failure. To obtain information about the error, call GetLastError().
bool PositionSelect(
string symbol // Symbol name
);
Parameters
symbol
[in] Name of the financial security.
Return Value
For the " netting " interpretation of positions (ACCOUNT_M ARGIN_MODE_RETAIL_NETTING and
ACCOUNT _M ARGIN_MODE_EXCHANGE), only one position can exist for a symbol at any moment of
time. This position is a result of one or more deals. Do not confuse positions with valid pending
orders, which are also displayed on the Trading tab of the Toolbox window.
If individual positions are allowed (ACCOUNT_M ARGIN_MODE_RETAIL_HEDGING), multiple positions
can be open for one symbol. In this case, PositionS elect will select a position with the lowest ticket.
Function PositionS elect() copies data about a position into the program environment, and further
calls of PositionGetDouble(), PositionGetInteger() and PositionGetS tring() return the earlier copied
data. This means that the position itself may no longer exist (or its volume, direction, etc. has
changed), but data of this position still can be obtained. To ensure receipt of fresh data about a
position, it is recommended to call PositionS elect() right before referring to them.
See also
PositionGetS ymbol(), PositionsTotal(), Position Properties
PositionSelectByTicket
S electsan open position to work with based on the ticket number specified in the position. If
successful, returns true. Returns false if the function failed. Call GetLastError() for error details.
bool PositionSelectByTicket(
ulong ticket // Position ticket
);
Parameters
ticket
[in] Position ticket.
Return Value
The PositionS electByTicket() function copies position data to the program environment. Further calls
of PositionGetDouble(), PositionGetInteger() and PositionGetS tring() return the previously copied
data. Even if a position does not exist already (or its size, direction etc. has changed), the data may
still be received sometimes. To make sure that you receive valid position data, it is recommended
to call PositionS electByTicket() before you access the data.
See also
PositionGetS ymbol(), PositionsTotal(), Position Properties
PositionGetDouble
The function returns the requested property of an open position, pre-selected using PositionGetS ymbol
or PositionS elect. The position property must be of the double type. There are 2 variants of the
function.
1. Immediately returns the property value.
double PositionGetDouble(
ENUM_POSITION_PROPERTY_DOUBLE property_id // Property identifier
);
2. R eturnstrue or false, depending on the success of the function execution. If successful, the value
of the property is placed in a receiving variable passed by reference by the last parameter.
bool PositionGetDouble(
ENUM_POSITION_PROPERTY_DOUBLE property_id, // Property identifier
double& double_var // Here we accept the property value
);
Parameters
property_id
[in] Identifier of a position property. The value can be one of the values of the
ENUM _POS ITION_PR OPER T Y_DOUBL E enumeration.
double_var
[out] Variable of the double type, accepting the value of the requested property.
Return Value
For the " netting " interpretation of positions (ACCOUNT_M ARGIN_MODE_RETAIL_NETTING and
ACCOUNT _M ARGIN_MODE_EXCHANGE), only one position can exist for a symbol at any moment of
time. This position is a result of one or more deals. Do not confuse positions with valid pending
orders, which are also displayed on the Trading tab of the Toolbox window.
If individual positions are allowed (ACCOUNT_M ARGIN_MODE_RETAIL_HEDGING), multiple positions
can be open for one symbol.
To ensure receipt of fresh data about a position, it is recommended to call PositionS elect() right
before referring to them.
See also
PositionGetS ymbol(), PositionS elect(), Position Properties
PositionGetInteger
The function returns the requested property of an open position, pre-selected using PositionGetS ymbol
or PositionS elect. The position property should be of datetime, int type. There are 2 variants of the
function.
1. Immediately returns the property value.
long PositionGetInteger(
ENUM_POSITION_PROPERTY_INTEGER property_id // Property identifier
);
2. R eturnstrue or false, depending on the success of the function execution. If successful, the value
of the property is placed in a receiving variables passed by reference by the last parameter.
bool PositionGetInteger(
ENUM_POSITION_PROPERTY_INTEGER property_id, // Property identifier
long& long_var // Here we accept the property value
);
Parameters
property_id
[in] Identifier of a position property. The value can be one of the values of the
ENUM _POS ITION_PR OPER T Y_INT EGER enumeration.
long_var
[out] Variable of the long type accepting the value of the requested property.
Return Value
For the " netting " interpretation of positions (ACCOUNT_M ARGIN_MODE_RETAIL_NETTING and
ACCOUNT _M ARGIN_MODE_EXCHANGE), only one position can exist for a symbol at any moment of
time. This position is a result of one or more deals. Do not confuse positions with valid pending
orders, which are also displayed on the Trading tab of the Toolbox window.
If individual positions are allowed (ACCOUNT_M ARGIN_MODE_RETAIL_HEDGING), multiple positions
can be open for one symbol.
To ensure receipt of fresh data about a position, it is recommended to call PositionS elect() right
before referring to them.
Example:
//+------------------------------------------------------------------+
//| Trade function |
//+------------------------------------------------------------------+
void OnTrade()
{
//--- check if a position is present and display the time of its changing
if(PositionSelect(_Symbol))
{
//--- receive position ID for further work
ulong position_ID=PositionGetInteger(POSITION_IDENTIFIER);
Print(_Symbol," position #",position_ID);
//--- receive the time of position forming in milliseconds since 01.01.1970
long create_time_msc=PositionGetInteger(POSITION_TIME_MSC);
PrintFormat("Position #%d POSITION_TIME_MSC = %i64 milliseconds => %s",position_ID,
create_time_msc,TimeToString(create_time_msc/1000));
//--- receive the time of the position's last change in seconds since 01.01.1970
long update_time_sec=PositionGetInteger(POSITION_TIME_UPDATE);
PrintFormat("Position #%d POSITION_TIME_UPDATE = %i64 seconds => %s",
position_ID,update_time_sec,TimeToString(update_time_sec));
//--- receive the time of the position's last change in milliseconds since 01.01.1970
long update_time_msc=PositionGetInteger(POSITION_TIME_UPDATE_MSC);
PrintFormat("Position #%d POSITION_TIME_UPDATE_MSC = %i64 milliseconds => %s",
position_ID,update_time_msc,TimeToString(update_time_msc/1000));
}
//---
}
See also
PositionGetS ymbol(), PositionS elect(), Position Properties
PositionGetString
The function returns the requested property of an open position, pre-selected using PositionGetS ymbol
or PositionS elect. The position property should be of the string type. There are 2 variants of the
function.
1. Immediately returns the property value.
string PositionGetString(
ENUM_POSITION_PROPERTY_STRING property_id // Property identifier
);
2. R eturnstrue or false, depending on the success of the function execution. If successful, the value
of the property is placed in a receiving variables passed by reference by the last parameter.
bool PositionGetString(
ENUM_POSITION_PROPERTY_STRING property_id, // Property identifier
string& string_var // Here we accept the property value
);
Parameters
property_id
[in] Identifier of a position property. The value can be one of the values of the
ENUM _POS ITION_PR OPER T Y_S T R ING enumeration.
string_var
[out] Variable of the string type accepting the value of the requested property.
Return Value
Value of the string type. If the function fails, an empty string is returned.
Note
For the " netting " interpretation of positions (ACCOUNT_M ARGIN_MODE_RETAIL_NETTING and
ACCOUNT _M ARGIN_MODE_EXCHANGE), only one position can exist for a symbol at any moment of
time. This position is a result of one or more deals. Do not confuse positions with valid pending
orders, which are also displayed on the Trading tab of the Toolbox window.
If individual positions are allowed (ACCOUNT_M ARGIN_MODE_RETAIL_HEDGING), multiple positions
can be open for one symbol.
To ensure receipt of fresh data about a position, it is recommended to call PositionS elect() right
before referring to them.
See also
PositionGetS ymbol(), PositionS elect(), Position Properties
PositionGetTicket
The function returns the ticket of a position with the specified index in the list of open positions and
automatically selects the position to work with using functions PositionGetDouble, PositionGetInteger,
PositionGetS tring.
ulong PositionGetTicket(
int index // The number of a position in the list
);
Parameters
index
[in] The index of a position in the list of open positions, numeration starts with 0.
Return Value
For the " netting " interpretation of positions (ACCOUNT_M ARGIN_MODE_RETAIL_NETTING and
ACCOUNT _M ARGIN_MODE_EXCHANGE), only one position can exist for a symbol at any moment of
time. This position is a result of one or more deals. Do not confuse positions with valid pending
orders, which are also displayed on the Trading tab of the Toolbox window.
If individual positions are allowed (ACCOUNT_M ARGIN_MODE_RETAIL_HEDGING), multiple positions
can be open for one symbol.
To ensure receipt of fresh data about a position, it is recommended to call PositionS elect() right
before referring to them.
See also
PositionGetS ymbol(), PositionS elect(), Position Properties
OrdersTotal
R eturns the number of current orders.
int OrdersTotal();
Return Value
Do not confuse current pending orders with positions, which are also displayed on the " Trade" tab of
the " Toolbox" of the client terminal. An order is a request to conduct a transaction, while a position
is a result of one or more deals.
For the " netting " interpretation of positions (ACCOUNT_M ARGIN_MODE_RETAIL_NETTING and
ACCOUNT _M ARGIN_MODE_EXCHANGE), only one position can exist for a symbol at any moment of
time. This position is a result of one or more deals. Do not confuse positions with valid pending
orders, which are also displayed on the Trading tab of the Toolbox window.
If individual positions are allowed (ACCOUNT_M ARGIN_MODE_RETAIL_HEDGING), multiple positions
can be open for one symbol.
See also
OrderS elect(), OrderGetTicket(), Order Properties
OrderGetTicket
R eturnsticket of a corresponding order and automatically selects the order for further working with it
using functions.
ulong OrderGetTicket(
int index // Number in the list of orders
);
Parameters
index
[in] Number of an order in the list of current orders.
Return Value
Do not confuse current pending orders with positions, which are also displayed on the " Trade" tab of
the " Toolbox" of the client terminal. An order is a request to conduct a transaction, while a position
is a result of one or more deals.
For the " netting " interpretation of positions (ACCOUNT_M ARGIN_MODE_RETAIL_NETTING and
ACCOUNT _M ARGIN_MODE_EXCHANGE), only one position can exist for a symbol at any moment of
time. This position is a result of one or more deals. Do not confuse positions with valid pending
orders, which are also displayed on the Trading tab of the Toolbox window.
If individual positions are allowed (ACCOUNT_M ARGIN_MODE_RETAIL_HEDGING), multiple positions
can be open for one symbol.
Function OrderGetTicket() copies data about an order into the program environment, and further
calls of OrderGetDouble(), OrderGetInteger(), OrderGetS tring() return the earlier copied data. This
means that the order itself may no longer exist (or its open price, S top Loss /Take Profit levels or
expiration has changed), but data of this order still can be obtained. To ensure receipt of fresh data
about an order, it is recommended to call OrderGetTicket() right before referring to them.
Example:
void OnStart()
{
//--- variables for returning values from order properties
ulong ticket;
double open_price;
double initial_volume;
datetime time_setup;
string symbol;
string type;
long order_magic;
long positionID;
//--- number of current pending orders
uint total=OrdersTotal();
See also
OrdersTotal(), OrderS elect(), OrderGetInteger()
OrderSelect
S elects an order to work with. Returns true if the function has been successfully completed. Returns
false if the function completion has failed. For more information about an error call GetLastError().
bool OrderSelect(
ulong ticket // Order ticket
);
Parameters
ticket
[in] Order ticket.
Return Value
Do not confuse current pending orders with positions, which are also displayed on the " Trade" tab of
the " Toolbox" of the client terminal.
For the " netting " interpretation of positions (ACCOUNT_M ARGIN_MODE_RETAIL_NETTING and
ACCOUNT _M ARGIN_MODE_EXCHANGE), only one position can exist for a symbol at any moment of
time. This position is a result of one or more deals. Do not confuse positions with valid pending
orders, which are also displayed on the Trading tab of the Toolbox window.
If individual positions are allowed (ACCOUNT_M ARGIN_MODE_RETAIL_HEDGING), multiple positions
can be open for one symbol.
Function OrderS elect() copies data about an order into the program environment, and further calls
of OrderGetDouble(), OrderGetInteger(), OrderGetS tring() return the earlier copied data. This
means that the order itself may no longer exist (or its open price, S top Loss /Take Profit levels or
expiration has changed), but data of this order still can be obtained. To ensure receipt of fresh data
about an order, it is recommended to call OrderS elect() right before referring to them.
See also
OrderGetInteger(), OrderGetDouble(), OrderGetS tring(), OrderCalcProfit(), OrderGetTicket(), Order
Properties
OrderGetDouble
R eturns the requested property of an order, pre-selected using OrderGetTicket or OrderS elect. The
order property must be of the double type. There are 2 variants of the function.
1. Immediately returns the property value.
double OrderGetDouble(
ENUM_ORDER_PROPERTY_DOUBLE property_id // Property identifier
);
2. R eturns true or false, depending on the success of a function. If successful, the value of the
property is placed in a target variable passed by reference by the last parameter.
bool OrderGetDouble(
ENUM _ORDER_PR OPER T Y_DOUBL E property_id, // Property identifier
double& double_var // Here we accept the property value
);
Parameters
property_id
[in] Identifier of the order property. The value can be one of the values of the
ENUM _ORDER_PR OPER T Y_DOUBL E enumeration.
double_var
[out] Variable of the double type that accepts the value of the requested property.
Return Value
Do not confuse current pending orders with positions, which are also displayed on the " Trade" tab of
the " Toolbox" of the client terminal.
For the " netting " interpretation of positions (ACCOUNT_M ARGIN_MODE_RETAIL_NETTING and
ACCOUNT _M ARGIN_MODE_EXCHANGE), only one position can exist for a symbol at any moment of
time. This position is a result of one or more deals. Do not confuse positions with valid pending
orders, which are also displayed on the Trading tab of the Toolbox window.
If individual positions are allowed (ACCOUNT_M ARGIN_MODE_RETAIL_HEDGING), multiple positions
can be open for one symbol.
To ensure receipt of fresh data about an order, it is recommended to call OrderS elect() right before
referring to them.
See also
OrdersTotal(), OrderGetTicket(), Order Properties
OrderGetInteger
R eturns the requested order property, pre-selected using OrderGetTicket or OrderS elect. Order
property must be of the datetime, int type. There are 2 variants of the function.
1. Immediately returns the property value.
long OrderGetInteger(
ENUM_ORDER_PROPERTY_INTEGER property_id // Property identifier
);
2. R eturns true or false depending on the success of the function. If successful, the value of the
property is placed into a target variable passed by reference by the last parameter.
bool OrderGetInteger(
ENUM_ORDER_PROPERTY_INTEGER property_id, // Property identifier
long& long_var // Here we accept the property value
);
Parameters
property_id
[in] Identifier of the order property. The value can be one of the values of the
ENUM _ORDER_PR OPER T Y_INT EGER enumeration.
long_var
[out] Variable of the long type that accepts the value of the requested property.
Return Value
Do not confuse current pending orders with positions, which are also displayed on the " Trade" tab of
the " Toolbox" of the client terminal.
For the " netting " interpretation of positions (ACCOUNT_M ARGIN_MODE_RETAIL_NETTING and
ACCOUNT _M ARGIN_MODE_EXCHANGE), only one position can exist for a symbol at any moment of
time. This position is a result of one or more deals. Do not confuse positions with valid pending
orders, which are also displayed on the Trading tab of the Toolbox window.
If individual positions are allowed (ACCOUNT_M ARGIN_MODE_RETAIL_HEDGING), multiple positions
can be open for one symbol.
To ensure receipt of fresh data about an order, it is recommended to call OrderS elect() right before
referring to them.
See also
OrdersTotal(), OrderGetTicket(), Order Properties
OrderGetString
R eturnsthe requested order property, pre-selected using OrderGetTicket or OrderS elect. The order
property must be of the string type. There are 2 variants of the function.
1. Immediately returns the property value.
string OrderGetString(
ENUM_ORDER_PROPERTY_STRING property_id // Property identifier
);
2. R eturns true or false, depending on the success of the function. If successful, the value of the
property is placed into a target variable passed by reference by the last parameter.
bool OrderGetString(
ENUM_ORDER_PROPERTY_STRING property_id, // Property identifier
string& string_var // Here we accept the property value
);
Parameters
property_id
[in] Identifier of the order property. The value can be one of the values of the
ENUM _ORDER_PR OPER T Y_S T R ING enumeration.
string_var
[out] Variable of the string type that accepts the value of the requested property.
Return Value
Do not confuse current pending orders with positions, which are also displayed on the " Trade" tab of
the " Toolbox" of the client terminal.
For the " netting " interpretation of positions (ACCOUNT_M ARGIN_MODE_RETAIL_NETTING and
ACCOUNT _M ARGIN_MODE_EXCHANGE), only one position can exist for a symbol at any moment of
time. This position is a result of one or more deals. Do not confuse positions with valid pending
orders, which are also displayed on the Trading tab of the Toolbox window.
If individual positions are allowed (ACCOUNT_M ARGIN_MODE_RETAIL_HEDGING), multiple positions
can be open for one symbol.
To ensure receipt of fresh data about an order, it is recommended to call OrderS elect() right before
referring to them.
See also
OrdersTotal(), OrderGetTicket(), Order Properties
HistorySelect
R etrieves the history of deals and orders for the specified period of server time.
bool HistorySelect(
datetime from_date, // From date
datetime to_date // To date
);
Parameters
from_date
[in] S tart date of the request.
to_date
[in] End date of the request.
Return Value
H istoryS elect()
creates a list of orders and a list of trades in a mql5-program, for further referring
to the list elements using corresponding functions. The deals list size can be returned using the
H istoryDealsTotal() function; the size of the list of orders in the history can be obtained using
H istoryOrdersTotal(). S election in the list of orders should be better performed by
H istoryOrderGetTick et(), for items in the list of deals H istoryDealGetTick et() suits better.
After using HistoryOrderS elect(), the list of history orders available to the mql5 program is reset and
filled again by the found order, if the search of an order by the ticket has been completed
successfully. The same applies to the list of deals available to the mql5 program - it is reset by
H istoryDealS elect() and filled again in case of a successful receipt of a deal by tick et number.
Example:
void OnStart()
{
color BuyColor =clrBlue;
color SellColor=clrRed;
//--- request trade history
HistorySelect(0,TimeCurrent());
//--- create objects
string name;
uint total=HistoryDealsTotal();
ulong ticket=0;
double price;
double profit;
datetime time;
string symbol;
long type;
long entry;
//--- for all deals
for(uint i=0;i<total;i++)
{
//--- try to get deals ticket
if((ticket=HistoryDealGetTicket(i))>0)
{
//--- get deals properties
price =HistoryDealGetDouble(ticket,DEAL_PRICE);
time =(datetime)HistoryDealGetInteger(ticket,DEAL_TIME);
symbol=HistoryDealGetString(ticket,DEAL_SYMBOL);
type =HistoryDealGetInteger(ticket,DEAL_TYPE);
entry =HistoryDealGetInteger(ticket,DEAL_ENTRY);
profit=HistoryDealGetDouble(ticket,DEAL_PROFIT);
//--- only for current symbol
if(price && time && symbol==Symbol())
{
//--- create price object
name="TradeHistory_Deal_"+string(ticket);
if(entry) ObjectCreate(0,name,OBJ_ARROW_RIGHT_PRICE,0,time,price,0,0);
else ObjectCreate(0,name,OBJ_ARROW_LEFT_PRICE,0,time,price,0,0);
//--- set object properties
ObjectSetInteger(0,name,OBJPROP_SELECTABLE,0);
ObjectSetInteger(0,name,OBJPROP_BACK,0);
ObjectSetInteger(0,name,OBJPROP_COLOR,type?BuyColor:SellColor);
if(profit!=0) ObjectSetString(0,name,OBJPROP_TEXT,"Profit: "+string(profit));
}
}
}
//--- apply on chart
ChartRedraw();
}
See also
H istoryOrderS elect(), H istoryDealS elect()
HistorySelectByPosition
R etrieves the history of deals and orders having the specified position identifier.
bool HistorySelectByPosition(
long position_id // position identifier - POSITION_IDENTIFIER
);
Parameters
position_id
[in] Position identifier that is set to every executed order and every deal.
Return Value
Do not confuse orders of a trading history with current pending orders that appear on the " Trade"
tab of the " Toolbox" bar. The list of orders that were canceled or have led to a transaction, can be
viewed in the "History" tab of " Toolbox" of the client terminal.
H istoryS electByPosition()creates in a mql5 program a list of orders and a list of deals with a
specified position identifier for further reference to the elements of the list using the appropriate
functions. To know the size of the list of deals, use function HistoryDealsTotal(), the size of the list
of orders in the history can be obtained using HistoryOrdersTotal(). To run through elements of the
orders list, use HistoryOrderGetTicket(), for elements of the deals list - HistoryDealGetTicket().
After using HistoryOrderS elect(), list of history orders available to the mql5 program is reset and
filled again with the found order, if search of an order by its ticket was successful. The same refers
to the list of deals available to the mql5 program - it is reset by function HistoryDealS elect() and is
filled out again if a deal was found successfully by the ticket number.
See also
H istoryS elect(), H istoryOrderGetTick et(), Order Properties
HistoryOrderSelect
S electsan order from the history for further calling it through appropriate functions. It returns true if
the function has been successfully completed. Returns false if the function has failed. For more details
on error call GetLastError().
bool HistoryOrderSelect(
ulong ticket // Order ticket
);
Parameters
ticket
[in] Order ticket.
Return Value
Do not confuse orders of a trading history with current pending orders that appear on the " Trade"
tab of the " Toolbox" bar. The list of orders that were canceled or have led to a transaction, can be
viewed in the "History" tab of " Toolbox" of the client terminal.
H istoryOrderS elect()clears in a mql5-program the list of orders from a history, available for calls,
and copies to it a single order, if the execution of HistoryOrderS elect () has been completed
successfully. If you need to go through all orders selected by HistoryS elect(), you should better use
H istoryOrderGetTick et().
See also
H istoryS elect(), H istoryOrderGetTick et(), Order Properties
HistoryOrdersTotal
R eturnsthe number of orders in the history. Prior to calling HistoryOrdersTotal(), first it is necessary
to receive the history of deals and orders using the HistoryS elect() or HistoryS electByPosition()
function.
int HistoryOrdersTotal();
Return Value
Do not confuse orders of a trading history with current pending orders that appear on the " Trade"
tab of the " Toolbox" bar. The list of orders that were canceled or have led to a transaction, can be
viewed in the "History" tab of " Toolbox" of the client terminal.
See also
H istoryS elect(), H istoryOrderS elect(), H istoryOrderGetTick et(), Order Properties
HistoryOrderGetTicket
R eturn the tick et ofa corresponding order in the history. Prior to calling HistoryOrderGetTicket(), first
it is necessary to receive the history of deals and orders using the HistoryS elect() or
H istoryS electByPosition() function.
ulong HistoryOrderGetTicket(
int index // Number in the list of orders
);
Parameters
index
[in] Number of the order in the list of orders.
Return Value
Do not confuse orders of a trading history with current pending orders that appear on the " Trade"
tab of the " Toolbox" bar. The list of orders that were canceled or have led to a transaction, can be
viewed in the "History" tab of " Toolbox" of the client terminal.
Example:
void OnStart()
{
datetime from=0;
datetime to=TimeCurrent();
//--- request the entire history
HistorySelect(from,to);
//--- variables for returning values from order properties
ulong ticket;
double open_price;
double initial_volume;
datetime time_setup;
datetime time_done;
string symbol;
string type;
long order_magic;
long positionID;
//--- number of current pending orders
uint total=HistoryOrdersTotal();
//--- go through orders in a loop
for(uint i=0;i<total;i++)
{
//--- return order ticket by its position in the list
if((ticket=HistoryOrderGetTicket(i))>0)
{
//--- return order properties
open_price =HistoryOrderGetDouble(ticket,ORDER_PRICE_OPEN);
time_setup =(datetime)HistoryOrderGetInteger(ticket,ORDER_TIME_SETUP);
time_done =(datetime)HistoryOrderGetInteger(ticket,ORDER_TIME_DONE);
symbol =HistoryOrderGetString(ticket,ORDER_SYMBOL);
order_magic =HistoryOrderGetInteger(ticket,ORDER_MAGIC);
positionID =HistoryOrderGetInteger(ticket,ORDER_POSITION_ID);
initial_volume=HistoryOrderGetDouble(ticket,ORDER_VOLUME_INITIAL);
type =GetOrderType(HistoryOrderGetInteger(ticket,ORDER_TYPE));
//--- prepare and show information about the order
printf("#ticket %d %s %G %s at %G was set up at %s => done at %s, pos ID=%d",
ticket, // order ticket
type, // type
initial_volume, // placed volume
symbol, // symbol
open_price, // specified open price
TimeToString(time_setup),// time of order placing
TimeToString(time_done), // time of order execution or deletion
positionID // ID of a position , to which the deal of the order is in
);
}
}
//---
}
//+------------------------------------------------------------------+
//| Returns the string name of the order type |
//+------------------------------------------------------------------+
string GetOrderType(long type)
{
string str_type="unknown operation";
switch(type)
{
case (ORDER_TYPE_BUY): return("buy");
case (ORDER_TYPE_SELL): return("sell");
case (ORDER_TYPE_BUY_LIMIT): return("buy limit");
case (ORDER_TYPE_SELL_LIMIT): return("sell limit");
case (ORDER_TYPE_BUY_STOP): return("buy stop");
case (ORDER_TYPE_SELL_STOP): return("sell stop");
case (ORDER_TYPE_BUY_STOP_LIMIT): return("buy stop limit");
case (ORDER_TYPE_SELL_STOP_LIMIT):return("sell stop limit");
}
return(str_type);
}
See also
H istoryS elect(), H istoryOrdersTotal(), H istoryOrderS elect(), Order Properties
HistoryOrderGetDouble
R eturns the requested order property. The order property must be of the double type. There are 2
variants of the function.
1. Immediately returns the property value.
double HistoryOrderGetDouble(
ulong ticket_number, // Ticket
ENUM_ORDER_PROPERTY_DOUBLE property_id // Property identifier
);
2. R eturns true or false, depending on the success of the function. If successful, the value of the
property is placed into a target variable passed by reference by the last parameter.
bool HistoryOrderGetDouble(
ulong ticket_number, // Ticket
ENUM_ORDER_PROPERTY_DOUBLE property_id, // Property identifier
double& double_var // Here we accept the property value
);
Parameters
ticket_number
[in] Order ticket.
property_id
[in] Identifier of the order property. The value can be one of the values of the
ENUM _ORDER_PR OPER T Y_DOUBL E enumeration.
double_var
[out] Variable of the double type that accepts the value of the requested property.
Return Value
Do not confuse orders of a trading history with current pending orders that appear on the " Trade"
tab of the " Toolbox" bar. The list of orders that were canceled or have led to a transaction, can be
viewed in the "History" tab of " Toolbox" of the client terminal.
See also
H istoryS elect(), H istoryOrdersTotal(), H istoryOrderS elect(), Order Properties
HistoryOrderGetInteger
R eturns the requested property of an order. The order property must be of datetime, int type. There
are 2 variants of the function.
1. Immediately returns the property value.
long HistoryOrderGetInteger(
ulong ticket_number, // Ticket
ENUM_ORDER_PROPERTY_INTEGER property_id // Property identifier
);
2. R eturns true or false, depending on the success of the function. If successful, the value of the
property is placed into a target variable passed by reference by the last parameter.
bool HistoryOrderGetInteger(
ulong ticket_number, // Ticket
ENUM_ORDER_PROPERTY_INTEGER property_id, // Property identifier
long& long_var // Here we accept the property value
);
Parameters
ticket_number
[in] Order ticket.
property_id
[in] Identifier of the order property. The value can be one of the values of the
ENUM _ORDER_PR OPER T Y_INT EGER enumeration.
long_var
[out] Variable of the long type that accepts the value of the requested property.
Return Value
Do not confuse orders of a trading history with current pending orders that appear on the " Trade"
tab of the " Toolbox" bar. The list of orders that were canceled or have led to a transaction, can be
viewed in the "History" tab of " Toolbox" of the client terminal.
Example:
//+------------------------------------------------------------------+
//| Trade function |
//+------------------------------------------------------------------+
void OnTrade()
{
//--- receive the last order's ticket from week's trading history
ulong last_order=GetLastOrderTicket();
if(HistoryOrderSelect(last_order))
{
//--- time of placing an order in milliseconds since 01.01.1970
long time_setup_msc=HistoryOrderGetInteger(last_order,ORDER_TIME_SETUP_MSC);
PrintFormat("Order #%d ORDER_TIME_SETUP_MSC=%i64 => %s",
last_order,time_setup_msc,TimeToString(time_setup_msc/1000));
//--- order execution/cancellation time in milliseconds since 01.01.1970
long time_done_msc=HistoryOrderGetInteger(last_order,ORDER_TIME_DONE_MSC);
PrintFormat("Order #%d ORDER_TIME_DONE_MSC=%i64 => %s",
last_order,time_done_msc,TimeToString(time_done_msc/1000));
}
else // notify on failure
PrintFormat("HistoryOrderSelect() failed for #%d. Eror code=%d",
last_order,GetLastError());
//---
}
//+------------------------------------------------------------------+
//| Returns the last order ticket in history or -1 |
//+------------------------------------------------------------------+
ulong GetLastOrderTicket()
{
//--- request history for the last 7 days
if(!GetTradeHistory(7))
{
//--- notify on unsuccessful call and return -1
Print(__FUNCTION__," HistorySelect() returned false");
return -1;
}
//---
ulong first_order,last_order,orders=HistoryOrdersTotal();
//--- work with orders if there are any
if(orders>0)
{
Print("Orders = ",orders);
first_order=HistoryOrderGetTicket(0);
PrintFormat("first_order = %d",first_order);
if(orders>1)
{
last_order=HistoryOrderGetTicket((int)orders-1);
PrintFormat("last_order = %d",last_order);
return last_order;
}
return first_order;
}
//--- no order found, return -1
return -1;
}
//+--------------------------------------------------------------------------+
//| Requests history for the last days and returns false in case of failure |
//+--------------------------------------------------------------------------+
bool GetTradeHistory(int days)
{
//--- set a week period to request trade history
datetime to=TimeCurrent();
datetime from=to-days*PeriodSeconds(PERIOD_D1);
ResetLastError();
//--- make a request and check the result
if(!HistorySelect(from,to))
{
Print(__FUNCTION__," HistorySelect=false. Error code=",GetLastError());
return false;
}
//--- history received successfully
return true;
}
See also
H istoryS elect(), H istoryOrdersTotal(), H istoryOrderS elect(), Order Properties
HistoryOrderGetString
R eturnsthe requested property of an order. The order property must be of the string type. There are 2
variants of the function.
1. Immediately returns the property value.
string HistoryOrderGetString(
ulong ticket_number, // Ticket
ENUM_ORDER_PROPERTY_STRING property_id // Property identifier
);
2. R eturns true or false, depending on the success of the function. If successful, the value of the
property is placed into a target variable passed by reference by the last parameter.
bool HistoryOrderGetString(
ulong ticket_number, // Ticket
ENUM_ORDER_PROPERTY_STRING property_id, // Property identifier
string& string_var // Here we accept the property value
);
Parameters
ticket_number
[in] Order ticket.
property_id
[in] Identifier of the order property. The value can be one of the values of the
ENUM _ORDER_PR OPER T Y_S T R ING enumeration.
string_var
[out] Variable of the string type.
Return Value
Do not confuse orders of a trading history with current pending orders that appear on the " Trade"
tab of the " Toolbox" bar. The list of orders that were canceled or have led to a transaction, can be
viewed in the "History" tab of " Toolbox" of the client terminal.
See also
H istoryS elect(), H istoryOrdersTotal(), H istoryOrderS elect(), Order Properties
HistoryDealSelect
S electsa deal in the history for further calling it through appropriate functions. It returns true if the
function has been successfully completed. Returns false if the function has failed. For more details on
error call GetLastError().
bool HistoryDealSelect(
ulong ticket // Deal ticket
);
Parameters
ticket
[in] Deal tick et.
Return Value
Do not confuse orders, deals and positions. Each deal is the result of the execution of an order, each
position is the summary result of one or more deals.
H istoryDealS elect()clears in a mql5-program the list of deals available for reference, and copies the
single deal, if the execution of HistoryDealS elect() has been completed successfully. If you need to
go through all deals selected by the HistoryS elect() function, you should better use
H istoryDealGetTick et().
See also
H istoryS elect(), H istoryDealGetTick et(), Deal Properties
HistoryDealsTotal
R eturns the number of deal in history. Prior to calling HistoryDealsTotal(), first it is necessary to
receive the history of deals and orders using the HistoryS elect() or HistoryS electByPosition() function.
int HistoryDealsTotal();
Return Value
Do not confuse orders, deals and positions. Each deal is the result of the execution of an order, each
position is the summary result of one or more deals.
See also
H istoryS elect(), H istoryDealGetTick et(), Deal Properties
HistoryDealGetTicket
The function selects a deal for further processing and returns the deal ticket in history. Prior to calling
H istoryDealGetTick et(), first it is necessary to receive the history of deals and orders using the
H istoryS elect() or H istoryS electByPosition() function.
ulong HistoryDealGetTicket(
int index // ticket deal
);
Parameters
index
[in] Number of a deal in the list of deals
Return Value
Do not confuse orders, deals and positions. Each deal is the result of the execution of an order, each
position is the summary result of one or more deals.
Example:
void OnStart()
{
ulong deal_ticket; // deal ticket
ulong order_ticket; // ticket of the order the deal was executed on
datetime transaction_time; // time of a deal execution
long deal_type ; // type of a trade operation
long position_ID; // position ID
string deal_description; // operation description
double volume; // operation volume
string symbol; // symbol of the deal
//--- set the start and end date to request the history of deals
datetime from_date=0; // from the very beginning
datetime to_date=TimeCurrent();// till the current moment
//--- request the history of deals in the specified period
HistorySelect(from_date,to_date);
//--- total number in the list of deals
int deals=HistoryDealsTotal();
//--- now process each trade
for(int i=0;i<deals;i++)
{
deal_ticket= HistoryDealGetTicket(i);
volume= HistoryDealGetDouble(deal_ticket,DEAL_VOLUME);
transaction_time=(datetime)HistoryDealGetInteger(deal_ticket,DEAL_TIME);
order_ticket= HistoryDealGetInteger(deal_ticket,DEAL_ORDER);
deal_type= HistoryDealGetInteger(deal_ticket,DEAL_TYPE);
symbol= HistoryDealGetString(deal_ticket,DEAL_SYMBOL);
position_ID= HistoryDealGetInteger(deal_ticket,DEAL_POSITION_ID);
deal_description= GetDealDescription(deal_type,volume,symbol,order_ticket,position_I
//--- perform fine formatting for the deal number
string print_index=StringFormat("% 3d",i);
//--- show information on the deal
Print(print_index+": deal #",deal_ticket," at ",transaction_time,deal_description);
}
}
//+------------------------------------------------------------------+
//| Returns the string description of the operation |
//+------------------------------------------------------------------+
string GetDealDescription(long deal_type,double volume,string symbol,long ticket,long pos_ID)
{
string descr;
//---
switch(deal_type)
{
case DEAL_TYPE_BALANCE: return ("balance");
case DEAL_TYPE_CREDIT: return ("credit");
case DEAL_TYPE_CHARGE: return ("charge");
case DEAL_TYPE_CORRECTION: return ("correction");
case DEAL_TYPE_BUY: descr="buy"; break;
case DEAL_TYPE_SELL: descr="sell"; break;
case DEAL_TYPE_BONUS: return ("bonus");
case DEAL_TYPE_COMMISSION: return ("additional commission");
case DEAL_TYPE_COMMISSION_DAILY: return ("daily commission");
case DEAL_TYPE_COMMISSION_MONTHLY: return ("monthly commission");
case DEAL_TYPE_COMMISSION_AGENT_DAILY: return ("daily agent commission");
case DEAL_TYPE_COMMISSION_AGENT_MONTHLY: return ("monthly agent commission");
case DEAL_TYPE_INTEREST: return ("interest rate");
case DEAL_TYPE_BUY_CANCELED: descr="cancelled buy deal"; break;
case DEAL_TYPE_SELL_CANCELED: descr="cancelled sell deal"; break;
}
descr=StringFormat("%s %G %s (order #%d, position ID %d)",
descr, // current description
volume, // deal volume
symbol, // deal symbol
ticket, // ticket of the order that caused the deal
pos_ID // ID of a position, in which the deal is included
);
return(descr);
//---
}
See also
H istoryS elect(), H istoryDealsTotal(), H istoryDealS elect(), Deal Properties
HistoryDealGetDouble
R eturns the requested property of a deal. The deal property must be of the double type. There are 2
variants of the function.
1. Immediately returns the property value.
double HistoryDealGetDouble(
ulong ticket_number, // Ticket
ENUM_DEAL_PROPERTY_DOUBLE property_id // Property identifier
);
2. R eturns true or false, depending on the success of the function. If successful, the value of the
property is placed into a target variable passed by reference by the last parameter.
bool HistoryDealGetDouble(
ulong ticket_number, // Ticket
ENUM_DEAL_PROPERTY_DOUBLE property_id, // Property identifier
double& double_var // Here we accept the property value
);
Parameters
ticket_number
[in] Deal tick et.
property_id
[in] Identifier of a deal property. The value can be one of the values of the
ENUM _DEAL _PR OPER T Y_DOUBL E enumeration.
double_var
[out] Variable of the double type that accepts the value of the requested property.
Return Value
Do not confuse orders, deals and positions. Each deal is the result of the execution of an order, each
position is the summary result of one or more deals.
See also
H istoryS elect(), H istoryDealsTotal(), H istoryDealGetTick et(), Deal Properties
HistoryDealGetInteger
R eturns the requested property of a deal. The deal property must be of the datetime, int type. There
are 2 variants of the function.
1. Immediately returns the property value.
long HistoryDealGetInteger(
ulong ticket_number, // Ticket
ENUM_DEAL_PROPERTY_INTEGER property_id // Property identifier
);
2. R eturns true or false, depending on the success of the function. If successful, the value of the
property is placed into a target variable passed by reference by the last parameter.
bool HistoryDealGetInteger(
ulong ticket_number, // Ticket
ENUM_DEAL_PROPERTY_INTEGER property_id, // Property identifier
long& long_var // Here we accept the property value
);
Parameters
ticket_number
[in] Trade ticket.
property_id
[in] Identifier of the deal property. The value can be one of the values of the
ENUM _DEAL _PR OPER T Y_INT EGER enumeration.
long_var
[out] Variable of the long type that accepts the value of the requested property.
Return Value
Do not confuse orders, deals and positions. Each deal is the result of the execution of an order, each
position is the summary result of one or more deals.
Example:
//+------------------------------------------------------------------+
//| Trade function |
//+------------------------------------------------------------------+
void OnTrade()
{
//--- receive the last deal's ticket from week's trading history
ulong last_deal=GetLastDealTicket();
if(HistoryDealSelect(last_deal))
{
ResetLastError();
//--- make a request and check the result
if(!HistorySelect(from,to))
{
Print(__FUNCTION__," HistorySelect=false. Error code=",GetLastError());
return false;
}
//--- history received successfully
return true;
}
See also
H istoryDealsTotal(), H istoryS elect(), H istoryDealGetTick et(), Deal Properties
HistoryDealGetString
R eturns the requested property of a deal. The deal property must be of the string type. There are 2
variants of the function.
1. Immediately returns the property value.
string HistoryDealGetString(
ulong ticket_number, // Ticket
ENUM_DEAL_PROPERTY_STRING property_id // Property identifier
);
2. R eturns true or false, depending on the success of the function. If successful, the value of the
property is placed into a target variable passed by reference by the last parameter.
bool HistoryDealGetString(
ulong ticket_number, // Ticket
ENUM_DEAL_PROPERTY_STRING property_id, // Property identifier
string& string_var // Here we accept the property value
);
Parameters
ticket_number
[in] Deal tick et.
property_id
[in] Identifier of the deal property. The value can be one of the values of the
ENUM _DEAL _PR OPER T Y_S T R ING enumeration.
string_var
[out] Variable of the string type that accepts the value of the requested property.
Return Value
Do not confuse orders, deals and positions. Each deal is the result of the execution of an order, each
position is the summary result of one or more deals.
See also
H istoryDealsTotal(), H istoryS elect(), H istoryDealGetTick et(), Deal Properties
Trade Signals
This is the group of functions intended for managing trade signals. The functions allow:
· get information about trade signals, available for copying,
· get and set the signal copy settings,
· subscribe and unsubscribe to the signal copying using MQL5 language functions.
Function Action
S ignalBaseGetDouble R eturns the value of double type property for selected signal
S ignalBaseGetInteger R eturns the value of integer type property for selected signal
S ignalBaseGetS tring R eturns the value of string type property for selected signal
S ignalBaseS elect S elects a signal from signals, available in terminal for further
working with it
S ignalBaseTotal R eturns the total amount of signals, available in terminal
S ignalInfoGetDouble R eturns the value of double type property of signal copy settings
S ignalInfoGetInteger R eturns the value of integer type property of signal copy settings
S ignalInfoGetS tring R eturns the value of string type property of signal copy settings
S ignalInfoS etDouble S ets the value of double type property of signal copy settings
S ignalInfoS etInteger S ets the value of integer type property of signal copy settings
S ignalS ubscribe S ubscribes to the trading signal
S ignalUnsubscribe Cancels subscription
SignalBaseGetDouble
R eturns the value of double type property for selected signal.
double SignalBaseGetDouble(
ENUM_SIGNAL_BASE_DOUBLE property_id, // property identifier
);
Parameters
property_id
[in] S ignal property identifier. The value can be one of the values of the
ENUM _S IGNAL _BASE_DOUBL E enumeration.
Return Value
SignalBaseGetInteger
R eturns the value of integer type property for selected signal.
long SignalBaseGetInteger(
ENUM_SIGNAL_BASE_INTEGER property_id, // property identifier
);
Parameters
property_id
[in] S ignal property identifier. The value can be one of the values of the
ENUM _S IGNAL _BASE_INT EGER enumeration.
Return Value
SignalBaseGetString
R eturns the value of string type property for selected signal.
string SignalBaseGetString(
ENUM_SIGNAL_BASE_STRING property_id, // property identifier
);
Parameters
property_id
[in] S ignal property identifier. The value can be one of the values of the
ENUM _S IGNAL _BASE_S T R ING enumeration.
Return Value
SignalBaseSelect
S elects a signal from signals, available in terminal for further working with it.
bool SignalBaseSelect(
int index // signal index
);
Parameters
index
[in] S ignal index in base of trading signals.
Return Value
R eturns true if successful, otherwise returns false. To read more about the error call GetLastError().
Example:
void OnStart()
{
//--- get total amount of signals in the terminal
int total=SignalBaseTotal();
//--- process all signals
for(int i=0;i<total;i++)
{
//--- select the signal by index
if(SignalBaseSelect(i))
{
//--- get signal properties
long id =SignalBaseGetInteger(SIGNAL_BASE_ID); // signal id
long pips =SignalBaseGetInteger(SIGNAL_BASE_PIPS); // profit in pips
long subscr=SignalBaseGetInteger(SIGNAL_BASE_SUBSCRIBERS); // number of subscribers
string name =SignalBaseGetString(SIGNAL_BASE_NAME); // signal name
double price =SignalBaseGetDouble(SIGNAL_BASE_PRICE); // signal price
string curr =SignalBaseGetString(SIGNAL_BASE_CURRENCY); // signal currency
//--- print all profitable free signals with subscribers
if(price==0.0 && pips>0 && subscr>0)
PrintFormat("id=%d, name=\"%s\", currency=%s, pips=%d, subscribers=%d",id,name,curr,pip
}
else PrintFormat("Error in call of SignalBaseSelect. Error code=%d",GetLastError());
}
}
SignalBaseTotal
R eturns the total amount of signals, available in terminal.
int SignalBaseTotal();
Return Value
SignalInfoGetDouble
R eturns the value of double type property of signal copy settings.
double SignalInfoGetDouble(
ENUM_SIGNAL_INFO_DOUBLE property_id, // property identifier
);
Parameters
property_id
[in] S ignal copy settings property identifier. The value can be one of the values of the
ENUM _S IGNAL _INFO_DOUBL E enumeration.
Return Value
SignalInfoGetInteger
R eturns the value of integer type property of signal copy settings.
long SignalInfoGetInteger(
ENUM_SIGNAL_INFO_INTEGER property_id, // property identifier
);
Parameters
property_id
[in] S ignal copy settings property identifier. The value can be one of the values of the
ENUM _S IGNAL _INFO_INT EGER enumeration.
Return Value
SignalInfoGetString
R eturns the value of string type property of signal copy settings.
string SignalInfoGetString(
ENUM_SIGNAL_INFO_STRING property_id, // property identifier
);
Parameters
property_id
[in] S ignal copy settings property identifier. The value can be one of the values of the
ENUM _S IGNAL _INFO_S T R ING enumeration.
Return Value
SignalInfoSetDouble
S ets the value of double type property of signal copy settings.
bool SignalInfoSetDouble(
ENUM_SIGNAL_INFO_DOUBLE property_id, // property identifier
double value // new value
);
Parameters
property_id
[in] S ignal copy settings property identifier. The value can be one of the values of the
ENUM _S IGNAL _INFO_DOUBL E enumeration.
value
[in] The value of signal copy settings property.
Return Value
R eturns true if property has been changed, otherwise returns false. To read more about the error
call GetLastError().
SignalInfoSetInteger
S ets the value of integer type property of signal copy settings.
bool SignalInfoSetInteger(
ENUM_SIGNAL_INFO_INTEGER property_id, // property identifier
long value // new value
);
Parameters
property_id
[in] S ignal copy settings property identifier. The value can be one of the values of the
ENUM _S IGNAL _INFO_INT EGER enumeration.
value
[in] The value of signal copy settings property.
Return Value
R eturns true if property has been changed, otherwise returns false. To read more about the error
call GetLastError().
SignalSubscribe
S ubscribes to the trading signal.
bool SignalSubscribe(
long signal_id // signal id
);
Parameters
signal_id
[in] S ignal identifier.
Return Value
R eturns true if subscription was successful, otherwise returns false. To read more about the error
call GetLastError().
SignalUnsubscribe
Cancels subscription.
bool SignalUnsubscribe();
Return Value
R eturnstrue if subscription has been canceled successfully, otherwise returns false. To read more
about the error call GetLastError().
Network functions
MQL5 programs can exchange data with remote servers, as well as send push notifications, emails and
data via FTP.
· The S ocket* group of functions allows establishing a TCP connection (including a secure TLS ) with a
remote host via system sockets. The operation principle is simple: create a socket, connect to the
server and start reading and writing data.
· The W ebRequest function is designed to work with web resources and allows sending HTTP requests
(including GET and POS T) easily.
· S endFTP, S endMail and S endNotification are more simple functions for sending files, emails and
mobile notifications.
For end-user security, the list of allowed IP addresses is implemented on the client terminal side. The
list contains IP addresses the MQL5 program is allowed to connect to via the S ocket* and W ebRequest
functions. For example, if the program needs to connect to https ://www.someserver.com, this
address should be explicitly indicated by a terminal user in the list. An address cannot be added
programmatically.
Add an explicit message to the MQL5 program to notify a user of the need for additional configuration.
You can do that via #property description, Alert or Print.
Function Action
S ock etCreate Create a socket with specified flags and return its handle
S ock etClose Close a socket
S ock etConnect Connect to the server with timeout control
S ock etIsConnected Checks if the socket is currently connected
Function Action
S ock etIs R eadable Get a number of bytes that can be read from a socket
S ock etIs W ritable Check whether data can be written to a socket at the current time
S ock etTimeouts S ettimeouts for receiving and sending data for a socket system
object
S ock etR ead R ead data from a socket
S ock etS end W rite data to a socket
S ock etTls H andshak e Initiate secure TLS (SS L) connection to a specified host via TLS
H andshak e protocol
S ock etTlsCertificate Get data on the certificate used to secure network connection
S ock etTls R ead R ead data from secure TLS connection
S ock etTls R eadAvailable R ead all available data from secure TLS connection
S ock etTls S end S end data via secure TLS connection
W ebR equest S end an H TTP request to a specified server
S endFTP S end a file to an address specified on the FTP tab
S endMail S end an email to an address specified in the Email tab of the
options window
S endNotification S end push notifications to mobile terminals whose MetaQuotes IDs
are specified in the Notifications tab
SocketCreate
Create a socket with specified flags and return its handle.
int SocketCreate(
uint flags // flags
);
Parameters
flags
[in]Combination of flags defining the mode of working with a socket. Currently, only one flag is
supported — S OCKET_DEFAULT.
Return Value
To free up computer memory from an unused socket, call S ocketClose for it.
You can create a maximum of 128 sockets from one MQL5 program. If the limit is exceeded, the
error 5271 (ERR_NETS OCKET_TOO_M ANY_OPENED) is written to _LastError.
The function can be called only from Expert Advisors and scripts, as they run in their own execution
threads. If calling from an indicator, GetLastError() returns the error 4014 – "Function is not allowed
for call" .
Example:
//+------------------------------------------------------------------+
//| SocketExample.mq5 |
//| Copyright 2018, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property description "Add Address to the list of allowed ones in the terminal settings to let the
#property script_show_inputs
return(false);
//--- if secure TLS connection is used via the port 443
if(ExtTLS)
return(SocketTlsSend(socket,req,len)==len);
//--- if standard TCP connection is used
return(SocketSend(socket,req,len)==len);
}
//+------------------------------------------------------------------+
//| Read server response |
//+------------------------------------------------------------------+
bool HTTPRecv(int socket,uint timeout)
{
char rsp[];
string result;
uint timeout_check=GetTickCount()+timeout;
//--- read data from sockets till they are still present but not longer than timeout
do
{
uint len=SocketIsReadable(socket);
if(len)
{
int rsp_len;
//--- various reading commands depending on whether the connection is secure or not
if(ExtTLS)
rsp_len=SocketTlsRead(socket,rsp,len);
else
rsp_len=SocketRead(socket,rsp,len,timeout);
//--- analyze the response
if(rsp_len>0)
{
result+=CharArrayToString(rsp,0,rsp_len);
//--- print only the response header
int header_end=StringFind(result,"\r\n\r\n");
if(header_end>0)
{
Print("HTTP answer header received:");
Print(StringSubstr(result,0,header_end));
return(true);
}
}
}
}
while(GetTickCount()<timeout_check && !IsStopped());
return(false);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
int socket=SocketCreate();
//--- check the handle
if(socket!=INVALID_HANDLE)
{
//--- connect if all is well
if(SocketConnect(socket,Address,Port,1000))
{
Print("Established connection to ",Address,":",Port);
string subject,issuer,serial,thumbprint;
datetime expiration;
//--- if connection is secured by the certificate, display its data
if(SocketTlsCertificate(socket,subject,issuer,serial,thumbprint,expiration))
{
Print("TLS certificate:");
Print(" Owner: ",subject);
Print(" Issuer: ",issuer);
Print(" Number: ",serial);
Print(" Print: ",thumbprint);
Print(" Expiration: ",expiration);
ExtTLS=true;
}
//--- send GET request to the server
if(HTTPSend(socket,"GET / HTTP/1.1\r\nHost: www.mql5.com\r\nUser-Agent: MT5\r\n\r\n"))
{
Print("GET request sent");
//--- read the response
if(!HTTPRecv(socket,1000))
Print("Failed to get a response, error ",GetLastError());
}
else
Print("Failed to send GET request, error ",GetLastError());
}
else
{
Print("Connection to ",Address,":",Port," failed, error ",GetLastError());
}
//--- close a socket after using
SocketClose(socket);
}
else
Print("Failed to create a socket, error ",GetLastError());
}
//+------------------------------------------------------------------+
SocketClose
Close a socket.
bool SocketClose(
const int socket // socket handle
);
Parameters
socket
[in] H andle ofa socket to be closed. The handle is returned by the S ocketCreate function. W hen
an incorrect handle is passed, the error 5270 (ERR_NETS OCKET_INVALIDHANDLE) is written to
_LastError.
Return Value
//+------------------------------------------------------------------+
//| SocketExample.mq5 |
//| Copyright 2018, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property description "Add Address to the list of allowed ones in the terminal settings to let the
#property script_show_inputs
int socket=SocketCreate();
//--- check the handle
if(socket!=INVALID_HANDLE)
{
//--- connect if all is well
if(SocketConnect(socket,Address,Port,1000))
{
Print("Established connection to ",Address,":",Port);
string subject,issuer,serial,thumbprint;
datetime expiration;
//--- if connection is secured by the certificate, display its data
if(SocketTlsCertificate(socket,subject,issuer,serial,thumbprint,expiration))
{
Print("TLS certificate:");
Print(" Owner: ",subject);
Print(" Issuer: ",issuer);
Print(" Number: ",serial);
Print(" Print: ",thumbprint);
Print(" Expiration: ",expiration);
ExtTLS=true;
}
//--- send GET request to the server
if(HTTPSend(socket,"GET / HTTP/1.1\r\nHost: www.mql5.com\r\nUser-Agent: MT5\r\n\r\n"))
{
Print("GET request sent");
//--- read the response
if(!HTTPRecv(socket,1000))
Print("Failed to get a response, error ",GetLastError());
}
else
Print("Failed to send GET request, error ",GetLastError());
}
else
{
Print("Connection to ",Address,":",Port," failed, error ",GetLastError());
}
//--- close a socket after using
SocketClose(socket);
}
else
Print("Failed to create a socket, error ",GetLastError());
}
//+------------------------------------------------------------------+
SocketConnect
Connect to the server with timeout control.
bool SocketConnect(
int socket, // socket
const string server, // connection address
uint port, // connection port
uint timeout_receive_ms // connection timeout
);
Parameters
socket
[in] S ock et handle returned by the S ock etCreate function. W hen an incorrect handle is passed, the
error 5270 (ERR_NETS OCKET_INVALIDHANDLE) is written to _LastError.
server
[in] Domain name of the server you want to connect to or its IP address.
port
[in] Connection port number.
timeout_receive_ms
[in]Connection timeout in milliseconds. If connection is not established within that time interval,
attempts are stopped.
Return Value
Connection address should be added to the list of allowed ones on the client terminal side (Tools \
Options \ Expert Advisors).
If connection fails, error 5272 (ERR_NETS OCKET_CANNOT_CONNECT) is written to _LastError.
The function can be called only from Expert Advisors and scripts, as they run in their own execution
threads. If calling from an indicator, GetLastError() returns the error 4014 – "Function is not allowed
for call" .
Example:
//+------------------------------------------------------------------+
//| SocketExample.mq5 |
//| Copyright 2018, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property description "Add Address to the list of allowed ones in the terminal settings to let the
#property script_show_inputs
return(true);
}
}
}
}
while(GetTickCount()<timeout_check && !IsStopped());
return(false);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
int socket=SocketCreate();
//--- check the handle
if(socket!=INVALID_HANDLE)
{
//--- connect if all is well
if(SocketConnect(socket,Address,Port,1000))
{
Print("Established connection to ",Address,":",Port);
string subject,issuer,serial,thumbprint;
datetime expiration;
//--- if connection is secured by the certificate, display its data
if(SocketTlsCertificate(socket,subject,issuer,serial,thumbprint,expiration))
{
Print("TLS certificate:");
Print(" Owner: ",subject);
Print(" Issuer: ",issuer);
Print(" Number: ",serial);
Print(" Print: ",thumbprint);
Print(" Expiration: ",expiration);
ExtTLS=true;
}
//--- send GET request to the server
if(HTTPSend(socket,"GET / HTTP/1.1\r\nHost: www.mql5.com\r\nUser-Agent: MT5\r\n\r\n"))
{
Print("GET request sent");
//--- read the response
if(!HTTPRecv(socket,1000))
Print("Failed to get a response, error ",GetLastError());
}
else
Print("Failed to send GET request, error ",GetLastError());
}
else
{
Print("Connection to ",Address,":",Port," failed, error ",GetLastError());
}
//--- close a socket after using
SocketClose(socket);
}
else
Print("Failed to create a socket, error ",GetLastError());
}
//+------------------------------------------------------------------+
SocketIsConnected
Checks if the socket is currently connected.
bool SocketIsConnected(
const int socket // socket handle
);
Parameters
socket
[in] S ock et handle returned by the S ock etCreate() function. W hen an incorrect handle is passed to
_LastError, the error 5270 (ERR_NET S OCKET _INVALIDHANDL E) is activated.
Return Value
The S ocketIsConnected() function allows checking the current socket connection status.
The function can be called only from Expert Advisors and scripts, as they run in their own execution
threads. If calling from an indicator, GetLastError() returns the error 4014 – "Function is not allowed
for call" .
See also
S ock etConnect, S ock etIs W ritable, S ock etCreate, S ock etClose
SocketIsReadable
Get a number of bytes that can be read from a socket.
uint SocketIsReadable(
const int socket // socket handle
);
Parameters
socket
[in] S ock et handle returned by the S ock etCreate function. W hen an incorrect handle is passed to
_LastError, the error 5270 (ERR_NET S OCKET _INVALIDHANDL E) is activated.
Return Value
If an error occurs on a system socket when executing the function, connection established via
S ock etConnect is discontinued.
Before calling S ock etR ead, check if the sock et features data for reading. Otherwise, if there are no
data, the S ocketRead function waits for data within timeout_ms delaying the program execution.
The function can be called only from Expert Advisors and scripts, as they run in their own execution
threads. If calling from an indicator, GetLastError() returns the error 4014 – "Function is not allowed
for call" .
Example:
//+------------------------------------------------------------------+
//| SocketExample.mq5 |
//| Copyright 2018, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property description "Add Address to the list of allowed ones in the terminal settings to let the
#property script_show_inputs
if(len<0)
return(false);
//--- if secure TLS connection is used via the port 443
if(ExtTLS)
return(SocketTlsSend(socket,req,len)==len);
//--- if standard TCP connection is used
return(SocketSend(socket,req,len)==len);
}
//+------------------------------------------------------------------+
//| Read server response |
//+------------------------------------------------------------------+
bool HTTPRecv(int socket,uint timeout)
{
char rsp[];
string result;
uint timeout_check=GetTickCount()+timeout;
//--- read data from sockets till they are still present but not longer than timeout
do
{
uint len=SocketIsReadable(socket);
if(len)
{
int rsp_len;
//--- various reading commands depending on whether the connection is secure or not
if(ExtTLS)
rsp_len=SocketTlsRead(socket,rsp,len);
else
rsp_len=SocketRead(socket,rsp,len,timeout);
//--- analyze the response
if(rsp_len>0)
{
result+=CharArrayToString(rsp,0,rsp_len);
//--- print only the response header
int header_end=StringFind(result,"\r\n\r\n");
if(header_end>0)
{
Print("HTTP answer header received:");
Print(StringSubstr(result,0,header_end));
return(true);
}
}
}
}
while(GetTickCount()<timeout_check && !IsStopped());
return(false);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
int socket=SocketCreate();
//--- check the handle
if(socket!=INVALID_HANDLE)
{
//--- connect if all is well
if(SocketConnect(socket,Address,Port,1000))
{
Print("Established connection to ",Address,":",Port);
string subject,issuer,serial,thumbprint;
datetime expiration;
//--- if connection is secured by the certificate, display its data
if(SocketTlsCertificate(socket,subject,issuer,serial,thumbprint,expiration))
{
Print("TLS certificate:");
Print(" Owner: ",subject);
Print(" Issuer: ",issuer);
Print(" Number: ",serial);
Print(" Print: ",thumbprint);
Print(" Expiration: ",expiration);
ExtTLS=true;
}
//--- send GET request to the server
if(HTTPSend(socket,"GET / HTTP/1.1\r\nHost: www.mql5.com\r\nUser-Agent: MT5\r\n\r\n"))
{
Print("GET request sent");
//--- read the response
if(!HTTPRecv(socket,1000))
Print("Failed to get a response, error ",GetLastError());
}
else
Print("Failed to send GET request, error ",GetLastError());
}
else
{
Print("Connection to ",Address,":",Port," failed, error ",GetLastError());
}
//--- close a socket after using
SocketClose(socket);
}
else
Print("Failed to create a socket, error ",GetLastError());
}
//+------------------------------------------------------------------+
SocketIsWritable
Check whether data can be written to a socket at the current time.
bool SocketIsWritable(
const int socket // socket handle
);
Parameters
socket
[in] S ock et handle returned by the S ock etCreate function. W hen an incorrect handle is passed, the
error 5270 (ERR_NETS OCKET_INVALIDHANDLE) is written to _LastError.
Return Value
This function allows you to check whether it is possible to write data to a socket right now.
If an error occurs on a system socket when executing the function, connection established via
S ock etConnect is discontinued.
The function can be called only from Expert Advisors and scripts, as they run in their own execution
threads. If calling from an indicator, GetLastError() returns the error 4014 – "Function is not allowed
for call" .
SocketTimeouts
S et timeouts for receiving and sending data for a socket system object.
bool SocketTimeouts(
int socket, // socket
uint timeout_send_ms, // data sending timeout
uint timeout_receive_ms // data obtaining timeout
);
Parameters
socket
[in] S ock et handle returned by the S ock etCreate function. W hen an incorrect handle is passed, the
error 5270 (ERR_NETS OCKET_INVALIDHANDLE) is written to _LastError.
timeout_send_ms
[in] Data sending timeout in milliseconds.
timeout_receive_ms
[in] Data obtaining timeout in milliseconds.
Return Value
Do not confuse system object timeouts with the ones set when reading data via S ocketRead.
S ock etTimeout sets timeouts once for a sock et object in the operating system. These timeouts are
to be applied to all functions for reading and sending data via this socket. In S ocketRead, the
timeout is set for a certain data reading operation.
The function can be called only from Expert Advisors and scripts, as they run in their own execution
threads. If calling from an indicator, GetLastError() returns the error 4014 – "Function is not allowed
for call" .
SocketRead
R ead data from a socket.
int SocketRead(
int socket, // socket
uchar& buffer[], // buffer for reading data from socket
uint buffer_maxlen, // number of bytes to read
uint timeout_ms // reading timeout
);
Parameters
socket
[in] S ock et handle returned by the S ock etCreate function. W hen an incorrect handle is passed to
_LastError, the error 5270 (ERR_NET S OCKET _INVALIDHANDL E) is activated.
buffer
[out] R eference tothe uchar type array the data is read in. Dynamic array size is increased by the
number of read bytes. The array size cannot exceed INT_M AX (2147483647).
buffer_maxlen
[in] Number of bytes to read to the buffer[] array. Data not fitting into the array remain in the
socket. They can be received by the next S ocketRead call. buffer_maxlen cannot exceed INT_M AX
(2147483647).
timeout_ms
[in] Data reading timeout in milliseconds. If data is not obtained within this time, attempts are
stopped and the function returns -1.
Return Value
If an error occurs on a system socket when executing the function, connection established via
S ock etConnect is discontinued.
In case of a data reading error, the error 5273 (ERR_NETS OCKET_IO_ERROR) is written in
_LastError.
The function can be called only from Expert Advisors and scripts, as they run in their own execution
threads. If calling from an indicator, GetLastError() returns the error 4014 – "Function is not allowed
for call" .
Example:
//+------------------------------------------------------------------+
//| SocketExample.mq5 |
//| Copyright 2018, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
if(header_end>0)
{
Print("HTTP answer header received:");
Print(StringSubstr(result,0,header_end));
return(true);
}
}
}
}
while(GetTickCount()<timeout_check && !IsStopped());
return(false);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
int socket=SocketCreate();
//--- check the handle
if(socket!=INVALID_HANDLE)
{
//--- connect if all is well
if(SocketConnect(socket,Address,Port,1000))
{
Print("Established connection to ",Address,":",Port);
string subject,issuer,serial,thumbprint;
datetime expiration;
//--- if connection is secured by the certificate, display its data
if(SocketTlsCertificate(socket,subject,issuer,serial,thumbprint,expiration))
{
Print("TLS certificate:");
Print(" Owner: ",subject);
Print(" Issuer: ",issuer);
Print(" Number: ",serial);
Print(" Print: ",thumbprint);
Print(" Expiration: ",expiration);
ExtTLS=true;
}
//--- send GET request to the server
if(HTTPSend(socket,"GET / HTTP/1.1\r\nHost: www.mql5.com\r\nUser-Agent: MT5\r\n\r\n"))
{
Print("GET request sent");
//--- read the response
if(!HTTPRecv(socket,1000))
Print("Failed to get a response, error ",GetLastError());
}
else
Print("Failed to send GET request, error ",GetLastError());
}
else
{
Print("Connection to ",Address,":",Port," failed, error ",GetLastError());
}
//--- close a socket after using
SocketClose(socket);
}
else
Print("Failed to create a socket, error ",GetLastError());
}
//+------------------------------------------------------------------+
See also
S ock etTimeouts, MathS wap
SocketSend
W rite data to a socket.
int SocketSend(
int socket, // socket
const uchar& buffer[], // data buffer
uint buffer_len // buffer size
);
Parameters
socket
[in] S ock et handle returned by the S ock etCreate function. W hen an incorrect handle is passed, the
error 5270 (ERR_NETS OCKET_INVALIDHANDLE) is written to _LastError.
buffer
[in] R eference to the uchar type array with the data to be sent to the socket.
buffer_len
[in] 'buffer' array size.
Return Value
If successful, return the number of bytes written to a socket. In case of an error, -1 is returned.
Note
If an error occurs on a system socket when executing the function, connection established via
S ock etConnect is discontinued.
In case of a data writing error, the error 5273 (ERR_NETS OCKET_IO_ERROR) is written to
_LastError.
The function can be called only from Expert Advisors and scripts, as they run in their own execution
threads. If calling from an indicator, GetLastError() returns the error 4014 – "Function is not allowed
for call" .
Example:
//+------------------------------------------------------------------+
//| SocketExample.mq5 |
//| Copyright 2018, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property description "Add Address to the list of allowed ones in the terminal settings to let the
#property script_show_inputs
}
}
while(GetTickCount()<timeout_check && !IsStopped());
return(false);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
int socket=SocketCreate();
//--- check the handle
if(socket!=INVALID_HANDLE)
{
//--- connect if all is well
if(SocketConnect(socket,Address,Port,1000))
{
Print("Established connection to ",Address,":",Port);
string subject,issuer,serial,thumbprint;
datetime expiration;
//--- if connection is secured by the certificate, display its data
if(SocketTlsCertificate(socket,subject,issuer,serial,thumbprint,expiration))
{
Print("TLS certificate:");
Print(" Owner: ",subject);
Print(" Issuer: ",issuer);
Print(" Number: ",serial);
Print(" Print: ",thumbprint);
Print(" Expiration: ",expiration);
ExtTLS=true;
}
//--- send GET request to the server
if(HTTPSend(socket,"GET / HTTP/1.1\r\nHost: www.mql5.com\r\nUser-Agent: MT5\r\n\r\n"))
{
Print("GET request sent");
//--- read the response
if(!HTTPRecv(socket,1000))
Print("Failed to get a response, error ",GetLastError());
}
else
Print("Failed to send GET request, error ",GetLastError());
}
else
{
Print("Connection to ",Address,":",Port," failed, error ",GetLastError());
}
//--- close a socket after using
SocketClose(socket);
}
else
Print("Failed to create a socket, error ",GetLastError());
}
//+------------------------------------------------------------------+
See also
S ock etTimeouts, MathS wap, S tringToCharArray
SocketTlsHandshake
Initiate secure TLS (SS L) connection to a specified host via TLS Handshake protocol. During
H andshak e, a client and a server agree on connection parameters : applied protocol version and data
encryption method.
bool SocketTlsHandshake(
int socket, // socket
const string host // host address
);
Parameters
socket
[in] S ock et handle returned by the S ock etCreate function. W hen an incorrect handle is passed, the
error 5270 (ERR_NETS OCKET_INVALIDHANDLE) is written to _LastError.
host
[in] Address of a host a secure connection is established with.
Return Value
Before a secure connection, the program should establish a standard TCP connection with the host
using S ocketConnect.
If secure connection fails, the error 5274 (ERR_NETS OCKET_HANDSHAKE_FAILED) is written to
_LastError.
There is no need to call the function when connecting to the port 443. This is a standard TCP port
used for secure TLS (SS L) connections.
The function can be called only from Expert Advisors and scripts, as they run in their own execution
threads. If calling from an indicator, GetLastError() returns the error 4014 – "Function is not allowed
for call" .
SocketTlsCertificate
Get data on the certificate used to secure network connection.
int SocketTlsCertificate(
int socket, // socket
string& subject, // certificate owner
string& issuer, // certificate issuer
string& serial, // certificate serial number
string& thumbprint, // certificate print
datetime& expiration // certificate expiration
);
Parameters
socket
[in] S ock et handle returned by the S ock etCreate function. W hen an incorrect handle is passed, the
error 5270 (ERR_NETS OCKET_INVALIDHANDLE) is written to _LastError.
subject
[in] Certificate owner name. Corresponds to the S ubject field.
issuer
[in] Certificate issuer name. Corresponds to the Issuer field.
serial
[in] Certificate serial number. Corresponds to the S erialNumber field.
thumbprint
[in] Certificate print. Corresponds to the SHA-1 hash from the entire certificate file (all fields
including the issuer signature).
expiration
[in] Certificate expiration date in the datetime format.
Return Value
Certificate data can be requested only after establishing a secure connection using
S ock etTls H andshak e.
//+------------------------------------------------------------------+
//| SocketExample.mq5 |
//| Copyright 2018, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property description "Add Address to the list of allowed ones in the terminal settings to let the
#property script_show_inputs
if(rsp_len>0)
{
result+=CharArrayToString(rsp,0,rsp_len);
//--- print only the response header
int header_end=StringFind(result,"\r\n\r\n");
if(header_end>0)
{
Print("HTTP answer header received:");
Print(StringSubstr(result,0,header_end));
return(true);
}
}
}
}
while(GetTickCount()<timeout_check && !IsStopped());
return(false);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
int socket=SocketCreate();
//--- check the handle
if(socket!=INVALID_HANDLE)
{
//--- connect if all is well
if(SocketConnect(socket,Address,Port,1000))
{
Print("Established connection to ",Address,":",Port);
string subject,issuer,serial,thumbprint;
datetime expiration;
//--- if connection is secured by the certificate, display its data
if(SocketTlsCertificate(socket,subject,issuer,serial,thumbprint,expiration))
{
Print("TLS certificate:");
Print(" Owner: ",subject);
Print(" Issuer: ",issuer);
Print(" Number: ",serial);
Print(" Print: ",thumbprint);
Print(" Expiration: ",expiration);
ExtTLS=true;
}
//--- send GET request to the server
if(HTTPSend(socket,"GET / HTTP/1.1\r\nHost: www.mql5.com\r\nUser-Agent: MT5\r\n\r\n"))
{
Print("GET request sent");
//--- read the response
if(!HTTPRecv(socket,1000))
Print("Failed to get a response, error ",GetLastError());
}
else
Print("Failed to send GET request, error ",GetLastError());
}
else
{
Print("Connection to ",Address,":",Port," failed, error ",GetLastError());
}
//--- close a socket after using
SocketClose(socket);
}
else
Print("Failed to create a socket, error ",GetLastError());
}
//+------------------------------------------------------------------+
SocketTlsRead
R ead data from secure TLS connection.
int SocketTlsRead(
int socket, // socket
uchar& buffer[], // buffer for reading data from socket
uint buffer_maxlen // number of bytes to read
);
Parameters
socket
[in] S ock et handle returned by the S ock etCreate function. W hen an incorrect handle is passed to
_LastError, the error 5270 (ERR_NET S OCKET _INVALIDHANDL E) is activated.
buffer
[out] R eference tothe uchar type array the data is read in. Dynamic array size is increased by the
number of read bytes. The array size cannot exceed INT_M AX (2147483647).
buffer_maxlen
[in] Number of bytes to read to the buffer[] array. Data not fitting into the array remain in the
socket. They can be received by the next S ocketTLSRead call. buffer_maxlen cannot exceed
INT_M AX (2147483647).
Return Value
If an error occurs on a system socket when executing the function, connection established via
S ock etConnect is discontinued.
The function is executed till it receives the specified amount of data or the timeout is reached
(S ocketTimeouts).
In case of a data reading error, the error 5273 (ERR_NETS OCKET_IO_ERROR) is written in
_LastError.
The function can be called only from Expert Advisors and scripts, as they run in their own execution
threads. If calling from an indicator, GetLastError() returns the error 4014 – "Function is not allowed
for call" .
Example:
//+------------------------------------------------------------------+
//| SocketExample.mq5 |
//| Copyright 2018, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property description "Add Address to the list of allowed ones in the terminal settings to let the
#property script_show_inputs
string subject,issuer,serial,thumbprint;
datetime expiration;
//--- if connection is secured by the certificate, display its data
if(SocketTlsCertificate(socket,subject,issuer,serial,thumbprint,expiration))
{
Print("TLS certificate:");
Print(" Owner: ",subject);
Print(" Issuer: ",issuer);
Print(" Number: ",serial);
Print(" Print: ",thumbprint);
Print(" Expiration: ",expiration);
ExtTLS=true;
}
//--- send GET request to the server
if(HTTPSend(socket,"GET / HTTP/1.1\r\nHost: www.mql5.com\r\nUser-Agent: MT5\r\n\r\n"))
{
Print("GET request sent");
//--- read the response
if(!HTTPRecv(socket,1000))
Print("Failed to get a response, error ",GetLastError());
}
else
Print("Failed to send GET request, error ",GetLastError());
}
else
{
Print("Connection to ",Address,":",Port," failed, error ",GetLastError());
}
//--- close a socket after using
SocketClose(socket);
}
else
Print("Failed to create a socket, error ",GetLastError());
}
//+------------------------------------------------------------------+
See also
S ock etTimeouts, MathS wap
SocketTlsReadAvailable
R ead all available data from secure TLS connection.
int SocketTlsReadAvailable(
int socket, // socket
uchar& buffer[], // buffer for reading data from socket
const uint buffer_maxlen // number of bytes to read
);
Parameters
socket
[in] S ock et handle returned by the S ock etCreate function. W hen an incorrect handle is passed to
_LastError, the error 5270 (ERR_NET S OCKET _INVALIDHANDL E) is activated.
buffer
[out] R eference tothe uchar type array the data is read in. Dynamic array size is increased by the
number of read bytes. The array size cannot exceed INT_M AX (2147483647).
buffer_maxlen
[in] Number of bytes to read to the buffer[] array. Data not fitting into the array remain in the
socket. They can be received by the next S ocketTls ReadAvailable or S ocketTls Read call.
buffer_maxlen cannot exceed INT_M AX (2147483647).
Return Value
If an error occurs on a system socket when executing the function, connection established via
S ock etConnect is discontinued.
In case of a data reading error, the error 5273 (ERR_NETS OCKET_IO_ERROR) is written in
_LastError.
The function can be called only from Expert Advisors and scripts, as they run in their own execution
threads. If calling from an indicator, GetLastError() returns the error 4014 – "Function is not allowed
for call" .
See also
S ock etTimeouts, MathS wap
SocketTlsSend
S end data via secure TLS connection.
int SocketTlsSend(
int socket, // socket
const uchar& buffer[], // data buffer
uint buffer_len // buffer size
);
Parameters
socket
[in] S ock et handle returned by the S ock etCreate function. W hen an incorrect handle is passed, the
error 5270 (ERR_NETS OCKET_INVALIDHANDLE) is written to _LastError.
buffer
[in] R eference to the uchar type array with the data to be sent.
buffer_len
[in] 'buffer' array size.
Return Value
If successful, return the number of bytes written to a socket. In case of an error, -1 is returned.
Note
If an error occurs on a system socket when executing the function, connection established via
S ock etConnect is discontinued.
In case of a data writing error, the error 5273 (ERR_NETS OCKET_IO_ERROR) is written to
_LastError.
The function can be called only from Expert Advisors and scripts, as they run in their own execution
threads. If calling from an indicator, GetLastError() returns the error 4014 – "Function is not allowed
for call" .
See also
S ock etTimeouts, MathS wap, S tringToCharArray
WebRequest
The function sends an HTTP request to a specified server. The function has two versions :
1. Sending simple requests of type "key=value" using the header Content-Type: application/x-www-
form-urlencoded.
int WebRequest(
const string method, // HTTP method
const string url, // URL
const string cookie, // cookie
const string referer, // referer
int timeout, // timeout
const char &data[], // the array of the HTTP message body
int data_size, // data[] array size in bytes
char &result[], // an array containing server response data
string &result_headers // headers of server response
);
2. Sending a request of any type specifying the custom set of headers for a more flexible interaction
with various W eb services.
int WebRequest(
const string method, // HTTP method
const string url, // URL
const string headers, // headers
int timeout, // timeout
const char &data[], // the array of the HTTP message body
char &result[], // an array containing server response data
string &result_headers // headers of server response
);
Parameters
method
[in] H TTP method.
url
[in] UR L.
headers
[in] R equest headers of type "key: value" , separated by a line break "\r\n" .
cookie
[in] Cookie value.
referer
[in] Value of the Referer header of the HTTP request.
timeout
[in] Timeout in milliseconds.
data[]
[in] Data array of the HTTP message body.
data_size
[in] S ize of the data[] array.
result[]
[out] An array containing server response data.
result_headers
[out] S erver response headers.
Return Value
To use the W ebRequest() function, add the addresses of the required servers in the list of allowed
UR Ls in the "Expert Advisors " tab of the " Options " window. S erver port is automatically selected on
the basis of the specified protocol - 80 for " http://" and 443 for " https ://" .
The W ebRequest() function is synchronous, which means its breaks the program execution and waits
for the response from the requested server. S ince the delays in receiving a response can be large,
the function is not available for calls from indicators, because indicators run in a common thread
shared by all indicators and charts on one symbol. Indicator performance delay on one of the charts
of a symbol may stop updating of all charts of the same symbol.
The function can be called only from Expert Advisors and scripts, as they run in their own execution
threads. If you try to call the function from an indicator, GetLastError() will return error 4014 –
"Function is not allowed for call" .
void OnStart()
{
string cookie=NULL,headers;
char post[],result[];
string url="https://finance.yahoo.com";
//--- To enable access to the server, you should add URL "https://finance.yahoo.com"
//--- to the list of allowed URLs (Main Menu->Tools->Options, tab "Expert Advisors"):
//--- Resetting the last error code
ResetLastError();
//--- Downloading a html page from Yahoo Finance
int res=WebRequest("GET",url,cookie,NULL,500,post,0,result,headers);
if(res==-1)
{
Print("Error in WebRequest. Error code =",GetLastError());
//--- Perhaps the URL is not listed, display a message about the necessity to add the address
MessageBox("Add the address '"+url+"' to the list of allowed URLs on tab 'Expert Advisors'","
}
else
{
if(res==200)
{
//--- Successful download
PrintFormat("The file has been successfully downloaded, File size %d byte.",ArraySize(resu
//PrintFormat("Server headers: %s",headers);
//--- Saving the data to a file
int filehandle=FileOpen("url.htm",FILE_WRITE|FILE_BIN);
if(filehandle!=INVALID_HANDLE)
{
//--- Saving the contents of the result[] array to a file
FileWriteArray(filehandle,result,0,ArraySize(result));
//--- Closing the file
FileClose(filehandle);
}
else
Print("Error in FileOpen. Error code =",GetLastError());
}
else
PrintFormat("Downloading '%s' failed, error code %d",url,res);
}
}
SendFTP
S ends a file at the address, specified in the setting window of the "FTP" tab.
bool SendFTP(
string filename, // file to be send by ftp
string ftp_path=NULL // ftp catalog
);
Parameters
filename
[in] Name of sent file.
ftp_path=NULL
[in] FTP catalog. If a directory is not specified, directory described in settings is used.
Return Value
S ent file must be located in the folder terminal_directory\MQL5\files or its subfolders. S ending isn't
performed if FTP address and/or access password are not specified in settings.
S endFTP() function does not work in the S trategy Tester.
SendMail
S ends an email at the address specified in the settings window of the "Email" tab.
bool SendMail(
string subject, // header
string some_text // email text
);
Parameters
subject
[in] Email header.
some_text
[in] Email body.
Return Value
S ending can be prohibited in settings, email address can be omitted as well. For the error
information call GetLastError().
S endMail() function does not work in the S trategy Tester.
SendNotification
S ends push notifications to the mobile terminals, whose MetaQuotes IDs are specified in the
"Notifications " tab.
bool SendNotification(
string text // Text of the notification
);
Parameters
text
[in] The text of the notification. The message length should not exceed 255 characters.
Return Value
true if a notification has been successfully sent from the terminal; in case of failure returns false.
W hen check ing after a failed push of notification, GetLastError () may return one of the following
errors :
· 4515 – ERR_NOTI FICATION_SEND_FAIL ED,
· 4516 – ERR_NOTI FICATION_WR ONG_PARAM ET ER ,
· 4517 – ERR_NOTI FICATION_WR ONG_SETTI NGS ,
· 4518 – ERR_NOTI FICATION_TOO_FREQUENT.
Note
S trict
use restrictions are set for the S endNotification() function: no more than 2 calls per second
and not more than 10 calls per minute. Monitoring the frequency of use is dynamic. The function can
be disabled in case of the restriction violation.
S endNotification() function does not work in the S trategy Tester.
Function Action
GlobalVariableCheck
Checks the existence of a global variable with the specified name
bool GlobalVariableCheck(
string name // Global variable name
);
Parameters
name
[in] Global variable name.
Return Value
GlobalVariableTime
R eturns the time when the global variable was last accessed.
datetime GlobalVariableTime(
string name // name
);
Parameters
name
[in] Name of the global variable.
Return Value
The function returns time of last accessing the specified global variable. Addressing a variable for
its value, for example using the GlobalVariableGet() and GlobalVariableCheck() functions, also
modifies the time of last access. In order to obtain error details, call the GetLastError() function.
Note
Global variables exist in the client terminal during 4 weeks since they were called last. After that
they are automatically deleted.
See also
GlobalVariableCheck ()
GlobalVariableDel
Deletes a global variable from the client terminal.
bool GlobalVariableDel(
string name // Global variable name
);
Parameters
name
[in] Global variable name.
Return Value
If successful, the function returns true, otherwise it returns false. To obtain an information about
the error it is necessary to call the function GetLastError().
Note
Globalvariables exist in the client terminal during 4 weeks since their last use, then they are
automatically deleted.
GlobalVariableGet
R eturnsthe value of an existing global variable of the client terminal. There are 2 variants of the
function.
1. Immediately returns the value of the global variable.
double GlobalVariableGet(
string name // Global variable name
);
2. R eturns true or false depending on the success of the function run. If successful, the global variable
of the client terminal is placed in a variable passed by reference in the second parameter.
bool GlobalVariableGet(
string name, // Global variable name
double& double_var // This variable will contain the value of the global variable
);
Parameters
name
[in] Global variable name.
double_var
[out] Target variable of the double type, which accepts the value stored in a the global variable of
the client terminal.
Return Value
The value of the existing global variable or 0 in case of an error. For more details about the error,
call GetLastError().
Note
Globalvariables exist in the client terminal during 4 weeks since their last use, then they are
automatically deleted.
GlobalVariableName
R eturns the name of a global variable by its ordinal number.
string GlobalVariableName(
int index // Global variable number in the list of global variables
);
Parameters
index
[in] S equence number in the list of global variables. It should be greater than or equal to 0 and
less than GlobalVariablesTotal().
Return Value
Global variable name by its ordinal number in the list of global variables. For more details about the
error, call GetLastError().
Note
Globalvariables exist in the client terminal during 4 weeks since their last use, then they are
automatically deleted.
GlobalVariableSet
S etsa new value for a global variable. If the variable does not exist, the system creates a new global
variable.
datetime GlobalVariableSet(
string name, // Global variable name
double value // Value to set
);
Parameters
name
[in] Global variable name.
value
[in] The new numerical value.
Return Value
If successful, the function returns the last modification time, otherwise 0. For more details about
the error, call GetLastError().
Note
A global variable name should not exceed 63 characters. Global variables exist in the client terminal
during 4 weeks since their last use, then they are automatically deleted.
GlobalVariablesFlush
Forcibly saves contents of all global variables to a dis k.
void GlobalVariablesFlush();
Return Value
No return value.
Note
The terminal writes all the global variables when the work is over, but data can be lost at a sudden
computer operation failure. This function allows independently controlling the process of saving
global variables in case of contingency.
GlobalVariableTemp
The function attempts to create a temporary global variable. If the variable doesn't exist, the system
creates a new temporary global variable.
bool GlobalVariableTemp(
string name // Global variable name
);
Parameters
name
[in] The name of a temporary global variable.
Return Value
If successful, the function returns true, otherwise - false. To get details about the error, you should
call the GetLastError() function.
Note
Temporary global variables exist only while the client terminal is running; after the terminal
shutdown they are automatically deleted. Note that during the execution of GlobalVariables Flush()
temporary global variables are not written to a dis k.
After a temporary global variable has been created, it can be accessed and modified the same as
global variable of the client terminal.
GlobalVariableSetOnCondition
S etsthe new value of the existing global variable if the current value equals to the third parameter
check_value. If there is no global variable, the function will generate an error
ERR_GLOBAL VAR IABL E_NOT _FOUND (4501) and return false.
bool GlobalVariableSetOnCondition(
string name, // Global variable name
double value, // New value for variable if condition is true
double check_value // Check value condition
);
Parameters
name
[in] The name of a global variable.
value
[in] New value.
check_value
[in] The value to check the current value of the global variable.
Return Value
If successful, the function returns true, otherwise it returns false. For details about the error call
GetLastError(). If the current value of the global variable is different from check_value, the function
returns false.
Note
Function provides atomic access to the global variable, so it can be used for providing of a mutex at
interaction of several Expert Advisors working simultaneously within one client terminal.
GlobalVariablesDeleteAll
Deletes global variables of the client terminal.
int GlobalVariablesDeleteAll(
string prefix_name=NULL, // All global variables with names beginning with the prefix
datetime limit_data=0 // All global variables that were changed before this date
);
Parameters
prefix_name=NULL
[in] Name prefix global variables to remove. If you specify a prefix NULL or empty string, then all
variables that meet the data criterion will be deleted.
limit_data=0
[in] Date to select global variables by the time of their last modification. The function removes
global variables, which were changed before this date. If the parameter is zero, then all variables
that meet the first criterion (prefix) are deleted.
Return Value
If both options are equal to zero (prefix_name = NULL and limit_data = 0), then function deletes all
global variables of the terminal. If both parameters are specified, then it deletes global variables
corresponding to both parameters.
Globalvariables exist in the client terminal during 4 weeks since their last use, then they are
automatically deleted.
GlobalVariablesTotal
R eturns the total number of global variables of the client terminal.
int GlobalVariablesTotal();
Return Value
Global variables exist in the client terminal during 4 weeks since their last use, then they are
automatically deleted. Call of a global variable is not only setting a new value, but also reading the
value of the global variable.
File Functions
This is a group of functions for working with files.
For security reasons, work with files is strictly controlled in the MQL5 language. Files with which file
operations are conducted using MQL5 means cannot be outside the file sandbox.
There are two directories (with subdirectories) in which working files can be located:
· terminal_data_folder\MQL5\FILES\ (in the terminal menu select to view "File" - " Open the data
directory" );
· the common folder for all the terminals installed on a computer - usually located in the directory C:
\Documents and S ettings \All Users \Application Data\MetaQuotes \Terminal\Common\Files.
There is a program method to obtain names of these catalogs using the TerminalInfoS tring() function,
using the ENUM _TERMINAL_INFO_S TRING enumeration:
//--- Folder that stores the terminal data
string terminal_data_path=TerminalInfoString(TERMINAL_DATA_PATH);
//--- Common folder for all client terminals
string common_data_path=TerminalInfoString(TERMINAL_COMMONDATA_PATH);
Function Action
Function Action
FileCopy Copies the original file from a local or shared folder to another file
FileMove Moves or renames a file
FileR eadArray R eads arrays of any type except for string from the file of the BIN
type
FileR eadBool R eads from the file of the CSV type a string from the current
position till a delimiter (or till the end of a text line) and converts
the read string to a value of bool type
FileR eadDatetime R eads from the file of the CSV type a string of one of the formats :
"YYYY.MM.DD HH:MM :SS" , "YYYY.MM.DD" or "HH:MM :SS" - and
converts it into a datetime value
FileR eadDouble R eads a double value from the current position of the file pointer
FileR eadFloat R eads a float value from the current position of the file pointer
FileR eadInteger R eads int, short or char value from the current position of the file
pointer
FileR eadLong R eads a long type value from the current position of the file pointer
FileR eadNumber R eads from the file of the CSV type a string from the current
position till a delimiter (or til the end of a text line) and converts the
read string into double value
FileR eadS tring R eads a string from the current position of a file pointer from a file
FileR eadS truct R eads
the contents from a binary file into a structure passed as a
parameter, from the current position of the file pointer
FileS eek Moves the position of the file pointer by a specified number of bytes
relative to the specified position
FileS ize R eturns the size of a corresponding open file
FileTell R eturns the current position of the file pointer of a corresponding
open file
FileW rite W rites data to a file of CSV or TXT type
FileW riteArray W rites arrays of any type except for string into a file of BIN type
FileW riteDouble W ritesvalue of the double type from the current position of a file
pointer into a binary file
FileW riteFloat W rites value of the float type from the current position of a file
pointer into a binary file
FileW riteInteger W rites value of the int type from the current position of a file pointer
into a binary file
FileW riteLong W rites value of the long type from the current position of a file
pointer into a binary file
Function Action
FileW riteS tring W ritesthe value of a string parameter into a BIN or TXT file starting
from the current position of the file pointer
FileW riteS truct W rites the contents of a structure passed as a parameter into a
binary file, starting from the current position of the file pointer
FileLoad R eadsall data of a specified binary file into a passed array of
numeric types or simple structures
FileS ave W ritesto a binary file all elements of an array passed as a
parameter
FolderCreate Creates a folder in the Files directory
FolderDelete R emovesa selected directory. If the folder is not empty, then it can't
be removed
FolderClean Deletes all files in the specified folder
FileSelectDialog
Create a file or folder opening/creation dialog.
int FileSelectDialog(
string caption, // window header
string initial_dir, // initial directory
string filter, // extension filter
uint flags, // combination of flags
string& filenames[], // array with file names
string default_filename // default file name
);
Parameters
caption
[in] Dialog window header.
initial_dir
[in] Initial directory name relative to MQL5\Files, the contents of which is to be displayed in the
dialog box. If the value is NULL, MQL5\Files is displayed in the dialog.
filter
[in] Extension filter of the files to be displayed in the selection dialog window. Files of other
formats are hidden.
flags
[in] Combination of flags defining the dialog window mode. The flags are defined as follows :
FSD_WR IT E_FIL E – file open dialog ;
FSD_SEL ECT _FOL DER – allow selection of folders only;
FSD_ALLOW_M ULTISEL ECT – allow selection of multiple files ;
FSD_FIL E_M US T _EXIS T – selected files should exist;
FSD_COMMON_FOL DER – file is located in the common folder of all client terminals
\Terminal\Common\Files.
filenames[]
[out] Array of strings the names of selected files /folders are placed to.
default_filename
[in] Default file/folder name. If specified, a name is automatically added to the open dialog and
returned in the filenames[] array when testing.
Return Value
In case of a successful completion, the function returns the number of selected files whose names
can be obtained in filenames[]. If a user closes the dialog without selecting a file, the function
returns 0. In case of unsuccessful execution, a value less than 0 is returned. The error code can be
obtained using GetLastError().
Note
For reasons of security, working with files is strictly controlled in MQL5 language. Files used in file
operations by means of MQL5 language cannot be located outside the file sandbox (namely, outside
the MQL5\Files directory).
The initial_dir name is searched in the client terminal's directory in MQL5\Files (or
testing_agent_directory\MQL5\Files in case of testing). If FSD_COMMON_FOLDER is set among the
flags, the search for the initial directory is performed in the common folder of all client terminals
\Terminal\Common\Files.
The filter parameter indicates valid files and should be set in the "<description 1>|<extension 1>|
<description 2>|<extension 2>..." format, for example, " Text files (*.txt)|*.txt|All files (*.*)|*.*" .
The first extension " Text files (*.txt)|*.txt" is selected as a default file type.
If filter=NULL, the mas k of file selection in the dialog window is "All Files (*.*)|*.*|"
If the default_filename parameter is set, calling FileS electDialog() returns 1, while the
default_filename value itself is copied to the filenames[] array during the non-visualized testing.
The function cannot be used in custom indicators since calling FileS electDialog() suspends the thread
of execution for the whole time while waiting for the user's response. S ince all indicators for each
symbol are executed in a single thread, such suspension makes the operation of all charts on all
timeframes for this symbol impossible.
Example:
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- get the names of text files for downloading from the common folder of the client terminals
string filenames[];
if(FileSelectDialog("Select files to download", NULL,
"Text files (*.txt)|*.txt|All files (*.*)|*.*",
FSD_ALLOW_MULTISELECT|FSD_COMMON_FOLDER, filenames, "data.txt")>0)
{
//--- display the name of each selected file
int total=ArraySize(filenames);
for(int i=0; i<total; i++)
Print(i, ": ", filenames[i]);
}
else
{
Print("Files not selected");
}
//---
}
See also
FileOpen, FileIs Exist, FileDelete, FileMove, FolderCreate, FolderDelete, FolderClean, Flags of
opening files
FileFindFirst
The function starts the search of files or subdirectories in a directory in accordance with the specified
filter.
long FileFindFirst(
const string file_filter, // String - search filter
string& returned_filename, // Name of the file or subdirectory found
int common_flag=0 // Defines the search
);
Parameters
file_filter
[in] S earch filter. A subdirectory (or sequence of nested subdirectories) relative to the \Files
directory, in which files should be searched for, can be specified in the filter.
returned_filename
[out] The returned parameter, where, in case of success, the name of the first found file or
subdirectory is placed. Only the file name is returned (including the extension), the directories and
subdirectories are not included no matter if they are specified or not in the search filter.
common_flag
[in] Flag determining the location of the file. If common_flag = FILE_COMMON, then the file is
located in a shared folder for all client terminals \Terminal\Common\Files. Otherwise, the file is
located in a local folder.
Return Value
R eturns handle of the object searched, which should be used for further sorting of files and
subdirectories by the FileFindNext() function, or INVALID_HANDLE when there is no file and
subdirectory corresponding to the filter (in the particular case - when the directory is empty). After
searching, the handle must be closed using the FileFindClose() function.
Note
Forsecurity reasons, work with files is strictly controlled in the MQL5 language. Files with which file
operations are conducted using MQL5 means, cannot be outside the file sandbox.
Example:
//--- display the window of input parameters when launching the script
#property script_show_inputs
//--- filter
input string InpFilter="Dir1\\*";
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
string file_name;
string int_dir="";
int i=1,pos=0,last_pos=-1;
//--- search for the last backslash
while(!IsStopped())
{
pos=StringFind(InpFilter,"\\",pos+1);
if(pos>=0)
last_pos=pos;
else
break;
}
//--- the filter contains the folder name
if(last_pos>=0)
int_dir=StringSubstr(InpFilter,0,last_pos+1);
//--- get the search handle in the root of the local folder
long search_handle=FileFindFirst(InpFilter,file_name);
//--- check if the FileFindFirst() is executed successfully
if(search_handle!=INVALID_HANDLE)
{
//--- in a loop, check if the passed strings are the names of files or directories
do
{
ResetLastError();
//--- if it's a file, the function returns true, and if it's a directory, it returns error
FileIsExist(int_dir+file_name);
PrintFormat("%d : %s name = %s",i,GetLastError()==ERR_FILE_IS_DIRECTORY ? "Directory" : "F
i++;
}
while(FileFindNext(search_handle,file_name));
//--- close the search handle
FileFindClose(search_handle);
}
else
Print("Files not found!");
}
See also
FileFindNext, FileFindClose
FileFindNext
The function continues the search started by FileFindFirst().
bool FileFindNext(
long search_handle, // Search handle
string& returned_filename // Name of the file or subdirectory found
);
Parameters
search_handle
[in] S earch handle, retrieved by FileFindFirst().
returned_filename
[out] The name of the next file or subdirectory found. Only the file name is returned (including the
extension), the directories and subdirectories are not included no matter if they are specified or
not in the search filter.
Return Value
//--- display the window of input parameters when launching the script
#property script_show_inputs
//--- filter
input string InpFilter="*";
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
string file_name;
int i=1;
//--- receive search handle in local folder's root
long search_handle=FileFindFirst(InpFilter,file_name);
//--- check if FileFindFirst() function executed successfully
if(search_handle!=INVALID_HANDLE)
{
//--- check if the passed strings are file or directory names in the loop
do
{
ResetLastError();
//--- if this is a file, the function will return true, if it is a directory, the function
FileIsExist(file_name);
PrintFormat("%d : %s name = %s",i,GetLastError()==ERR_FILE_IS_DIRECTORY ? "Directory" : "F
i++;
}
while(FileFindNext(search_handle,file_name));
See also
FileFindFirst, FileFindClose
FileFindClose
The function closes the search handle.
void FileFindClose(
long search_handle // Search handle
);
Parameters
search_handle
[in] S earch handle, retrieved by FileFindFirst().
Return Value
No value returned.
Note
//--- display the window of input parameters when launching the script
#property script_show_inputs
//--- filter
input string InpFilter="*";
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
string file_name;
int i=1;
//--- receive search handle in local folder's root
long search_handle=FileFindFirst(InpFilter,file_name);
//--- check if FileFindFirst() function executed successfully
if(search_handle!=INVALID_HANDLE)
{
//--- check if the passed strings are file or directory names in the loop
do
{
ResetLastError();
//--- if this is a file, the function will return true, if it is a directory, the function
FileIsExist(file_name);
PrintFormat("%d : %s name = %s",i,GetLastError()==5018 ? "Directory" : "File",file_name);
i++;
}
while(FileFindNext(search_handle,file_name));
//--- close search handle
FileFindClose(search_handle);
}
else
Print("Files not found!");
}
See also
FileFindFirst, FileFindNext
FileIsExist
Checks the existence of a file.
bool FileIsExist(
const string file_name, // File name
int common_flag=0 // Search area
);
Parameters
file_name
[in] The name of the file being checked
common_flag=0
[in] Flag determining the location of the file. If common_flag = FILE_COMMON, then the file is
located in a shared folder for all client terminals \Terminal\Common\Files. Otherwise, the file is
located in a local folder.
Return Value
Checked file can turn out to be a subdirectory. In this case, FileIs Exist() function will return false,
while error 5018 will be logged in _LastError variable - " This is a directory, not a file" (see example
for FileFindFirst function).
Forsecurity reasons, work with files is strictly controlled in the MQL5 language. Files with which file
operations are conducted using MQL5 means, cannot be outside the file sandbox.
If common_flag = FILE_COMMON, then the function looks for the file in a shared folder for all client
terminals \Terminal\Common\Files, otherwise the function looks for a file in a local folder
(MQL5\Files or MQL5\Tester\Files in the case of testing).
Example:
//--- show the window of input parameters when launching the script
#property script_show_inputs
//--- date for old files
input datetime InpFilesDate=D'2013.01.01 00:00';
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
string file_name; // variable for storing file names
string filter="*.txt"; // filter for searching the files
datetime create_date; // file creation date
string files[]; // list of file names
int def_size=25; // array size by default
int size=0; // number of files
See also
FileFindFirst
FileOpen
The function opens the file with the specified name and flag.
int FileOpen(
string file_name, // File name
int open_flags, // Combination of flags
short delimiter='\t', // Delimiter
uint codepage=CP_ACP // Code page
);
Parameters
file_name
[in] The name of the file can contain subfolders. If the file is opened for writing, these subfolders
will be created if there are no such ones.
open_flags
[in] combination of flags determining the operation mode for the file. The flags are defined as
follows :
FIL E_READ file is opened for reading
FIL E_WR IT E file is opened for writing
FIL E_BIN binary read-write mode (no conversion from a string and to a string)
FIL E_CSV file of csv type (all recorded items are converted to the strings of unicode or ansi type,
and are separated by a delimiter)
FIL E_T XT a simple text file (the same as csv, but the delimiter is not tak en into account)
FIL E_ANS I lines of ANS I type (single-byte symbols)
FIL E_UNICODE lines of UNICODE type (double-byte characters)
FIL E_SHARE_READ shared reading from several programs
FIL E_SHARE_WR IT E shared writing from several programs
FIL E_COMMON location of the file in a shared folder for all client terminals
\Terminal\Common\Files
delimiter='\t'
[in]value to be used as a separator in txt or csv-file. If the csv-file delimiter is not specified, it
defaults to a tab. If the txt-file delimiter is not specified, then no separator is used. If the
separator is clearly set to 0, then no separator is used.
codepage=CP_ACP
[in] The value of the code page. For the most-used code pages provide appropriate constants.
Return Value
If a file has been opened successfully, the function returns the file handle, which is then used to
access the file data. In case of failure returns INVALID_HANDLE.
Note
Forsecurity reasons, work with files is strictly controlled in the MQL5 language. Files with which file
operations are conducted using MQL5 means, cannot be outside the file sandbox.
Make sure to set the FILE_ANS I flag if the file should be read in a specific encoding (the codepage
parameter with a code page value is specified). If there is no specified FILE_ANS I flag, the text file
is read in Unicode without any conversion.
The file is opened in the folder of the client terminal in the subfolder MQL5\files (or
testing_agent_directory\MQL5\files in case of testing). If FILE_COMMON is specified among flags,
the file is opened in a shared folder for all MetaTrader 5 client terminals.
"Named pipes " can be opened according to the following rules :
· Pipe name is a string, which should have the following look: "\\servername\pipe\pipename" , where
servername - server name in the network, while pipename is a pipe name. If the pipes are used
on the same computer, the server name can be omitted but a point should be inserted instead of
it: "\\.\pipe\pipename" . A client trying to connect the pipe should know its name.
· FileFlush() and FileS eek () should be called to the beginning of a file between sequential operations
of reading from the pipe and writing to it.
A special symbol '\' is used in shown strings. Therefore, '\' should be doubled when writing a name in
MQL5 application. It means that the above example should have the following look in the code: "\\\
\servername\\pipe\\pipename" .
More information about working with named pipes can be found in the article " Communicating W ith
MetaTrader 5 Using Named Pipes W ithout Using DLLs " .
Example:
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- incorrect file opening method
string terminal_data_path=TerminalInfoString(TERMINAL_DATA_PATH);
string filename=terminal_data_path+"\\MQL5\\Files\\"+"fractals.csv";
int filehandle=FileOpen(filename,FILE_WRITE|FILE_CSV);
if(filehandle<0)
{
Print("Failed to open the file by the absolute path ");
Print("Error code ",GetLastError());
}
string subfolder="Research";
filehandle=FileOpen(subfolder+"\\fractals.txt",FILE_WRITE|FILE_CSV);
if(filehandle!=INVALID_HANDLE)
{
FileWrite(filehandle,TimeCurrent(),Symbol(), EnumToString(_Period));
FileClose(filehandle);
Print("The file must be created in the folder "+terminal_data_path+"\\"+subfolder);
}
else Print("File open failed, error ",GetLastError());
}
See also
Use of a Codepage, FileFindFirst, FolderCreate, File opening flags
FileClose
Close the file previously opened by FileOpen().
void FileClose(
int file_handle // File handle
);
Parameters
file_handle
[in] File descriptor returned by FileOpen().
Return Value
No value returned.
Example:
//--- show the window of input parameters when launching the script
#property script_show_inputs
//--- input parameters
input string InpFileName="file.txt"; // file name
input string InpDirectoryName="Data"; // directory name
input int InpEncodingType=FILE_ANSI; // ANSI=32 or UNICODE=64
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- print the path to the file we are going to use
PrintFormat("Working %s\\Files\\ folder",TerminalInfoString(TERMINAL_DATA_PATH));
//--- reset the error value
ResetLastError();
//--- open the file for reading (if the file does not exist, the error will occur)
int file_handle=FileOpen(InpDirectoryName+"//"+InpFileName,FILE_READ|FILE_TXT|InpEncodingType);
if(file_handle!=INVALID_HANDLE)
{
//--- print the file contents
while(!FileIsEnding(file_handle))
Print(FileReadString(file_handle));
//--- close the file
FileClose(file_handle);
}
else
PrintFormat("Error, code = %d",GetLastError());
}
FileCopy
The function copies the original file from a local or shared folder to another file.
bool FileCopy(
const string src_file_name, // Name of a source file
int common_flag, // Location
const string dst_file_name, // Name of the destination file
int mode_flags // Access mode
);
Parameters
src_file_name
[in] File name to copy.
common_flag
[in] Flag determining the location of the file. If common_flag = FILE_COMMON, then the file is
located in a shared folder for all client terminals \Terminal\Common\Files. Otherwise, the file is
located in a local folder (for example, common_flag=0).
dst_file_name
[in] R esult file name.
mode_flags
[in] Access flags. The parameter can contain only 2 flags : FILE_REWRITE and/or FILE_COMMON -
other flags are ignored. If the file already exists, and the FILE_REWRITE flag hasn't been
specified, then the file will not be rewritten, and the function will return false.
Return Value
Forsecurity reasons, work with files is strictly controlled in the MQL5 language. Files with which file
operations are conducted using MQL5 means, cannot be outside the file sandbox.
If the new file already exists, the copy will be made depending on the availability of the
FIL E_REWR IT E flag in the mode_flags parameter.
Example:
//--- display the window of input parameters when launching the script
#property script_show_inputs
//--- input parameters
input string InpSrc="source.txt"; // source
input string InpDst="destination.txt"; // copy
input int InpEncodingType=FILE_ANSI; // ANSI=32 or UNICODE=64
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- display the source contents (it must exist)
if(!FileDisplay(InpSrc))
return;
//--- check if the copy file already exists (may not be created)
if(!FileDisplay(InpDst))
{
//--- the copy file does not exist, copying without FILE_REWRITE flag (correct copying)
if(FileCopy(InpSrc,0,InpDst,0))
Print("File is copied!");
else
Print("File is not copied!");
}
else
{
//--- the copy file already exists, try to copy without FILE_REWRITE flag (incorrect copying)
if(FileCopy(InpSrc,0,InpDst,0))
Print("File is copied!");
else
Print("File is not copied!");
//--- InpDst file's contents remains the same
FileDisplay(InpDst);
//--- copy once more with FILE_REWRITE flag (correct copying if the file exists)
if(FileCopy(InpSrc,0,InpDst,FILE_REWRITE))
Print("File is copied!");
else
Print("File is not copied!");
}
//--- receive InpSrc file copy
FileDisplay(InpDst);
}
//+------------------------------------------------------------------+
//| Read the file contents |
//+------------------------------------------------------------------+
bool FileDisplay(const string file_name)
{
//--- reset the error value
ResetLastError();
//--- open the file
int file_handle=FileOpen(file_name,FILE_READ|FILE_TXT|InpEncodingType);
if(file_handle!=INVALID_HANDLE)
{
//--- display the file contents in the loop
Print("+---------------------+");
PrintFormat("File name = %s",file_name);
while(!FileIsEnding(file_handle))
Print(FileReadString(file_handle));
Print("+---------------------+");
//--- close the file
FileClose(file_handle);
return(true);
}
//--- failed to open the file
PrintFormat("%s is not opened, error = %d",file_name,GetLastError());
return(false);
}
FileDelete
Deletes the specified file in a local folder of the client terminal.
bool FileDelete(
const string file_name, // File name to delete
int common_flag=0 // Location of the file to delete
);
Parameters
file_name
[in] File name.
common_flag=0
[in] Flag determining the file location. If common_flag = FILE_COMMON, then the file is located in
a shared folder for all client terminals \Terminal\Common\Files. Otherwise, the file is located in a
local folder.
Return Value
Forsecurity reasons, work with files is strictly controlled in the MQL5 language. Files with which file
operations are conducted using MQL5 means, cannot be outside the file sandbox.
Deletes the specified file from a local folder of the client terminal (MQL5\Files or MQL5\Tester\Files
in case of testing). If common_flag = FILE_COMMON, then the function removes the file from the
shared folder for all client terminals \Terminal\Common\Files.
Example:
//--- show the window of input parameters when launching the script
#property script_show_inputs
//--- date for old files
input datetime InpFilesDate=D'2013.01.01 00:00';
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
string file_name; // variable for storing file names
string filter="*.txt"; // filter for searching the files
datetime create_date; // file creation date
string files[]; // list of file names
int def_size=25; // array size by default
int size=0; // number of files
//--- allocate memory for the array
ArrayResize(files,def_size);
//--- receive the search handle in the local folder's root
long search_handle=FileFindFirst(filter,file_name);
FileMove
Moves a file from a local or shared folder to another folder.
bool FileMove(
const string src_file_name, // File name for the move operation
int common_flag, // Location
const string dst_file_name, // Name of the destination file
int mode_flags // Access mode
);
Parameters
src_file_name
[in] File name to move/rename.
common_flag
[in] Flag determining the location of the file. If common_flag = FILE_COMMON, then the file is
located in a shared folder for all client terminals \Terminal\Common\Files. Otherwise, the file is
located in a local folder (common_flag=0).
dst_file_name
[in] File name after operation
mode_flags
[in] Access flags. The parameter can contain only 2 flags : FILE_REWRITE and/or FILE_COMMON -
other flags are ignored. If the file already exists and the FILE_REWRITE flag isn't specified, the file
will not be rewritten, and the function will return false.
Return Value
Forsecurity reasons, work with files is strictly controlled in the MQL5 language. Files with which file
operations are conducted using MQL5 means, cannot be outside the file sandbox.
If the new file already exists, the copy will be made depending on the availability of the
FIL E_REWR IT E flag in the mode_flags parameter.
Example:
//--- display the window of input parameters when launching the script
#property script_show_inputs
//--- input parameters
input string InpSrcName="data.txt";
input string InpDstName="newdata.txt";
input string InpSrcDirectory="SomeFolder";
input string InpDstDirectory="OtherFolder";
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
string local=TerminalInfoString(TERMINAL_DATA_PATH);
string common=TerminalInfoString(TERMINAL_COMMONDATA_PATH);
//--- receive file paths
string src_path;
string dst_path;
StringConcatenate(src_path,InpSrcDirectory,"//",InpSrcName);
StringConcatenate(dst_path,InpDstDirectory,"//",InpDstName);
//--- check if the source file exists (if not - exit)
if(FileIsExist(src_path))
PrintFormat("%s file exists in the %s\\Files\\%s folder",InpSrcName,local,InpSrcDirectory);
else
{
PrintFormat("Error, %s source file not found",InpSrcName);
return;
}
//--- check if the result file already exists
if(FileIsExist(dst_path,FILE_COMMON))
{
PrintFormat("%s file exists in the %s\\Files\\%s folder",InpDstName,common,InpDstDirectory);
//--- file exists, moving should be performed with FILE_REWRITE flag
ResetLastError();
if(FileMove(src_path,0,dst_path,FILE_COMMON|FILE_REWRITE))
PrintFormat("%s file moved",InpSrcName);
else
PrintFormat("Error! Code = %d",GetLastError());
}
else
{
PrintFormat("%s file does not exist in the %s\\Files\\%s folder",InpDstName,common,InpDstDire
//--- the file does not exist, moving should be performed without FILE_REWRITE flag
ResetLastError();
if(FileMove(src_path,0,dst_path,FILE_COMMON))
PrintFormat("%s file moved",InpSrcName);
else
PrintFormat("Error! Code = %d",GetLastError());
}
//--- the file is moved; let's check it out
if(FileIsExist(dst_path,FILE_COMMON) && !FileIsExist(src_path,0))
Print("Success!");
else
Print("Error!");
}
See also
FileIs Exist
FileFlush
W rites to a dis k all data remaining in the input/output file buffer.
void FileFlush(
int file_handle // File handle
);
Parameters
file_handle
[in] File descriptor returned by FileOpen().
Return Value
No value returned.
Note
W hen writing to a file, the data may be actually found there only after some time. To save the data
in the file instantly, use FileFlush() function. If the function is not used, part of the data that has
not been stored in the dis k yet, will be forcibly written there only when the file is closed using
FileClose() function.
The function should be used when written data is of a certain value. It should be kept in mind that
frequent function call may affect the program operation speed.
Function FileFlush () must be called between the operations of reading from a file and writing to it.
Example:
//--- show the window of input parameters when launching the script
#property script_show_inputs
//--- file name for writing
input string InpFileName="example.csv"; // file name
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- reset error value
ResetLastError();
//--- open the file
int file_handle=FileOpen(InpFileName,FILE_READ|FILE_WRITE|FILE_CSV);
if(file_handle!=INVALID_HANDLE)
{
//--- write data to the file
for(int i=0;i<1000;i++)
{
//--- call write function
FileWrite(file_handle,TimeCurrent(),SymbolInfoDouble(Symbol(),SYMBOL_BID),SymbolInfoDouble
//--- save data on the disk at each 128th iteration
if((i & 127)==127)
{
//--- now, data will be located in the file and will not be lost in case of a critical
FileFlush(file_handle);
PrintFormat("i = %d, OK",i);
}
//--- 0.01 second pause
Sleep(10);
}
//--- close the file
FileClose(file_handle);
}
else
PrintFormat("Error, code = %d",GetLastError());
}
See also
FileClose
FileGetInteger
Gets an integer property of a file. There are two variants of the function.
1. Get a property by the handle of a file.
long FileGetInteger(
int file_handle, // File handle
ENUM_FILE_PROPERTY_INTEGER property_id // Property ID
);
Parameters
file_handle
[in] File descriptor returned by FileOpen().
file_name
[in] File name.
property_id
[in] File property ID. The value can be one of the values of the ENUM _FILE_PROPERTY_INTEGER
enumeration. If the second variant of the function is used, you can receive only the values of the
following properties : FILE_EXIS TS , FILE_CREATE_DATE, FILE_MODIFY_DATE, FILE_ACCESS_DATE
and FILE_S IZE.
common_folder=false
[in] Points to the file location. If the parameter is false, terminal data folder is viewed. Otherwise
it is assumed that the file is in the shared folder of all terminals \Terminal\Common\Files
(FILE_COMMON).
Return Value
The value of the property. In case of an error, -1 is returned. To get an error code use the
GetLastError() function.
If a folder is specified when getting properties by the name, the function will have error 5018
(ERR_MQL_FILE_IS_DIRECTORY) in any case, though the return value will be correct.
Note
The function always changes the error code. In case of successful completion the error code is reset
to NULL.
Example:
//--- display the window of input parameters when launching the script
#property script_show_inputs
//--- input parameters
input string InpFileName="data.csv";
input string InpDirectoryName="SomeFolder";
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
string path=InpDirectoryName+"//"+InpFileName;
long l=0;
//--- open the file
ResetLastError();
int handle=FileOpen(path,FILE_READ|FILE_CSV);
if(handle!=INVALID_HANDLE)
{
//--- print all information about the file
Print(InpFileName," file info:");
FileInfo(handle,FILE_EXISTS,l,"bool");
FileInfo(handle,FILE_CREATE_DATE,l,"date");
FileInfo(handle,FILE_MODIFY_DATE,l,"date");
FileInfo(handle,FILE_ACCESS_DATE,l,"date");
FileInfo(handle,FILE_SIZE,l,"other");
FileInfo(handle,FILE_POSITION,l,"other");
FileInfo(handle,FILE_END,l,"bool");
FileInfo(handle,FILE_IS_COMMON,l,"bool");
FileInfo(handle,FILE_IS_TEXT,l,"bool");
FileInfo(handle,FILE_IS_BINARY,l,"bool");
FileInfo(handle,FILE_IS_CSV,l,"bool");
FileInfo(handle,FILE_IS_ANSI,l,"bool");
FileInfo(handle,FILE_IS_READABLE,l,"bool");
FileInfo(handle,FILE_IS_WRITABLE,l,"bool");
//--- close the file
FileClose(handle);
}
else
PrintFormat("%s file is not opened, ErrorCode = %d",InpFileName,GetLastError());
}
//+------------------------------------------------------------------+
//| Display the value of the file property |
//+------------------------------------------------------------------+
void FileInfo(const int handle,const ENUM_FILE_PROPERTY_INTEGER id,
long l,const string type)
{
//--- receive the property value
ResetLastError();
if((l=FileGetInteger(handle,id))!=-1)
{
//--- the value received, display it in the correct format
if(!StringCompare(type,"bool"))
Print(EnumToString(id)," = ",l ? "true" : "false");
if(!StringCompare(type,"date"))
Print(EnumToString(id)," = ",(datetime)l);
if(!StringCompare(type,"other"))
Print(EnumToString(id)," = ",l);
}
else
Print("Error, Code = ",GetLastError());
}
See also
File Operations, File Properties
FileIsEnding
Defines the end of a file in the process of reading.
bool FileIsEnding(
int file_handle // File handle
);
Parameters
file_handle
[in] File descriptor returned by FileOpen().
Return Value
The function returns true if the file end has been reached in the process of reading or moving of the
file pointer.
Note
To define the end of the file, the function tries to read the next string from it. If the string does not
exist, the function returns true, otherwise it returns false.
Example:
//--- show the window of input parameters when launching the script
#property script_show_inputs
//--- input parameters
input string InpFileName="file.txt"; // file name
input string InpDirectoryName="Data"; // directory name
input int InpEncodingType=FILE_ANSI; // ANSI=32 or UNICODE=64
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- print the path to the file we are going to use
PrintFormat("Working %s\\Files\\ folder",TerminalInfoString(TERMINAL_DATA_PATH));
//--- reset the error value
ResetLastError();
//--- open the file for reading (if the file does not exist, the error will occur)
int file_handle=FileOpen(InpDirectoryName+"//"+InpFileName,FILE_READ|FILE_TXT|InpEncodingType);
if(file_handle!=INVALID_HANDLE)
{
//--- print the file contents
while(!FileIsEnding(file_handle))
Print(FileReadString(file_handle));
//--- close the file
FileClose(file_handle);
}
else
PrintFormat("Error, code = %d",GetLastError());
FileIsLineEnding
Defines the line end in a text file in the process of reading.
bool FileIsLineEnding(
int file_handle // File handle
);
Parameters
file_handle
[in] File descriptor returned by FileOpen().
Return Value
R eturns true if in the process of reading txt or csv-file reached the end of the line (the characters
CR-LF).
Example (the file obtained during the execution of an example for FileW riteS tring function is used
here)
//+------------------------------------------------------------------+
//| Demo_FileIsLineEnding.mq5 |
//| Copyright 2013, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2013, MetaQuotes Software Corp."
#property link "https://www.mql5.com"
#property version "1.00"
#property indicator_chart_window
#property indicator_buffers 5
#property indicator_plots 1
//---- plot Label1
#property indicator_label1 "Overbought & Oversold"
#property indicator_type1 DRAW_COLOR_BARS
#property indicator_color1 clrRed, clrBlue
#property indicator_style1 STYLE_SOLID
#property indicator_width1 2
//--- parameters for data reading
input string InpFileName="RSI.csv"; // file name
input string InpDirectoryName="Data"; // directory name
//--- indicator buffers
double open_buff[];
double high_buff[];
double low_buff[];
double close_buff[];
double color_buff[];
//--- overbought variables
int ovb_ind=0;
int ovb_size=0;
datetime ovb_time[];
//---- set the indicator values that will not be visible on the chart
PlotIndexSetDouble(0,PLOT_EMPTY_VALUE,0);
//---
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Read the file's string data |
//+------------------------------------------------------------------+
void ReadData(const int file_handle,datetime &arr[],int &size,int &def_size)
{
bool flag=false;
//--- read till the end of the string or of the file is reached
while(!FileIsLineEnding(file_handle) && !FileIsEnding(file_handle))
{
//--- shift the position by reading the number
if(flag)
FileReadNumber(file_handle);
//--- store the current date
arr[size]=FileReadDatetime(file_handle);
size++;
//--- increase the array size if necessary
if(size==def_size)
{
def_size+=100;
ArrayResize(arr,def_size);
}
//--- slip past the first iteration
flag=true;
}
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
ArraySetAsSeries(time,false);
ArraySetAsSeries(open,false);
ArraySetAsSeries(high,false);
ArraySetAsSeries(low,false);
ArraySetAsSeries(close,false);
//--- the loop for the bars that have not been handled yet
for(int i=prev_calculated;i<rates_total;i++)
{
//--- 0 by default
open_buff[i]=0;
high_buff[i]=0;
low_buff[i]=0;
close_buff[i]=0;
color_buff[i]=0;
//--- check if any data is still present
if(ovb_ind<ovb_size)
for(int j=ovb_ind;j<ovb_size;j++)
{
//--- if the dates coincide, the bar is in the overbought area
if(time[i]==ovb_time[j])
{
open_buff[i]=open[i];
high_buff[i]=high[i];
low_buff[i]=low[i];
close_buff[i]=close[i];
//--- 0 - red color
color_buff[i]=0;
//--- increase the counter
ovb_ind=j+1;
break;
}
}
//--- check if any data still exists
if(ovs_ind<ovs_size)
for(int j=ovs_ind;j<ovs_size;j++)
{
//--- if the dates coincide, the bar is in the oversold area
if(time[i]==ovs_time[j])
{
open_buff[i]=open[i];
high_buff[i]=high[i];
low_buff[i]=low[i];
close_buff[i]=close[i];
//--- 1 - blue color
color_buff[i]=1;
//--- increase the counter
ovs_ind=j+1;
break;
}
}
}
//--- return value of prev_calculated for next call
return(rates_total);
}
//+------------------------------------------------------------------+
//| ChartEvent event handler |
//+------------------------------------------------------------------+
void OnChartEvent(const int id,
const long &lparam,
const double &dparam,
const string &sparam
)
{
//--- change the indicator width according to the scale
if(ChartGetInteger(0,CHART_SCALE)>3)
PlotIndexSetInteger(0,PLOT_LINE_WIDTH,2);
else
PlotIndexSetInteger(0,PLOT_LINE_WIDTH,1);
}
See also
FileW riteS tring
FileReadArray
R eads from a file of BIN type arrays of any type except string (may be an array of structures, not
containing strings, and dynamic arrays ).
uint FileReadArray(
int file_handle, // File handle
void& array[], // Array to record
int start=0, // start array position to write
int count=WHOLE_ARRAY // count to read
);
Parameters
file_handle
[in] File descriptor returned by FileOpen().
array[]
[out] An array where the data will be loaded.
start=0
[in] S tart position to read from the array.
count=WHOLE_ARRAY
[in] Number of elements to read. By default, reads the entire array (count=WHOLE_ARRAY).
Return Value
S tring array can be read only from the file of TXT type. If necessary, the function tries to increase
the size of the array.
Example (the file obtained after execution of the example for FileW riteArray function is used here)
//--- display the window of input parameters when launching the script
#property script_show_inputs
//--- input parameters
input string InpFileName="data.bin";
input string InpDirectoryName="SomeFolder";
//+------------------------------------------------------------------+
//| Structure for storing price data |
//+------------------------------------------------------------------+
struct prices
{
datetime date; // date
double bid; // bid price
double ask; // ask price
};
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- structure array
prices arr[];
//--- file path
string path=InpDirectoryName+"//"+InpFileName;
//--- open the file
ResetLastError();
int file_handle=FileOpen(path,FILE_READ|FILE_BIN);
if(file_handle!=INVALID_HANDLE)
{
//--- read all data from the file to the array
FileReadArray(file_handle,arr);
//--- receive the array size
int size=ArraySize(arr);
//--- print data from the array
for(int i=0;i<size;i++)
Print("Date = ",arr[i].date," Bid = ",arr[i].bid," Ask = ",arr[i].ask);
Print("Total data = ",size);
//--- close the file
FileClose(file_handle);
}
else
Print("File open failed, error ",GetLastError());
}
See also
Variables, FileW riteArray
FileReadBool
R eads from the file of CSV type string from the current position to a delimiter (or till the end of the
text line) and converts the read string to a bool type value.
bool FileReadBool(
int file_handle // File handle
);
Parameters
file_handle
[in] File descriptor returned by FileOpen().
Return Value
Line read may be set to " true" , " false" or the symbolic representation of integers "0" or "1" . A
nonzero value is converted to a logical true. The function returns the converted value.
Example (the file obtained after executing the example for FileW rite function is used here)
//+------------------------------------------------------------------+
//| Demo_FileReadBool.mq5 |
//| Copyright 2013, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2013, MetaQuotes Software Corp."
#property link "https://www.mql5.com"
#property version "1.00"
#property indicator_chart_window
#property indicator_buffers 2
#property indicator_plots 2
//---- plot Label1
#property indicator_label1 "UpSignal"
#property indicator_type1 DRAW_ARROW
#property indicator_color1 clrRed
#property indicator_style1 STYLE_SOLID
#property indicator_width1 4
//---- plot Label2
#property indicator_label2 "DownSignal"
#property indicator_type2 DRAW_ARROW
#property indicator_color2 clrRed
#property indicator_style2 STYLE_SOLID
#property indicator_width2 4
//--- parameters for data reading
input string InpFileName="MACD.csv"; // file name
input string InpDirectoryName="Data"; // directory name
//--- global variables
int ind=0; // index
double upbuff[]; // indicator buffers of up arrows
double downbuff[]; // indicator buffer of down arrows
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
ArraySetAsSeries(time,false);
ArraySetAsSeries(low,false);
ArraySetAsSeries(high,false);
//--- the loop for the bars that have not been handled yet
for(int i=prev_calculated;i<rates_total;i++)
{
//--- 0 by default
upbuff[i]=0;
downbuff[i]=0;
//--- check if any data is still present
if(ind<size)
{
for(int j=ind;j<size;j++)
{
//--- if dates coincide, use the value from the file
if(time[i]==time_buff[j])
{
//--- draw the arrow according to the signal
if(sign_buff[j])
upbuff[i]=high[i];
else
downbuff[i]=low[i];
//--- increase the counter
ind=j+1;
break;
}
}
}
}
//--- return value of prev_calculated for next call
return(rates_total);
}
See also
Type bool, FileW rite
FileReadDatetime
R eads from the file of CSV type a string of one of the formats : "YYYY.MM.DD HH:MI:SS" ,
"YYYY.MM.DD" or "HH:MI:SS" - and converts it into a value of datetime type.
datetime FileReadDatetime(
int file_handle // File handle
);
Parameters
file_handle
[in] File descriptor returned by FileOpen().
Return Value
See also
Type datetime, S tringToTime, TimeToS tring, FileW rite
FileReadDouble
R eads a double-precision floating point number (double) from the current position of the binary file.
double FileReadDouble(
int file_handle // File handle
);
Parameters
file_handle
[in] File descriptor returned by FileOpen().
Return Value
See also
R eal types (double, float), S tringToDouble, DoubleToS tring, FileW riteDouble
FileReadFloat
R eads the single-precision floating point number (float) from the current position of the binary file.
float FileReadFloat(
int file_handle // File handle
);
Parameters
file_handle
[in] File descriptor returned by FileOpen().
Return Value
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
ArraySetAsSeries(time,false);
//--- the loop for the bars that have not been handled yet
for(int i=prev_calculated;i<rates_total;i++)
{
//--- 0 by default
buff[i]=0;
color_buff[i]=0; // red color by default
//--- check if any data is still present
if(ind<size)
{
for(int j=ind;j<size;j++)
{
//--- if the dates coincide, the value from the file is used
if(time[i]==time_buff[j])
{
//--- receive the price
buff[i]=close_buff[j];
//--- if the current price exceeds the previous one, the color is blue
if(buff[i-1]>buff[i])
color_buff[i]=1;
//--- increase the counter
ind=j+1;
break;
}
}
}
}
//--- return value of prev_calculated for next call
return(rates_total);
}
See also
R eal types (double, float), FileReadDouble, FileW riteFloat
FileReadInteger
The function reads int, short or char value from the current position of the file pointer depending on
the length specified in bytes.
int FileReadInteger(
int file_handle, // File handle
int size=INT_VALUE // Size of an integer in bytes
);
Parameters
file_handle
[in] File descriptor returned by FileOpen().
size=INT_VALUE
[in] Number of bytes (up to 4 inclusive) that should be read. The corresponding constants are
provided: CHAR_VALUE = 1, SHORT_VALUE = 2 and INT_VALUE = 4, so the function can read the
whole value of char, short or int type.
Return Value
A value of the int type. The result of this function must be explicitly cast to a target type, i.e. to the
type of data that you need to read. S ince a value of the int type is returned, it can be easily
converted to any integer value. The file pointer is shifted by the number of bytes read.
Note
W hen reading less than 4 bytes, the received result is always positive. If one or two bytes are read,
the sign of the number can be determined by explicit casting to type char (1 byte) or short (2 bytes).
Getting the sign for a three-byte number is not trivial, since there is no corresponding underlying
type.
Example (the file obtained after executing the example for FileW riteInteger function is used here)
//+------------------------------------------------------------------+
//| Demo_FileReadInteger.mq5 |
//| Copyright 2013, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2013, MetaQuotes Software Corp."
#property link "https://www.mql5.com"
#property version "1.00"
#property indicator_chart_window
#property indicator_buffers 1
#property indicator_plots 1
//---- plot Label1
#property indicator_label1 "Trends"
#property indicator_type1 DRAW_SECTION
#property indicator_color1 clrRed
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
else
{
PrintFormat("Failed to open %s file, Error code = %d",InpFileName,GetLastError());
return(INIT_FAILED);
}
//--- bind the array to the indicator buffer
SetIndexBuffer(0,buff,INDICATOR_DATA);
//---- set the indicator values that will not be visible on the chart
PlotIndexSetDouble(0,PLOT_EMPTY_VALUE,0);
//---
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
ArraySetAsSeries(time,false);
ArraySetAsSeries(close,false);
//--- the loop for the bars that have not been handled yet
for(int i=prev_calculated;i<rates_total;i++)
{
//--- 0 by default
buff[i]=0;
//--- check if any data is still present
if(ind<size)
{
for(int j=ind;j<size;j++)
{
//--- if dates coincide, the value from the file is used
if(time[i]==time_buff[j])
{
//--- receive the price
buff[i]=close[i];
//--- increase the counter
ind=j+1;
break;
}
}
}
}
//--- return value of prev_calculated for next call
return(rates_total);
}
See also
IntegerToS tring, S tringToInteger, Integer types, FileW riteInteger
FileReadLong
The function reads an integer of long type (8 bytes) from the current position of the binary file.
long FileReadLong(
int file_handle // File handle
);
Parameters
file_handle
[in] File descriptor returned by FileOpen().
Return Value
{
//--- open the file
ResetLastError();
int file_handle=FileOpen(InpDirectoryName+"//"+InpFileName,FILE_READ|FILE_BIN);
if(file_handle!=INVALID_HANDLE)
{
PrintFormat("%s file is open for writing",InpFileName);
PrintFormat("File path: %s\\Files\\",TerminalInfoString(TERMINAL_DATA_PATH));
//--- first, read the amount of data in the file
size=(int)FileReadLong(file_handle);
//--- allocate memory for the arrays
ArrayResize(volume_buff,size);
ArrayResize(time_buff,size);
//--- read data from the file
for(int i=0;i<size;i++)
{
time_buff[i]=(datetime)FileReadLong(file_handle);
volume_buff[i]=FileReadLong(file_handle);
}
//--- close the file
FileClose(file_handle);
PrintFormat("Data is read, %s file is closed",InpFileName);
}
else
{
PrintFormat("Failed to open %s file, Error code = %d",InpFileName,GetLastError());
return(INIT_FAILED);
}
//--- bind the array to the indicator buffer with 0 index
SetIndexBuffer(0,buff,INDICATOR_DATA);
//---- set the indicator values that will be visible on the chart
PlotIndexSetDouble(0,PLOT_EMPTY_VALUE,0);
//---
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
ArraySetAsSeries(time,false);
//--- the loop for the bars that have not been handled yet
for(int i=prev_calculated;i<rates_total;i++)
{
//--- 0 by default
buff[i]=0;
//--- check if any data is still present
if(ind<size)
{
for(int j=ind;j<size;j++)
{
//--- if dates coincide, the value from the file is used
if(time[i]==time_buff[j])
{
buff[i]=(double)volume_buff[j];
ind=j+1;
break;
}
}
}
}
//--- return value of prev_calculated for next call
return(rates_total);
}
See also
Integer types, FileReadInteger, FileW riteLong
FileReadNumber
The function reads from the CSV file a string from the current position till a separator (or till the end
of a text string) and converts the read string to a value of double type.
double FileReadNumber(
int file_handle // File handle
);
Parameters
file_handle
[in] File descriptor returned by FileOpen().
Return Value
//---- set the indicator values that will not be visible on the chart
PlotIndexSetDouble(0,PLOT_EMPTY_VALUE,0);
//---
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Read the file's string data |
//+------------------------------------------------------------------+
void ReadData(const int file_handle,datetime &arr[],int &size,int &def_size)
{
bool flag=false;
//--- read till the end of the string or of the file is reached
while(!FileIsLineEnding(file_handle) && !FileIsEnding(file_handle))
{
//--- shift the carriage after reading the number
if(flag)
FileReadNumber(file_handle);
//--- store the current date
arr[size]=FileReadDatetime(file_handle);
size++;
//--- increase the array size if necessary
if(size==def_size)
{
def_size+=100;
ArrayResize(arr,def_size);
}
//--- slip past the first iteration
flag=true;
}
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
ArraySetAsSeries(time,false);
ArraySetAsSeries(open,false);
ArraySetAsSeries(high,false);
ArraySetAsSeries(low,false);
ArraySetAsSeries(close,false);
//--- the loop for the bars that have not been handled yet
for(int i=prev_calculated;i<rates_total;i++)
{
//--- 0 by default
open_buff[i]=0;
high_buff[i]=0;
low_buff[i]=0;
close_buff[i]=0;
color_buff[i]=0;
//--- check if any date is still present
if(ovb_ind<ovb_size)
for(int j=ovb_ind;j<ovb_size;j++)
{
//--- if the dates coincide, the bar is in the overbought area
if(time[i]==ovb_time[j])
{
open_buff[i]=open[i];
high_buff[i]=high[i];
low_buff[i]=low[i];
close_buff[i]=close[i];
//--- 0 - red color
color_buff[i]=0;
//--- increase the counter
ovb_ind=j+1;
break;
}
}
//--- check if any data still exists
if(ovs_ind<ovs_size)
for(int j=ovs_ind;j<ovs_size;j++)
{
//--- if the dates coincide, the bar is in the oversold area
if(time[i]==ovs_time[j])
{
open_buff[i]=open[i];
high_buff[i]=high[i];
low_buff[i]=low[i];
close_buff[i]=close[i];
//--- 1 - blue color
color_buff[i]=1;
//--- increase the counter
ovs_ind=j+1;
break;
}
}
}
//--- return value of prev_calculated for next call
return(rates_total);
}
//+------------------------------------------------------------------+
//| ChartEvent event handler |
//+------------------------------------------------------------------+
void OnChartEvent(const int id,
const long &lparam,
const double &dparam,
const string &sparam
)
{
//--- change the indicator width according to the scale
if(ChartGetInteger(0,CHART_SCALE)>3)
PlotIndexSetInteger(0,PLOT_LINE_WIDTH,2);
else
PlotIndexSetInteger(0,PLOT_LINE_WIDTH,1);
}
See also
FileW riteS tring
FileReadString
The function reads a string from the current position of a file pointer in a file.
string FileReadString(
int file_handle, // File handle
int length=-1 // Length of the string
);
Parameters
file_handle
[in] File descriptor returned by FileOpen().
length=-1
[in] Number of characters to read.
Return Value
W hen reading from a bin-file. the length of a string to read must be specified. W hen reading from a
txt-file the string length is not required, and the string will be read from the current position to the
line feed character "\r\n" . W hen reading from a csv-file, the string length isn't required also, the
string will be read from the current position till the nearest delimiter or till the text string end
character.
If the file is opened with FILE_ANS I flag, then the line read is converted to Unicode.
Example (the file obtained after executing the example for FileW riteInteger function is used here)
//--- display the window of input parameters when launching the script
#property script_show_inputs
//--- parameters for data reading
input string InpFileName="Trend.bin"; // file name
input string InpDirectoryName="Data"; // directory name
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- open the file
ResetLastError();
int file_handle=FileOpen(InpDirectoryName+"//"+InpFileName,FILE_READ|FILE_BIN|FILE_ANSI);
if(file_handle!=INVALID_HANDLE)
{
PrintFormat("%s file is available for reading",InpFileName);
PrintFormat("File path: %s\\Files\\",TerminalInfoString(TERMINAL_DATA_PATH));
//--- additional variables
int str_size;
string str;
See also
S tring Type, Conversion Functions, FileW riteInteger
FileReadStruct
The function reads contents into a structure passed as a parameter from a binary-file, starting with
the current position of the file pointer.
uint FileReadStruct(
int file_handle, // file handle
const void& struct_object, // target structure to which the contents are read
int size=-1 // structure size in bytes
);
Parameters
file_handle
[in] File descriptor of an open bin-file.
struct_object
[out] The object of this structure. The structure should not contain strings, dynamic arrays or
virtual functions.
size=-1
[in] Number of bytes that should be read. If size is not specified or the indicated value is greater
than the size of the structure, the exact size of the specified structure is used.
Return Value
If successful the function returns the number of bytes read. File pointer is moved by the same
number of bytes.
Example (the file obtained after using the example for FileW riteS truct function is used here)
//+------------------------------------------------------------------+
//| Demo_FileReadStruct.mq5 |
//| Copyright 2013, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2013, MetaQuotes Software Corp."
#property link "https://www.mql5.com"
#property version "1.00"
#property indicator_separate_window
#property indicator_buffers 4
#property indicator_plots 1
//---- plot Label1
#property indicator_label1 "Candles"
#property indicator_type1 DRAW_CANDLES
#property indicator_color1 clrOrange
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
#property indicator_separate_window
//--- parameters for receiving data
input string InpFileName="EURUSD.txt"; // file name
input string InpDirectoryName="Data"; // directory name
//+------------------------------------------------------------------+
//| Structure for storing candlestick data |
//+------------------------------------------------------------------+
struct candlesticks
{
double open; // open price
double close; // close price
double high; // high price
double low; // low price
datetime date; // date
};
//--- indicator buffers
double open_buff[];
double close_buff[];
double high_buff[];
double low_buff[];
//--- global variables
candlesticks cand_buff[];
int size=0;
int ind=0;
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
int default_size=100;
ArrayResize(cand_buff,default_size);
//--- open the file
ResetLastError();
int file_handle=FileOpen(InpDirectoryName+"//"+InpFileName,FILE_READ|FILE_BIN|FILE_COMMON);
if(file_handle!=INVALID_HANDLE)
{
PrintFormat("%s file is available for reading",InpFileName);
PrintFormat("File path: %s\\Files\\",TerminalInfoString(TERMINAL_COMMONDATA_PATH));
//--- read data from the file
while(!FileIsEnding(file_handle))
{
//--- write data to the array
FileReadStruct(file_handle,cand_buff[size]);
size++;
//--- check if the array is overflown
if(size==default_size)
{
//--- increase the array size
default_size+=100;
ArrayResize(cand_buff,default_size);
}
}
//--- close the file
FileClose(file_handle);
PrintFormat("Data is read, %s file is closed",InpFileName);
}
else
{
PrintFormat("Failed to open %s file, Error code = %d",InpFileName,GetLastError());
return(INIT_FAILED);
}
//--- indicator buffers mapping
SetIndexBuffer(0,open_buff,INDICATOR_DATA);
SetIndexBuffer(1,high_buff,INDICATOR_DATA);
SetIndexBuffer(2,low_buff,INDICATOR_DATA);
SetIndexBuffer(3,close_buff,INDICATOR_DATA);
//--- empty value
PlotIndexSetDouble(0,PLOT_EMPTY_VALUE,0);
//---
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
ArraySetAsSeries(time,false);
//--- the loop for the candlesticks that have not been handled yet
for(int i=prev_calculated;i<rates_total;i++)
{
//--- 0 by default
open_buff[i]=0;
close_buff[i]=0;
high_buff[i]=0;
low_buff[i]=0;
//--- check if any data is still present
if(ind<size)
{
for(int j=ind;j<size;j++)
{
//--- if dates coincide, the value from the file is used
if(time[i]==cand_buff[j].date)
{
open_buff[i]=cand_buff[j].open;
close_buff[i]=cand_buff[j].close;
high_buff[i]=cand_buff[j].high;
low_buff[i]=cand_buff[j].low;
//--- increase the counter
ind=j+1;
break;
}
}
}
}
//--- return value of prev_calculated for next call
return(rates_total);
}
See also
S tructures and classes, FileW riteS truct
FileSeek
The function moves the position of the file pointer by a specified number of bytes relative to the
specified position.
bool FileSeek(
int file_handle, // File handle
long offset, // In bytes
ENUM_FILE_POSITION origin // Position for reference
);
Parameters
file_handle
[in] File descriptor returned by FileOpen().
offset
[in] The shift in bytes (may take a negative value).
origin
[in] The starting point for the displacement. Can be one of values of ENUM _FILE_POS ITION.
Return Value
If successful the function returns true, otherwise false. To obtain information about the error call
the GetLastError() function.
Note
If the execution of the FileS eek() function results in a negative shift (going beyond the " level
boundary" of the file), the file pointer will be set to the file beginning.
If a position is set beyond the " right boundary" of the file (larger than the file size), the next writing
to the file will be performed not from the end of the file, but from the position set. In this case
indefinite values will be written for the previous file end and the position set.
Example:
//+------------------------------------------------------------------+
//| Demo_FileSeek.mq5 |
//| Copyright 2013, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2013, MetaQuotes Software Corp."
#property link "https://www.mql5.com"
#property version "1.00"
//--- display the window of input parameters when launching the script
#property script_show_inputs
//--- input parameters
input string InpFileName="file.txt"; // file name
input string InpDirectoryName="Data"; // directory name
input int InpEncodingType=FILE_ANSI; // ANSI=32 or UNICODE=64
//+------------------------------------------------------------------+
int def_size=127;
//--- allocate memory for the array
ArrayResize(arr,def_size);
//--- string counter
int i=0;
//--- if this is not the file's end, then there is at least one string
if(!FileIsEnding(handle))
{
arr[i]=FileTell(handle);
i++;
}
else
return; // the file is empty, exit
//--- define the shift in bytes depending on encoding
int shift;
if(FileGetInteger(handle,FILE_IS_ANSI))
shift=1;
else
shift=2;
//--- go through the strings in the loop
while(1)
{
//--- read the string
FileReadString(handle);
//--- check for the file end
if(!FileIsEnding(handle))
{
//--- store the next string's position
arr[i]=FileTell(handle)+shift;
i++;
//--- increase the size of the array if it is overflown
if(i==def_size)
{
def_size+=def_size+1;
ArrayResize(arr,def_size);
}
}
else
break; // end of the file, exit
}
//--- define the actual size of the array
ArrayResize(arr,i);
}
FileSize
The function returns the file size in bytes.
ulong FileSize(
int file_handle // File handle
);
Parameters
file_handle
[in] File descriptor returned by FileOpen().
Return Value
//--- show the window of input parameters when launching the script
#property script_show_inputs
//--- input parameters
input ulong InpThresholdSize=20; // file threshold size in kilobytes
input string InpBigFolderName="big"; // folder for large files
input string InpSmallFolderName="small"; // folder for small files
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
string file_name; // variable for storing file names
string filter="*.csv"; // filter for searching the files
ulong file_size=0; // file size in bytes
int size=0; // number of files
//--- print the path to the file we are going to work with
PrintFormat("Working in %s\\Files\\ folder",TerminalInfoString(TERMINAL_COMMONDATA_PATH));
//--- receive the search handle in common folder's root of all terminals
long search_handle=FileFindFirst(filter,file_name,FILE_COMMON);
//--- check if FileFindFirst() has been executed successfully
if(search_handle!=INVALID_HANDLE)
{
//--- move files in the loop according to their size
do
{
//--- open the file
ResetLastError();
int file_handle=FileOpen(file_name,FILE_READ|FILE_CSV|FILE_COMMON);
if(file_handle!=INVALID_HANDLE)
{
//--- receive the file size
file_size=FileSize(file_handle);
//--- close the file
FileClose(file_handle);
}
else
{
PrintFormat("Failed to open %s file, Error code = %d",file_name,GetLastError());
continue;
}
//--- print the file size
PrintFormat("Size of %s file is equal to %d bytes",file_name,file_size);
//--- define the path for moving the file
string path;
if(file_size>InpThresholdSize*1024)
path=InpBigFolderName+"//"+file_name;
else
path=InpSmallFolderName+"//"+file_name;
//--- move the file
ResetLastError();
if(FileMove(file_name,FILE_COMMON,path,FILE_REWRITE|FILE_COMMON))
PrintFormat("%s file is moved",file_name);
else
PrintFormat("Error, code = %d",GetLastError());
}
while(FileFindNext(search_handle,file_name));
//--- close the search handle
FileFindClose(search_handle);
}
else
Print("Files not found!");
}
FileTell
The file returns the current position of the file pointer of an open file.
ulong FileTell(
int file_handle // File handle
);
Parameters
file_handle
[in] File descriptor returned by FileOpen().
Return Value
Current position of the file descriptor in bytes from the beginning of the file.
Note
//+------------------------------------------------------------------+
//| Demo_FileTell.mq5 |
//| Copyright 2013, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2013, MetaQuotes Software Corp."
#property link "https://www.mql5.com"
#property version "1.00"
//--- display the window of input parameters when launching the script
#property script_show_inputs
//--- input parameters
input string InpFileName="file.txt"; // file name
input string InpDirectoryName="Data"; // directory name
input int InpEncodingType=FILE_ANSI; // ANSI=32 or UNICODE=64
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- specify the value of the variable for generating random numbers
_RandomSeed=GetTickCount();
//--- variables for positions of the strings' start points
ulong pos[];
int size;
//--- reset the error value
ResetLastError();
//--- open the file
int file_handle=FileOpen(InpDirectoryName+"//"+InpFileName,FILE_READ|FILE_TXT|InpEncodingType);
if(file_handle!=INVALID_HANDLE)
{
PrintFormat("%s file is available for reading",InpFileName);
//--- receive start position for each string in the file
GetStringPositions(file_handle,pos);
//--- define the number of strings in the file
size=ArraySize(pos);
if(!size)
{
//--- stop if the file does not have strings
PrintFormat("%s file is empty!",InpFileName);
FileClose(file_handle);
return;
}
//--- make a random selection of a string number
int ind=MathRand()%size;
//--- shift position to the starting point of the string
FileSeek(file_handle,pos[ind],SEEK_SET);
//--- read and print the string with ind number
PrintFormat("String text with %d number: \"%s\"",ind,FileReadString(file_handle));
//--- close the file
FileClose(file_handle);
PrintFormat("%s file is closed",InpFileName);
}
else
PrintFormat("Failed to open %s file, Error code = %d",InpFileName,GetLastError());
}
//+-------------------------------------------------------------------------------+
//| The function defines starting points for each of the strings in the file and |
//| places them in arr array |
//+-------------------------------------------------------------------------------+
void GetStringPositions(const int handle,ulong &arr[])
{
//--- default array size
int def_size=127;
//--- allocate memory for the array
ArrayResize(arr,def_size);
//--- string counter
int i=0;
//--- if this is not the file's end, then there is at least one string
if(!FileIsEnding(handle))
{
arr[i]=FileTell(handle);
i++;
}
else
return; // the file is empty, exit
//--- define the shift in bytes depending on encoding
int shift;
if(FileGetInteger(handle,FILE_IS_ANSI))
shift=1;
else
shift=2;
//--- go through the strings in the loop
while(1)
{
//--- read the string
FileReadString(handle);
//--- check for the file end
if(!FileIsEnding(handle))
{
//--- store the next string's position
arr[i]=FileTell(handle)+shift;
i++;
//--- increase the size of the array if it is overflown
if(i==def_size)
{
def_size+=def_size+1;
ArrayResize(arr,def_size);
}
}
else
break; // end of the file, exit
}
//--- define the actual size of the array
ArrayResize(arr,i);
}
FileWrite
The function is intended for writing of data into a CSV file, delimiter being inserted automatically
unless it is equal to 0. After writing into the file, the line end character "\r\n" will be added.
uint FileWrite(
int file_handle, // File handle
... // List of recorded parameters
);
Parameters
file_handle
[in] File descriptor returned by FileOpen().
...
[in]The list of parameters separated by commas, to write to the file. The number of written
parameters can be up to 63.
Return Value
Numbers will be converted into a text at output (see the Print() function). Data of the double type
are output with the accuracy of 16 digits after the decimal point, and the data can be displayed
either in traditional or in scientific format - depending on which format will be the most compact.
The data of the float type are shown with 5 digits after the decimal point. To output real numbers
with different precision or in a clearly specified format, use DoubleToS tring().
Numbers of the bool type are displayed as " true" or " false" strings. Numbers of the datetime type are
displayed as "YYYY.MM.DD HH:MI:SS" .
Example:
//+------------------------------------------------------------------+
//| Demo_FileWrite.mq5 |
//| Copyright 2013, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2013, MetaQuotes Software Corp."
#property link "https://www.mql5.com"
#property version "1.00"
//--- show the window of input parameters when launching the script
#property script_show_inputs
//--- parameters for receiving data from the terminal
input string InpSymbolName="EURUSD"; // currency pair
input ENUM_TIMEFRAMES InpSymbolPeriod=PERIOD_H1; // time frame
input int InpFastEMAPeriod=12; // fast EMA period
input int InpSlowEMAPeriod=26; // slow EMA period
input int InpSignalPeriod=9; // difference averaging period
input ENUM_APPLIED_PRICE InpAppliedPrice=PRICE_CLOSE; // price type
ArrayResize(sign_buff,macd_size-1);
ArrayResize(time_buff,macd_size-1);
for(int i=1;i<macd_size;i++)
{
//--- buy signal
if(macd_buff[i-1]<0 && macd_buff[i]>=0)
{
sign_buff[sign_size]=true;
time_buff[sign_size]=date_buff[i];
sign_size++;
}
//--- sell signal
if(macd_buff[i-1]>0 && macd_buff[i]<=0)
{
sign_buff[sign_size]=false;
time_buff[sign_size]=date_buff[i];
sign_size++;
}
}
//--- open the file for writing the indicator values (if the file is absent, it will be created aut
ResetLastError();
int file_handle=FileOpen(InpDirectoryName+"//"+InpFileName,FILE_READ|FILE_WRITE|FILE_CSV);
if(file_handle!=INVALID_HANDLE)
{
PrintFormat("%s file is available for writing",InpFileName);
PrintFormat("File path: %s\\Files\\",TerminalInfoString(TERMINAL_DATA_PATH));
//--- first, write the number of signals
FileWrite(file_handle,sign_size);
//--- write the time and values of signals to the file
for(int i=0;i<sign_size;i++)
FileWrite(file_handle,time_buff[i],sign_buff[i]);
//--- close the file
FileClose(file_handle);
PrintFormat("Data is written, %s file is closed",InpFileName);
}
else
PrintFormat("Failed to open %s file, Error code = %d",InpFileName,GetLastError());
}
See also
Comment, Print, S tringFormat
FileWriteArray
The function writes arrays of any type except for string to a BIN file (can be an array of structures not
containing strings or dynamic arrays).
uint FileWriteArray(
int file_handle, // File handle
const void& array[], // Array
int start=0, // Start index in the array
int count=WHOLE_ARRAY // Number of elements
);
Parameters
file_handle
[in] File descriptor returned by FileOpen().
array[]
[out] Array for recording.
start=0
[in] Initial index in the array (number of the first recorded element).
count=WHOLE_ARRAY
[in] Number of items to write (WHOLE_ARRAY means that all items starting with the number start
until the end of the array will be written).
Return Value
S tring
array can be recorded in a TXT file. In this case, strings are automatically ended by the line
end characters "\r\n" . Depending on the file type ANS I or UNICODE, strings are either converted to
ansi-encoding or not.
Example:
//+------------------------------------------------------------------+
//| Demo_FileWriteArray.mq5 |
//| Copyright 2013, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2013, MetaQuotes Software Corp."
#property link "https://www.mql5.com"
#property version "1.00"
//--- input parameters
input string InpFileName="data.bin";
input string InpDirectoryName="SomeFolder";
//+------------------------------------------------------------------+
//| Structure for storing price data |
//+------------------------------------------------------------------+
struct prices
{
datetime date; // date
double bid; // bid price
double ask; // ask price
};
//--- global variables
int count=0;
int size=20;
string path=InpDirectoryName+"//"+InpFileName;
prices arr[];
//+------------------------------------------------------------------+
//| Expert initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- allocate memory for the array
ArrayResize(arr,size);
//---
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Expert deinitialization function |
//+------------------------------------------------------------------+
void OnDeinit(const int reason)
{
//--- write the remaining count strings if count<n
WriteData(count);
}
//+------------------------------------------------------------------+
//| Expert tick function |
//+------------------------------------------------------------------+
void OnTick()
{
//--- save data to array
arr[count].date=TimeCurrent();
arr[count].bid=SymbolInfoDouble(Symbol(),SYMBOL_BID);
arr[count].ask=SymbolInfoDouble(Symbol(),SYMBOL_ASK);
//--- show current data
Print("Date = ",arr[count].date," Bid = ",arr[count].bid," Ask = ",arr[count].ask);
//--- increase the counter
count++;
//--- if the array is filled, write data to the file and zero it out
if(count==size)
{
WriteData(size);
count=0;
}
}
//+------------------------------------------------------------------+
//| Write n elements of the array to file |
//+------------------------------------------------------------------+
void WriteData(const int n)
{
//--- open the file
ResetLastError();
int handle=FileOpen(path,FILE_READ|FILE_WRITE|FILE_BIN);
if(handle!=INVALID_HANDLE)
{
//--- write array data to the end of the file
FileSeek(handle,0,SEEK_END);
FileWriteArray(handle,arr,0,n);
//--- close the file
FileClose(handle);
}
else
Print("Failed to open the file, error ",GetLastError());
}
See also
Variables, FileS eek
FileWriteDouble
The function writes the value of a double parameter to a a bin-file, starting from the current position
of the file pointer.
uint FileWriteDouble(
int file_handle, // File handle
double value // Value to write
);
Parameters
file_handle
[in] File descriptor returned by FileOpen().
value
[in] The value of double type.
Return Value
If successful the function returns the number of bytes written (in this case sizeof(double)=8). The
file pointer is shifted by the same number of bytes.
Example:
//+------------------------------------------------------------------+
//| Demo_FileWriteDouble.mq5 |
//| Copyright 2013, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2013, MetaQuotes Software Corp."
#property link "https://www.mql5.com"
#property version "1.00"
//--- show the window of input parameters when launching the script
#property script_show_inputs
//--- parameters for receiving data from the terminal
input string InpSymbolName="EURJPY"; // currency pair
input ENUM_TIMEFRAMES InpSymbolPeriod=PERIOD_M15; // time frame
input int InpMAPeriod=10; // smoothing period
input int InpMAShift=0; // indicator shift
input ENUM_MA_METHOD InpMAMethod=MODE_SMA; // smoothing type
input ENUM_APPLIED_PRICE InpAppliedPrice=PRICE_CLOSE; // price type
input datetime InpDateStart=D'2013.01.01 00:00'; // data copying start date
//--- parameters for writing data to the file
input string InpFileName="MA.csv"; // file name
input string InpDirectoryName="Data"; // directory name
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
datetime date_finish=TimeCurrent();
double ma_buff[];
datetime time_buff[];
int size;
//--- receive MA indicator handle
ResetLastError();
int ma_handle=iMA(InpSymbolName,InpSymbolPeriod,InpMAPeriod,InpMAShift,InpMAMethod,InpAppliedPri
if(ma_handle==INVALID_HANDLE)
{
//--- failed to receive the indicator handle
PrintFormat("Error when receiving indicator handle. Error code = %d",GetLastError());
return;
}
//--- being in the loop until the indicator calculates all its values
while(BarsCalculated(ma_handle)==-1)
Sleep(20); // a pause to allow the indicator to calculate all its values
PrintFormat("Indicator values starting from %s will be written to the file",TimeToString(InpDate
//--- copy the indicator values
ResetLastError();
if(CopyBuffer(ma_handle,0,InpDateStart,date_finish,ma_buff)==-1)
{
PrintFormat("Failed to copy the indicator values. Error code = %d",GetLastError());
return;
}
//--- copy the time of the appropriate bars' arrival
ResetLastError();
if(CopyTime(InpSymbolName,InpSymbolPeriod,InpDateStart,date_finish,time_buff)==-1)
{
PrintFormat("Failed to copy time values. Error code = %d",GetLastError());
return;
}
//--- receive the buffer size
size=ArraySize(ma_buff);
//--- free the memory occupied by the indicator
IndicatorRelease(ma_handle);
//--- open the file for writing the indicator values (if the file is absent, it will be created aut
ResetLastError();
int file_handle=FileOpen(InpDirectoryName+"//"+InpFileName,FILE_READ|FILE_WRITE|FILE_BIN);
if(file_handle!=INVALID_HANDLE)
{
PrintFormat("%s file is available for writing",InpFileName);
PrintFormat("File path: %s\\Files\\",TerminalInfoString(TERMINAL_DATA_PATH));
//--- first, write the size of data sample
FileWriteDouble(file_handle,(double)size);
//--- write the indicator time and value to the file
for(int i=0;i<size;i++)
{
FileWriteDouble(file_handle,(double)time_buff[i]);
FileWriteDouble(file_handle,ma_buff[i]);
}
//--- close the file
FileClose(file_handle);
PrintFormat("Data is written, %s file is closed",InpFileName);
}
else
PrintFormat("Failed to open %s file, Error code = %d",InpFileName,GetLastError());
}
See also
R eal types (double, float)
FileWriteFloat
The function writes the value of the float parameter to a bin-file, starting from the current position of
the file pointer.
uint FileWriteFloat(
int file_handle, // File handle
float value // Value to be written
);
Parameters
file_handle
[in] File descriptor returned by FileOpen().
value
[in] The value of float type.
Return Value
If successful the function returns the number of bytes written (in this case sizeof(float)=4). The file
pointer is shifted by the same number of bytes.
Example:
//+------------------------------------------------------------------+
//| Demo_FileWriteFloat.mq5 |
//| Copyright 2013, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2013, MetaQuotes Software Corp."
#property link "https://www.mql5.com"
#property version "1.00"
//--- show the window of input parameters when launching the script
#property script_show_inputs
//--- parameters for receiving data from the terminal
input string InpSymbolName="EURUSD"; // currency pair
input ENUM_TIMEFRAMES InpSymbolPeriod=PERIOD_M15; // time frame
input datetime InpDateStart=D'2013.01.01 00:00'; // data copying start date
//--- parameters for writing data to the file
input string InpFileName="Close.bin"; // file name
input string InpDirectoryName="Data"; // directory name
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
datetime date_finish=TimeCurrent();
double close_buff[];
datetime time_buff[];
int size;
See also
R eal types (double, float), FileW riteDouble
FileWriteInteger
The function writes the value of the int parameter to a bin-file, starting from the current position of
the file pointer.
uint FileWriteInteger(
int file_handle, // File handle
int value, // Value to be written
int size=INT_VALUE // Size in bytes
);
Parameters
file_handle
[in] File descriptor returned by FileOpen().
value
[in] Integer value.
size=INT_VALUE
[in] Number of bytes (up to 4 inclusive), that should be written. The corresponding constants are
provided: CHAR_VALUE=1, SHORT_VALUE=2 and INT_VALUE=4, so the function can write the
integer value of char, uchar, short, ushort, int, or uint type.
Return Value
If successful the function returns the number of bytes written. The file pointer is shifted by the
same number of bytes.
Example:
//+------------------------------------------------------------------+
//| Demo_FileWriteInteger.mq5 |
//| Copyright 2013, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2013, MetaQuotes Software Corp."
#property link "https://www.mql5.com"
#property version "1.00"
//--- show the window of input parameters when launching the script
#property script_show_inputs
//--- parameters for receiving data from the terminal
input string InpSymbolName="EURUSD"; // currency pair
input ENUM_TIMEFRAMES InpSymbolPeriod=PERIOD_H1; // time frame
input datetime InpDateStart=D'2013.01.01 00:00'; // data copying start date
//--- parameters for writing data to the file
input string InpFileName="Trend.bin"; // file name
input string InpDirectoryName="Data"; // directory name
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
datetime date_finish=TimeCurrent();
double close_buff[];
datetime time_buff[];
int size;
//--- reset the error value
ResetLastError();
//--- copy the close price for each bar
if(CopyClose(InpSymbolName,InpSymbolPeriod,InpDateStart,date_finish,close_buff)==-1)
{
PrintFormat("Failed to copy the values of close prices. Error code = %d",GetLastError());
return;
}
//--- copy the time for each bar
if(CopyTime(InpSymbolName,InpSymbolPeriod,InpDateStart,date_finish,time_buff)==-1)
{
PrintFormat("Failed to copy time values. Error code = %d",GetLastError());
return;
}
//--- receive the buffer size
size=ArraySize(close_buff);
//--- open the file for writing the values (if the file is absent, it will be created automatically
ResetLastError();
int file_handle=FileOpen(InpDirectoryName+"//"+InpFileName,FILE_READ|FILE_WRITE|FILE_BIN);
if(file_handle!=INVALID_HANDLE)
{
PrintFormat("%s file is available for writing",InpFileName);
PrintFormat("File path: %s\\Files\\",TerminalInfoString(TERMINAL_DATA_PATH));
//---
int up_down=0; // trend flag
int arr_size; // arr array size
uchar arr[]; // uchar type array
//--- write time values to the file
for(int i=0;i<size-1;i++)
{
//--- compare close prices of the current and next bars
if(close_buff[i]<=close_buff[i+1])
{
if(up_down!=1)
{
//--- write date value to the file using FileWriteInteger
StringToCharArray(TimeToString(time_buff[i]),arr);
arr_size=ArraySize(arr);
//--- first, write the number of symbols in the array
FileWriteInteger(file_handle,arr_size,INT_VALUE);
//--- write the symbols
for(int j=0;j<arr_size;j++)
FileWriteInteger(file_handle,arr[j],CHAR_VALUE);
//--- change the trend flag
up_down=1;
}
}
else
{
if(up_down!=-1)
{
//--- write the date value to the file using FileWriteInteger
StringToCharArray(TimeToString(time_buff[i]),arr);
arr_size=ArraySize(arr);
//--- first, write the number of symbols in the array
FileWriteInteger(file_handle,arr_size,INT_VALUE);
//--- write the symbols
for(int j=0;j<arr_size;j++)
FileWriteInteger(file_handle,arr[j],CHAR_VALUE);
//--- change the trend flag
up_down=-1;
}
}
}
//--- close the file
FileClose(file_handle);
PrintFormat("Data is written, %s file is closed",InpFileName);
}
else
PrintFormat("Failed to open %s file, Error code = %d",InpFileName,GetLastError());
}
See also
IntegerToS tring, S tringToInteger, Integer types
FileWriteLong
The function writes the value of the long-type parameter to a bin-file, starting from the current
position of the file pointer.
uint FileWriteLong(
int file_handle, // File handle
long value // Value to be written
);
Parameters
file_handle
[in] File descriptor returned by FileOpen().
value
[in] Value of type long.
Return Value
If successful the function returns the number of bytes written (in this case sizeof(long)=8). The file
pointer is shifted by the same number of bytes.
Example:
//+------------------------------------------------------------------+
//| Demo_FileWriteLong.mq5 |
//| Copyright 2013, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2013, MetaQuotes Software Corp."
#property link "https://www.mql5.com"
#property version "1.00"
//--- show the window of input parameters when launching the script
#property script_show_inputs
//--- parameters for receiving data from the terminal
input string InpSymbolName="EURUSD"; // currency pair
input ENUM_TIMEFRAMES InpSymbolPeriod=PERIOD_H1; // time frame
input datetime InpDateStart=D'2013.01.01 00:00'; // data copying start date
//--- parameters for writing data to the file
input string InpFileName="Volume.bin"; // file name
input string InpDirectoryName="Data"; // directory name
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
datetime date_finish=TimeCurrent();
long volume_buff[];
datetime time_buff[];
int size;
See also
Integer types, FileW riteInteger
FileWriteString
The function writes the value of a string-type parameter into a BIN, CSV or TXT file starting from the
current position of the file pointer. W hen writing to a CSV or TXT file: if there is a symbol in the string
'\n' (L F) without previous character '\r' (CR ), then before '\n' the missing '\r' is added.
uint FileWriteString(
int file_handle, // File handle
const string text_string, // string to write
int length=-1 // number of symbols
);
Parameters
file_handle
[in] File descriptor returned by FileOpen().
text_string
[in] S tring.
length=-1
[in] The number of characters that you want to write. This option is needed for writing a string
into a BIN file. If the size is not specified, then the entire string without the trailer 0 is written. If
you specify a size smaller than the length of the string, then a part of the string without the trailer
0 is written. If you specify a size greater than the length of the string, the string is filled by the
appropriate number of zeros. For files of CSV and TXT type, this parameter is ignored and the
string is written entirely.
Return Value
If successful the function returns the number of bytes written. The file pointer is shifted by the
same number of bytes.
Note
Note that when writing to a file opened by the FILE_UNICODE flag (or without a flag FILE_ANS I), then
the number of bytes written will be twice as large as the number of string characters written. W hen
recording to a file opened with the FILE_ANS I flag, the number of bytes written will coincide with the
number of string characters written.
Example:
//+------------------------------------------------------------------+
//| Demo_FileWriteString.mq5 |
//| Copyright 2013, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2013, MetaQuotes Software Corp."
#property link "https://www.mql5.com"
#property version "1.00"
//--- show the window of input parameters when launching the script
#property script_show_inputs
//--- parameters for receiving data from the terminal
//--- open the file for writing the indicator values (if the file is absent, it will be created aut
ResetLastError();
int file_handle=FileOpen(InpDirectoryName+"//"+InpFileName,FILE_READ|FILE_WRITE|FILE_CSV|FILE_AN
if(file_handle!=INVALID_HANDLE)
{
PrintFormat("%s file is available for writing",InpFileName);
PrintFormat("File path: %s\\Files\\",TerminalInfoString(TERMINAL_DATA_PATH));
//--- prepare additional variables
string str="";
bool is_formed=false;
//--- write dates of forming overbought and oversold areas
for(int i=0;i<rsi_size;i++)
{
//--- check the indicator values
if(rsi_buff[i]>=70 || rsi_buff[i]<=30)
{
//--- if the value is the first one in this area
if(!is_formed)
{
//--- add the value and the date
str=(string)rsi_buff[i]+"\t"+(string)date_buff[i];
is_formed=true;
}
else
str+="\t"+(string)rsi_buff[i]+"\t"+(string)date_buff[i];
//--- move to the next loop iteration
continue;
}
//--- check the flag
if(is_formed)
{
//--- the string is formed, write it to the file
FileWriteString(file_handle,str+"\r\n");
is_formed=false;
}
}
//--- close the file
FileClose(file_handle);
PrintFormat("Data is written, %s file is closed",InpFileName);
}
else
PrintFormat("Failed to open %s file, Error code = %d",InpFileName,GetLastError());
}
See also
S tring Type, S tringFormat
FileWriteStruct
The function writes into a bin-file contents of a structure passed as a parameter, starting from the
current position of the file pointer.
uint FileWriteStruct(
int file_handle, // File handle
const void& struct_object, // link to an object
int size=-1 // size to be written in bytes
);
Parameters
file_handle
[in] File descriptor returned by FileOpen().
struct_object
[in] R eference to the object of this structure. The structure should not contain strings, dynamic
arrays or virtual functions.
size=-1
[in] Number of bytes that you want to record. If size is not specified or the specified number of
bytes is greater than the size of the structure, the entire structure is written.
Return Value
If successful the function returns the number of bytes written. The file pointer is shifted by the
same number of bytes.
Example:
//+------------------------------------------------------------------+
//| Demo_FileWiteStruct.mq5 |
//| Copyright 2013, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2013, MetaQuotes Software Corp."
#property link "https://www.mql5.com"
#property version "1.00"
//--- show the window of input parameters when launching the script
#property script_show_inputs
//--- parameters for receiving data from the terminal
input string InpSymbolName="EURUSD"; // currency pair
input ENUM_TIMEFRAMES InpSymbolPeriod=PERIOD_H1; // time frame
input datetime InpDateStart=D'2013.01.01 00:00'; // data copying start date
//--- parameters for writing data to the file
input string InpFileName="EURUSD.txt"; // file name
input string InpDirectoryName="Data"; // directory name
//+------------------------------------------------------------------+
//| Structure for storing candlestick data |
//+------------------------------------------------------------------+
struct candlesticks
{
double open; // open price
double close; // close price
double high; // high price
double low; // low price
datetime date; // date
};
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
datetime date_finish=TimeCurrent();
int size;
datetime time_buff[];
double open_buff[];
double close_buff[];
double high_buff[];
double low_buff[];
candlesticks cand_buff[];
//--- reset the error value
ResetLastError();
//--- receive the time of the arrival of the bars from the range
if(CopyTime(InpSymbolName,InpSymbolPeriod,InpDateStart,date_finish,time_buff)==-1)
{
PrintFormat("Failed to copy time values. Error code = %d",GetLastError());
return;
}
//--- receive high prices of the bars from the range
if(CopyHigh(InpSymbolName,InpSymbolPeriod,InpDateStart,date_finish,high_buff)==-1)
{
PrintFormat("Failed to copy values of high prices. Error code = %d",GetLastError());
return;
}
//--- receive low prices of the bars from the range
if(CopyLow(InpSymbolName,InpSymbolPeriod,InpDateStart,date_finish,low_buff)==-1)
{
PrintFormat("Failed to copy values of low prices. Error code = %d",GetLastError());
return;
}
//--- receive open prices of the bars from the range
if(CopyOpen(InpSymbolName,InpSymbolPeriod,InpDateStart,date_finish,open_buff)==-1)
{
PrintFormat("Failed to copy values of open prices. Error code = %d",GetLastError());
return;
}
//--- receive close prices of the bars from the range
if(CopyClose(InpSymbolName,InpSymbolPeriod,InpDateStart,date_finish,close_buff)==-1)
{
//--- open the file for writing the structure array to the file (if the file is absent, it will be
ResetLastError();
int file_handle=FileOpen(InpDirectoryName+"//"+InpFileName,FILE_READ|FILE_WRITE|FILE_BIN|FILE_CO
if(file_handle!=INVALID_HANDLE)
{
PrintFormat("%s file is open for writing",InpFileName);
PrintFormat("File path: %s\\Files\\",TerminalInfoString(TERMINAL_COMMONDATA_PATH));
//--- prepare the counter of the number of bytes
uint counter=0;
//--- write array values in the loop
for(int i=0;i<size;i++)
counter+=FileWriteStruct(file_handle,cand_buff[i]);
PrintFormat("%d bytes of information is written to %s file",InpFileName,counter);
PrintFormat("Total number of bytes: %d * %d * %d = %d, %s",size,5,8,size*5*8,size*5*8==counte
//--- close the file
FileClose(file_handle);
PrintFormat("Data is written, %s file is closed",InpFileName);
}
else
PrintFormat("Failed to open %s file, Error code = %d",InpFileName,GetLastError());
}
See also
S tructures and classes
FileLoad
R eads all data of a specified binary file into a passed array of numeric types or simple structures. The
function allows you to quickly read data of a known type into the appropriate array.
long FileLoad(
const string file_name, // File name
void& buffer[], // An array of numeric types or simple structures
int common_flag=0 // A file flag, is searched in <data_folder>\MQL5\Files\ by def
);
Parameters
file_name
[in] The name of the file from which data will be read.
buffer
[out] An array of numeric types or simple structures.
common_flag=0
[in] A file flag indicating the operation mode. If the parameter is not specified, the file is
searched in the subfolder MQL5\Files (or in <testing_agent_directory>\MQL5\Files in case of
testing).
Return Value
The FileLoad() function reads from a file the number of bytes multiple of the array element size.
S uppose the file size is 10 bytes, and the function reads data into an array of type double
(sizeof(double)=8). In this case the function will read only 8 bytes, the remaining 2 bytes at the end
of the file will be dropped, and the function FileLoad() will return 1 (1 element read).
Example:
//+------------------------------------------------------------------+
//| Demo_FileLoad.mq5 |
//| Copyright 2016, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property script_show_inputs
//--- input parameters
input int bars_to_save=10; // Number of bars
//+------------------------------------------------------------------+
See also
S tructures and Classes, FileReadArray, FileReadS truct, FileS ave
FileSave
W rites to a binary file all elements of an array passed as a parameter. The function allows you to
quick ly write arrays of numeric types or simple structures as one string.
bool FileSave(
const string file_name, // File name
void& buffer[], // An array of numeric types or simple structures
int common_flag=0 // A file flag, by default files are written to <data_folder>\M
);
Parameters
file_name
[in] The name of the file, to the data array will be written.
buffer
[in] An array of numeric types or simple structures.
common_flag=0
[in] A file flag indicating the operation mode. If the parameter is not specified, the file will be
written to the subfolder MQL5\Files (or to <testing_agent_directory>\MQL5\Files in case of
testing).
Return Value
//+------------------------------------------------------------------+
//| Demo_FileSave.mq5 |
//| Copyright 2016, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property script_show_inputs
//--- input parameters
input int ticks_to_save=1000; // Number of ticks
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
string filename=_Symbol+"_ticks.bin";
MqlTick ticks[];
u//---
int copied=CopyTicks(_Symbol,ticks,COPY_TICKS_ALL,0,ticks_to_save);
if(copied!=-1)
{
See also
S tructures and Classes, FileW riteArray, FileW riteS truct, FileLoad, FileW rite
FolderCreate
Creates a directory in the Files folder (depending on the common_flag value)
bool FolderCreate(
string folder_name, // line with the created folder name
int common_flag=0 // action area
);
Parameters
folder_name
[in] Name of the directory to be created. Contains the relative path to the folder.
common_flag=0
[in] Flag defining the directory location. If common_flag=FILE_COMMON, the directory is located
in the common folder of all client terminals \Terminal\Common\Files. Otherwise, the directory is in
the local folder (MQL5\Files or MQL5\Tester\Files when testing).
Return Value
Forreasons of security, working with files is strictly controlled in MQL5 language. Files used in file
operations by means of MQL5 language cannot be located outside the file sandbox.
Example:
//--- display window of the input parameters during the script's launch
#property script_show_inputs
//--- the input parameter defines the folder, in which the script works
input bool common_folder=false; // common folder for all terminals
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- folder to be created in MQL5\Files
string root_folder="Folder_A";
if(CreateFolder(root_folder,common_folder))
{
//--- create the Child_Folder_B1 sub-folder in it
string folder_B1="Child_Folder_B1";
string path=root_folder+"\\"+folder_B1; // create the folder name considering the st
if(CreateFolder(path,common_folder))
{
//--- create 3 more sub-directories in this folder
string folder_C11="Child_Folder_C11";
string child_path=root_folder+"\\"+folder_C11;// create the folder name considering the st
CreateFolder(child_path,common_folder);
//--- second sub-directory
string folder_C12="Child_Folder_C12";
child_path=root_folder+"\\"+folder_C12;
CreateFolder(child_path,common_folder);
See also
FileOpen(), FolderClean(), FileCopy()
FolderDelete
The function removes the specified directory. If the folder is not empty, then it can't be removed.
bool FolderDelete(
string folder_name, // String with the name of the folder to delete
int common_flag=0 // Scope
);
Parameters
folder_name
[in] The name of the directory you want to delete. Contains the full path to the folder.
common_flag=0
[in] Flag determining the location of the directory. If common_flag =FIL E_COMMON, then the
directory is in the shared folder for all client terminals \Terminal\Common\Files. Otherwise, the
directory is in a local folder (MQL5\Files or MQL5\Tester\Files in the case of testing).
Return Value
Forsecurity reasons, work with files is strictly controlled in the MQL5 language. Files with which file
operations are conducted using MQL5 means, cannot be outside the file sandbox.
If the directory contains at least one file and/or subdirectory, then this directory can't be deleted, it
must be cleared first. FolderClean() is used to clear a folder of all its files or subfolders.
Example:
//+------------------------------------------------------------------+
//| Demo_FolderDelete.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
//--- Description
#property description "The script shows a sample use of FolderDelete()."
#property description "First two folders are created; one of them is empty, the second one contains
#property description "When trying to delete a non-empty folder, an error is returned and a warning
//--- Show the dialog of input parameters when starting the script
#property script_show_inputs
//--- Input parameters
input string firstFolder="empty"; // An empty folder
input string secondFolder="nonempty";// The folder, in which one file will be created
string filename="delete_me.txt"; // The name of the file that will be created in folder secon
//+------------------------------------------------------------------+
else
PrintFormat("Failed to delete folder %s. Error code=%d", firstFolder, GetLastError());
ResetLastError();
//--- Delete the folder that contains a file
if(FolderDelete(secondFolder))
PrintFormat("Folder %s has been successfully deleted", secondFolder);
else
//--- The following message should appear since the folder contains a file
PrintFormat("Failed to delete folder %s. Error code=%d", secondFolder, GetLastError());
}
else
Print("Deletion canceled");
//---
}
See also
FileOpen(), FolderClean(), FileMove()
FolderClean
The function deletes all files in a specified folder.
bool FolderClean(
string folder_name, // String with the name of the deleted folder
int common_flag=0 // Scope
);
Parameters
folder_name
[in] The name of the directory where you want to delete all files. Contains the full path to the
folder.
common_flag=0
[in] Flag determining the location of the directory. If common_flag = FILE_COMMON, then the
directory is in the shared folder for all client terminals \Terminal\Common\Files. Otherwise, the
directory is in a local folder(MQL5\Files or MQL5\Tester\Files in case of testing).
Return Value
Forsecurity reasons, work with files is strictly controlled in the MQL5 language. Files with which file
operations are conducted using MQL5 means, cannot be outside the file sandbox.
This function should be used with caution, since all the files and all subdirectories are deleted
irretrievably.
Example:
//+------------------------------------------------------------------+
//| Demo_FolderClean.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
//--- Description
#property description "The script shows a sample use of FolderClean()."
#property description "First, files are created in the specified folder using the FileOpen() functi
#property description "Then, before the files are deleted, a warning is shown using MessageBox()."
//--- Show the dialog of input parameters when starting the script
#property script_show_inputs
//--- Input parameters
input string foldername="demo_folder"; // Create a folder in MQL5/Files/
input int files=5; // The number of files to create and delete
//+------------------------------------------------------------------+
//---
}
//+------------------------------------------------------------------+
//| Returns the number of files in the specified folder |
//+------------------------------------------------------------------+
int FilesInFolder(string path,int flag)
{
int count=0;
long handle;
string filename;
//---
handle=FileFindFirst(path,filename,flag);
//--- If at least one file found, search for more files
if(handle!=INVALID_HANDLE)
{
//--- Show the name of the file
PrintFormat("File %s found",filename);
//--- Increase the counter of found files/folders
count++;
//--- Start search in all files/folders
while(FileFindNext(handle,filename))
{
PrintFormat("File %s found",filename);
count++;
}
//--- Do not forget to close the search handle upon completion
FileFindClose(handle);
}
else // Failed to get the handle
{
PrintFormat("Files search in folder %s failed",path);
}
//--- Return the result
return count;
}
See also
FileFindFirst, FileFindNext, FileFindClose
Custom Indicators
This is the group functions used in the creation of custom indicators. These functions can't be used
when writing Expert Advisors and S cripts.
Function Action
S etIndex Buffer Binds the specified indicator buffer with one-dimensional dynamic
array of the double type
IndicatorS etDouble S ets the value of an indicator property of the double type
IndicatorS etInteger S ets the value of an indicator property of the int type
IndicatorS etS tring S ets the value of an indicator property of the string type
PlotIndexS etDouble S ets the value of an indicator line property of the type double
PlotIndexS etInteger S ets the value of an indicator line property of the int type
PlotIndexS etS tring S ets the value of an indicator line property of the string type
PlotIndexGetInteger R eturns the value of an indicator line property of the integer type
Indicator properties can be set using the compiler directives or using functions. To better understand
this, it is recommended that you study indicator styles in examples.
Allthe necessary calculations of a custom indicator must be placed in the predetermined function
OnCalculate(). If you use a short form of the OnCalculate() function call, like
int OnCalculate (const int rates_total, const int prev_calculated, const int begin, const double& p
then the rates_total variable contains the value of the total number of elements of the price[] array,
passed as an input parameter for calculating indicator values.
Parameter prev_calculated is the result of the execution of OnCalculate() at the previous call; it allows
organizing a saving algorithm for calculating indicator values. For example, if the current value
rates _total = 1000, prev _calculated = 999, then perhaps it's enough to make calculations only for one
value of each indicator buffer.
If the information about the size of the input array price would have been unavailable, then it would
lead to the necessity to make calculations for 1000 values of each indicator buffer. At the first call of
OnCalculate() value prev _calculated = 0. If the price[] array has changed somehow, then in this case
prev _calculated is also equal to 0.
The begin parameter shows the number of initial values of the price array, which don't contain data for
calculation. For example, if values of Accelerator Oscillator (for which the first 37 values aren't
calculated) were used as an input parameter, then begin = 37. For example, let's consider a simple
indicator:
#property indicator_chart_window
#property indicator_buffers 1
#property indicator_plots 1
//---- plot Label1
#property indicator_label1 "Label1"
{
//---
Print("begin = ",begin," prev_calculated = ",prev_calculated," rates_total = ",rates_total);
//--- return value of prev_calculated for next call
return(rates_total);
}
Drag it from the "Navigator" window to the window of the Accelerator Oscillator indicator and we
indicate that calculations will be made based on the values of the previous indicator:
As a result, the first call of OnCalculate() the value of prev _calculated will be equal to zero, and in
further calls it will be equal to the rates _total value (until the number of bars on the price chart
increases).
The value of the begin parameter will be exactly equal to the number of initial bars, for which the
values of the Accelerator indicator aren't calculated according to the logic of this indicator. If we look
at the source code of the custom indicator Accelerator.mq5, we'll see the following lines in the OnInit()
function:
//--- sets first bar from which index will be drawn
PlotIndexSetInteger(0,PLOT_DRAW_BEGIN,37);
Each plotting requires one to five arrays of the double type, in which indicator values are stored. For
the purpose of convenience, these arrays are associated with the indicator buffers. The number of
buffers in an indicator must be declared in advance using compiler directives, for example:
#property indicator_buffers 3 // Number of buffers
#property indicator_plots 2 // number of plots
The number of buffers in the indicator is always greater than or equal to the number of plots in the
indicator.
S ince each basic plotting
type can have color variation or construction specifics, the actual number of
plotting types in the MQL5 is 18:
Plotting Descripti Value buffers Color buffers
on
DRAW_NONE Is not
visually
displayed
in the
chart,
but the
values of
the
1 -
correspo
nding
buffer
can be
viewed
in the
Data
W indow
DRAW_LINE A line is
plotted
on the
values of
the
correspo
nding
buffer 1 -
(empty
values in
the
buffer
are
undesira
ble)
DRAW_SECTION Is drawn
as line
segment
s
between
the
values of
the 1 -
correspo
nding
buffer
(usually
has a lot
of empty
values)
DRAW_H IS TOGRAM Is drawn
as a
histogra
m from
the zero
line to
the
values of
1 -
the
correspo
nding
buffer
(may
have
empty
values)
DRAW_BARS Is drawn
as bars. 4 -
4 values
of the
correspo
nding
buffers
are
shown in
the Data
W indow
DRAW_CANDL ES Drawn as
Japanese
candlesti
cks. 4
values of
the
correspo 4 -
nding
buffers
are
shown in
the Data
W indow
be set
dynamica
lly
DRAW_COLOR_H IS TOGRAM S imilar
to the
style
DRAW_H
IS TOGRA
M, but
each
strip may
1 1
have a
different
color,
you can
set the
color
dynamica
lly
DRAW_COLOR_H IS TOGRAM 2 S imilar
to the
style
DRAW_H
IS TOGRA
M 2, but
each
strip may
2 1
have a
different
color,
you can
set the
color
dynamica
lly
DRAW_COLOR_ARR OW S imilar
to the
style
DRAW_A
RR OW ,
but each 1 1
symbol
can have
its color.
Color can
be
changed
dynamica
lly
DRAW_COLOR_ZIGZAG The
DRAW_ZI
GZAG
style
with the
options
of
individua 2 1
l coloring
of
sections
and
dynamic
color
changing
DRAW_COLOR_BARS The
DRAW_B
ARS style
with the
options
of
individua 4 1
l coloring
of bars
and
dynamic
color
changing
DRAW_COLOR_CANDL ES The
DRAW_C
ANDL ES
style
with the
options
of
individua 4 1
l coloring
of
candlesti
cks and
dynamic
color
changing
In each indicator, on its global level, you should declare one or more arrays of the double type, which
then must be used as an indicator buffer using the S etIndexBuffer() function. To draw indicator plots,
only the values of the indicator buffers are used, any other arrays cannot be used for this purpose. In
addition, buffer values are displayed in the Data W indow.
An indicator buffer should be dynamic and does not require specification of the size – the size of the
array used as the indicator buffer is set by the terminal execution subsystem automatically.
After the array is bound to the indicator buffer, the indexing direction is set by default like in ordinary
arrays, but you can use the ArrayS etAs S eries() function to change the way of access to the array
elements. By default, the indicator buffer is used to store data used for plotting (INDICATOR_DATA).
If the calculation of indicator values requires holding intermediate calculations and storing the
additional values for each bar, then such an array can be declared as a calculation buffer during
binding (INDICATOR_CALCULATIONS ). For the intermediate values, you can also use a regular array,
but in this case, the programmer has to manage the size of the array.
S ome plots allow setting a color for each bar. To store the information about color, color buffers are
used (INDICATOR_COLOR_INDEX). The color is an integer type color, but all indicator buffers must be
of type double. Values of color and auxiliary (INDICATOR_CALCULATIONS ) buffers cannot be obtained
by using CopyBuffer().
The number of indicator buffers must be specified using the compiler directive #property
indicator_buffers number_of_buffers :
#property indicator_buffers 3 // the indicator has 3 buffers
Each plotting is based on one or more indicator buffers. S o, for displaying simple candlesticks, four
values are required - Open, High, Low and Close prices. Accordingly, to display an indicator in the
form of candlesticks, it is necessary to declare 4 indicator buffers and 4 arrays of the double type for
them. For example:
//--- The indicator has four indicator buffers
#property indicator_buffers 4
//--- The indicator has one plotting
#property indicator_plots 1
//--- Graphical plotting number 1 will appear as candlesticks
#property indicator_type1 DRAW_CANDLES
//--- Candlestick will be drawn in clrDodgerBlue
#property indicator_color1 clrDodgerBlue
//--- 4 arrays for the indicator buffers
double OBuffer[];
double HBuffer[];
double LBuffer[];
double CBuffer[];
Graphical plots automatically use indicator buffers in accordance with the plot number. Numbering of
plots starts with 1, numbering of buffers starts with zero. If the first plotting requires 4 indicator
buffers, then the first 4 indicator buffers will be used to draw it. These four buffers should be linked
with the appropriate arrays with correct indexing using the S etIndexBuffer() function.
//--- Binding arrays with indicator buffers
SetIndexBuffer(0,OBuffer,INDICATOR_DATA); // The first buffer corresponds to the zero index
SetIndexBuffer(1,HBuffer,INDICATOR_DATA); // The second buffer corresponds to index 1
SetIndexBuffer(2,LBuffer,INDICATOR_DATA); // The third buffer corresponds to index 2
SetIndexBuffer(3,CBuffer,INDICATOR_DATA); // The fourth buffer corresponds to index 3
The plotting candlesticks, the indicator will use just the first four buffers, because plotting of
" candlestick s " was announced under the first number.
Change the example, and add plotting of a simple line - DRAW_LINE. Now suppose that the line is
numbered 1, and the candlesticks are number 2. The number of buffers and the number of plots has
increased.
//--- The indicator has 5 indicator buffers
#property indicator_buffers 5
//--- The indicator has 2 plots
#property indicator_plots 2
//--- Plot 1 is a line
#property indicator_type1 DRAW_LINE
//--- The color of the line is clrDodgerRed
#property indicator_color1 clrDodgerRed
//--- Plot 2 is drawn as Japanese candlesticks
#property indicator_type2 DRAW_CANDLES
//--- The color of the candlesticks is clrDodgerBlue
#property indicator_color2 clrDodgerBlue
//--- 5 arrays for indicator buffers
double LineBuffer[];
double OBuffer[];
double HBuffer[];
double LBuffer[];
double CBuffer[];
The order of the plots has changed, and now the line comes first, followed by Japanese candlesticks.
Therefore, the order of the buffers is appropriate - first we announce a buffer for the line with the
zero index, and then four buffers for the candlestick s.
The number of buffers and plots can be set only by using compiler directives, it is impossible to
change these properties dynamically using functions.
Ascan be seen in the table, the styles are divided into two groups. The first group includes styles in
whose name there is no word COLOR, we call these styles basic:
· DRAW_LI NE
· DRAW_SECTION
· DRAW_H I S TOGRAM
· DRAW_H I S TOGRAM 2
· DRAW_ARR OW
· DRAW_ZI GZAG
· DRAW_FILLI NG
· DRAW_BARS
· DRAW_CANDL ES
In the second group, the style names contain the word COLOR, let's call them color versions :
· DRAW_COLOR_LI NE
· DRAW_COLOR_SECTION
· DRAW_COLOR_H I S TOGRAM
· DRAW_COLOR_H I S TOGRAM 2
· DRAW_COLOR_ARR OW
· DRAW_COLOR_ZI GZAG
· DRAW_COLOR_BARS
· DRAW_COLOR_CANDL ES
All colorversions of styles differ from the basic ones in that they allow specifying a color for each part
of the plotting. The minimal part of plotting is a bar, so we can say that the color versions allow
setting the color on each bar.
Exceptions are styles DRAW_NONE and DRAW_FILLING, they do not have color versions.
To set the plotting color on each bar, an additional buffer for storing the color index has been added to
the color version. These indices indicate the number of a color in a special array, which contains a
predefined set of colors. The size of the array of colors is 64. This means that each color version of a
style allows painting a plot in 64 different colors.
The set and the number of colors in the special array of colors can be set via a compiler directive
#property indicator_color, where you can specify all the necessary colors separated by commas. For
example, such an entry in an indicator:
//--- Define 8 colors for coloring candlesticks (they are stored in the special array)
#property indicator_color1 clrRed,clrBlue,clrGreen,clrYellow,clrMagenta,clrCyan,clrLime,clrOrange
It states that for plotting 1, 8 colors are set, which will be placed in a special array. Further in the
program we will not specify the color of the plotting, but only its index. If we want to set red color for
the bar number K, the color index value from an array should be set in the color buffer of the
indicator. The red color is specified first in the directive, it corresponds to the index number 0.
//--- set the candlestick color clrRed
col_buffer[buffer_index]=0;
The set of colors is not given once and for all, it can be changed dynamically using
PlotIndexS etInteger(). Example:
//--- Set the color for each index as the property PLOT_LINE_COLOR
PlotIndexSetInteger(0, // The number of a graphical style
PLOT_LINE_COLOR, // Property identifier
plot_color_ind, // The index of the color, where we write the colo
color_array[i]); // A new color
For indicator plots, properties can be set by means of compiler directives and using the appropriate
functions. Read more information about this in Connection between Indicator Properties and
Functions. Dynamic change of indicator properties using special functions allows creating more flexible
custom indicators.
In many cases, according to the conditions of the algorithm, it is impossible to start calculating the
indicator values immediately with the current bar, since it is necessary to provide a minimum number
of previous bars available in history. For example, many types of smoothing imply using an array of
prices over the previous N bars, and on the basis of these values, the indicator value on the current
bar is calculated.
In such cases, either there is no way to calculate the indicator values for the first N bars, or these
values are not intended to be displayed on the chart and are only subsidiary for calculating further
values. To avoid plotting of the indicator on the first N bars of the history, set the N value to the
PLOT_DRAW_BEGIN property for the corresponding plot:
//--- Binding arrays with indicator buffers for the candlesticks
PlotIndexSetInteger(number_of_plot,PLOT_DRAW_BEGIN,N);
H ere:
· number_of_plot – a value from zero to indicator_plots-1 (numbering of plots starts with zero).
· N - the number of first bars in the history, on which the indicator should not be displayed on the
chart.
DRAW_NONE
The DRAW_NONE style is designed for use in cases where it is necessary to calculate the values of a
buffer and show them in the Data W indow, but plotting on the chart is not required. To set up the
accuracy use the expression IndicatorS etInteger(INDICATOR_DIGITS ,num_chars) in the OnInit()
function:
int OnInit()
{
//--- indicator buffers mapping
SetIndexBuffer(0,InvisibleBuffer,INDICATOR_DATA);
//--- Set the accuracy of values to be displayed in the Data Window
IndicatorSetInteger(INDICATOR_DIGITS,0);
//---
return(INIT_SUCCEEDED);
}
Note that despite the fact that, for red color is set plotting #1, the indicator does not draw anything
on the chart.
//+------------------------------------------------------------------+
//| DRAW_NONE.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property indicator_chart_window
#property indicator_buffers 1
#property indicator_plots 1
//--- plot Invisible
#property indicator_label1 "Bar Index"
#property indicator_type1 DRAW_NONE
#property indicator_style1 STYLE_SOLID
#property indicator_color1 clrRed
#property indicator_width1 1
//--- indicator buffers
double InvisibleBuffer[];
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- Binding an array and an indicator buffer
SetIndexBuffer(0,InvisibleBuffer,INDICATOR_DATA);
//--- Set the accuracy of values to be displayed in the Data Window
IndicatorSetInteger(INDICATOR_DIGITS,0);
//---
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
static datetime lastbar=0;
//--- If this is the first calculation of the indicator
if(prev_calculated==0)
{
//--- Renumber the bars for the first time
CalcValues(rates_total,close);
//--- Remember the opening time of the current bar in lastbar
lastbar=(datetime)SeriesInfoInteger(_Symbol,_Period,SERIES_LASTBAR_DATE);
}
else
{
//--- If a new bar has appeared, its open time differs from lastbar
if(lastbar!=SeriesInfoInteger(_Symbol,_Period,SERIES_LASTBAR_DATE))
{
//--- Renumber the bars once again
CalcValues(rates_total,close);
//--- Update the opening time of the current bar in lastbar
lastbar=(datetime)SeriesInfoInteger(_Symbol,_Period,SERIES_LASTBAR_DATE);
}
}
//--- return value of prev_calculated for next call
return(rates_total);
}
//+------------------------------------------------------------------+
//| Number the bars like in a timeseries |
//+------------------------------------------------------------------+
void CalcValues(int total,double const &array[])
{
//--- Set indexing of the indicator buffer like in a timeseries
ArraySetAsSeries(InvisibleBuffer,true);
//--- Fill in each bar with its number
for(int i=0;i<total;i++) InvisibleBuffer[i]=i;
}
DRAW_LINE
DRAW_LINE draws a line of the specified color by the values of the indicator buffer. The width, style
and color of the line can be set using the compiler directives and dynamically using the
PlotIndexS etInteger() function. Dynamic changes of the plotting properties allows " to enliven"
indicators, so that their appearance changes depending on the current situation.
The number of buffers required for plotting DRAW_LINE is 1.
An example ofthe indicator that draws a line using Close prices of bars. The line color, width and style
change randomly every N=5 ticks.
Note that initially for plot1 with DRAW_LINE the properties are set using the compiler directive
#property,and then in the OnCalculate() function these three properties are set randomly. The N
parameter is set in external parameters of the indicator for the possibility of manual configuration
(the Parameters tab in the indicator's Properties window).
//+------------------------------------------------------------------+
//| DRAW_LINE.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property indicator_chart_window
#property indicator_buffers 1
#property indicator_plots 1
//--- Line properties are set using the compiler directives
#property indicator_label1 "Line" // Name of a plot for the Data Window
#property indicator_type1 DRAW_LINE // Type of plotting is line
#property indicator_color1 clrRed // Line color
#property indicator_style1 STYLE_SOLID // Line style
#property indicator_width1 1 // Line Width
//--- input parameter
input int N=5; // Number of ticks to change
//--- An indicator buffer for the plot
double LineBuffer[];
//--- An array to store colors
color colors[]={clrRed,clrBlue,clrGreen};
//--- An array to store the line styles
ENUM_LINE_STYLE styles[]={STYLE_SOLID,STYLE_DASH,STYLE_DOT,STYLE_DASHDOT,STYLE_DASHDOTDOT};
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- Binding an array and an indicator buffer
SetIndexBuffer(0,LineBuffer,INDICATOR_DATA);
//--- Initializing the generator of pseudo-random numbers
MathSrand(GetTickCount());
//---
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
static int ticks=0;
//--- Calculate ticks to change the style, color and width of the line
ticks++;
//--- If a critical number of ticks has been accumulated
if(ticks>=N)
{
//--- Return the prev_calculated value for the next call of the function
return(rates_total);
}
//+------------------------------------------------------------------+
//| Changes the appearance of the drawn line in the indicator |
//+------------------------------------------------------------------+
void ChangeLineAppearance()
{
//--- A string for the formation of information about the line properties
string comm="";
//--- A block for changing the color of the line
//--- Get a random number
int number=MathRand();
//--- The divisor is equal to the size of the colors[] array
int size=ArraySize(colors);
//--- Get the index to select a new color as the remainder of integer division
int color_index=number%size;
//--- Set the color as the PLOT_LINE_COLOR property
PlotIndexSetInteger(0,PLOT_LINE_COLOR,colors[color_index]);
//--- Write the line color
comm=comm+(string)colors[color_index];
DRAW_SECTION
DRAW_SECTION draws sections of the specified color by the values of the indicator buffer. The width,
color and style of the line can be specified like for the DRAW_LINE style - using compiler directives or
dynamically using the PlotIndexS etInteger() function. Dynamic changes of the plotting properties allows
" to enliven" indicators, so that their appearance changes depending on the current situation.
S ectionsare drawn from one non-empty value to another non-empty value of the indicator buffer,
empty values are ignored. To specify what value should be considered as " empty" , set this value in the
PLOT_EMPTY_VALUE property: For example, if the indicator should be drawn as a sequence of sections
on non-zero values, then you need to set the zero value as an empty one:
//--- The 0 (empty) value will mot participate in drawing
PlotIndexSetDouble(index_of_plot_DRAW_SECTION,PLOT_EMPTY_VALUE,0);
Always explicitly fill in the values of the indicator buffers, set an empty value in a buffer to the
elements that should not be plotted.
The number of buffers required for plotting DRAW_SECTION is 1.
An example of the indicator that draws sections between the High and Low prices. The color, width
and style of all sections change randomly every N ticks.
Note that initially for plot1with DRAW_SECTION the properties are set using the compiler directive
#property, and then in the OnCalculate() function these three properties are set randomly. The N
parameter is set in external parameters of the indicator for the possibility of manual configuration
(the Parameters tab in the indicator's Properties window).
//+------------------------------------------------------------------+
//| DRAW_SECTION.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property indicator_chart_window
#property indicator_buffers 1
#property indicator_plots 1
//--- plot Section
#property indicator_label1 "Section"
#property indicator_type1 DRAW_SECTION
#property indicator_color1 clrRed
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
//--- input parameter
input int bars=5; // The length of sections in bars
input int N=5; // The number of ticks to change the style of sections
//--- An indicator buffer for the plot
double SectionBuffer[];
//--- An auxiliary variable to calculate ends of sections
int divider;
//--- An array to store colors
color colors[]={clrRed,clrBlue,clrGreen};
//--- An array to store the line styles
ENUM_LINE_STYLE styles[]={STYLE_SOLID,STYLE_DASH,STYLE_DOT,STYLE_DASHDOT,STYLE_DASHDOTDOT};
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- Binding an array and an indicator buffer
SetIndexBuffer(0,SectionBuffer,INDICATOR_DATA);
//--- The 0 (empty) value will mot participate in drawing
PlotIndexSetDouble(0,PLOT_EMPTY_VALUE,0);
//--- Check the indicator parameter
if(bars<=0)
{
PrintFormat("Invalid value of parameter bar=%d",bars);
return(INIT_PARAMETERS_INCORRECT);
}
else divider=2*bars;
//---+
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
static int ticks=0;
//--- Calculate ticks to change the style, color and width of the line
ticks++;
//--- If a critical number of ticks has been accumulated
if(ticks>=N)
{
//--- Change the line properties
ChangeLineAppearance();
//--- Reset the counter of ticks to zero
ticks=0;
}
//--- The number of the bar from which the calculation of indicator values starts
int start=0;
//--- If the indicator has been calculated before, then set start on the previous bar
if(prev_calculated>0) start=prev_calculated-1;
//--- Here are all the calculations of the indicator values
for(int i=start;i<rates_total;i++)
{
//--- Get a remainder of the division of the bar number by 2*bars
int rest=i%divider;
//--- If the bar number is divisible by 2*bars
if(rest==0)
{
//--- Set the end of the section at the High price of this bar
SectionBuffer[i]=high[i];
}
//---If the remainder of the division is equal to bars,
else
{
//--- Set the end of the section at the High price of this bar
if(rest==bars) SectionBuffer[i]=low[i];
//--- If nothing happened, ignore the bar - set 0
else SectionBuffer[i]=0;
}
}
//--- Return the prev_calculated value for the next call of the function
return(rates_total);
}
//+------------------------------------------------------------------+
//| Changes the appearance of sections in the indicator |
//+------------------------------------------------------------------+
void ChangeLineAppearance()
{
//--- A string for the formation of information about the line properties
string comm="";
//--- A block of line color change
int number=MathRand(); // Get a random number
//--- The divisor is equal to the size of the colors[] array
int size=ArraySize(colors);
//--- Get the index to select a new color as the remainder of integer division
int color_index=number%size;
//--- Set the color as the PLOT_LINE_COLOR property
PlotIndexSetInteger(0,PLOT_LINE_COLOR,colors[color_index]);
//--- Write the line color
comm=comm+"\r\n"+(string)colors[color_index];
DRAW_HISTOGRAM
The DRAW_HIS TOGRAM style draws a histogram as a sequence of columns of a specified color from
zero to a specified value. Values are tak en from the indicator buffer. The width, color and style of the
column can be specified like for the DRAW_LINE style - using compiler directives or dynamically using
the PlotIndexS etInteger() function. Dynamic changes of the plotting properties allows changing the
look of the histogram based on the current situation.
S ince acolumn from the zero level is drawn on each bar, DRAW_HIS TOGRAM should better be used in
a separate chart window. Most often this type of plotting is used to create indicators of the oscillator
type, for example, Bears Power or OsM A. For the empty non-displayable values the zero value should
be specified.
The number of buffers required for plotting DRAW_HIS TOGRAM is 1.
An example of the indicator that draws a sinusoid of a specified color based on the MathS in() function.
The color, width and style of all histogram columns change randomly each N ticks. The bars parameter
specifies the period of the sinusoid, that is after the specified number of bars the sinusoid will repeat
the cycle.
Note that initially for plot1 with DRAW_HIS TOGRAM the properties are set using the compiler
directive #property, and then in the OnCalculate() function these three properties are set randomly.
The N parameter is set in external parameters of the indicator for the possibility of manual
configuration (the Parameters tab in the indicator's Properties window).
//+------------------------------------------------------------------+
//| DRAW_HISTOGRAM.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property indicator_separate_window
#property indicator_buffers 1
#property indicator_plots 1
//--- plot Histogram
#property indicator_label1 "Histogram"
#property indicator_type1 DRAW_HISTOGRAM
#property indicator_color1 clrBlue
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
//--- input parameters
input int bars=30; // The period of a sinusoid in bars
input int N=5; // The number of ticks to change the histogram
//--- indicator buffers
double HistogramBuffer[];
//--- A factor to get the 2Pi angle in radians, when multiplied by the bars parameter
double multiplier;
//--- An array to store colors
color colors[]={clrRed,clrBlue,clrGreen};
//--- An array to store the line styles
ENUM_LINE_STYLE styles[]={STYLE_SOLID,STYLE_DASH,STYLE_DOT,STYLE_DASHDOT,STYLE_DASHDOTDOT};
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- indicator buffers mapping
SetIndexBuffer(0,HistogramBuffer,INDICATOR_DATA);
//--- Calculate the multiplier
if(bars>1)multiplier=2.*M_PI/bars;
else
{
PrintFormat("Set the value of bars=%d greater than 1",bars);
//--- Early termination of the indicator
return(INIT_PARAMETERS_INCORRECT);
}
//---
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
static int ticks=0;
//--- Calculate ticks to change the style, color and width of the line
ticks++;
//--- If a critical number of ticks has been accumulated
if(ticks>=N)
{
//--- Change the line properties
ChangeLineAppearance();
//--- Reset the counter of ticks to zero
ticks=0;
}
DRAW_HISTOGRAM2
The DRAW_HIS TOGRAM 2 style draws a histogram of a specified color – vertical segments using the
values of two indicator buffers. The width, color and style of the segments can be specified like for
the DRAW_LINE style - using compiler directives or dynamically using the PlotIndexS etInteger()
function. Dynamic changes of the plotting properties allows changing the look of the histogram based
on the current situation.
The DRAW_HIS TOGRAM 2 style can be used in a separate subwindow of a chart and in its main window.
For empty values nothing is drawn, all the values in the indicator buffers need to be set explicitly.
Buffers are not initialized with a zero value.
Note that initially for plot1 with DRAW_HIS TOGRAM 2 the properties are set using the compiler
directive #property, and then in the OnCalculate() function these three properties are set randomly.
The N parameter is set in external parameters of the indicator for the possibility of manual
configuration (the Parameters tab in the indicator's Properties window).
//+------------------------------------------------------------------+
//| DRAW_HISTOGRAM2.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property indicator_chart_window
#property indicator_buffers 2
#property indicator_plots 1
//--- plot Histogram_2
#property indicator_label1 "Histogram_2"
#property indicator_type1 DRAW_HISTOGRAM2
#property indicator_color1 clrRed
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
//--- input parameters
input int N=5; // The number of ticks to change the histogram
//--- indicator buffers
double Histogram_2Buffer1[];
double Histogram_2Buffer2[];
//--- The day of the week for which the indicator is not plotted
int invisible_day;
//--- An array to store colors
color colors[]={clrRed,clrBlue,clrGreen};
//--- An array to store the line styles
ENUM_LINE_STYLE styles[]={STYLE_SOLID,STYLE_DASH,STYLE_DOT,STYLE_DASHDOT,STYLE_DASHDOTDOT};
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- indicator buffers mapping
SetIndexBuffer(0,Histogram_2Buffer1,INDICATOR_DATA);
SetIndexBuffer(1,Histogram_2Buffer2,INDICATOR_DATA);
//--- Set an empty value
PlotIndexSetDouble(0,PLOT_EMPTY_VALUE,0);
//--- Get a random number from 0 to 5
invisible_day=MathRand()%6;
//---
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
void ChangeLineAppearance()
{
//--- A string for the formation of information about the line properties
string comm="";
//--- A block of line color change
int number=MathRand(); // Get a random number
//--- The divisor is equal to the size of the colors[] array
int size=ArraySize(colors);
//--- Get the index to select a new color as the remainder of integer division
int color_index=number%size;
//--- Set the color as the PLOT_LINE_COLOR property
PlotIndexSetInteger(0,PLOT_LINE_COLOR,colors[color_index]);
//--- Write the line color
comm=comm+"\r\n"+(string)colors[color_index];
DRAW_ARROW
The DRAW_ARROW style draws arrows of the specified color (symbols of the set W ingdings) based on
the value of the indicator buffer. The width and color of the symbols can be specified like for the
DRAW_LINE style - using compiler directives or dynamically using the PlotIndex S etInteger() function.
Dynamic changes of the plotting properties allows changing the look of an indicator based on the
current situation.
The symbol code is set using the PLOT_ARROW property.
//--- Define the symbol code from the Wingdings font to draw in PLOT_ARROW
PlotIndexSetInteger(0,PLOT_ARROW,code);
A negative value of PLOT_ARROW_SHIFT means the shift of arrows upwards, a positive values shifts
the arrow down.
The DRAW_ARROW style can be used in a separate subwindow of a chart and in its main window.
Empty values are not drawn and do not appear in the "Data W indow" , all the values in the indicator
buffers should be set explicitly. Buffers are not initialized with a zero value.
//--- Set an empty value
PlotIndexSetDouble(index_of_plot_DRAW_ARROW,PLOT_EMPTY_VALUE,0);
In the example, for plot1 with the DRAW_ARROW style, the properties, color and size are specified
using the compiler directive #property, and then in the OnCalculate() function the properties are set
randomly. The N parameter is set in external parameters of the indicator for the possibility of manual
configuration (the Parameters tab in the indicator's Properties window).
//+------------------------------------------------------------------+
//| DRAW_ARROW.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property indicator_chart_window
#property indicator_buffers 1
#property indicator_plots 1
//--- plot Arrows
#property indicator_label1 "Arrows"
#property indicator_type1 DRAW_ARROW
#property indicator_color1 clrGreen
#property indicator_width1 1
//--- input parameters
input int N=5; // Number of ticks to change
if(prev_calculated>0) start=prev_calculated-1;
//--- Calculation loop
for(int i=1;i<rates_total;i++)
{
//--- If the current Close price is higher than the previous one, draw an arrow
if(close[i]>close[i-1])
ArrowsBuffer[i]=close[i];
//--- Otherwise specify the zero value
else
ArrowsBuffer[i]=0;
}
//--- return value of prev_calculated for next call
return(rates_total);
}
//+------------------------------------------------------------------+
//| Change the appearance of symbols in the indicator |
//+------------------------------------------------------------------+
void ChangeLineAppearance()
{
//--- A string for the formation of information about the indicator properties
string comm="";
//--- A block for changing the arrow color
int number=MathRand(); // Get a random number
//--- The divisor is equal to the size of the colors[] array
int size=ArraySize(colors);
//--- Get the index to select a new color as the remainder of integer division
int color_index=number%size;
//--- Set the color as the PLOT_LINE_COLOR property
PlotIndexSetInteger(0,PLOT_LINE_COLOR,colors[color_index]);
//--- Write the line color
comm=comm+"\r\n"+(string)colors[color_index];
DRAW_ZIGZAG
The DRAW_ZIGZAG style draws segments of a specified color based on the values of two indicator
buffers. This style is very similar to DRAW_SECTION, but unlike the latter, it allows drawing vertical
segments within one bar, if values of both indicator buffers are set for this bar. The segments are
plotted from a value in the first buffer to a value in the second indicator buffer. None of the buffers
can contain only empty values, since in this case nothing is plotted.
The width, color and style of the line can be specified like for the DRAW_SECTION style - using
compiler directives or dynamically using the PlotIndexS etInteger() function. Dynamic changes of the
plotting properties allows " to enliven" indicators, so that their appearance changes depending on the
current situation.
S ections
are drawn from a non-empty value of one buffer to a non-empty value of another indicator
buffer. To specify what value should be considered as " empty" , set this value in the
PLOT_EMPTY_VALUE property:
//--- The 0 (empty) value will mot participate in drawing
PlotIndexSetDouble(index_of_plot_DRAW_ZIGZAG,PLOT_EMPTY_VALUE,0);
Always explicitly fill in the values of the indicator buffers, set an empty value in a buffer to s kip bars.
The number of buffers required for plotting DRAW_ZIGZAG is 2.
An example of the indicator that plots a saw based on the H igh and Low prices. The color, width and
style of the zigzag lines change randomly every N ticks.
Note that initially for plot1 with DRAW_ZIGZAG the properties are set using the compiler directive
#property, and then in the OnCalculate() function these properties are set randomly. The N parameter
is set in external parameters of the indicator for the possibility of manual configuration (the
Parameters tab in the indicator's Properties window).
//+------------------------------------------------------------------+
//| DRAW_ZIGZAG.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property indicator_separate_window
#property indicator_buffers 2
#property indicator_plots 1
//--- plot ZigZag
#property indicator_label1 "ZigZag"
#property indicator_type1 DRAW_ZIGZAG
#property indicator_color1 clrBlue
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
//--- input parameters
input int N=5; // Number of ticks to change
//--- indicator buffers
double ZigZagBuffer1[];
double ZigZagBuffer2[];
//--- The day of the week for which the indicator is not plotted
int invisible_day;
//--- An array to store colors
color colors[]={clrRed,clrBlue,clrGreen};
//--- An array to store the line styles
ENUM_LINE_STYLE styles[]={STYLE_SOLID,STYLE_DASH,STYLE_DOT,STYLE_DASHDOT,STYLE_DASHDOTDOT};
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- Binding arrays and indicator buffers
SetIndexBuffer(0,ZigZagBuffer1,INDICATOR_DATA);
SetIndexBuffer(1,ZigZagBuffer2,INDICATOR_DATA);
//--- Get a random value from 0 to 6, for this day the indicator is not plotted
invisible_day=MathRand()%6;
//--- The 0 (empty) value will mot participate in drawing
PlotIndexSetDouble(0,PLOT_EMPTY_VALUE,0);
//--- The 0 (empty) value will mot participate in drawing
PlotIndexSetString(0,PLOT_LABEL,"ZigZag1;ZigZag2");
//---
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
static int ticks=0;
//--- Calculate ticks to change the style, color and width of the line
ticks++;
//--- If a sufficient number of ticks has been accumulated
if(ticks>=N)
{
//--- Change the line properties
ChangeLineAppearance();
//--- Reset the counter of ticks to zero
ticks=0;
}
//--- The structure of time is required to get the day of week of each bar
MqlDateTime dt;
else
{
//--- If the bar number if even
if(i%2==0)
{
//--- Write High in the 1st buffer and Low in the 2nd one
ZigZagBuffer1[i]=high[i];
ZigZagBuffer2[i]=low[i];
}
//--- The bar number is odd
else
{
//--- Fill in the bar in a reverse order
ZigZagBuffer1[i]=low[i];
ZigZagBuffer2[i]=high[i];
}
}
}
//--- return value of prev_calculated for next call
return(rates_total);
}
//+------------------------------------------------------------------+
//| Changes the appearance of the zigzag segments |
//+------------------------------------------------------------------+
void ChangeLineAppearance()
{
//--- A string for the formation of information about the ZigZag properties
string comm="";
//--- A block for changing the color of the ZigZag
int number=MathRand(); // Get a random number
//--- The divisor is equal to the size of the colors[] array
int size=ArraySize(colors);
//--- Get the index to select a new color as the remainder of integer division
int color_index=number%size;
//--- Set the color as the PLOT_LINE_COLOR property
PlotIndexSetInteger(0,PLOT_LINE_COLOR,colors[color_index]);
//--- Write the line color
comm=comm+"\r\n"+(string)colors[color_index];
number=MathRand();
//--- The divisor is equal to the size of the styles array
size=ArraySize(styles);
//--- Get the index to select a new style as the remainder of integer division
int style_index=number%size;
//--- Set the color as the PLOT_LINE_COLOR property
PlotIndexSetInteger(0,PLOT_LINE_STYLE,styles[style_index]);
//--- Write the line style
comm="\r\n"+EnumToString(styles[style_index])+""+comm;
//--- Add information about the day that is omitted in calculations
comm="\r\nNot plotted day - "+EnumToString((ENUM_DAY_OF_WEEK)invisible_day)+comm;
//--- Show the information on the chart using a comment
Comment(comm);
}
DRAW_FILLING
The DRAW_FILLING style plots a colored area between the values of two indicator buffers. In fact, this
style draws two lines and fills the space between them with one of two specified colors. It is used for
creating indicators that draw channels. None of the buffers can contain only empty values, since in this
case nothing is plotted.
You can set two fill colors :
· the first color is used for the areas where values in the first buffer are greater than the values in
the second indicator buffer;
· the second color is used for the areas where values in the second buffer are greater than the values
in the first indicator buffer.
The fill color can be set using the compiler directives or dynamically using the PlotIndexS etInteger()
function. Dynamic changes of the plotting properties allows " to enliven" indicators, so that their
appearance changes depending on the current situation.
The indicator is calculated for all bars, for which the values of the both indicator buffers are equal
neither to 0 nor to the empty value. To specify what value should be considered as " empty" , set this
value in PLOT_EMPTY_VALUE property:
#define INDICATOR_EMPTY_VALUE -1.0
...
//--- INDICATOR_EMPTY_VALUE (empty value) will not participate in calculation of
PlotIndexSetDouble (DRAW_FILLING_creation_index,PLOT_EMPTY_VALUE,INDICATOR_EMPTY_VALUE);
Drawing on the bars that do not participate in the indicator calculation will depend on the values i n the
indicator buffers :
· Bars, for which the values of both indicator buffers are equal to 0, do not participate in drawing the
indicator. It means that the area with zero values is not filled out.
· Bars, for which the values of the indicator buffers are equal to the " empty value" , participate in
drawing the indicator. The area with empty values will be filled out so that to connect the areas with
significant values.
It should be noted that if the " empty value" is equal to zero, the bars that do not participate in the
indicator calculation are also filled out.
The number of buffers required for plotting DRAW_FILLING is 2.
An example of the indicator that draws a channel between two M As with different averaging periods in
a separate window. The change of the colors at the crossing of moving averages visually shows the
change of the upward and downward trends. The colors change randomly every N ticks. The N
parameter is set in external parameters of the indicator for the possibility of manual configuration
(the Parameters tab in the indicator's Properties window).
Note that initially for plot1 with DRAW_FILLING the properties are set using the compiler directive
#property, and then in the OnCalculate() function new colors are set randomly.
//+------------------------------------------------------------------+
//| DRAW_FILLING.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property indicator_separate_window
#property indicator_buffers 2
#property indicator_plots 1
//--- plot Intersection
#property indicator_label1 "Intersection"
#property indicator_type1 DRAW_FILLING
#property indicator_color1 clrRed,clrBlue
#property indicator_width1 1
//--- input parameters
input int Fast=13; // The period of a fast MA
input int Slow=21; // The period of a slow MA
input int shift=1; // A shift of MAs towards the future (positive)
input int N=5; // Number of ticks to change
//--- Indicator buffers
double IntersectionBuffer1[];
double IntersectionBuffer2[];
int fast_handle;
int slow_handle;
//--- An array to store colors
color colors[]={clrRed,clrBlue,clrGreen,clrAquamarine,clrBlanchedAlmond,clrBrown,clrCoral,clrDarkSl
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- indicator buffers mapping
SetIndexBuffer(0,IntersectionBuffer1,INDICATOR_DATA);
SetIndexBuffer(1,IntersectionBuffer2,INDICATOR_DATA);
//---
PlotIndexSetInteger(0,PLOT_SHIFT,shift);
//---
fast_handle=iMA(_Symbol,_Period,Fast,0,MODE_SMA,PRICE_CLOSE);
slow_handle=iMA(_Symbol,_Period,Slow,0,MODE_SMA,PRICE_CLOSE);
//---
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
//--- Make the first calculation of the indicator, or data has changed and requires a complete reca
if(prev_calculated==0)
{
//--- Copy all the values of the indicators to the appropriate buffers
int copied1=CopyBuffer(fast_handle,0,0,rates_total,IntersectionBuffer1);
int copied2=CopyBuffer(slow_handle,0,0,rates_total,IntersectionBuffer2);
}
else // Fill only those data that are updated
{
//--- Get the difference in bars between the current and previous start of OnCalculate()
int to_copy=rates_total-prev_calculated;
//--- If there is no difference, we still copy one value - on the zero bar
if(to_copy==0) to_copy=1;
//--- copy to_copy values to the very end of indicator buffers
int copied1=CopyBuffer(fast_handle,0,0,to_copy,IntersectionBuffer1);
int copied2=CopyBuffer(slow_handle,0,0,to_copy,IntersectionBuffer2);
}
//--- return value of prev_calculated for next call
return(rates_total);
}
//+------------------------------------------------------------------+
//| Changes the colors of the channel filling |
//+------------------------------------------------------------------+
void ChangeLineAppearance()
{
//--- A string for the formation of information about the line properties
string comm="";
//--- A block for changing the color of the line
//--- Get the index to select a new color as the remainder of integer division
int color_index1=number%size;
//--- Set the first color as the PLOT_LINE_COLOR property
PlotIndexSetInteger(0,PLOT_LINE_COLOR,0,colors[color_index1]);
//--- Write the first color
comm=comm+"\r\nColor1 "+(string)colors[color_index1];
//--- Get the index to select a new color as the remainder of integer division
number=MathRand(); // Get a random number
int color_index2=number%size;
//--- Set the second color as the PLOT_LINE_COLOR property
PlotIndexSetInteger(0,PLOT_LINE_COLOR,1,colors[color_index2]);
//--- Write the second color
comm=comm+"\r\nColor2 "+(string)colors[color_index2];
//--- Show the information on the chart using a comment
Comment(comm);
}
DRAW_BARS
The DRAW_BARS style draws bars on the values of four indicator buffers, which contain the Open,
H igh, Low and Close prices. It is used for creating custom indicators as bars, including those in a
separate subwindow of a chart and on other financial instruments.
The color of bars can be set using the compiler directives or dynamically using the
PlotIndexS etInteger() function. Dynamic changes of the plotting properties allows " to enliven"
indicators, so that their appearance changes depending on the current situation.
The indicator is drawn only to those bars, for which non-empty values of all four indicator buffers are
set. To specify what value should be considered as " empty" , set this value in the PLOT_EMPTY_VALUE
property:
//--- The 0 (empty) value will mot participate in drawing
PlotIndexSetDouble(index_of_plot_DRAW_BARS,PLOT_EMPTY_VALUE,0);
Always explicitly fill in the values of the indicator buffers, set an empty value in a buffer to s kip bars.
The number of required buffers for plotting DRAW_BARS is 4. All buffers for the plotting should go one
after the other in the given order: Open, High, Low and Close. None of the buffers can contain only
empty values, since in this case nothing is plotted.
An example of the indicator that draws bars on a selected financial instrument in a separate window.
The color of bars changes randomly every N ticks. The N parameter is set in external parameters of
the indicator for the possibility of manual configuration (the Parameters tab in the indicator's
Properties window).
Please note that for plot1 with the DRAW_BARS style, the color is set using the compiler directive
#property, and then in the OnCalculate() function the color is set randomly from an earlier prepared
list.
//+------------------------------------------------------------------+
//| DRAW_BARS.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property indicator_separate_window
#property indicator_buffers 4
#property indicator_plots 1
//--- plot Bars
#property indicator_label1 "Bars"
#property indicator_type1 DRAW_BARS
#property indicator_color1 clrGreen
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
//--- input parameters
input int N=5; // The number of ticks to change the type
input int bars=500; // The number of bars to show
input bool messages=false; // Show messages in the "Expert Advisors" log
//--- Indicator buffers
double BarsBuffer1[];
double BarsBuffer2[];
double BarsBuffer3[];
double BarsBuffer4[];
//--- Symbol name
string symbol;
//--- An array to store colors
color colors[]={clrRed,clrBlue,clrGreen,clrPurple,clrBrown,clrIndianRed};
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- If bars is very small - complete the work ahead of time
if(bars<50)
{
Comment("Please specify a larger number of bars! The operation of the indicator has been term
return(INIT_PARAMETERS_INCORRECT);
}
//--- indicator buffers mapping
SetIndexBuffer(0,BarsBuffer1,INDICATOR_DATA);
SetIndexBuffer(1,BarsBuffer2,INDICATOR_DATA);
SetIndexBuffer(2,BarsBuffer3,INDICATOR_DATA);
SetIndexBuffer(3,BarsBuffer4,INDICATOR_DATA);
//--- The name of the symbol, for which the bars are drawn
symbol=_Symbol;
//--- Set the display of the symbol
PlotIndexSetString(0,PLOT_LABEL,symbol+" Open;"+symbol+" High;"+symbol+" Low;"+symbol+" Close");
IndicatorSetString(INDICATOR_SHORTNAME,"DRAW_BARS("+symbol+")");
//--- An empty value
PlotIndexSetDouble(0,PLOT_EMPTY_VALUE,0.0);
//---
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
static int ticks=0;
//--- Calculate ticks to change the style, color and width of the line
ticks++;
//--- If a sufficient number of ticks has been accumulated
if(ticks>=N)
{
//--- Select a new symbol from the Market watch window
symbol=GetRandomSymbolName();
//--- Change the line properties
ChangeLineAppearance();
int tries=0;
//--- Make 5 attempts to fill in the buffers with the prices from symbol
while(!CopyFromSymbolToBuffers(symbol,rates_total) && tries<5)
{
//--- A counter of calls of the CopyFromSymbolToBuffers() function
tries++;
}
//--- Reset the counter of ticks to zero
ticks=0;
}
//--- return value of prev_calculated for next call
return(rates_total);
}
//+------------------------------------------------------------------+
//| Fill in the indicator buffers with prices |
//+------------------------------------------------------------------+
bool CopyFromSymbolToBuffers(string name,int total)
{
//--- In the rates[] array, we will copy Open, High, Low and Close
MqlRates rates[];
//--- The counter of attempts
int attempts=0;
//--- How much has been copied
int copied=0;
//--- Make 25 attempts to get a timeseries on the desired symbol
while(attempts<25 && (copied=CopyRates(name,_Period,0,bars,rates))<0)
{
Sleep(100);
attempts++;
if(messages) PrintFormat("%s CopyRates(%s) attempts=%d",__FUNCTION__,name,attempts);
}
//--- If failed to copy a sufficient number of bars
if(copied!=bars)
{
//--- Form a message string
string comm=StringFormat("For the symbol %s, managed to receive only %d bars of %d requested
name,
copied,
bars
);
//--- Show a message in a comment in the main chart window
Comment(comm);
//--- Show the message
if(messages) Print(comm);
return(false);
}
else
{
//--- Set the display of the symbol
PlotIndexSetString(0,PLOT_LABEL,name+" Open;"+name+" High;"+name+" Low;"+name+" Close");
IndicatorSetString(INDICATOR_SHORTNAME,"DRAW_BARS("+name+")");
}
//--- Initialize buffers with empty values
ArrayInitialize(BarsBuffer1,0.0);
ArrayInitialize(BarsBuffer2,0.0);
ArrayInitialize(BarsBuffer3,0.0);
ArrayInitialize(BarsBuffer4,0.0);
//--- Copy prices to the buffers
for(int i=0;i<copied;i++)
{
DRAW_CANDLES
The DRAW_CANDLES style draws candlesticks on the values of four indicator buffers, which contain the
Open, High, Low and Close prices. It is used for creating custom indicators as a sequence of
candlesticks, including those in a separate subwindow of a chart and on other financial instruments.
The color of candlesticks can be set using the compiler directives or dynamically using the
PlotIndexS etInteger() function. Dynamic changes of the plotting properties allows " to enliven"
indicators, so that their appearance changes depending on the current situation.
The indicator is drawn only to those bars, for which non-empty values of all four indicator buffers are
set. To specify what value should be considered as " empty" , set this value in the PLOT_EMPTY_VALUE
property:
//--- The 0 (empty) value will mot participate in drawing
PlotIndexSetDouble(index_of_plot_DRAW_CANDLES,PLOT_EMPTY_VALUE,0);
Always explicitly fill in the values of the indicator buffers, set an empty value in a buffer to s kip bars.
The number of required buffers for plotting DRAW_CANDLES is 4. All buffers for the plotting should go
one after the other in the given order: Open, High, Low and Close. None of the buffers can contain
only empty values, since in this case nothing is plotted.
You can set up to three colors for the DRAW_CANDLES style affecting the candle look. If only one color
is set, it is applied to all candles on a chart.
//--- identical candles with a single color applied to them
#property indicator_label1 "One color candles"
#property indicator_type1 DRAW_CANDLES
//--- only one color is specified, therefore all candles are of the same color
#property indicator_color1 clrGreen
If two comma-separated colors are specified, the first one is applied to candle outlines, while the
second one is applied to the body.
//--- different colors for candles and wicks
#property indicator_label1 "Two color candles"
#property indicator_type1 DRAW_CANDLES
//--- green is applied to wicks and outlines, while white is applied to the body
#property indicator_color1 clrGreen,clrWhite
S pecifythree comma-separated colors so that rising and falling candles are displayed differently. In
that case, the first color is applied to the candle outlines, while the second and third ones – to bullish
and bearish candles.
//--- different colors for candles and wicks
#property indicator_label1 "One color candles"
#property indicator_type1 DRAW_CANDLES
//--- wicks and outlines are green, bullish candle body is white, while bearish candle body is red
#property indicator_color1 clrGreen,clrWhite,clrRed
Thus, the DRAW_CANDLES style allows you to create custom candle coloring options. Besides, all colors
can be changed dynamically during the indicator operation using the PlotIndexS etInteger function
An example of the indicator that draws candlesticks for a selected financial instrument in a separate
window. The color of candlesticks changes randomly every N ticks. The N parameter is set in external
parameters of the indicator for the possibility of manual configuration (the Parameters tab in the
indicator's Properties window).
Please note that for plot1, the color is set using the compiler directive #property, and then in the
OnCalculate() function the color is set randomly from an earlier prepared list.
//+------------------------------------------------------------------+
//| DRAW_CANDLES.mq5 |
//| Copyright 2000-2024, MetaQuotes Ltd. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property indicator_separate_window
#property indicator_buffers 4
#property indicator_plots 1
//--- plot Bars
#property indicator_label1 "DRAW_CANDLES1"
#property indicator_type1 DRAW_CANDLES
#property indicator_color1 clrGreen
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
{
//--- Calculate the appropriate index for the buffers
int buffer_index=total-copied+i;
//--- Write the prices to the buffers
buff1[buffer_index]=rates[i].open;
buff2[buffer_index]=rates[i].high;
buff3[buffer_index]=rates[i].low;
buff4[buffer_index]=rates[i].close;
}
return(true);
}
//+------------------------------------------------------------------+
//| Randomly returns a symbol from the Market Watch |
//+------------------------------------------------------------------+
string GetRandomSymbolName()
{
//--- The number of symbols shown in the Market watch window
int symbols=SymbolsTotal(true);
//--- The position of a symbol in the list - a random number from 0 to symbols
int number=MathRand()%symbols;
//--- Return the name of a symbol at the specified position
return SymbolName(number,true);
}
//+------------------------------------------------------------------+
//| Changes the appearance of bars |
//+------------------------------------------------------------------+
void ChangeLineAppearance()
{
//--- A string for the formation of information about the bar properties
string comm="";
//--- A block for changing the color of bars
int number=MathRand(); // Get a random number
//--- The divisor is equal to the size of the colors[] array
int size=ArraySize(colors);
//--- Get the index to select a new color as the remainder of integer division
int color_index=number%size;
//--- Set the color as the PLOT_LINE_COLOR property
PlotIndexSetInteger(0,PLOT_LINE_COLOR,colors[color_index]);
//--- Write the color
comm=comm+"\r\n"+(string)colors[color_index];
//--- Write the symbol name
comm="\r\n"+symbol+comm;
//--- Show the information on the chart using a comment
Comment(comm);
}
DRAW_COLOR_LINE
The DRAW_COLOR_LINE value is a colored variant of the DRAW_LINE style; it also draws a line using
the values of the indicator buffer. But this style, like all color styles with the word COLOR in their title
has an additional special indicator buffer that stores the color index (number) from a specially set
array of colors. Thus, the color of each line segment can be defined by specifying the color index of
the index to draw the line at this bar.
The width, style and colors of lines can be set using the compiler directives and dynamically using the
PlotIndexS etInteger() function. Dynamic changes of the plotting properties allows " to enliven"
indicators, so that their appearance changes depending on the current situation.
The number of buffers required for plotting DRAW_COLOR_LINE is 2.
· one buffer to store the indicator values used for drawing a line;
· one buffer to store the index of the color of the line on each bar.
Colors can be specified by the compiler directive #property indicator_color1 separated by a comma.
The number of colors cannot exceed 64.
//--- Define 5 colors for coloring each bar (they are stored in the special array)
#property indicator_color1 clrRed,clrBlue,clrGreen,clrOrange,clrDeepPink // (Up to 64 colors can b
An example of the indicator that draws a line using Close prices of bars. The line width and style
change randomly every N=5 ticks.
The colors of the line segments also change randomly in the custom function ChangeColors().
//+------------------------------------------------------------------+
//| Changes the color of line segments |
//+------------------------------------------------------------------+
void ChangeColors(color &cols[],int plot_colors)
{
//--- The number of colors
int size=ArraySize(cols);
//---
string comm=ChartGetString(0,CHART_COMMENT)+"\r\n\r\n";
The example shows the feature of the " color" versions of indicators - to change the color of a line
segment, you do not need to change values in the ColorLineColors [] buffer (which contains the color
indexes). All you need to do is set new colors in a special array. This allows you to quickly change the
color once for the entire plotting, changing only a small array of colors using the PlotIndexS etInteger()
function.
Note that initially for plot1 with DRAW_COLOR_LINE the properties are set using the compiler
directive #property, and then in the OnCalculate() function these three properties are set randomly.
The N and Length (the length of color segments in bars) parameters are set in external parameters of
the indicator for the possibility of manual configuration (the Parameters tab in the indicator's
Properties window).
//+------------------------------------------------------------------+
//| DRAW_COLOR_LINE.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property indicator_chart_window
#property indicator_buffers 2
#property indicator_plots 1
//--- plot ColorLine
#property indicator_label1 "ColorLine"
#property indicator_type1 DRAW_COLOR_LINE
//--- Define 5 colors for coloring each bar (they are stored in the special array)
#property indicator_color1 clrRed,clrBlue,clrGreen,clrOrange,clrDeepPink // (Up to 64 colors can b
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
//--- input parameters
input int N=5; //Number of ticks to change
input int Length=20; // The length of each color part in bars
int line_colors=5; // The number of set colors is 5 - see #property indicator_color1
//--- A buffer for plotting
double ColorLineBuffer[];
//--- A buffer for storing the line color on each bar
double ColorLineColors[];
//--- Return the prev_calculated value for the next call of the function
return(rates_total);
}
//+------------------------------------------------------------------+
//| Changes the color of line segments |
//+------------------------------------------------------------------+
void ChangeColors(color &cols[],int plot_colors)
{
//--- The number of colors
int size=ArraySize(cols);
//---
string comm=ChartGetString(0,CHART_COMMENT)+"\r\n\r\n";
//--- Set the color for each index as the property PLOT_LINE_COLOR
PlotIndexSetInteger(0, // The number of a graphical style
PLOT_LINE_COLOR, // Property identifier
plot_color_ind, // The index of the color, where we write the colo
cols[i]); // A new color
//--- Write the colors
comm=comm+StringFormat("LineColorIndex[%d]=%s \r\n",plot_color_ind,ColorToString(cols[i],true
ChartSetString(0,CHART_COMMENT,comm);
}
//---
}
//+------------------------------------------------------------------+
//| Changes the appearance of a displayed line in the indicator |
//+------------------------------------------------------------------+
void ChangeLineAppearance()
{
//--- A string for the formation of information about the line properties
string comm="";
//--- A block for changing the width of the line
int number=MathRand();
//--- Get the width of the remainder of integer division
int width=number%5; // The width is set from 0 to 4
//--- Set the color as the PLOT_LINE_WIDTH property
PlotIndexSetInteger(0,PLOT_LINE_WIDTH,width);
//--- Write the line width
comm=comm+" Width="+IntegerToString(width);
DRAW_COLOR_SECTION
The DRAW_COLOR_SECTION style is a color version of DRAW_SECTION, but unlike the latter, it allows
drawing sections of different colors. The DRAW_COLOR_SECTION style, like all color styles with the
word COLOR in their title, contains an additional special indicator buffer that stores the color index
(number) from a specially set array of colors. Thus, the color of each section can be defined by
specifying the color index of the index of the bar that corresponds to the section end.
The width, color and style of the sections can be specified like for the DRAW_SECTION style - using
compiler directives or dynamically using the PlotIndexS etInteger() function. Dynamic changes of the
plotting properties allows " to enliven" indicators, so that their appearance changes depending on the
current situation.
S ectionsare drawn from one non-empty value to another non-empty value of the indicator buffer,
empty values are ignored. To specify what value should be considered as " empty" , set this value in the
PLOT_EMPTY_VALUE property: For example, if the indicator should be drawn as a sequence of sections
on non-zero values, then you need to set the zero value as an empty one:
//--- The 0 (empty) value will mot participate in drawing
PlotIndexSetDouble(index_of_plot_DRAW_COLOR_SECTION,PLOT_EMPTY_VALUE,0);
Always explicitly fill in the values of the indicator buffers, set an empty value in a buffer to the
elements that should not be plotted.
The number of buffers required for plotting DRAW_COLOR_SECTION is 2.
· one buffer to store the indicator values used for drawing a line;
· one buffer to store the color index, which is used to draw the section (it makes sense to set only
non-empty values).
Colors can be specified by the compiler directive #property indicator_color1 separated by a comma.
The number of colors cannot exceed 64.
An example of the indicator that draws colored sections each 5 bars long, using the High price values.
The color, width and style of sections change randomly every N ticks.
Note that initially for plot1 with DRAW_COLOR_SECTION 8 colors are set using the compiler directive
#property. Then in the OnCalculate() function, colors are set randomly from the array of colors
colors [].
The N parameter is set in external parameters of the indicator for the possibility of manual
configuration (the Parameters tab in the indicator's Properties window).
//+------------------------------------------------------------------+
//| DRAW_COLOR_SECTION.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property indicator_chart_window
#property indicator_buffers 2
#property indicator_plots 1
//--- plot ColorSection
#property indicator_label1 "ColorSection"
#property indicator_type1 DRAW_COLOR_SECTION
//--- Define 8 colors for coloring sections (they are stored in a special array)
#property indicator_color1 clrRed,clrGold,clrMediumBlue,clrLime,clrMagenta,clrBrown,clrTan,clrMedi
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
//--- input parameters
input int N=5; // Number of ticks to change
input int bars_in_section=5; // The length of sections in bars
//--- An auxiliary variable to calculate ends of sections
int divider;
int color_sections;
//--- A buffer for plotting
double ColorSectionBuffer[];
//--- A buffer for storing the line color on each bar
double ColorSectionColors[];
//--- An array for storing colors contains 14 elements
color colors[]=
{
clrRed,clrBlue,clrGreen,clrChocolate,clrMagenta,clrDodgerBlue,clrGoldenrod,
clrIndigo,clrLightBlue,clrAliceBlue,clrMoccasin,clrWhiteSmoke,clrCyan,clrMediumPurple
};
//--- An array to store the line styles
ENUM_LINE_STYLE styles[]={STYLE_SOLID,STYLE_DASH,STYLE_DOT,STYLE_DASHDOT,STYLE_DASHDOTDOT};
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- indicator buffers mapping
SetIndexBuffer(0,ColorSectionBuffer,INDICATOR_DATA);
SetIndexBuffer(1,ColorSectionColors,INDICATOR_COLOR_INDEX);
//--- The 0 (empty) value will mot participate in drawing
PlotIndexSetDouble(0,PLOT_EMPTY_VALUE,0);
//---- The number of colors to color the sections
int color_sections=8; // see A comment to #property indicator_color1
//--- Check the indicator parameter
if(bars_in_section<=0)
{
PrintFormat("Invalid section length=%d",bars_in_section);
return(INIT_PARAMETERS_INCORRECT);
}
else divider=color_sections*bars_in_section;
//---
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
//--- The number of the bar from which the calculation of indicator values starts
int start=0;
//--- If the indicator has been calculated before, then set start on the previous bar
if(prev_calculated>0) start=prev_calculated-1;
//--- Here are all the calculations of the indicator values
for(int i=start;i<rates_total;i++)
{
//--- If the bar number is divisible by the section_length, it means this is the end of the s
if(i%bars_in_section==0)
{
//--- Set the end of the section at the High price of this bar
ColorSectionBuffer[i]=high[i];
//--- A remainder of the division of the bar number by scetion_length*number_of_colors
int rest=i%divider;
//Get the number of the color = from 0 to number_of_colors-1
int color_indext=rest/bars_in_section;
ColorSectionColors[i]=color_indext;
}
//---If the remainder of the division is equal to bars,
else
{
//--- If nothing happened, ignore the bar - set 0
else ColorSectionBuffer[i]=0;
}
}
//--- Return the prev_calculated value for the next call of the function
return(rates_total);
}
//+------------------------------------------------------------------+
DRAW_COLOR_HISTOGRAM
The DRAW_COLOR_HIS TOGRAM style draws a histogram as a sequence of colored columns from zero
to a specified value. Values are taken from the indicator buffer. Each column can have its own color
from a predefined set of colors.
The width, color and style of the histogram can be specified like for the DRAW_HIS TOGRAM style -
using compiler directives or dynamically using the PlotIndexS etInteger() function. Dynamic changes of
the plotting properties allows changing the look of the histogram based on the current situation.
S ince a column from the zero level is drawn on each bar, DRAW_COLOR_HIS TOGRAM should better be
used in a separate chart window. Most often this type of plotting is used to create indicators of the
oscillator type, for example, Awesome Oscillator or Market Facilitation Index. For the empty non-
displayable values the zero value should be specified.
The number of buffers required for plotting DRAW_COLOR_HIS TOGRAM is 2.
· one buffer for storing a non-zero value of the vertical segment on each bar, the second end of the
segment is always on the zero line of the indicator;
· one buffer to store the color index, which is used to draw the section (it makes sense to set only
non-empty values).
Colors can be specified using the compiler directive #property indicator_color1 separated by a comma.
The number of colors cannot exceed 64.
An example of the indicator that draws a sinusoid of a specified color based on the MathS in() function.
The color, width and style of all histogram columns change randomly each N ticks. The bars parameter
specifies the period of the sinusoid, that is after the specified number of bars the sinusoid will repeat
the cycle.
Please note that for plot1 with the DRAW_COLOR_HIS TOGRAM style, 5 colors are set using the
compiler directive #property, and then in the OnCalculate() function the colors are selected randomly
from the 14 colors stored in the colors [] array. The N parameter is set in external parameters of the
indicator for the possibility of manual configuration (the Parameters tab in the indicator's Properties
window).
//+------------------------------------------------------------------+
//| DRAW_COLOR_HISTOGRAM.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property indicator_separate_window
#property indicator_buffers 2
#property indicator_plots 1
//--- input parameters
input int bars=30; // The period of a sinusoid in bars
input int N=5; // The number of ticks to change the histogram
//--- plot Color_Histogram
#property indicator_label1 "Color_Histogram"
#property indicator_type1 DRAW_COLOR_HISTOGRAM
//--- Define 8 colors for coloring sections (they are stored in a special array)
#property indicator_color1 clrRed,clrGreen,clrBlue,clrYellow,clrMagenta,clrCyan,clrMediumSeaGreen,
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
//--- A buffer of values
double Color_HistogramBuffer[];
//--- A buffer of color indexes
double Color_HistogramColors[];
//--- A factor to get the 2Pi angle in radians, when multiplied by the bars parameter
double multiplier;
int color_sections;
//--- An array for storing colors contains 14 elements
color colors[]=
{
clrRed,clrBlue,clrGreen,clrChocolate,clrMagenta,clrDodgerBlue,clrGoldenrod,
clrIndigo,clrLightBlue,clrAliceBlue,clrMoccasin,clrWhiteSmoke,clrCyan,clrMediumPurple
};
//--- An array to store the line styles
ENUM_LINE_STYLE styles[]={STYLE_SOLID,STYLE_DASH,STYLE_DOT,STYLE_DASHDOT,STYLE_DASHDOTDOT};
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- indicator buffers mapping
SetIndexBuffer(0,Color_HistogramBuffer,INDICATOR_DATA);
SetIndexBuffer(1,Color_HistogramColors,INDICATOR_COLOR_INDEX);
//---- The number of colors to color the sinusoid
color_sections=8; // see A comment to #property indicator_color1
//--- Calculate the multiplier
if(bars>1)multiplier=2.*M_PI/bars;
else
{
PrintFormat("Set the value of bars=%d greater than 1",bars);
//--- Early termination of the indicator
return(INIT_PARAMETERS_INCORRECT);
}
//---
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
static int ticks=0;
//--- Calculate ticks to change the style, color and width of the line
ticks++;
//--- If a critical number of ticks has been accumulated
if(ticks>=N)
{
//--- Change the line properties
ChangeLineAppearance();
//--- Change colors used for the histogram
ChangeColors(colors,color_sections);
//--- Reset the counter of ticks to zero
ticks=0;
}
string comm="";
//--- A block for changing the width of the line
int number=MathRand();
//--- Get the width of the remainder of integer division
int width=number%5; // The width is set from 0 to 4
//--- Set the color as the PLOT_LINE_WIDTH property
PlotIndexSetInteger(0,PLOT_LINE_WIDTH,width);
//--- Write the line width
comm=comm+" Width="+IntegerToString(width);
DRAW_COLOR_HISTOGRAM2
The DRAW_COLOR_HIS TOGRAM 2 style draws a histogram of a specified color – vertical segments
using the values of two indicator buffers. But unlike the one-color DRAW_HIS TOGRAM 2, in this style
each column of the histogram can have its own color from a predefined set. The values of all the
segments are taken from the indicator buffer.
The width, style and color of the histogram can be specified like for theDRAW_HIS TOGRAM 2 style –
using compiler directives or dynamically using the PlotIndexS etInteger() function. Dynamic changes of
the plotting properties allows changing the look of the histogram based on the current situation.
The DRAW_COLOR_HIS TOGRAM 2 style can be used in a separate subwindow of a chart and in its main
window. For empty values nothing is drawn, all the values in the indicator buffers need to be set
explicitly. Buffers are not initialized with empty values.
The number of buffers required for plotting DRAW_COLOR_HIS TOGRAM 2 is 3:
· two buffers to store the upper and lower end of the vertical segment on each bar;
· one buffer to store the color index, which is used to draw the segment (it makes sense to set only
non-empty values).
An example of the indicator that draws a histogram of a specified color between the High and Low
prices. For each day of week, the histogram lines have a different color. The color of the day, width
and style of the histogram change randomly each N ticks.
Please note that for plot1 with the DRAW_COLOR_HIS TOGRAM 2 style, 5 colors are set using the
compiler directive #property, and then in the OnCalculate() function the colors are selected randomly
from the 14 colors stored in the colors [] array.
The N parameter is set in external parameters of the indicator for the possibility of manual
configuration (the Parameters tab in the indicator's Properties window).
//+------------------------------------------------------------------+
//| DRAW_COLOR_HISTOGRAM2.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property indicator_chart_window
#property indicator_buffers 3
#property indicator_plots 1
//--- plot ColorHistogram_2
#property indicator_label1 "ColorHistogram_2"
#property indicator_type1 DRAW_COLOR_HISTOGRAM2
//--- Define 5 colors for coloring the histogram based on the days of week (they are stored in the
#property indicator_color1 clrRed,clrBlue,clrGreen,clrYellow,clrMagenta
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
SetIndexBuffer(2,ColorHistogram_2Colors,INDICATOR_COLOR_INDEX);
//--- Set an empty value
PlotIndexSetDouble(0,PLOT_EMPTY_VALUE,0);
//---- The number of colors to color the sinusoid
color_sections=8; // See a comment to #property indicator_color1
//---
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
static int ticks=0;
//--- Calculate ticks to change the style, color and width of the line
ticks++;
//--- If a critical number of ticks has been accumulated
if(ticks>=N)
{
//--- Change the line properties
ChangeLineAppearance();
//--- Change the colors used to draw the histogram
ChangeColors(colors,color_sections);
//--- Reset the counter of ticks to zero
ticks=0;
}
comm=comm+" Width="+IntegerToString(width);
DRAW_COLOR_ARROW
The DRAW_COLOR_ARROW style draws colored arrows (symbols of the set W ingdings) based on the
value of the indicator buffer. In contrast to DRAW_ARROW , in this style it is possible to set a color
from a predefined set of colors specified by the indicator_color1 property for each symbol.
The width and color of the symbols can be specified like for theDRAW_ARROW style – using compiler
directives or dynamically using the PlotIndexS etInteger() function. Dynamic changes of the plotting
properties allows changing the look of an indicator based on the current situation.
The symbol code is set using the PLOT_ARROW property.
//--- Define the symbol code from the Wingdings font to draw in PLOT_ARROW
PlotIndexSetInteger(0,PLOT_ARROW,code);
A negative value of PLOT_ARROW_SHIFT means the shift of arrows upwards, a positive values shifts
the arrow down.
The DRAW_COLOR_ARROW style can be used in a separate subwindow of a chart and in its main
window. Empty values are not drawn and do not appear in the "Data W indow" , all the values in the
indicator buffers should be set explicitly. Buffers are not initialized with a zero value.
//--- Set an empty value
PlotIndexSetDouble(DRAW_COLOR_ARROW_plot_index,PLOT_EMPTY_VALUE,0);
In the example, for plot1 with the DRAW_COLOR_ARROW style, the properties, color and size are
specified using the compiler directive #property, and then in the OnCalculate() function the properties
are set randomly. The N parameter is set in external parameters of the indicator for the possibility of
manual configuration (the Parameters tab in the indicator's Properties window).
Please note that initially 8 colors are set using the compiler directive #property, and then in the
OnCalculate() function, the color is set randomly from the 14 colors that are stored in the colors []
array.
//+------------------------------------------------------------------+
//| DRAW_COLOR_ARROW.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property indicator_chart_window
#property indicator_buffers 2
#property indicator_plots 1
//--- plot ColorArrow
#property indicator_label1 "ColorArrow"
#property indicator_type1 DRAW_COLOR_ARROW
//--- Define 8 colors for coloring the histogram (they are stored in the special array)
#property indicator_color1 clrRed,clrBlue,clrSeaGreen,clrGold,clrDarkOrange,clrMagenta,clrYellowGr
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
DRAW_COLOR_ZIGZAG
The DRAW_COLOR_ZIGZAG style draws segments of different colors, using the values of two indicator
buffers. This style is a colored version of DRAW_ZIGZAG, i.e. allows specifying for each segment an
individual color from the predefined set of colors. The segments are plotted from a value in the first
buffer to a value in the second indicator buffer. None of the buffers can contain only empty values,
since in this case nothing is plotted.
The width, color and style of the line can be specified like for the DRAW_ZIGZAG style - using compiler
directives or dynamically using the PlotIndexS etInteger() function. Dynamic changes of the plotting
properties allows " to enliven" indicators, so that their appearance changes depending on the current
situation.
S ections
are drawn from a non-empty value of one buffer to a non-empty value of another indicator
buffer. To specify what value should be considered as " empty" , set this value in the
PLOT_EMPTY_VALUE property:
//--- The 0 (empty) value will mot participate in drawing
PlotIndexSetDouble(index_of_plot_DRAW_COLOR_ZIGZAG,PLOT_EMPTY_VALUE,0);
Always explicitly fill in the of the indicator buffers, set an empty value in a buffer to s kip bars.
The number of buffers required for plotting DRAW_COLOR_ZIGZAG is 3:
· two buffers to store the values of ends of the zigzag sections ;
· one buffer to store the color index, which is used to draw the section (it makes sense to set only
non-empty values).
An example of the indicator that plots a saw based on the H igh and Low prices. The color, width and
style of the zigzag lines change randomly every N ticks.
Please note that for plot1 with the DRAW_COLOR_ZIGZAG style, 8 colors are set using the compiler
directive #property, and then in the OnCalculate() function the color is selected randomly from the 14
colors stored in the colors [] array.
The N parameter is set in external parameters of the indicator for the possibility of manual
configuration (the Parameters tab in the indicator's Properties window).
//+------------------------------------------------------------------+
//| DRAW_COLOR_ZIGZAG.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property indicator_chart_window
#property indicator_buffers 3
#property indicator_plots 1
//--- plot Color_Zigzag
#property indicator_label1 "Color_Zigzag"
#property indicator_type1 DRAW_COLOR_ZIGZAG
//--- Define 8 colors for coloring sections (they are stored in a special array)
#property indicator_color1 clrRed,clrBlue,clrGreen,clrYellow,clrMagenta,clrCyan,clrLime,clrOrange
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
//--- input parameter
input int N=5; // Number of ticks to change
int color_sections;
//--- Buffers of values of segment ends
double Color_ZigzagBuffer1[];
double Color_ZigzagBuffer2[];
//--- Buffers of color indexes of segment ends
double Color_ZigzagColors[];
//--- An array for storing colors contains 14 elements
color colors[]=
{
clrRed,clrBlue,clrGreen,clrChocolate,clrMagenta,clrDodgerBlue,clrGoldenrod,
clrIndigo,clrLightBlue,clrAliceBlue,clrMoccasin,clrWhiteSmoke,clrCyan,clrMediumPurple
};
//--- An array to store the line styles
ENUM_LINE_STYLE styles[]={STYLE_SOLID,STYLE_DASH,STYLE_DOT,STYLE_DASHDOT,STYLE_DASHDOTDOT};
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- indicator buffers mapping
SetIndexBuffer(0,Color_ZigzagBuffer1,INDICATOR_DATA);
SetIndexBuffer(1,Color_ZigzagBuffer2,INDICATOR_DATA);
SetIndexBuffer(2,Color_ZigzagColors,INDICATOR_COLOR_INDEX);
//----Number of color for coloring the zigzag
color_sections=8; // see a comment to the #property indicator_color1 property
//---
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
static int ticks=0;
//--- Calculate ticks to change the style, color and width of the line
ticks++;
//--- If a sufficient number of ticks has been accumulated
if(ticks>=N)
{
//--- Change the line properties
ChangeLineAppearance();
//--- Change colors used to plot the sections
ChangeColors(colors,color_sections);
//--- Reset the counter of ticks to zero
ticks=0;
}
//--- The structure of time is required to get the day of week of each bar
MqlDateTime dt;
{
//--- Write the bar open time in the structure
TimeToStruct(time[i],dt);
comm=comm+StringFormat("ZigzagColorIndex[%d]=%s \r\n",plot_color_ind,ColorToString(cols[i],tr
ChartSetString(0,CHART_COMMENT,comm);
}
//---
}
//+------------------------------------------------------------------+
//| Changes the appearance of the zigzag segments |
//+------------------------------------------------------------------+
void ChangeLineAppearance()
{
//--- A string for the formation of information about the properties of Color_ZigZag
string comm="";
//--- A block for changing the width of the line
int number=MathRand();
//--- Get the width of the remainder of integer division
int width=number%5; // The width is set from 0 to 4
//--- Set the color as the PLOT_LINE_WIDTH property
PlotIndexSetInteger(0,PLOT_LINE_WIDTH,width);
//--- Write the line width
comm=comm+"\r\nWidth="+IntegerToString(width);
DRAW_COLOR_BARS
The DRAW_COLOR_BARS style draws bars on the values of four indicator buffers, which contain the
Open, High, Low and Close prices. This style is an advanced version of DRAW_BARS and allows
specifying for each bar an individual color from the predefined set of colors. It used for creating
custom indicators as bars, including those in a separate subwindow of a chart and on other financial
instruments.
The color of bars can be set using the compiler directives or dynamically using the
PlotIndexS etInteger() function. Dynamic changes of the plotting properties allows " to enliven"
indicators, so that their appearance changes depending on the current situation.
The indicator is drawn only to those bars, for which non-empty values of all four indicator buffers are
set. To specify what value should be considered as " empty" , set this value in the PLOT_EMPTY_VALUE
property:
//--- The 0 (empty) value will mot participate in drawing
PlotIndexSetDouble(index_of_plot_DRAW_COLOR_BARS,PLOT_EMPTY_VALUE,0);
Always explicitly fill in the values of the indicator buffers, set an empty value in a buffer to s kip bars.
The number of buffers required for plotting DRAW_COLOR_BARS is 5:
· four buffer to store the values of Open, High, Low and Close;
· one buffer to store the color index, which is used to draw a bar (it makes sense to set it only for the
bars that will be drawn).
All buffers for the plotting should go one after the other in the given order: Open, High, Low, Close
and the color buffer. None of the price buffers can contain only null values, since in this case nothing
is plotted.
An example of the indicator that draws bars on a selected financial instrument in a separate window.
The color of bars changes randomly every N ticks. The N parameter is set in external parameters of
the indicator for the possibility of manual configuration (the Parameters tab in the indicator's
Properties window).
Please note that for plot1 with the DRAW_COLOR_BARS style, 8 colors are set using the compiler
directive #property, and then in the OnCalculate() function the color is selected randomly from the 14
colors stored in the colors [] array.
//+------------------------------------------------------------------+
//| DRAW_COLOR_BARS.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property indicator_separate_window
#property indicator_buffers 5
#property indicator_plots 1
//--- plot ColorBars
#property indicator_label1 "ColorBars"
#property indicator_type1 DRAW_COLOR_BARS
//--- Define 8 colors for coloring bars (they are stored in the special array)
#property indicator_color1 clrRed,clrBlue,clrGreen,clrYellow,clrMagenta,clrCyan,clrLime,clrOrange
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
//--- input parameters
input int N=5; // The number of ticks to change the type
ticks++;
//--- If a sufficient number of ticks has been accumulated
if(ticks>=N)
{
//--- Select a new symbol from the Market watch window
symbol=GetRandomSymbolName();
//--- Change the line properties
ChangeLineAppearance();
//--- Change the colors used to draw the candlesticks
ChangeColors(colors,bars_colors);
int tries=0;
//--- Make 5 attempts to fill in the buffers with the prices from symbol
while(!CopyFromSymbolToBuffers(symbol,rates_total,bars_colors) && tries<5)
{
//--- A counter of calls of the CopyFromSymbolToBuffers() function
tries++;
}
//--- Reset the counter of ticks to zero
ticks=0;
}
//--- return value of prev_calculated for next call
return(rates_total);
}
//+------------------------------------------------------------------+
//| Fill in the indicator buffers with prices |
//+------------------------------------------------------------------+
bool CopyFromSymbolToBuffers(string name,int total,int bar_colors)
{
//--- In the rates[] array, we will copy Open, High, Low and Close
MqlRates rates[];
//--- The counter of attempts
int attempts=0;
//--- How much has been copied
int copied=0;
//--- Make 25 attempts to get a timeseries on the desired symbol
while(attempts<25 && (copied=CopyRates(name,_Period,0,bars,rates))<0)
{
Sleep(100);
attempts++;
if(messages) PrintFormat("%s CopyRates(%s) attempts=%d",__FUNCTION__,name,attempts);
}
//--- If failed to copy a sufficient number of bars
if(copied!=bars)
{
//--- Form a message string
string comm=StringFormat("For the symbol %s, managed to receive only %d bars of %d requested
name,
copied,
bars
);
//--- Show a message in a comment in the main chart window
Comment(comm);
//--- Show the message
if(messages) Print(comm);
return(false);
}
else
{
//--- Set the display of the symbol
PlotIndexSetString(0,PLOT_LABEL,name+" Open;"+name+" High;"+name+" Low;"+name+" Close");
IndicatorSetString(INDICATOR_SHORTNAME,"DRAW_COLOR_BARS("+name+")");
}
//--- Initialize buffers with empty values
ArrayInitialize(ColorBarsBuffer1,0.0);
ArrayInitialize(ColorBarsBuffer2,0.0);
ArrayInitialize(ColorBarsBuffer3,0.0);
ArrayInitialize(ColorBarsBuffer4,0.0);
DRAW_COLOR_CANDLES
The DRAW_COLOR_CANDLES style, like DRAW_CANDLES , draws candlesticks using the values of four
indicator buffers, which contain Open, High, Low and Close prices. In addition, it allows specifying a
color for each candlestick from a given set. For this purpose, the style has a special color buffer that
stores color indexes for each bar. It used for creating custom indicators as a sequence of candlesticks,
including those in a separate subwindow of a chart and on other financial instruments.
The number of colors of candlesticks can be set using the compiler directives or dynamically using the
PlotIndexS etInteger() function. Dynamic changes of the plotting properties allows " to enliven"
indicators, so that their appearance changes depending on the current situation.
The indicator is drawn only to those bars, for which non-empty values of four price buffers of the
indicator are set. To specify what value should be considered as " empty" , set this value in the
PLOT_EMPTY_VALUE property:
//--- The 0 (empty) value will mot participate in drawing
PlotIndexSetDouble(index_of_plot_DRAW_COLOR_CANDLES,PLOT_EMPTY_VALUE,0);
Always explicitly fill in the values of the indicator buffers, set an empty value in a buffer to s kip bars.
The number of required buffers for plotting DRAW_COLOR_CANDLES is 5:
· four buffer to store the values of Open, High, Low and Close;
· one buffer to store the color index, which is used to draw a candlestick (it makes sense to set it only
for the candlesticks that will be drawn).
Allbuffers for the plotting should go one after the other in the given order: Open, High, Low, Close
and the color buffer. None of the price buffers can contain only empty values, since in this case
nothing is plotted.
An example of the indicator that draws candlesticks for a selected financial instrument in a separate
window. The color of candlesticks changes randomly every N ticks. The N parameter is set in external
parameters of the indicator for the possibility of manual configuration (the Parameters tab in the
indicator's Properties window).
Please note that for plot1, the color is set using the compiler directive #property, and then in the
OnCalculate() function the color is set randomly from an earlier prepared list.
//+------------------------------------------------------------------+
//| DRAW_COLOR_CANDLES.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property indicator_separate_window
#property indicator_buffers 5
#property indicator_plots 1
//--- plot ColorCandles
#property indicator_label1 "ColorCandles"
#property indicator_type1 DRAW_COLOR_CANDLES
//--- Define 8 colors for coloring candlesticks (they are stored in the special array)
#property indicator_color1 clrRed,clrBlue,clrGreen,clrYellow,clrMagenta,clrCyan,clrLime,clrOrange
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
int tries=0;
//--- Make 5 attempts to fill in the buffers of plot1 with the prices from symbol
while(!CopyFromSymbolToBuffers(symbol,rates_total,0,
ColorCandlesBuffer1,ColorCandlesBuffer2,ColorCandlesBuffer3,
ColorCandlesBuffer4,ColorCandlesColors,candles_colors)
&& tries<5)
{
//--- A counter of calls of the CopyFromSymbolToBuffers() function
tries++;
}
//--- Reset the counter of ticks to zero
ticks=0;
}
//--- return value of prev_calculated for next call
return(rates_total);
}
//+------------------------------------------------------------------+
//| Fills in the specified candlestick |
//+------------------------------------------------------------------+
bool CopyFromSymbolToBuffers(string name,
int total,
int plot_index,
double &buff1[],
double &buff2[],
double &buff3[],
double &buff4[],
double &col_buffer[],
int cndl_colors
)
{
//--- In the rates[] array, we will copy Open, High, Low and Close
MqlRates rates[];
//--- The counter of attempts
int attempts=0;
//--- How much has been copied
int copied=0;
//--- Make 25 attempts to get a timeseries on the desired symbol
while(attempts<25 && (copied=CopyRates(name,_Period,0,bars,rates))<0)
{
Sleep(100);
attempts++;
if(messages) PrintFormat("%s CopyRates(%s) attempts=%d",__FUNCTION__,name,attempts);
}
//--- If failed to copy a sufficient number of bars
if(copied!=bars)
{
//--- Form a message string
string comm=StringFormat("For the symbol %s, managed to receive only %d bars of %d requested
name,
copied,
bars
);
//--- Show a message in a comment in the main chart window
Comment(comm);
//--- Show the message
if(messages) Print(comm);
return(false);
}
else
{
//--- Set the display of the symbol
PlotIndexSetString(plot_index,PLOT_LABEL,name+" Open;"+name+" High;"+name+" Low;"+name+" Clos
IndicatorSetString(INDICATOR_SHORTNAME,"DRAW_COLOR_CANDLES("+symbol+")");
}
//--- Initialize buffers with empty values
ArrayInitialize(buff1,0.0);
ArrayInitialize(buff2,0.0);
ArrayInitialize(buff3,0.0);
ArrayInitialize(buff4,0.0);
//--- On each tick copy prices to buffers
for(int i=0;i<copied;i++)
{
ChartSetString(0,CHART_COMMENT,comm);
}
//---
}
//+------------------------------------------------------------------+
//| Changes the appearance of candlesticks |
//+------------------------------------------------------------------+
void ChangeLineAppearance()
{
//--- A string for the formation of information about the candlestick properties
string comm="";
//--- Write the symbol name
comm="\r\n"+symbol+comm;
//--- Show the information on the chart using a comment
Comment(comm);
}
Also there are other properties that can be set both through preprocessor directives and through
functions intended for custom indicator creation. These properties and corresponding functions are
described in the following table.
It should be noted that numeration of levels and plots in preprocessor terms starts with one, while
numeration of the same properties at using functions starts with zero, i.e. the indicated value must
be by 1 less than that indicated for #property.
There are several directives, for which there are no corresponding functions :
Directive Description
Directive Description
SetIndexBuffer
The function binds a specified indicator buffer with one-dimensional dynamic array of the double type.
bool SetIndexBuffer(
int index, // buffer index
double buffer[], // array
ENUM_INDEXBUFFER_TYPE data_type // what will be stored
);
Parameters
index
[in] Number of the indicator buffer. The numbering starts with 0. The number must be less than
the value declared in #property indicator_buffers.
buffer[]
[in] An array declared in the custom indicator program.
data_type
[in] Type of data stored in the indicator array. By default it is INDICATOR_DATA (values of the
calculated indicator). It may also take the value of INDICATOR_COLOR_INDEX; in this case this
buffer is used for storing color indexes for the previous indicator buffer. You can specify up to 64
colors in the #property indicator_colorN line. The INDICATOR_CALCULATIONS value means that the
buffer is used in intermediate calculations of the indicator and is not intended for drawing.
Return Value
After binding, the dynamic array buffer[] will be indexed as in common arrays, even if the indexing
of timeseries is pre-installed for the bound array. If you want to change the order of access to
elements of the indicator array, use the ArrayS etAs S eries() function after binding the array using
the SetIndexBuffer() function. Please note that you can't change the size for dynamic arrays set as
indicator buffers by the function S etIndexBuffer(). For indicator buffers, all operations of size
changes are performed by the executing sub-system of the terminal.
Example:
//+------------------------------------------------------------------+
//| TestCopyBuffer1.mq5 |
//| Copyright 2009, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "2009, MetaQuotes Software Corp."
#property link "https://www.mql5.com"
#property version "1.00"
#property indicator_separate_window
#property indicator_buffers 1
#property indicator_plots 1
//---- plot MA
#property indicator_label1 "MA"
#property indicator_type1 DRAW_LINE
#property indicator_color1 clrRed
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
//--- input parameters
input bool AsSeries=true;
input int period=15;
input ENUM_MA_METHOD smootMode=MODE_EMA;
input ENUM_APPLIED_PRICE price=PRICE_CLOSE;
input int shift=0;
//--- indicator buffers
double MABuffer[];
int ma_handle;
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- indicator buffers mapping
if(AsSeries) ArraySetAsSeries(MABuffer,true);
Print("Indicator buffer is timeseries = ",ArrayGetAsSeries(MABuffer));
SetIndexBuffer(0,MABuffer,INDICATOR_DATA);
Print("Indicator buffer after SetIndexBuffer() is timeseries = ",
ArrayGetAsSeries(MABuffer));
IndicatorSetString(INDICATOR_SHORTNAME,"MA("+period+")"+AsSeries);
//---
ma_handle=iMA(Symbol(),0,period,shift,smootMode,price);
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
//--- Copy the values of the moving average in the buffer MABuffer
int copied=CopyBuffer(ma_handle,0,0,rates_total,MABuffer);
See also
IndicatorSetDouble
The function sets the value of the corresponding indicator property. Indicator property must be of the
double type. There are two variants of the function.
Call with specifying the property identifier.
bool IndicatorSetDouble(
int prop_id, // identifier
double prop_value // value to be set
);
bool IndicatorSetDouble(
int prop_id, // identifier
int prop_modifier, // modifier
double prop_value // value to be set
)
Parameters
prop_id
[in] Identifier of the indicator property. The value can be one of the values of the
ENUM _CUS TOMIND_PR OPER T Y_DOUBL E enumeration.
prop_modifier
[in] Modifier of the specified property. Only level properties require a modifier. Numbering of
levels starts from 0. It means that in order to set property for the second level you need to specify
1 (1 less than when using compiler directive).
prop_value
[in] Value of property.
Return Value
Numbering of properties (modifiers) starts from 1 (one) when using the #property directive, while
the function uses numbering from 0 (zero). In case the level number is set incorrectly, indicator
display can differ from the intended one.
For example, the first level value for the indicator in a separate subwindow can be set in two ways :
· property indicator_level1 50 - the value of 1 is used for specifying the level number,
· IndicatorS etDouble(INDICATOR_LEVELVALUE, 0, 50) - 0 is used for specifying the first level.
Example: indicator that turns upside down the maximum and minimum values o f the indicator window
and values of levels on which the horizontal lines are placed.
#property indicator_separate_window
//--- set the maximum and minimum values for the indicator window
#property indicator_minimum 0
#property indicator_maximum 100
//--- display three horizontal levels in a separate indicator window
#property indicator_level1 25
#property indicator_level2 50
#property indicator_level3 75
//--- set thickness of horizontal levels
#property indicator_levelwidth 1
//--- set style of horizontal levels
#property indicator_levelstyle STYLE_DOT
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- set descriptions of horizontal levels
IndicatorSetString(INDICATOR_LEVELTEXT,0,"First Level (index 0)");
IndicatorSetString(INDICATOR_LEVELTEXT,1,"Second Level (index 1)");
IndicatorSetString(INDICATOR_LEVELTEXT,2,"Third Level (index 2)");
//--- set the short name for indicator
IndicatorSetString(INDICATOR_SHORTNAME,"IndicatorSetDouble() Demo");
//--- set color for each level
IndicatorSetInteger(INDICATOR_LEVELCOLOR,0,clrBlue);
IndicatorSetInteger(INDICATOR_LEVELCOLOR,1,clrGreen);
IndicatorSetInteger(INDICATOR_LEVELCOLOR,2,clrRed);
//---
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
static int tick_counter=0;
static double level1=25,level2=50,level3=75;
static double max=100,min=0, shift=100;
//--- calculate ticks
tick_counter++;
//--- turn levels upside down on every 10th tick
if(tick_counter%10==0)
{
//--- invert sign for the level values
level1=-level1;
level2=-level2;
level3=-level3;
//--- invert sign for the maximum and minimum values
max-=shift;
min-=shift;
//--- invert the shift value
shift=-shift;
//--- set new level values
IndicatorSetDouble(INDICATOR_LEVELVALUE,0,level1);
IndicatorSetDouble(INDICATOR_LEVELVALUE,1,level2);
IndicatorSetDouble(INDICATOR_LEVELVALUE,2,level3);
//--- set new values of maximum and minimum in the indicator window
Print("Set up max = ",max,", min = ",min);
IndicatorSetDouble(INDICATOR_MAXIMUM,max);
IndicatorSetDouble(INDICATOR_MINIMUM,min);
}
//--- return value of prev_calculated for next call
return(rates_total);
}
See also
Indicator S tyles in Examples, Connection between Indicator Properties and Functions, Drawing S tyles
IndicatorSetInteger
The function sets the value of the corresponding indicator property. Indicator property must be of the
int or color type. There are two variants of the function.
Call with specifying the property identifier.
bool IndicatorSetInteger(
int prop_id, // identifier
int prop_value // value to be set
);
bool IndicatorSetInteger(
int prop_id, // identifier
int prop_modifier, // modifier
int prop_value // value to be set
)
Parameters
prop_id
[in] Identifier of the indicator property. The value can be one of the values of the
ENUM _CUS TOMIND_PR OPER T Y_INT EGER enumeration.
prop_modifier
[in] Modifier of the specified property. Only level properties require a modifier.
prop_value
[in] Value of property.
Return Value
Numbering of properties (modifiers) starts from 1 (one) when using the #property directive, while
the function uses numbering from 0 (zero). In case the level number is set incorrectly, indicator
display can differ from the intended one.
For example, in order to set thickness of the first horizontal line use zeroth index:
· IndicatorS etInteger(INDICATOR_LEVELW IDTH, 0, 5) - index 0 is used to set thickness of the first
level.
Example: indicator that sets color, style and thickness of the indicator horizontal lines.
#property indicator_separate_window
#property indicator_minimum 0
#property indicator_maximum 100
//--- display three horizontal levels in a separate indicator window
#property indicator_level1 20
#property indicator_level2 50
#property indicator_level3 80
//--- set thickness of horizontal levels
#property indicator_levelwidth 5
//--- set color of horizontal levels
#property indicator_levelcolor clrAliceBlue
//--- set style of horizontal levels
#property indicator_levelstyle STYLE_DOT
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- set descriptions of horizontal levels
IndicatorSetString(INDICATOR_LEVELTEXT,0,"First Level (index 0)");
IndicatorSetString(INDICATOR_LEVELTEXT,1,"Second Level (index 1)");
IndicatorSetString(INDICATOR_LEVELTEXT,2,"Third Level (index 2)");
//--- set the short name for indicator
IndicatorSetString(INDICATOR_SHORTNAME,"IndicatorSetInteger() Demo");
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
if(tick_number%t_trigger==0)
index=2; // if tick_number is divided by t_trigger without the remainder
//--- if color is defined, set it
if(index!=-1)
IndicatorSetInteger(INDICATOR_LEVELCOLOR,level,colors[index]);
//---
}
//+------------------------------------------------------------------+
//| Set style of horizontal line in the separate indicator window |
//+------------------------------------------------------------------+
void ChangeLevelStyle(int level, // number of horizontal line
int tick_number// number to get the remainder of division
)
{
//--- array to store styles
static ENUM_LINE_STYLE styles[5]=
{STYLE_SOLID,STYLE_DASH,STYLE_DOT,STYLE_DASHDOT,STYLE_DASHDOTDOT};
//--- index of style from the styles[] array
int index=-1;
//--- calculate the number from the styles[] array to set style of horizontal line
if(tick_number%50==0)
index=5; // if tick_number is divided by 50 without the remainder, then style is STYLE_DASH
if(tick_number%40==0)
index=4; // ... style is STYLE_DASHDOT
if(tick_number%30==0)
index=3; // ... STYLE_DOT
if(tick_number%20==0)
index=2; // ... STYLE_DASH
if(tick_number%10==0)
index=1; // ... STYLE_SOLID
//--- if style is defined, set it
if(index!=-1)
IndicatorSetInteger(INDICATOR_LEVELSTYLE,level,styles[index]);
}
See also
IndicatorSetString
The function sets the value of the corresponding indicator property. Indicator property must be of the
string type. There are two variants of the function.
Call with specifying the property identifier.
bool IndicatorSetString(
int prop_id, // identifier
string prop_value // value to be set
);
bool IndicatorSetString(
int prop_id, // identifier
int prop_modifier, // modifier
string prop_value // value to be set
)
Parameters
prop_id
[in] Identifier of the indicator property. The value can be one of the values of the
ENUM _CUS TOMIND_PR OPER T Y_S T R ING enumeration.
prop_modifier
[in] Modifier of the specified property. Only level properties require a modifier.
prop_value
[in] Value of property.
Return Value
Numbering of properties (modifiers) starts from 1 (one) when using the #property directive, while
the function uses numbering from 0 (zero). In case the level number is set incorrectly, indicator
display can differ from the intended one.
For example, in order to set description of the first horizontal line use zeroth index:
· IndicatorS etS tring(INDICATOR_LEVELTEXT, 0, "First Level" ) - index 0 is used to set text
description of the first level.
Example: indicator that sets text labels to the indicator horizontal lines.
#property indicator_separate_window
#property indicator_minimum 0
#property indicator_maximum 100
//--- display three horizontal levels in a separate indicator window
#property indicator_level1 30
#property indicator_level2 50
#property indicator_level3 70
//--- set color of horizontal levels
#property indicator_levelcolor clrRed
//--- set style of horizontal levels
#property indicator_levelstyle STYLE_SOLID
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- set descriptions of horizontal levels
IndicatorSetString(INDICATOR_LEVELTEXT,0,"First Level (index 0)");
IndicatorSetString(INDICATOR_LEVELTEXT,1,"Second Level (index 1)");
IndicatorSetString(INDICATOR_LEVELTEXT,2,"Third Level (index 2)");
//--- set the short name for indicator
IndicatorSetString(INDICATOR_SHORTNAME,"IndicatorSetString() Demo");
//---
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
//---
See also
PlotIndexSetDouble
The function sets the value of the corresponding property of the corresponding indicator line. The
indicator property must be of the double type.
bool PlotIndexSetDouble(
int plot_index, // plotting style index
int prop_id, // property identifier
double prop_value // value to be set
);
Parameters
plot_index
[in] Index of the graphical plotting
prop_id
[in] The value can be one of the values of the ENUM _PLOT_PROPERTY_DOUBLE enumeration.
prop_value
[in] The value of the property.
Return Value
PlotIndexSetInteger
The function sets the value of the corresponding property of the corresponding indicator line. The
indicator property must be of the int, char, bool or color type. There are 2 variants of the function.
Call indicating identifier of the property.
bool PlotIndexSetInteger(
int plot_index, // plotting style index
int prop_id, // property identifier
int prop_value // value to be set
);
bool PlotIndexSetInteger(
int plot_index, // plotting style index
int prop_id, // property identifier
int prop_modifier, // property modifier
int prop_value // value to be set
)
Parameters
plot_index
[in] Index of the graphical plotting
prop_id
[in] The value can be one of the values of the ENUM _PLOT_PROPERTY_INTEGER enumeration.
prop_modifier
[in] Modifier of the specified property. Only color index properties require a modifier.
prop_value
[in] The value of the property.
Return Value
#property indicator_chart_window
#property indicator_buffers 2
#property indicator_plots 1
//---- plot ColorLine
#property indicator_label1 "ColorLine"
#property indicator_type1 DRAW_COLOR_LINE
#property indicator_color1 clrRed,clrGreen,clrBlue
#property indicator_style1 STYLE_SOLID
#property indicator_width1 3
//--- indicator buffers
double ColorLineBuffer[];
double ColorBuffer[];
int MA_handle;
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
void OnInit()
{
//--- indicator buffers mapping
SetIndexBuffer(0,ColorLineBuffer,INDICATOR_DATA);
SetIndexBuffer(1,ColorBuffer,INDICATOR_COLOR_INDEX);
//--- get MA handle
MA_handle=iMA(Symbol(),0,10,0,MODE_EMA,PRICE_CLOSE);
//---
}
//+------------------------------------------------------------------+
//| get color index |
//+------------------------------------------------------------------+
int getIndexOfColor(int i)
{
int j=i%300;
if(j<100) return(0);// first index
if(j<200) return(1);// second index
return(2); // third index
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
//---
static int ticks=0,modified=0;
int limit;
//--- first calculation or number of bars was changed
if(prev_calculated==0)
{
//--- copy values of MA into indicator buffer ColorLineBuffer
int copied=CopyBuffer(MA_handle,0,0,rates_total,ColorLineBuffer);
if(copied<=0) return(0);// copying failed - throw away
//--- now set line color for every bar
for(int i=0;i<rates_total;i++)
ColorBuffer[i]=getIndexOfColor(i);
}
else
{
//--- copy values of MA into indicator buffer ColorLineBuffer
int copied=CopyBuffer(MA_handle,0,0,rates_total,ColorLineBuffer);
if(copied<=0) return(0);
PlotIndexSetString
The function sets the value of the corresponding property of the corresponding indicator line. The
indicator property must be of the string type.
bool PlotIndexSetString(
int plot_index, // plotting style index
int prop_id, // property identifier
string prop_value // value to be set
);
Parameters
plot_index
[in] Index of graphical plot
prop_id
[in] The value can be one of the values of the ENUM _PLOT_PROPERTY_S TRING enumeration.
prop_value
[in] The value of the property.
Return Value
PlotIndexGetInteger
The function sets the value of the corresponding property of the corresponding indicator line. The
indicator property must be of the int, color, bool or char type. There are 2 variants of the function.
Call indicating identifier of the property.
int PlotIndexGetInteger(
int plot_index, // plotting style index
int prop_id, // property identifier
);
int PlotIndexGetInteger(
int plot_index, // plotting index
int prop_id, // property identifier
int prop_modifier // property modifier
)
Parameters
plot_index
[in] Index of the graphical plotting
prop_id
[in] The value can be one of the values of the ENUM _PLOT_PROPERTY_INTEGER enumeration.
prop_modifier
[in] Modifier of the specified property. Only color index properties require a modifier.
Note
Function is designed to extract the settings of drawing of the appropriate indicator line. The
function works in tandem with the function PlotIndexS etInteger to copy the drawing properties of
one line to another.
Example: an indicator that colors candles depending on the day of the week. Colors for each day are
set in a programmatically.
#property indicator_separate_window
#property indicator_buffers 5
#property indicator_plots 1
//---- plot ColorCandles
#property indicator_label1 "ColorCandles"
#property indicator_type1 DRAW_COLOR_CANDLES
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
//--- indicator buffers
double OpenBuffer[];
double HighBuffer[];
double LowBuffer[];
double CloseBuffer[];
double ColorCandlesColors[];
color ColorOfDay[6]={CLR_NONE,clrMediumSlateBlue,
clrDarkGoldenrod,clrForestGreen,clrBlueViolet,clrRed};
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
void OnInit()
{
//--- indicator buffers mapping
SetIndexBuffer(0,OpenBuffer,INDICATOR_DATA);
SetIndexBuffer(1,HighBuffer,INDICATOR_DATA);
SetIndexBuffer(2,LowBuffer,INDICATOR_DATA);
SetIndexBuffer(3,CloseBuffer,INDICATOR_DATA);
SetIndexBuffer(4,ColorCandlesColors,INDICATOR_COLOR_INDEX);
//--- set number of colors in color buffer
PlotIndexSetInteger(0,PLOT_COLOR_INDEXES,6);
//--- set colors for color buffer
for(int i=1;i<6;i++)
PlotIndexSetInteger(0,PLOT_LINE_COLOR,i,ColorOfDay[i]);
//--- set accuracy
IndicatorSetInteger(INDICATOR_DIGITS,_Digits);
printf("We have %u colors of days",PlotIndexGetInteger(0,PLOT_COLOR_INDEXES));
//---
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
//---
int i;
MqlDateTime t;
//----
if(prev_calculated==0) i=0;
else i=prev_calculated-1;
//----
while(i<rates_total)
{
OpenBuffer[i]=open[i];
HighBuffer[i]=high[i];
LowBuffer[i]=low[i];
CloseBuffer[i]=close[i];
//--- set color for every candle
TimeToStruct(time[i],t);
ColorCandlesColors[i]=t.day_of_week;
//---
i++;
}
//--- return value of prev_calculated for next call
return(rates_total);
}
//+------------------------------------------------------------------+
Object Functions
This is the group of functions intended for working with graphic objects relating to any specified
chart.
The functions defining the properties of graphical objects, as well as ObjectCreate() and ObjectMove()
operations for creating and moving objects along the chart are actually used for sending commands to
the chart. If these functions are executed successfully, the command is included in the common queue
of the chart events. Visual changes in the properties of graphical objects are implemented when
handling the queue of the chart events.
Thus, do not expect an immediate visual update of graphical objects after calling these functions.
Generally, the graphical objects on the chart are updated automatically by the terminal following the
change events - a new quote arrival, resizing the chart window, etc. Use ChartRedraw() function to
forcefully update the graphical objects.
Function Action
Function Action
TextGetS ize R eturns the string's width and height at the current font settings
Every graphical object should have a name unique within one chart, including its subwindows.
Changing of a name of a graphic object generates two events : event of deletion of an object with the
old name, and event of creation of an object with a new name.
After an object is created or an object property is modified it is recommended to call the
ChartRedraw() function, which commands the client terminal to forcibly draw a chart (and all visible
objects in it).
ObjectCreate
The function creates an object with the specified name, type, and the initial coordinates in the
specified chart subwindow. During creation up to 30 coordinates can be specified.
bool ObjectCreate(
long chart_id, // chart identifier
string name, // object name
ENUM_OBJECT type, // object type
sub_window nwin, // window index
datetime time1, // time of the first anchor point
double price1, // price of the first anchor point
...
datetime timeN=0, // time of the N-th anchor point
double priceN=0, // price of the N-th anchor point
...
datetime time30=0, // time of the 30th anchor point
double price30=0 // price of the 30th anchor point
);
Parameters
chart_id
[in] Chart identifier. 0 means the current chart.
name
[in] Name of the object. The name must be unique within a chart, including its subwindows.
type
[in] Object type. The value can be one of the values of the ENUM _OBJECT enumeration.
sub_window
[in] Number of the chart subwindow. 0 means the main chart window. The specified subwindow
must exist, otherwise the function returns false.
time1
[in] The time coordinate of the first anchor.
price1
[in] The price coordinate of the first anchor point.
timeN=0
[in] The time coordinate of the N-th anchor point.
priceN=0
[in] The price coordinate of the N-th anchor point.
time30=0
[in] The time coordinate of the thirtieth anchor point.
price30=0
[in] The price coordinate of the thirtieth anchor point.
Return Value
The function returns true if the command has been successfully added to the queue of the specified
chart, or false otherwise. If an object has already been created, an attempt is made to change its
coordinates.
Note
An asynchronous call is always used for ObjectCreate(), that is why the function only returns the
results of adding the command to a chart queue. In this case, true only means that the command
has been successfully enqueued, but the result of its execution is unknown.
To check the command execution result, you can use the ObjectFind() function or any other function
that requests object properties, such as ObjectGetXXX. However, you should keep in mind that such
functions are added to the end of the queue of that chart, and they wait for the execution result
(due to the synchronous call), and can therefore be time consuming. This feature should be taken
into account when working with a large number of objects on a chart.
An object name should not exceed 63 characters.
The numbering of the chart subwindows (if there are subwindows with indicators in the chart) starts
with 1. The main chart window of the chart is and always has index 0.
The large number of anchor points (up to 30) is implemented for future use. At the same time, the
limit of 30 possible anchor points for graphical objects is determined by the limit on the number of
parameters (not more than 64) that can be used when calling a function.
W hen an object is renamed, two events are formed simultaneously. These events can be handled in
an Expert Advisor or indicator by the OnChartEvent() function:
· an event of deletion of an object with the old name;
· an event of creation of an object with a new name.
There is a certain number of anchor points that must be specified when creating each object type:
ObjectName
The function returns the name of the corresponding object in the specified chart, in the specified
subwindow, of the specified type.
string ObjectName(
long chart_id, // chart identifier
int pos, // number in the list of objects
int sub_window=-1, // window index
int type=-1 // object type
);
Parameters
chart_id
[in] Chart identifier. 0 means the current chart.
pos
[in]Ordinal number of the object according to the specified filter by the number and type of the
subwindow.
sub_window=-1
[in] Number of the chart subwindow. 0 means the main chart window, -1 means all the
subwindows of the chart, including the main window.
type=-1
[in]Type of the object. The value can be one of the values of the ENUM _OBJECT enumeration. -1
means all types.
Return Value
The function uses a synchronous call, which means that the function waits for the execution of all
commands that have been enqueued for this chart prior to its call, that is why this function can be
time consuming. This feature should be taken into account when working with a large number of
objects on a chart.
W hen an object is renamed, two events are formed simultaneously. These events can be handled in
an Expert Advisor or indicator by the OnChartEvent() function:
· an event of deletion of an object with the old name;
· an event of creation of an object with a new name.
ObjectDelete
The function removes the object with the specified name from the specified chart.
bool ObjectDelete(
long chart_id, // chart identifier
string name // object name
);
Parameters
chart_id
[in] Chart identifier. 0 means the current chart.
name
[in] Name of object to be deleted.
Return Value
The function returns true if the command has been successfully added to the queue of the specified
chart, or false otherwise.
Note
An asynchronous call is always used for ObjectDelete(), that is why the function only returns the
results of adding the command to a chart queue. In this case, true only means that the command
has been successfully enqueued, but the result of its execution is unknown.
To check the command execution result, you can use the ObjectFind() function or any other function
that requests object properties, such as ObjectGetXXX. However, you should keep in mind that such
functions are added to the end of the queue of that chart, and they wait for the execution result
(due to the synchronous call), and can therefore be time consuming. This feature should be taken
into account when working with a large number of objects on a chart.
W hen an object is renamed, two events are formed simultaneously. These events can be handled in
an Expert Advisor or indicator by the OnChartEvent() function:
· an event of deletion of an object with the old name;
· an event of creation of an object with a new name.
ObjectsDeleteAll
R emoves all objects from the specified chart, specified chart subwindow, of the specified type.
int ObjectsDeleteAll(
long chart_id, // chart identifier
int sub_window=-1, // window index
int type=-1 // object type
);
R emoves all objects of the specified type using prefix in object names.
int ObjectsDeleteAll(
long chart_id, // chart ID
const string prefix, // prefix in object name
int sub_window=-1, // window index
int object_type=-1 // object type
);
Parameters
chart_id
[in] Chart identifier. 0 means the current chart.
prefix
[in] Prefix in object names. All objects whose names start with this set of characters will be
removed from chart. You can specify prefix as 'name' or 'name*' – both variants will work the same.
If an empty string is specified as the prefix, objects with all possible names will be removed.
sub_window=-1
[in] Number of the chart subwindow. 0 means the main chart window, -1 means all the subwindows
of the chart, including the main window.
type=-1
[in]Type of the object. The value can be one of the values of the ENUM _OBJECT enumeration. -1
means all types.
Return Value
R eturns the number of deleted objects. To read more about the error call GetLastError().
Note
The function uses a synchronous call, which means that the function waits for the execution of all
commands that have been enqueued for this chart prior to its call, that is why this function can be
time consuming. This feature should be taken into account when working with a large number of
objects on a chart.
ObjectFind
The function searches for an object with the specified name in the chart with the specified ID.
int ObjectFind(
long chart_id, // chart identifier
string name // object name
);
Parameters
chart_id
[in] Chart identifier. 0 means the current chart.
name
[in] The name of the searched object.
Return Value
If successful the function returns the number of the subwindow (0 means the main window of the
chart), in which the object is found. If the object is not found, the function returns a negative
number. To read more about the error call GetLastError().
Note
The function uses a synchronous call, which means that the function waits for the execution of all
commands that have been enqueued for this chart prior to its call, that is why this function can be
time consuming. This feature should be taken into account when working with a large number of
objects on a chart.
W hen an object is renamed, two events are formed simultaneously. These events can be handled in
an Expert Advisor or indicator by the OnChartEvent() function:
· an event of deletion of an object with the old name;
· an event of creation of an object with a new name.
ObjectGetTimeByValue
The function returns the time value for the specified price value of the specified object.
datetime ObjectGetTimeByValue(
long chart_id, // chart identifier
string name, // object name
double value, // Price
int line_id // Line number
);
Parameters
chart_id
[in] Chart identifier. 0 means the current chart.
name
[in] Name of the object.
value
[in] Price value.
line_id
[in] Line identifier.
Return Value
The time value for the specified price value of the specified object.
Note
The function uses a synchronous call, which means that the function waits for the execution of all
commands that have been enqueued for this chart prior to its call, that is why this function can be
time consuming. This feature should be taken into account when working with a large number of
objects on a chart.
An object can have several values in one price coordinate, therefore it is necessary to specify the
line number. This function applies only to the following objects :
· Trendline (OBJ_T REND)
· Trendline by angle (OBJ_T RENDBYANGL E)
· Gann line (OBJ_GANNLI NE)
· Equidistant channel (OBJ_CHANNEL) - 2 lines
· Linear regression channel (OBJ_REGRESS ION) - 3 lines
· S tandard deviation channel (OBJ_S T DDEVCHANNEL) - 3 lines
· Arrowed line (OBJ_ARR OWED_LI NE)
See also
Object Types
ObjectGetValueByTime
The function returns the price value for the specified time value of the specified object.
double ObjectGetValueByTime(
long chart_id, // chart identifier
string name, // object name
datetime time, // Time
int line_id // Line number
);
Parameters
chart_id
[in] Chart identifier. 0 means the current chart.
name
[in] Name of the object.
time
[in] Time value.
line_id
[in] Line ID.
Return Value
The price value for the specified time value of the specified object.
Note
The function uses a synchronous call, which means that the function waits for the execution of all
commands that have been enqueued for this chart prior to its call, that is why this function can be
time consuming. This feature should be taken into account when working with a large number of
objects on a chart.
An object can have several values in one price coordinate, therefore it is necessary to specify the
line number. This function applies only to the following objects :
· Trendline (OBJ_T REND)
· Trendline by angle (OBJ_T RENDBYANGL E)
· Gann line (OBJ_GANNLI NE)
· Equidistant channel (OBJ_CHANNEL) - 2 lines
· Linear regression channel (OBJ_REGRESS ION) - 3 lines
· S tandard deviation channel (OBJ_S T DDEVCHANNEL) - 3 lines
· Arrowed line (OBJ_ARR OWED_LI NE)
See also
Object Types
ObjectMove
The function changes coordinates of the specified anchor point of the object.
bool ObjectMove(
long chart_id, // chart identifier
string name, // object name
int point_index, // anchor point number
datetime time, // Time
double price // Price
);
Parameters
chart_id
[in] Chart identifier. 0 means the current chart.
name
[in] Name of the object.
point_index
[in] Index of the anchor point. The number of anchor points depends on the type of object.
time
[in] Time coordinate of the selected anchor point.
price
[in] Price coordinate of the selected anchor point.
Return Value
The function returns true if the command has been successfully added to the queue of the specified
chart, or false otherwise.
Note
An asynchronous call is always used for ObjectMove(), that is why the function only returns the
results of adding the command to a chart queue. In this case, true only means that the command
has been successfully enqueued, but the result of its execution is unknown.
To check the command execution result, you can use a function that requests object properties,
such as ObjectGetXXX. However, you should keep in mind that such functions are added to the end
of the queue of that chart, and they wait for the execution result (due to the synchronous call), and
can therefore be time consuming. This feature should be taken into account when working with a
large number of objects on a chart.
ObjectsTotal
The function returns the number of objects in the specified chart, specified subwindow, of the
specified type.
int ObjectsTotal(
long chart_id, // chart identifier
int sub_window=-1, // window index
int type=-1 // object type
);
Parameters
chart_id
[in] Chart identifier. 0 means the current chart.
sub_window=-1
[in] Number of the chart subwindow. 0 means the main chart window, -1 means all the
subwindows of the chart, including the main window.
type=-1
[in]Type of the object. The value can be one of the values of the ENUM _OBJECT enumeration. -1
means all types.
Return Value
The function uses a synchronous call, which means that the function waits for the execution of all
commands that have been enqueued for this chart prior to its call, that is why this function can be
time consuming. This feature should be taken into account when working with a large number of
objects on a chart.
ObjectSetDouble
The function sets the value of the corresponding object property. The object property must be of the
double type. There are 2 variants of the function.
Setting property value, without modifier
bool ObjectSetDouble(
long chart_id, // chart identifier
string name, // object name
ENUM_OBJECT_PROPERTY_DOUBLE prop_id, // property
double prop_value // value
);
bool ObjectSetDouble(
long chart_id, // chart identifier
string name, // object name
ENUM_OBJECT_PROPERTY_DOUBLE prop_id, // property
int prop_modifier, // modifier
double prop_value // value
);
Parameters
chart_id
[in] Chart identifier. 0 means the current chart.
name
[in] Name of the object.
prop_id
[in] ID of the object property. The value can be one of the values of the
ENUM _OBJECT _PR OPER T Y_DOUBL E enumeration.
prop_modifier
[in] Modifier of the specified property. It denotes the number of the level in Fibonacci tools and in
the graphical object Andrew's pitchfork. The numeration of levels starts from zero.
prop_value
[in] The value of the property.
Return Value
The function returns true only if the command to change properties of a graphical object has been
sent to a chart successfully. Otherwise it returns false. To read more about the error call
GetLastError().
Note
The function uses an asynchronous call, which means that the function does not wait for the
execution of the command that has been added to the queue of the specified chart. Instead, it
immediately returns control.
To check the command execution result, you can use a function that requests the specified object
property. However, you should keep in mind that such functions are added to the end of the queue
of that chart, and they wait for the execution result, and can therefore be time consuming. This
feature should be taken into account when working with a large number of objects on a chart.
Example of creating a Fibonacci object and adding a new level in it
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- auxiliary arrays
double high[],low[],price1,price2;
datetime time[],time1,time2;
//--- Copy the open prices - 100 latest bars are enough
int copied=CopyHigh(Symbol(),0,0,100,high);
if(copied<=0)
{
Print("Failed to copy the values of the High price series");
return;
}
//--- Copy the close price - 100 latest bars are enough
copied=CopyLow(Symbol(),0,0,100,low);
if(copied<=0)
{
Print("Failed to copy the values of the Low price series");
return;
}
//--- Copy the open time for the last 100 bars
copied=CopyTime(Symbol(),0,0,100,time);
if(copied<=0)
{
Print("Failed to copy the values of the price series of Time");
return;
}
//--- Organize access to the copied data as to timeseries - backwards
ArraySetAsSeries(high,true);
ArraySetAsSeries(low,true);
ArraySetAsSeries(time,true);
time2=time[50];
See also
Object Types, Object Properties
ObjectSetInteger
The function sets the value of the corresponding object property. The object property must be of the
datetime, int, color, bool or char type. There are 2 variants of the function.
Setting property value, without modifier
bool ObjectSetInteger(
long chart_id, // chart identifier
string name, // object name
ENUM_OBJECT_PROPERTY_INTEGER prop_id, // property
long prop_value // value
);
bool ObjectSetInteger(
long chart_id, // chart identifier
string name, // object name
ENUM_OBJECT_PROPERTY_INTEGER prop_id, // property
int prop_modifier, // modifier
long prop_value // value
);
Parameters
chart_id
[in] Chart identifier. 0 means the current chart.
name
[in] Name of the object.
prop_id
[in] ID of the object property. The value can be one of the values of the
ENUM _OBJECT _PR OPER T Y_INT EGER enumeration.
prop_modifier
[in] Modifier of the specified property. It denotes the number of the level in Fibonacci tools and
in the graphical object Andrew's pitchfork. The numeration of levels starts from zero.
prop_value
[in] The value of the property.
Return Value
The function returns true only if the command to change properties of a graphical object has been
sent to a chart successfully. Otherwise it returns false. To read more about the error call
GetLastError().
Note
The function uses an asynchronous call, which means that the function does not wait for the
execution of the command that has been added to the queue of the specified chart. Instead, it
immediately returns control.
To check the command execution result, you can use a function that requests the specified object
property. However, you should keep in mind that such functions are added to the end of the queue
of that chart, and they wait for the execution result, and can therefore be time consuming. This
feature should be taken into account when working with a large number of objects on a chart.
An example of how to create a table of Web colors
//+------------------------------------------------------------------+
//| Table of Web Colors|
//| Copyright 2011, MetaQuotes Software Corp |
//| https://www.metaquotes.net |
//+------------------------------------------------------------------+
#define X_SIZE 140 // width of an edit object
#define Y_SIZE 33 // height of an edit object
//+------------------------------------------------------------------+
//| Array of web colors |
//+------------------------------------------------------------------+
color ExtClr[140]=
{
clrAliceBlue,clrAntiqueWhite,clrAqua,clrAquamarine,clrAzure,clrBeige,clrBisque,clrBlack,clrBlanc
clrBlue,clrBlueViolet,clrBrown,clrBurlyWood,clrCadetBlue,clrChartreuse,clrChocolate,clrCoral,clr
clrCornsilk,clrCrimson,clrCyan,clrDarkBlue,clrDarkCyan,clrDarkGoldenrod,clrDarkGray,clrDarkGreen
clrDarkMagenta,clrDarkOliveGreen,clrDarkOrange,clrDarkOrchid,clrDarkRed,clrDarkSalmon,clrDarkSea
clrDarkSlateBlue,clrDarkSlateGray,clrDarkTurquoise,clrDarkViolet,clrDeepPink,clrDeepSkyBlue,clrD
clrDodgerBlue,clrFireBrick,clrFloralWhite,clrForestGreen,clrFuchsia,clrGainsboro,clrGhostWhite,c
clrGoldenrod,clrGray,clrGreen,clrGreenYellow,clrHoneydew,clrHotPink,clrIndianRed,clrIndigo,clrIv
clrLavender,clrLavenderBlush,clrLawnGreen,clrLemonChiffon,clrLightBlue,clrLightCoral,clrLightCya
clrLightGoldenrod,clrLightGreen,clrLightGray,clrLightPink,clrLightSalmon,clrLightSeaGreen,clrLig
clrLightSlateGray,clrLightSteelBlue,clrLightYellow,clrLime,clrLimeGreen,clrLinen,clrMagenta,clrM
clrMediumAquamarine,clrMediumBlue,clrMediumOrchid,clrMediumPurple,clrMediumSeaGreen,clrMediumSla
clrMediumSpringGreen,clrMediumTurquoise,clrMediumVioletRed,clrMidnightBlue,clrMintCream,clrMisty
clrNavajoWhite,clrNavy,clrOldLace,clrOlive,clrOliveDrab,clrOrange,clrOrangeRed,clrOrchid,clrPale
clrPaleGreen,clrPaleTurquoise,clrPaleVioletRed,clrPapayaWhip,clrPeachPuff,clrPeru,clrPink,clrPlu
clrPurple,clrRed,clrRosyBrown,clrRoyalBlue,clrSaddleBrown,clrSalmon,clrSandyBrown,clrSeaGreen,cl
clrSienna,clrSilver,clrSkyBlue,clrSlateBlue,clrSlateGray,clrSnow,clrSpringGreen,clrSteelBlue,clr
clrThistle,clrTomato,clrTurquoise,clrViolet,clrWheat,clrWhite,clrWhiteSmoke,clrYellow,clrYellowG
};
//+------------------------------------------------------------------+
//| Creating and initializing an edit object |
//+------------------------------------------------------------------+
void CreateColorBox(int x,int y,color c)
{
//--- generate a name for a new edit object
string name="ColorBox_"+(string)x+"_"+(string)y;
//--- create a new edit object
if(!ObjectCreate(0,name,OBJ_EDIT,0,0,0))
{
Print("Cannot create: '",name,"'");
return;
}
//--- set coordinates, width and height
ObjectSetInteger(0,name,OBJPROP_XDISTANCE,x*X_SIZE);
ObjectSetInteger(0,name,OBJPROP_YDISTANCE,y*Y_SIZE);
ObjectSetInteger(0,name,OBJPROP_XSIZE,X_SIZE);
ObjectSetInteger(0,name,OBJPROP_YSIZE,Y_SIZE);
//--- set text color
if(clrBlack==c) ObjectSetInteger(0,name,OBJPROP_COLOR,clrWhite);
else ObjectSetInteger(0,name,OBJPROP_COLOR,clrBlack);
//--- set background color
ObjectSetInteger(0,name,OBJPROP_BGCOLOR,c);
//--- set text
ObjectSetString(0,name,OBJPROP_TEXT,(string)c);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- create 7x20 table of colored edit objects
for(uint i=0;i<140;i++)
CreateColorBox(i%7,i/7,ExtClr[i]);
}
See also
Object Types, Object Properties
ObjectSetString
The function sets the value of the corresponding object property. The object property must be of the
string type. There are 2 variants of the function.
Setting property value, without modifier
bool ObjectSetString(
long chart_id, // chart identifier
string name, // object name
ENUM_OBJECT_PROPERTY_STRING prop_id, // property
string prop_value // value
);
bool ObjectSetString(
long chart_id, // chart identifier
string name, // object name
ENUM_OBJECT_PROPERTY_STRING prop_id, // property
int prop_modifier, // modifier
string prop_value // value
);
Parameters
chart_id
[in] Chart identifier. 0 means the current chart.
name
[in] Name of the object.
prop_id
[in] ID of the object property. The value can be one of the values of the
ENUM _OBJECT _PR OPER T Y_S T R ING enumeration.
prop_modifier
[in] Modifier of the specified property. It denotes the number of the level in Fibonacci tools and
in the graphical object Andrew's pitchfork. The numeration of levels starts from zero.
prop_value
[in] The value of the property.
Return Value
The function returns true only if the command to change properties of a graphical object has been
sent to a chart successfully. Otherwise it returns false. To read more about the error call
GetLastError().
Note
The function uses an asynchronous call, which means that the function does not wait for the
execution of the command that has been added to the queue of the specified chart. Instead, it
immediately returns control.
To check the command execution result, you can use a function that requests the specified object
property. However, you should keep in mind that such functions are added to the end of the queue
of that chart, and they wait for the execution result, and can therefore be time consuming. This
feature should be taken into account when working with a large number of objects on a chart.
W hen an object is renamed, two events are formed simultaneously. These events can be handled in
an Expert Advisor or indicator by the OnChartEvent() function:
· an event of deletion of an object with the old name;
· an event of creation of an object with a new name.
ObjectGetDouble
The function returns the value of the corresponding object property. The object property must be of
the double type. There are 2 variants of the function.
1. Immediately returns the property value.
double ObjectGetDouble(
long chart_id, // chart identifier
string name, // object name
ENUM_OBJECT_PROPERTY_DOUBLE prop_id, // property identifier
int prop_modifier=0 // property modifier, if required
);
2. Returns true or false, depending on the success of the function. If successful, the property value
is placed to a receiving variable passed by reference by the last parameter.
bool ObjectGetDouble(
long chart_id, // chart identifier
string name, // object name
ENUM_OBJECT_PROPERTY_DOUBLE prop_id, // property identifier
int prop_modifier, // property modifier
double& double_var // here we accept the property value
);
Parameters
chart_id
[in] Chart identifier. 0 means the current chart.
name
[in] Name of the object.
prop_id
[in] ID of the object property. The value can be one of the values of the
ENUM _OBJECT _PR OPER T Y_DOUBL E enumeration.
prop_modifier
[in] Modifier of the specified property. For the first variant, the default modifier value is equal to
0. Most properties do not require a modifier. It denotes the number of the level in Fibonacci tools
and in the graphical object Andrew's pitchfork. The numeration of levels starts from zero.
double_var
[out] Variable of the double type that received the value of the requested property.
Return Value
Note
The function uses a synchronous call, which means that the function waits for the execution of all
commands that have been enqueued for this chart prior to its call, that is why this function can be
time consuming. This feature should be taken into account when working with a large number of
objects on a chart.
ObjectGetInteger
The function returns the value of the corresponding object property. The object property must be of
the datetime, int, color, bool or char type. There are 2 variants of the function.
1. Immediately returns the property value.
long ObjectGetInteger(
long chart_id, // chart identifier
string name, // object name
ENUM_OBJECT_PROPERTY_INTEGER prop_id, // property identifier
int prop_modifier=0 // property modifier, if required
);
2. Returns true or false, depending on the success of the function. If successful, the property value
is placed to a receiving variable passed by reference by the last parameter.
bool ObjectGetInteger(
long chart_id, // chart identifier
string name, // object name
ENUM_OBJECT_PROPERTY_INTEGER prop_id, // property identifier
int prop_modifier, // property modifier
long& long_var // here we accept the property value
);
Parameters
chart_id
[in] Chart identifier. 0 means the current chart.
name
[in] Name of the object.
prop_id
[in] ID of the object property. The value can be one of the values of the
ENUM _OBJECT _PR OPER T Y_INT EGER enumeration.
prop_modifier
[in] Modifier of the specified property. For the first variant, the default modifier value is equal to
0. Most properties do not require a modifier. It denotes the number of the level in Fibonacci tools
and in the graphical object Andrew's pitchfork. The numeration of levels starts from zero.
long_var
[out] Variable of the long type that receives the value of the requested property.
Return Value
Note
The function uses a synchronous call, which means that the function waits for the execution of all
commands that have been enqueued for this chart prior to its call, that is why this function can be
time consuming. This feature should be taken into account when working with a large number of
objects on a chart.
ObjectGetString
The function returns the value of the corresponding object property. The object property must be of
the string type. There are 2 variants of the function.
1. Immediately returns the property value.
string ObjectGetString(
long chart_id, // chart identifier
string name, // object name
ENUM_OBJECT_PROPERTY_STRING prop_id, // property identifier
int prop_modifier=0 // property modifier, if required
);
2. Returns true or false, depending on the success of the function. If successful, the property value
is placed to a receiving variable passed by reference by the last parameter.
bool ObjectGetString(
long chart_id, // chart identifier
string name, // object name
ENUM_OBJECT_PROPERTY_STRING prop_id, // property identifier
int prop_modifier, // property modifier
string& string_var // here we accept the property value
);
Parameters
chart_id
[in] Chart identifier. 0 means the current chart.
name
[in] Name of the object.
prop_id
[in] ID of the object property. The value can be one of the values of the
ENUM _OBJECT _PR OPER T Y_S T R ING enumeration.
prop_modifier
[in] Modifier of the specified property. For the first variant, the default modifier value is equal to
0. Most properties do not require a modifier. It denotes the number of the level in Fibonacci tools
and in the graphical object Andrew's pitchfork. The numeration of levels starts from zero.
string_var
[out] Variable of the string type that receives the value of the requested properties.
Return Value
Note
The function uses a synchronous call, which means that the function waits for the execution of all
commands that have been enqueued for this chart prior to its call, that is why this function can be
time consuming. This feature should be taken into account when working with a large number of
objects on a chart.
W hen an object is renamed, two events are formed simultaneously. These events can be handled in
an Expert Advisor or indicator by the OnChartEvent() function:
· an event of deletion of an object with the old name;
· an event of creation of an object with a new name.
TextSetFont
The function sets the font for displaying the text using drawing methods and returns the result of that
operation. Arial font with the size -120 (12 pt) is used by default.
bool TextSetFont(
const string name, // font name or path to font file on the disk
int size, // font size
uint flags, // combination of flags
int orientation=0 // text slope angle
);
Parameters
name
[in] Font name in the system or the name of the resource containing the font or the path to font
file on the dis k.
size
[in] The font size that can be set using positive and negative values. In case of positive values,
the size of a displayed text does not depend on the operating system's font size settings. In case
of negative values, the value is set in tenths of a point and the text size depends on the operating
system settings (" standard scale" or " large scale" ). S ee the Note below for more information about
the differences between the modes.
flags
[in] Combination of flags describing font style.
orientation
[in] Text's horizontal inclination to X axis, the unit of measurement is 0.1 degrees. It means that
orientation=450 stands for inclination equal to 45 degrees.
Return Value
R eturns true if the current font is successfully installed, otherwise false. Possible code errors :
· ERR_INVALID_PARAM ET ER (4003) - name presents NULL or "" (empty string),
· ERR_INT ERNAL _ERR OR (4001) - operating system error (for example, an attempt to create a non-
existent font).
Note
If "::" is used in font name, the font is downloaded from EX5 resource. If name font name is
specified with an extension, the font is downloaded from the file, if the path starts from "\" or "/" ,
the file is searched relative to MQL5 directory. Otherwise, it is searched relative to the path of EX5
file which called TextS etFont() function.
The font size is set using positive or negative values. This fact defines the dependence of the text
size from the operating system settings (size scale).
· If the size is specified using a positive number, this size is transformed into physical
measurement units of a device (pixels) when changing a logical font into a physical one, and this
size corresponds to the height of the symbol glyphs picked from the available fonts. This case is
not recommended when the texts displayed by TextOut() function and the ones displayed by
OBJ_LABEL (" Label" ) graphical object are to be used together on the chart.
· If the size is specified using a negative number, this number is supposed to be set in tenths of a
logical point and is divided by 10 (for example, -350 is equal to 35 logical points). An obtained
value is then transformed into physical measurement units of a device (pixels) and corresponds to
the absolute value of the height of a symbol picked from the available fonts. Multiply the font size
specified in the object properties by -10 to make the size of a text on the screen similar to the
one in OBJ_LABEL object.
The flags can be used as the combination of style flags with one of the flags specifying the font
width. Flag names are shown below.
Flags for specifying font style
Flag Description
Flag
FW_DONTCARE
FW_T H IN
FW_EXT RALIGH T
FW_ULT RALIGH T
FW_LIGH T
FW_NOR M AL
FW_REGUL AR
FW_M EDIUM
FW_SEMIBOL D
FW_DEMIBOL D
FW_BOL D
FW_EXT RABOL D
FW_ULT RABOL D
FW_HEAVY
FW_BL ACK
See also
R esources, R esourceCreate(), R esourceS ave(), TextOut()
TextOut
The function displays a text in a custom array (buffer) and returns the result of that operation. The
array is designed to create the graphical resource.
bool TextOut(
const string text, // displayed text
int x, // X coordinate
int y, // Y coordinate
uint anchor, // anchor type
uint &data[], // output buffer
uint width, // buffer width in pixels
uint height, // buffer height in pixels
uint color, // text color
ENUM_COLOR_FORMAT color_format // color format for output
);
Parameters
text
[in] Displayed text that will be written to the buffer. Only one-lined text is displayed.
x
[in] X coordinate of the anchor point of the displayed text.
y
[in] Y coordinate of the anchor point of the displayed text.
anchor
[in] The value out of the 9 pre-defined methods of the displayed text's anchor point location. The
value is set by a combination of two flags – flags of horizontal and vertical text align. Flag names
are listed in the Note below.
data[]
[in] Buffer, in which text is displayed. The buffer is used to create the graphical resource.
width
[in] Buffer width in pixels.
height
[in] Buffer height in pixels.
color
[in] Text color.
color_format
[in] Color format is set by ENUM _COLOR_FORM AT enumeration value.
Return Value
Anchor point specified by anchor is a combination of two flags of horizontal and vertical text align.
H orizontal text align flags :
· TA_LEFT – anchor point on the left side of the bounding box
· TA_CENTER – horizontal anchor point is located at the center of the bounding box
· TA_RIGHT – anchor point on the right side of the bounding box
Vertical text align flags :
· TA_TOP – anchor point at the upper side of the bounding box
· TA_VCENTER – vertical anchor point is located at the center of the bounding box
· TA_BOTTOM – anchor point at the lower side of the bounding box
Possible combinations of flags and specified anchor points are shown in the image.
Example:
int x,y; // variables for calculation of the current coordinates of text string anch
//--- rotate clock hands in an infinite loop, till the script is stopped
while(!IsStopped())
{
//--- clear the clock drawing buffer array
ArrayFill(ExtImg,0,IMG_WIDTH*IMG_HEIGHT,0);
//--- set the font for drawing digits for the clock-face
TextSetFont("Arial",-200,FW_EXTRABOLD,0);
//--- draw the clock-face
for(int i=1;i<=12;i++)
{
//--- receive the size of the current hour on the clock-face
TextGetSize(string(i),w,h);
//--- calculate the coordinates of the current hour on the clock-face
a=-((i*300)%3600*M_PI)/1800.0;
x=IMG_WIDTH/2-int(sin(a)*80+0.5+w/2);
y=IMG_HEIGHT/2-int(cos(a)*80+0.5+h/2);
//--- output the hour on the clock-face to ExtImg[] buffer
TextOut(string(i),x,y,TA_LEFT|TA_TOP,ExtImg,IMG_WIDTH,IMG_HEIGHT,0xFFFFFFFF,clr_format);
}
//--- now, specify the font for drawing the minute hand
TextSetFont("Arial",-200,FW_EXTRABOLD,-int(nm%3600));
//--- receive the size of the minute hand
TextGetSize("----->",w,h);
//--- calculate the coordinates of the minute hand on the clock-face
a=-(nm%3600*M_PI)/1800.0;
x=IMG_WIDTH/2-int(sin(a)*h/2+0.5);
y=IMG_HEIGHT/2-int(cos(a)*h/2+0.5);
//--- output of the minute hand to the clock-face in ExtImg[]buffer
TextOut("----->",x,y,TA_LEFT|TA_TOP,ExtImg,IMG_WIDTH,IMG_HEIGHT,0xFFFFFFFF,clr_format);
//--- now, set the font for drawing the minute hand
TextSetFont("Arial",-200,FW_EXTRABOLD,-int(nh/12%3600));
TextGetSize("==>",w,h);
//--- calculate the coordinates of the hour hand on the clock-face
a=-(nh/12%3600*M_PI)/1800.0;
x=IMG_WIDTH/2-int(sin(a)*h/2+0.5);
y=IMG_HEIGHT/2-int(cos(a)*h/2+0.5);
//--- output of the hour hand on the clock-face to ExtImg[] buffer
TextOut("==>",x,y,TA_LEFT|TA_TOP,ExtImg,IMG_WIDTH,IMG_HEIGHT,0xFFFFFFFF,clr_format);
See also
R esources, R esourceCreate(), R esourceS ave(), TextGetS ize(), TextS etFont()
TextGetSize
The function returns the line width and height at the current font settings.
bool TextGetSize(
const string text, // text string
uint& width, // buffer width in pixels
uint& height // buffer height in pixels
);
Parameters
text
[in] S tring, for which length and width should be obtained.
width
[out] Input parameter for receiving width.
height
[out] Input parameter for receiving height.
Return Value
See also
R esources, R esourceCreate(), R esourceS ave(), TextS etFont(), TextOut()
iDeMarker DeMark er
iEnvelopes Envelopes
iFractals Fractals
iVolumes Volumes
iAC
The function creates Accelerator Oscillator in a global cache of the client terminal and returns its
handle. It has only one buffer.
int iAC(
string symbol, // symbol name
ENUM_TIMEFRAMES period // period
);
Parameters
symbol
[in]The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.
period
[in] The value of the period can be one of the ENUM _TIM EFRAM ES enumeration values, 0 means
the current timeframe.
Return Value
R eturns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.
The computer memory can be freed from an indicator that is no more utilized, using the
IndicatorRelease() function, to which the indicator handle is passed.
Example:
//+------------------------------------------------------------------+
//| Demo_iAC.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property description "The indicator demonstrates how to obtain data"
#property description "of indicator buffers for the iAC technical indicator."
#property description "A symbol and timeframe used for calculation of the indicator,"
#property description "are set by the symbol and period parameters."
#property description "The method of creation of the handle is set through the 'type' parameter (fu
#property indicator_separate_window
#property indicator_buffers 2
#property indicator_plots 1
//--- plotting of iAC
#property indicator_label1 "iAC"
#property indicator_type1 DRAW_COLOR_HISTOGRAM
#property indicator_color1 clrGreen, clrRed
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
//+------------------------------------------------------------------+
//| Enumeration of the methods of handle creation |
//+------------------------------------------------------------------+
enum Creation
{
Call_iAC, // use iAC
Call_IndicatorCreate // use IndicatorCreate
};
//--- input parameters
input Creation type=Call_iAC; // type of the function
input string symbol=" "; // symbol
input ENUM_TIMEFRAMES period=PERIOD_CURRENT; // timeframe
//--- indicator buffers
double iACBuffer[];
double iACColors[];
//--- variable for storing the handle of the iAC indicator
int handle;
//--- variable for storing
string name=symbol;
//--- name of the indicator on a chart
string short_name;
//--- we will keep the number of values in the Accelerator Oscillator indicator
int bars_calculated=0;
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- assignment of arrays to indicator buffers
SetIndexBuffer(0,iACBuffer,INDICATOR_DATA);
SetIndexBuffer(1,iACColors,INDICATOR_COLOR_INDEX);
//--- determine the symbol the indicator is drawn for
name=symbol;
//--- delete spaces to the right and to the left
StringTrimRight(name);
StringTrimLeft(name);
//--- if it results in zero length of the 'name' string
if(StringLen(name)==0)
{
//--- take the symbol of the chart the indicator is attached to
name=_Symbol;
}
//--- create handle of the indicator
if(type==Call_iAC)
handle=iAC(name,period);
else
handle=IndicatorCreate(name,period,IND_AC);
//--- if the handle is not created
if(handle==INVALID_HANDLE)
{
//--- tell about the failure and output the error code
PrintFormat("Failed to create handle of the iAC indicator for the symbol %s/%s, error code %d
name,
EnumToString(period),
GetLastError());
//--- the indicator is stopped early
return(INIT_FAILED);
}
//--- show the symbol/timeframe the Accelerator Oscillator indicator is calculated for
short_name=StringFormat("iAC(%s/%s)",name,EnumToString(period));
IndicatorSetString(INDICATOR_SHORTNAME,short_name);
//--- normal initialization of the indicator
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
//--- number of values copied from the iAC indicator
int values_to_copy;
//--- determine the number of values calculated in the indicator
int calculated=BarsCalculated(handle);
if(calculated<=0)
{
PrintFormat("BarsCalculated() returned %d, error code %d",calculated,GetLastError());
return(0);
}
//--- if it is the first start of calculation of the indicator or if the number of values in the iA
//---or if it is necessary to calculated the indicator for two or more bars (it means something has
if(prev_calculated==0 || calculated!=bars_calculated || rates_total>prev_calculated+1)
{
//--- if the iACBuffer array is greater than the number of values in the iAC indicator for sy
//--- otherwise, we copy less than the size of indicator buffers
if(calculated>rates_total) values_to_copy=rates_total;
else values_to_copy=calculated;
}
else
{
//--- it means that it's not the first time of the indicator calculation, and since the last
//--- for calculation not more than one bar is added
values_to_copy=(rates_total-prev_calculated)+1;
}
//--- fill the iACBuffer and iACColors arrays with values from the Accelerator Oscillator indicator
//--- if FillArraysFromBuffer returns false, it means the information is nor ready yet, quit operat
if(!FillArraysFromBuffer(iACBuffer,iACColors,handle,values_to_copy)) return(0);
//--- form the message
string comm=StringFormat("%s ==> Updated value in the indicator %s: %d",
TimeToString(TimeCurrent(),TIME_DATE|TIME_SECONDS),
short_name,
values_to_copy);
//--- display the service message on the chart
Comment(comm);
//--- memorize the number of values in the Accelerator Oscillator indicator
bars_calculated=calculated;
//--- return the prev_calculated value for the next call
return(rates_total);
}
//+------------------------------------------------------------------+
//| Filling indicator buffers from the iAC indicator |
//+------------------------------------------------------------------+
bool FillArraysFromBuffer(double &values[], // indicator buffer of Accelerator Oscillator va
double &color_indexes[], // color buffer (for storing of color indexes)
int ind_handle, // handle of the iAC indicator
int amount // number of copied values
)
{
//--- reset error code
ResetLastError();
//--- fill a part of the iACBuffer array with values from the indicator buffer that has 0 index
if(CopyBuffer(ind_handle,0,0,amount,values)<0)
{
//--- if the copying fails, tell the error code
PrintFormat("Failed to copy data from the iAC indicator, error code %d",GetLastError());
//--- quit with zero result - it means that the indicator is considered as not calculated
return(false);
}
//--- now copy the indexes of colors
if(CopyBuffer(ind_handle,1,0,amount,color_indexes)<0)
{
//--- if the copying fails, tell the error code
PrintFormat("Failed to copy color values from the iAC indicator, error code %d",GetLastError(
//--- quit with zero result - it means that the indicator is considered as not calculated
return(false);
}
//--- everything is fine
return(true);
}
//+------------------------------------------------------------------+
//| Indicator deinitialization function |
//+------------------------------------------------------------------+
void OnDeinit(const int reason)
{
if(handle!=INVALID_HANDLE)
IndicatorRelease(handle);
//--- clear the chart after deleting the indicator
Comment("");
}
iAD
The function returns the handle of the Accumulation/Distribution indicator. It has only one buffer.
int iAD(
string symbol, // symbol name
ENUM_TIMEFRAMES period, // period
ENUM_APPLIED_VOLUME applied_volume // volume type for calculation
);
Parameters
symbol
[in]The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.
period
[in] The value of the period can be one of the ENUM _TIM EFRAM ES enumeration values, 0 means
the current timeframe.
applied_volume
[in] The volume used. Can be any of ENUM _APPLIED_VOLUM E values.
Return Value
R eturns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.
The computer memory can be freed from an indicator that is no more utilized, using the
IndicatorRelease() function, to which the indicator handle is passed.
Example:
//+------------------------------------------------------------------+
//| Demo_iAD.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property description "The indicator demonstrates how to obtain data"
#property description "of indicator buffers for the iAD technical indicator."
#property description "A symbol and timeframe used for calculation of the indicator,"
#property description "are set by the symbol and period parameters."
#property description "The method of creation of the handle is set through the 'type' parameter (fu
#property indicator_separate_window
#property indicator_buffers 1
#property indicator_plots 1
//--- plot iAD
#property indicator_label1 "iAD"
#property indicator_type1 DRAW_LINE
#property indicator_color1 clrLightSeaGreen
MqlParam pars[1];
pars[0].type=TYPE_INT;
pars[0].integer_value=volumes;
handle=IndicatorCreate(name,period,IND_AD,1,pars);
}
//--- if the handle is not created
if(handle==INVALID_HANDLE)
{
//--- tell about the failure and output the error code
PrintFormat("Failed to create handle of the iAD indicator for the symbol %s/%s, error code %d
name,
EnumToString(period),
GetLastError());
//--- the indicator is stopped early
return(INIT_FAILED);
}
//--- show the symbol/timeframe the Accumulation/Distribution indicator is calculated for
short_name=StringFormat("iAD(%s/%s)",name,EnumToString(period));
IndicatorSetString(INDICATOR_SHORTNAME,short_name);
//--- normal initialization of the indicator
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
//--- number of values copied from the iAD indicator
int values_to_copy;
//--- determine the number of values calculated in the indicator
int calculated=BarsCalculated(handle);
if(calculated<=0)
{
PrintFormat("BarsCalculated() returned %d, error code %d",calculated,GetLastError());
return(0);
}
//--- if it is the first start of calculation of the indicator or if the number of values in the iA
//---or if it is necessary to calculated the indicator for two or more bars (it means something has
if(prev_calculated==0 || calculated!=bars_calculated || rates_total>prev_calculated+1)
{
//--- if the iADBuffer array is greater than the number of values in the iAD indicator for sy
//--- otherwise, we copy less than the size of indicator buffers
if(calculated>rates_total) values_to_copy=rates_total;
else values_to_copy=calculated;
}
else
{
//--- it means that it's not the first time of the indicator calculation, and since the last
//--- for calculation not more than one bar is added
values_to_copy=(rates_total-prev_calculated)+1;
}
//--- fill the iADBuffer array with values of the Accumulation/Distribution indicator
//--- if FillArraysFromBuffer returns false, it means the information is nor ready yet, quit operat
if(!FillArrayFromBuffer(iADBuffer,handle,values_to_copy)) return(0);
//--- form the message
string comm=StringFormat("%s ==> Updated value in the indicator %s: %d",
TimeToString(TimeCurrent(),TIME_DATE|TIME_SECONDS),
short_name,
values_to_copy);
//--- display the service message on the chart
Comment(comm);
//--- memorize the number of values in the Accumulation/Distribution indicator
bars_calculated=calculated;
//--- return the prev_calculated value for the next call
return(rates_total);
}
//+------------------------------------------------------------------+
//| Filling indicator buffers from the iAD indicator |
//+------------------------------------------------------------------+
bool FillArrayFromBuffer(double &values[], // indicator buffer of the Accumulation/Distribution l
int ind_handle, // handle of the iAD indicator
int amount // number of copied values
)
{
//--- reset error code
ResetLastError();
//--- fill a part of the iADBuffer array with values from the indicator buffer that has 0 index
if(CopyBuffer(ind_handle,0,0,amount,values)<0)
{
//--- if the copying fails, tell the error code
PrintFormat("Failed to copy data from the iAD indicator, error code %d",GetLastError());
//--- quit with zero result - it means that the indicator is considered as not calculated
return(false);
}
//--- everything is fine
return(true);
}
//+------------------------------------------------------------------+
//| Indicator deinitialization function |
//+------------------------------------------------------------------+
void OnDeinit(const int reason)
{
if(handle!=INVALID_HANDLE)
IndicatorRelease(handle);
//--- clear the chart after deleting the indicator
Comment("");
}
iADX
The function returns the handle of the Average Directional Movement Index indicator.
int iADX(
string symbol, // symbol name
ENUM_TIMEFRAMES period, // period
int adx_period // averaging period
);
Parameters
symbol
[in]The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.
period
[in]The value of the period can be one of the ENUM _TIM EFRAM ES values, 0 means the current
timeframe.
adx_period
[in] Period to calculate the index.
Return Value
R eturns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.
The computer memory can be freed from an indicator that is no more utilized, using the
IndicatorRelease() function, to which the indicator handle is passed.
Note
//+------------------------------------------------------------------+
//| Demo_iADX.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property description "The indicator demonstrates how to obtain data"
#property description "of indicator buffers for the iADX technical indicator."
#property description "A symbol and timeframe used for calculation of the indicator,"
#property description "are set by the symbol and period parameters."
#property description "The method of creation of the handle is set through the 'type' parameter (fu
#property indicator_separate_window
#property indicator_buffers 3
#property indicator_plots 3
SetIndexBuffer(0,ADXBuffer,INDICATOR_DATA);
SetIndexBuffer(1,DI_plusBuffer,INDICATOR_DATA);
SetIndexBuffer(2,DI_minusBuffer,INDICATOR_DATA);
//--- determine the symbol the indicator is drawn for
name=symbol;
//--- delete spaces to the right and to the left
StringTrimRight(name);
StringTrimLeft(name);
//--- if it results in zero length of the 'name' string
if(StringLen(name)==0)
{
//--- take the symbol of the chart the indicator is attached to
name=_Symbol;
}
//--- create handle of the indicator
if(type==Call_iADX)
handle=iADX(name,period,adx_period);
else
{
//--- fill the structure with parameters of the indicator
MqlParam pars[1];
pars[0].type=TYPE_INT;
pars[0].integer_value=adx_period;
handle=IndicatorCreate(name,period,IND_ADX,1,pars);
}
//--- if the handle is not created
if(handle==INVALID_HANDLE)
{
//--- tell about the failure and output the error code
PrintFormat("Failed to create handle of the iADX indicator for the symbol %s/%s, error code %
name,
EnumToString(period),
GetLastError());
//--- the indicator is stopped early
return(INIT_FAILED);
}
//--- show the symbol/timeframe the Average Directional Movement Index indicator is calculated for
short_name=StringFormat("iADX(%s/%s period=%d)",name,EnumToString(period),adx_period);
IndicatorSetString(INDICATOR_SHORTNAME,short_name);
//--- normal initialization of the indicator
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
//--- fill a part of the DI_plusBuffer array with values from the indicator buffer that has index 1
if(CopyBuffer(ind_handle,1,0,amount,DIplus_values)<0)
{
//--- if the copying fails, tell the error code
PrintFormat("Failed to copy data from the iADX indicator, error code %d",GetLastError());
//--- quit with zero result - it means that the indicator is considered as not calculated
return(false);
}
//--- fill a part of the DI_minusBuffer array with values from the indicator buffer that has index
if(CopyBuffer(ind_handle,2,0,amount,DIminus_values)<0)
{
//--- if the copying fails, tell the error code
PrintFormat("Failed to copy data from the iADX indicator, error code %d",GetLastError());
//--- quit with zero result - it means that the indicator is considered as not calculated
return(false);
}
//--- everything is fine
return(true);
}
//+------------------------------------------------------------------+
//| Indicator deinitialization function |
//+------------------------------------------------------------------+
void OnDeinit(const int reason)
{
if(handle!=INVALID_HANDLE)
IndicatorRelease(handle);
//--- clear the chart after deleting the indicator
Comment("");
}
iADXWilder
The function returns the handle of Average Directional Movement Index by W elles W ilder.
int iADXWilder(
string symbol, // symbol name
ENUM_TIMEFRAMES period, // period
int adx_period // averaging period
);
Parameters
symbol
[in]The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.
period
[in]The value of the period can be one of the ENUM _TIM EFRAM ES values, 0 means the current
timeframe.
adx_period
[in] Period to calculate the index.
Return Value
R eturns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.
The computer memory can be freed from an indicator that is no more utilized, using the
IndicatorRelease() function, to which the indicator handle is passed.
Note
//+------------------------------------------------------------------+
//| iADXWilder.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property description "The indicator demonstrates how to obtain data"
#property description "of indicator buffers for the iADXWilder technical indicator."
#property description "A symbol and timeframe used for calculation of the indicator,"
#property description "are set by the symbol and period parameters."
#property description "The method of creation of the handle is set through the 'type' parameter (fu
#property indicator_separate_window
#property indicator_buffers 3
#property indicator_plots 3
SetIndexBuffer(0,ADXBuffer,INDICATOR_DATA);
SetIndexBuffer(1,DI_plusBuffer,INDICATOR_DATA);
SetIndexBuffer(2,DI_minusBuffer,INDICATOR_DATA);
//--- determine the symbol the indicator is drawn for
name=symbol;
//--- delete spaces to the right and to the left
StringTrimRight(name);
StringTrimLeft(name);
//--- if it results in zero length of the 'name' string
if(StringLen(name)==0)
{
//--- take the symbol of the chart the indicator is attached to
name=_Symbol;
}
//--- create handle of the indicator
if(type==Call_iADXWilder)
handle=iADXWilder(name,period,adx_period);
else
{
//--- fill the structure with parameters of the indicator
MqlParam pars[1];
pars[0].type=TYPE_INT;
pars[0].integer_value=adx_period;
handle=IndicatorCreate(name,period,IND_ADXW,1,pars);
}
//--- if the handle is not created
if(handle==INVALID_HANDLE)
{
//--- tell about the failure and output the error code
PrintFormat("Failed to create handle of the iADXWilder indicator for the symbol %s/%s, error
name,
EnumToString(period),
GetLastError());
//--- the indicator is stopped early
return(INIT_FAILED);
}
//--- show the symbol/timeframe the Average Directional Movement Index by Welles Wilder indicator i
short_name=StringFormat("iADXWilder(%s/%s period=%d)",name,EnumToString(period),adx_period);
IndicatorSetString(INDICATOR_SHORTNAME,short_name);
//--- normal initialization of the indicator
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
//--- fill a part of the DI_plusBuffer array with values from the indicator buffer that has index 1
if(CopyBuffer(ind_handle,1,0,amount,DIplus_values)<0)
{
//--- if the copying fails, tell the error code
PrintFormat("Failed to copy data from the iADXWilder indicator, error code %d",GetLastError()
//--- quit with zero result - it means that the indicator is considered as not calculated
return(false);
}
//--- fill a part of the DI_plusBuffer array with values from the indicator buffer that has index 2
if(CopyBuffer(ind_handle,2,0,amount,DIminus_values)<0)
{
//--- if the copying fails, tell the error code
PrintFormat("Failed to copy data from the iADXWilder indicator, error code %d",GetLastError()
//--- quit with zero result - it means that the indicator is considered as not calculated
return(false);
}
//--- everything is fine
return(true);
}
//+------------------------------------------------------------------+
//| Indicator deinitialization function |
//+------------------------------------------------------------------+
void OnDeinit(const int reason)
{
if(handle!=INVALID_HANDLE)
IndicatorRelease(handle);
//--- clear the chart after deleting the indicator
Comment("");
}
iAlligator
The function returns the handle of the Alligator indicator.
int iAlligator(
string symbol, // symbol name
ENUM_TIMEFRAMES period, // period
int jaw_period, // period for the calculation of jaws
int jaw_shift, // horizontal shift of jaws
int teeth_period, // period for the calculation of teeth
int teeth_shift, // horizontal shift of teeth
int lips_period, // period for the calculation of lips
int lips_shift, // horizontal shift of lips
ENUM_MA_METHOD ma_method, // type of smoothing
ENUM_APPLIED_PRICE applied_price // type of price or handle
);
Parameters
symbol
[in]The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.
period
[in]The value of the period can be one of the ENUM _TIM EFRAM ES values, 0 means the current
timeframe.
jaw_period
[in] Averaging period for the blue line (Alligator's Jaw)
jaw_shift
[in] The shift of the blue line relative to the price chart.
teeth_period
[in] Averaging period for the red line (Alligator's Teeth).
teeth_shift
[in] The shift of the red line relative to the price chart.
lips_period
[in] Averaging period for the green line (Alligator's lips).
lips_shift
[in] The shift of the green line relative to the price chart.
ma_method
[in] The method of averaging. Can be any of the ENUM _M A_M ETHOD values.
applied_price
[in] The price used. Can be any of the price constants ENUM _APPLIED_PR ICE or a handle of
another indicator.
Return Value
R eturns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.
The computer memory can be freed from an indicator that is no more utilized, using the
IndicatorRelease() function, to which the indicator handle is passed.
Note
The buffer numbers are the following: 0 - GATORJAW_LINE, 1 - GATOR T EET H_LINE, 2 -
GATOR LIPS_LINE.
Example:
//+------------------------------------------------------------------+
//| Demo_iAlligator.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property description "The indicator demonstrates how to obtain data"
#property description "of indicator buffers for the iAlligator technical indicator."
#property description "A symbol and timeframe used for calculation of the indicator,"
#property description "are set by the symbol and period parameters."
#property description "The method of creation of the handle is set through the 'type' parameter (fu
#property description "All the other parameters are similar to the standard Alligator."
#property indicator_chart_window
#property indicator_buffers 3
#property indicator_plots 3
//--- plot Jaws
#property indicator_label1 "Jaws"
#property indicator_type1 DRAW_LINE
#property indicator_color1 clrBlue
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
//--- plot Teeth
#property indicator_label2 "Teeth"
#property indicator_type2 DRAW_LINE
#property indicator_color2 clrRed
#property indicator_style2 STYLE_SOLID
#property indicator_width2 1
//--- plot Lips
#property indicator_label3 "Lips"
#property indicator_type3 DRAW_LINE
#property indicator_color3 clrLime
#property indicator_style3 STYLE_SOLID
#property indicator_width3 1
//+------------------------------------------------------------------+
jaw_period,jaw_shift,teeth_period,teeth_shift,lips_period,lips_shift);
IndicatorSetString(INDICATOR_SHORTNAME,short_name);
//--- normal initialization of the indicator
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
//--- number of values copied from the iAlligator indicator
int values_to_copy;
//--- determine the number of values calculated in the indicator
int calculated=BarsCalculated(handle);
if(calculated<=0)
{
PrintFormat("BarsCalculated() returned %d, error code %d",calculated,GetLastError());
return(0);
}
//--- if it is the first start of calculation of the indicator or if the number of values in the iA
//---or if it is necessary to calculated the indicator for two or more bars (it means something has
if(prev_calculated==0 || calculated!=bars_calculated || rates_total>prev_calculated+1)
{
//--- if the JawsBuffer array is greater than the number of values in the iAlligator indicato
//--- otherwise, we copy less than the size of indicator buffers
if(calculated>rates_total) values_to_copy=rates_total;
else values_to_copy=calculated;
}
else
{
//--- it means that it's not the first time of the indicator calculation, and since the last
//--- for calculation not more than one bar is added
values_to_copy=(rates_total-prev_calculated)+1;
}
//--- fill the arrays with values of the Alligator indicator
//--- if FillArraysFromBuffer returns false, it means the information is nor ready yet, quit operat
if(!FillArraysFromBuffers(JawsBuffer,jaw_shift,TeethBuffer,teeth_shift,LipsBuffer,lips_shift,han
//--- form the message
string comm=StringFormat("%s ==> Updated value in the indicator %s: %d",
TimeToString(TimeCurrent(),TIME_DATE|TIME_SECONDS),
short_name,
values_to_copy);
//--- display the service message on the chart
Comment(comm);
//--- memorize the number of values in the Alligator indicator
bars_calculated=calculated;
//--- return the prev_calculated value for the next call
return(rates_total);
}
//+------------------------------------------------------------------+
//| Filling indicator buffers from the iAlligator indicator |
//+------------------------------------------------------------------+
bool FillArraysFromBuffers(double &jaws_buffer[], // indicator buffer for the Jaw line
int j_shift, // shift of the Jaw line
double &teeth_buffer[], // indicator buffer for the Teeth line
int t_shift, // shift of the Teeth line
double &lips_buffer[], // indicator buffer for the Lips line
int l_shift, // shift of the Lips line
int ind_handle, // handle of the iAlligator indicator
int amount // number of copied values
)
{
//--- reset error code
ResetLastError();
//--- fill a part of the JawsBuffer array with values from the indicator buffer that has 0 index
if(CopyBuffer(ind_handle,0,-j_shift,amount,jaws_buffer)<0)
{
//--- if the copying fails, tell the error code
PrintFormat("Failed to copy data from the iAlligator indicator, error code %d",GetLastError()
//--- quit with zero result - it means that the indicator is considered as not calculated
return(false);
}
//--- fill a part of the TeethBuffer array with values from the indicator buffer that has index 1
if(CopyBuffer(ind_handle,1,-t_shift,amount,teeth_buffer)<0)
{
//--- if the copying fails, tell the error code
PrintFormat("Failed to copy data from the iAlligator indicator, error code %d",GetLastError()
//--- quit with zero result - it means that the indicator is considered as not calculated
return(false);
}
//--- fill a part of the LipsBuffer array with values from the indicator buffer that has index 2
if(CopyBuffer(ind_handle,2,-l_shift,amount,lips_buffer)<0)
{
//--- if the copying fails, tell the error code
PrintFormat("Failed to copy data from the iAlligator indicator, error code %d",GetLastError()
//--- quit with zero result - it means that the indicator is considered as not calculated
return(false);
}
//--- everything is fine
return(true);
}
//+------------------------------------------------------------------+
//| Indicator deinitialization function |
//+------------------------------------------------------------------+
void OnDeinit(const int reason)
{
if(handle!=INVALID_HANDLE)
IndicatorRelease(handle);
//--- clear the chart after deleting the indicator
Comment("");
}
iAMA
The function returns the handle of the Adaptive Moving Average indicator. It has only one buffer.
int iAMA(
string symbol, // symbol name
ENUM_TIMEFRAMES period, // period
int ama_period, // average period for AMA
int fast_ma_period, // fast MA period
int slow_ma_period, // slow MA period
int ama_shift, // horizontal shift of the indicator
ENUM_APPLIED_PRICE applied_price // type of the price or handle
);
Parameters
symbol
[in]The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.
period
[in]The value of the period can be one of the ENUM _TIM EFRAM ES values, 0 means the current
timeframe.
ama_period
[in] The calculation period, on which the efficiency coefficient is calculated.
fast_ma_period
[in] Fast period for the smoothing coefficient calculation for a rapid market.
slow_ma_period
[in] S low period for the smoothing coefficient calculation in the absence of trend.
ama_shift
[in] S hift of the indicator relative to the price chart.
applied_price
[in] The price used. Can be any of the price constants ENUM _APPLIED_PR ICE or a handle of
another indicator.
Return Value
R eturns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.
The computer memory can be freed from an indicator that is no more utilized, using the
IndicatorRelease() function, to which the indicator handle is passed.
Example:
//+------------------------------------------------------------------+
//| Demo_iAMA.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property indicator_chart_window
#property indicator_buffers 1
#property indicator_plots 1
//--- plot iAMA
#property indicator_label1 "iAMA"
#property indicator_type1 DRAW_LINE
#property indicator_color1 clrRed
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
//+------------------------------------------------------------------+
//| Enumeration of the methods of handle creation |
//+------------------------------------------------------------------+
enum Creation
{
Call_iAMA, // use iAMA
Call_IndicatorCreate // use IndicatorCreate
};
//--- input parameters
input Creation type=Call_iAMA; // type of the function
input string symbol=" "; // symbol
input ENUM_TIMEFRAMES period=PERIOD_CURRENT; // timeframe
input int ama_period=15; // period of calculation
input int fast_ma_period=2; // period of fast MA
input int slow_ma_period=30; // period of slow MA
input int ama_shift=0; // horizontal shift
input ENUM_APPLIED_PRICE applied_price; // type of price
//--- indicator buffer
double iAMABuffer[];
//--- variable for storing the handle of the iAMA indicator
int handle;
//--- variable for storing
string name=symbol;
//--- name of the indicator on a chart
string short_name;
//--- we will keep the number of values in the Adaptive Moving Average indicator
int bars_calculated=0;
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- indicator buffers mapping
SetIndexBuffer(0,iAMABuffer,INDICATOR_DATA);
//--- set shift
PlotIndexSetInteger(0,PLOT_SHIFT,ama_shift);
//--- determine the symbol the indicator is drawn for
name=symbol;
//--- delete spaces to the right and to the left
StringTrimRight(name);
StringTrimLeft(name);
//--- if it results in zero length of the 'name' string
if(StringLen(name)==0)
{
//--- take the symbol of the chart the indicator is attached to
name=_Symbol;
}
//--- create handle of the indicator
if(type==Call_iAMA)
handle=iAMA(name,period,ama_period,fast_ma_period,slow_ma_period,ama_shift,applied_price);
else
{
//--- fill the structure with parameters of the indicator
MqlParam pars[5];
pars[0].type=TYPE_INT;
pars[0].integer_value=ama_period;
pars[1].type=TYPE_INT;
pars[1].integer_value=fast_ma_period;
pars[2].type=TYPE_INT;
pars[2].integer_value=slow_ma_period;
pars[3].type=TYPE_INT;
pars[3].integer_value=ama_shift;
//--- type of price
pars[4].type=TYPE_INT;
pars[4].integer_value=applied_price;
handle=IndicatorCreate(name,period,IND_AMA,5,pars);
}
//--- if the handle is not created
if(handle==INVALID_HANDLE)
{
//--- tell about the failure and output the error code
PrintFormat("Failed to create handle of the iAMA indicator for the symbol %s/%s, error code %
name,
EnumToString(period),
GetLastError());
//--- the indicator is stopped early
return(INIT_FAILED);
}
//--- show the symbol/timeframe the Adaptive Moving Average indicator is calculated for
short_name=StringFormat("iAMA(%s/%s,%d,%d,%d,d)",name,EnumToString(period),ama_period,fast_ma_pe
IndicatorSetString(INDICATOR_SHORTNAME,short_name);
//--- normal initialization of the indicator
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
//--- number of values copied from the iAMA indicator
int values_to_copy;
//--- determine the number of values calculated in the indicator
int calculated=BarsCalculated(handle);
if(calculated<=0)
{
PrintFormat("BarsCalculated() returned %d, error code %d",calculated,GetLastError());
return(0);
}
//--- if it is the first start of calculation of the indicator or if the number of values in the iA
//---or if it is necessary to calculated the indicator for two or more bars (it means something has
if(prev_calculated==0 || calculated!=bars_calculated || rates_total>prev_calculated+1)
{
//--- if the iAMABuffer array is greater than the number of values in the iAMA indicator for
//--- otherwise, we copy less than the size of indicator buffers
if(calculated>rates_total) values_to_copy=rates_total;
else values_to_copy=calculated;
}
else
{
//--- it means that it's not the first time of the indicator calculation, and since the last
//--- for calculation not more than one bar is added
values_to_copy=(rates_total-prev_calculated)+1;
}
//--- fill the arrays with values of the Adaptive Moving Average indicator
//--- if FillArraysFromBuffer returns false, it means the information is nor ready yet, quit operat
if(!FillArrayFromBuffer(iAMABuffer,ama_shift,handle,values_to_copy)) return(0);
//--- form the message
string comm=StringFormat("%s ==> Updated value in the indicator %s: %d",
TimeToString(TimeCurrent(),TIME_DATE|TIME_SECONDS),
short_name,
values_to_copy);
//--- display the service message on the chart
Comment(comm);
//--- memorize the number of values in the Adaptive Moving Average indicator
bars_calculated=calculated;
//--- return the prev_calculated value for the next call
return(rates_total);
}
//+------------------------------------------------------------------+
//| Filling indicator buffer from the iAMA indicator |
//+------------------------------------------------------------------+
bool FillArrayFromBuffer(double &ama_buffer[], // indicator buffer of the AMA line
int a_shift, // shift of the AMA line
int ind_handle, // handle of the iAMA indicator
int amount // number of copied values
)
{
//--- reset error code
ResetLastError();
//--- fill a part of the iAMABuffer array with values from the indicator buffer that has 0 index
if(CopyBuffer(ind_handle,0,-a_shift,amount,ama_buffer)<0)
{
//--- if the copying fails, tell the error code
PrintFormat("Failed to copy data from the iAMA indicator, error code %d",GetLastError());
//--- quit with zero result - it means that the indicator is considered as not calculated
return(false);
}
//--- everything is fine
return(true);
}
//+------------------------------------------------------------------+
//| Indicator deinitialization function |
//+------------------------------------------------------------------+
void OnDeinit(const int reason)
{
if(handle!=INVALID_HANDLE)
IndicatorRelease(handle);
//--- clear the chart after deleting the indicator
Comment("");
}
iAO
The function returns the handle of the Awesome Oscillator indicator. It has only one buffer.
int iAO(
string symbol, // symbol name
ENUM_TIMEFRAMES period // period
);
Parameters
symbol
[in]The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.
period
[in]The value of the period can be one of the ENUM _TIM EFRAM ES values, 0 means the current
timeframe.
Return Value
R eturns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.
The computer memory can be freed from an indicator that is no more utilized, using the
IndicatorRelease() function, to which the indicator handle is passed.
Example:
//+------------------------------------------------------------------+
//| Demo_iAO.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property description "The indicator demonstrates how to obtain data"
#property description "of indicator buffers for the iAO technical indicator."
#property description "A symbol and timeframe used for calculation of the indicator,"
#property description "are set by the symbol and period parameters."
#property description "The method of creation of the handle is set through the 'type' parameter (fu
#property indicator_separate_window
#property indicator_buffers 2
#property indicator_plots 1
//--- the iAO plot
#property indicator_label1 "iAO"
#property indicator_type1 DRAW_COLOR_HISTOGRAM
#property indicator_color1 clrGreen,clrRed
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
//+------------------------------------------------------------------+
//--- tell about the failure and output the error code
PrintFormat("Failed to create handle of the iAO indicator for the symbol %s/%s, error code %d
name,
EnumToString(period),
GetLastError());
//--- the indicator is stopped early
return(INIT_FAILED);
}
//--- show the symbol/timeframe the Awesome Oscillator indicator is calculated for
short_name=StringFormat("iAO(%s/%s)",name,EnumToString(period));
IndicatorSetString(INDICATOR_SHORTNAME,short_name);
//--- normal initialization of the indicator
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
//--- number of values copied from the iAO indicator
int values_to_copy;
//--- determine the number of values calculated in the indicator
int calculated=BarsCalculated(handle);
if(calculated<=0)
{
PrintFormat("BarsCalculated() returned %d, error code %d",calculated,GetLastError());
return(0);
}
//--- if it is the first start of calculation of the indicator or if the number of values in the iA
//---or if it is necessary to calculated the indicator for two or more bars (it means something has
if(prev_calculated==0 || calculated!=bars_calculated || rates_total>prev_calculated+1)
{
//--- if the iAOBuffer array is greater than the number of values in the iAO indicator for sy
//--- otherwise, we copy less than the size of indicator buffers
if(calculated>rates_total) values_to_copy=rates_total;
else values_to_copy=calculated;
}
else
{
//--- it means that it's not the first time of the indicator calculation, and since the last
iATR
The function returns the handle of the Average True Range indicator. It has only one buffer.
int iATR(
string symbol, // symbol name
ENUM_TIMEFRAMES period, // period
int ma_period // averaging period
);
Parameters
symbol
[in]The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.
period
[in]The value of the period can be one of the ENUM _TIM EFRAM ES values, 0 means the current
timeframe.
ma_period
[in] The value of the averaging period for the indicator calculation.
Return Value
R eturns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.
The computer memory can be freed from an indicator that is no more utilized, using the
IndicatorRelease() function, to which the indicator handle is passed.
Example:
//+------------------------------------------------------------------+
//| Demo_iATR.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property description "The indicator demonstrates how to obtain data"
#property description "of indicator buffers for the iATR technical indicator."
#property description "A symbol and timeframe used for calculation of the indicator,"
#property description "are set by the symbol and period parameters."
#property description "The method of creation of the handle is set through the 'type' parameter (fu
#property indicator_separate_window
#property indicator_buffers 1
#property indicator_plots 1
//--- plot iATR
#property indicator_label1 "iATR"
#property indicator_type1 DRAW_LINE
#property indicator_color1 clrLightSeaGreen
MqlParam pars[1];
pars[0].type=TYPE_INT;
pars[0].integer_value=atr_period;
handle=IndicatorCreate(name,period,IND_ATR,1,pars);
}
//--- if the handle is not created
if(handle==INVALID_HANDLE)
{
//--- tell about the failure and output the error code
PrintFormat("Failed to create handle of the iATR indicator for the symbol %s/%s, error code %
name,
EnumToString(period),
GetLastError());
//--- the indicator is stopped early
return(INIT_FAILED);
}
//--- show the symbol/timeframe the Average True Range indicator is calculated for
short_name=StringFormat("iATR(%s/%s, period=%d)",name,EnumToString(period),atr_period);
IndicatorSetString(INDICATOR_SHORTNAME,short_name);
//--- normal initialization of the indicator
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
//--- number of values copied from the iATR indicator
int values_to_copy;
//--- determine the number of values calculated in the indicator
int calculated=BarsCalculated(handle);
if(calculated<=0)
{
PrintFormat("BarsCalculated() returned %d, error code %d",calculated,GetLastError());
return(0);
}
//--- if it is the first start of calculation of the indicator or if the number of values in the iA
//---or if it is necessary to calculated the indicator for two or more bars (it means something has
if(prev_calculated==0 || calculated!=bars_calculated || rates_total>prev_calculated+1)
{
//--- if the iATRBuffer array is greater than the number of values in the iATR indicator for
//--- otherwise, we copy less than the size of indicator buffers
if(calculated>rates_total) values_to_copy=rates_total;
else values_to_copy=calculated;
}
else
{
//--- it means that it's not the first time of the indicator calculation, and since the last
//--- for calculation not more than one bar is added
values_to_copy=(rates_total-prev_calculated)+1;
}
//--- fill the iATRBuffer array with values of the Average True Range indicator
//--- if FillArrayFromBuffer returns false, it means the information is nor ready yet, quit operati
if(!FillArrayFromBuffer(iATRBuffer,handle,values_to_copy)) return(0);
//--- form the message
string comm=StringFormat("%s ==> Updated value in the indicator %s: %d",
TimeToString(TimeCurrent(),TIME_DATE|TIME_SECONDS),
short_name,
values_to_copy);
//--- display the service message on the chart
Comment(comm);
//--- memorize the number of values in the Average True Range indicator
bars_calculated=calculated;
//--- return the prev_calculated value for the next call
return(rates_total);
}
//+------------------------------------------------------------------+
//| Filling indicator buffers from the iATR indicator |
//+------------------------------------------------------------------+
bool FillArrayFromBuffer(double &values[], // indicator buffer for ATR values
int ind_handle, // handle of the iATR indicator
int amount // number of copied values
)
{
//--- reset error code
ResetLastError();
//--- fill a part of the iATRBuffer array with values from the indicator buffer that has 0 index
if(CopyBuffer(ind_handle,0,0,amount,values)<0)
{
//--- if the copying fails, tell the error code
PrintFormat("Failed to copy data from the iATR indicator, error code %d",GetLastError());
//--- quit with zero result - it means that the indicator is considered as not calculated
return(false);
}
//--- everything is fine
return(true);
}
//+------------------------------------------------------------------+
//| Indicator deinitialization function |
//+------------------------------------------------------------------+
void OnDeinit(const int reason)
{
if(handle!=INVALID_HANDLE)
IndicatorRelease(handle);
//--- clear the chart after deleting the indicator
Comment("");
}
iBearsPower
The function returns the handle of the Bears Power indicator. It has only one buffer.
int iBearsPower(
string symbol, // symbol name
ENUM_TIMEFRAMES period, // period
int ma_period, // averaging period
);
Parameters
symbol
[in]The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.
period
[in]The value of the period can be one of the ENUM _TIM EFRAM ES values, 0 means the current
timeframe.
ma_period
[in] The value of the averaging period for the indicator calculation.
Return Value
R eturns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.
The computer memory can be freed from an indicator that is no more utilized, using the
IndicatorRelease() function, to which the indicator handle is passed.
Example:
//+------------------------------------------------------------------+
//| Demo_iBearsPower.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property description "The indicator demonstrates how to obtain data"
#property description "of indicator buffers for the iBearsPower technical indicator."
#property description "A symbol and timeframe used for calculation of the indicator,"
#property description "are set by the symbol and period parameters."
#property description "The method of creation of the handle is set through the 'type' parameter (fu
#property indicator_separate_window
#property indicator_buffers 1
#property indicator_plots 1
//--- the iBearsPower plot
#property indicator_label1 "iBearsPower"
#property indicator_type1 DRAW_HISTOGRAM
#property indicator_color1 clrSilver
MqlParam pars[1];
//--- period of ma
pars[0].type=TYPE_INT;
pars[0].integer_value=ma_period;
handle=IndicatorCreate(name,period,IND_BEARS,1,pars);
}
//--- if the handle is not created
if(handle==INVALID_HANDLE)
{
//--- tell about the failure and output the error code
PrintFormat("Failed to create handle of the iBearsPower indicator for the symbol %s/%s, error
name,
EnumToString(period),
GetLastError());
//--- the indicator is stopped early
return(INIT_FAILED);
}
//--- show the symbol/timeframe the Bears Power indicator is calculated for
short_name=StringFormat("iBearsPower(%s/%s, period=%d)",name,EnumToString(period),ma_period);
IndicatorSetString(INDICATOR_SHORTNAME,short_name);
//--- normal initialization of the indicator
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
//--- number of values copied from the iBearsPower indicator
int values_to_copy;
//--- determine the number of values calculated in the indicator
int calculated=BarsCalculated(handle);
if(calculated<=0)
{
PrintFormat("BarsCalculated() returned %d, error code %d",calculated,GetLastError());
return(0);
}
//--- if it is the first start of calculation of the indicator or if the number of values in the iB
//---or if it is necessary to calculated the indicator for two or more bars (it means something has
if(prev_calculated==0 || calculated!=bars_calculated || rates_total>prev_calculated+1)
{
//--- if the iBearsPowerBuffer array is greater than the number of values in the iBearsPower
//--- otherwise, we copy less than the size of indicator buffers
if(calculated>rates_total) values_to_copy=rates_total;
else values_to_copy=calculated;
}
else
{
//--- it means that it's not the first time of the indicator calculation, and since the last
//--- for calculation not more than one bar is added
values_to_copy=(rates_total-prev_calculated)+1;
}
//--- fill the iBearsPowerBuffer array with values of the Bears Power indicator
//--- if FillArrayFromBuffer returns false, it means the information is nor ready yet, quit operati
if(!FillArrayFromBuffer(iBearsPowerBuffer,handle,values_to_copy)) return(0);
//--- form the message
string comm=StringFormat("%s ==> Updated value in the indicator %s: %d",
TimeToString(TimeCurrent(),TIME_DATE|TIME_SECONDS),
short_name,
values_to_copy);
//--- display the service message on the chart
Comment(comm);
//--- memorize the number of values in the Bears Power indicator
bars_calculated=calculated;
//--- return the prev_calculated value for the next call
return(rates_total);
}
//+------------------------------------------------------------------+
//| Filling indicator buffers from the iBearsPower indicator |
//+------------------------------------------------------------------+
bool FillArrayFromBuffer(double &values[], // indicator buffer for Bears Power values
int ind_handle, // handle of the iBearsPower indicator
int amount // number of copied values
)
{
//--- reset error code
ResetLastError();
//--- fill a part of the iBearsPowerBuffer array with values from the indicator buffer that has 0 i
if(CopyBuffer(ind_handle,0,0,amount,values)<0)
{
//--- if the copying fails, tell the error code
PrintFormat("Failed to copy data from the iBearsPower indicator, error code %d",GetLastError(
//--- quit with zero result - it means that the indicator is considered as not calculated
return(false);
}
//--- everything is fine
return(true);
}
//+------------------------------------------------------------------+
iBands
The function returns the handle of the Bollinger Bands ® indicator.
int iBands(
string symbol, // symbol name
ENUM_TIMEFRAMES period, // period
int bands_period, // period for average line calculation
int bands_shift, // horizontal shift of the indicator
double deviation, // number of standard deviations
ENUM_APPLIED_PRICE applied_price // type of price or handle
);
Parameters
symbol
[in]The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.
period
[in]The value of the period can be one of the ENUM _TIM EFRAM ES values, 0 means the current
timeframe.
bands_period
[in] The averaging period of the main line of the indicator.
bands_shift
[in] The shift the indicator relative to the price chart.
deviation
[in] Deviation from the main line.
applied_price
[in] The price used. Can be any of the price constants ENUM _APPLIED_PR ICE or a handle of
another indicator.
Return Value
R eturns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.
The computer memory can be freed from an indicator that is no more utilized, using the
IndicatorRelease() function, to which the indicator handle is passed.
Note
//+------------------------------------------------------------------+
//| Demo_iBands.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property indicator_chart_window
#property indicator_buffers 3
#property indicator_plots 3
//--- the Upper plot
#property indicator_label1 "Upper"
#property indicator_type1 DRAW_LINE
#property indicator_color1 clrMediumSeaGreen
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
//--- the Lower plot
#property indicator_label2 "Lower"
#property indicator_type2 DRAW_LINE
#property indicator_color2 clrMediumSeaGreen
#property indicator_style2 STYLE_SOLID
#property indicator_width2 1
//--- the Middle plot
#property indicator_label3 "Middle"
#property indicator_type3 DRAW_LINE
#property indicator_color3 clrMediumSeaGreen
#property indicator_style3 STYLE_SOLID
#property indicator_width3 1
//+------------------------------------------------------------------+
//| Enumeration of the methods of handle creation |
//+------------------------------------------------------------------+
enum Creation
{
Call_iBands, // use iBands
Call_IndicatorCreate // use IndicatorCreate
};
//--- input parameters
input Creation type=Call_iBands; // type of the function
input int bands_period=20; // period of moving average
input int bands_shift=0; // shift
input double deviation=2.0; // number of standard deviations
input ENUM_APPLIED_PRICE applied_price=PRICE_CLOSE; // type of price
input string symbol=" "; // symbol
input ENUM_TIMEFRAMES period=PERIOD_CURRENT; // timeframe
//--- indicator buffers
double UpperBuffer[];
double LowerBuffer[];
double MiddleBuffer[];
//--- variable for storing the handle of the iBands indicator
int handle;
//--- variable for storing
string name=symbol;
//--- name of the indicator on a chart
string short_name;
//--- we will keep the number of values in the Bollinger Bands indicator
int bars_calculated=0;
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- assignment of arrays to indicator buffers
SetIndexBuffer(0,UpperBuffer,INDICATOR_DATA);
SetIndexBuffer(1,LowerBuffer,INDICATOR_DATA);
SetIndexBuffer(2,MiddleBuffer,INDICATOR_DATA);
//--- set shift of each line
PlotIndexSetInteger(0,PLOT_SHIFT,bands_shift);
PlotIndexSetInteger(1,PLOT_SHIFT,bands_shift);
PlotIndexSetInteger(2,PLOT_SHIFT,bands_shift);
//--- determine the symbol the indicator is drawn for
name=symbol;
//--- delete spaces to the right and to the left
StringTrimRight(name);
StringTrimLeft(name);
//--- if it results in zero length of the 'name' string
if(StringLen(name)==0)
{
//--- take the symbol of the chart the indicator is attached to
name=_Symbol;
}
//--- create handle of the indicator
if(type==Call_iBands)
handle=iBands(name,period,bands_period,bands_shift,deviation,applied_price);
else
{
//--- fill the structure with parameters of the indicator
MqlParam pars[4];
//--- period of ma
pars[0].type=TYPE_INT;
pars[0].integer_value=bands_period;
//--- shift
pars[1].type=TYPE_INT;
pars[1].integer_value=bands_shift;
//--- number of standard deviation
pars[2].type=TYPE_DOUBLE;
pars[2].double_value=deviation;
{
//--- if the size of indicator buffers is greater than the number of values in the iBands ind
//--- otherwise, we copy less than the size of indicator buffers
if(calculated>rates_total) values_to_copy=rates_total;
else values_to_copy=calculated;
}
else
{
//--- it means that it's not the first time of the indicator calculation, and since the last
//--- for calculation not more than one bar is added
values_to_copy=(rates_total-prev_calculated)+1;
}
//--- fill the array with values of the Bollinger Bands indicator
//--- if FillArraysFromBuffer returns false, it means the information is nor ready yet, quit operat
if(!FillArraysFromBuffers(MiddleBuffer,UpperBuffer,LowerBuffer,bands_shift,handle,values_to_copy
//--- form the message
string comm=StringFormat("%s ==> Updated value in the indicator %s: %d",
TimeToString(TimeCurrent(),TIME_DATE|TIME_SECONDS),
short_name,
values_to_copy);
//--- display the service message on the chart
Comment(comm);
//--- memorize the number of values in the Bollinger Bands indicator
bars_calculated=calculated;
//--- return the prev_calculated value for the next call
return(rates_total);
}
//+------------------------------------------------------------------+
//| Filling indicator buffers from the iBands indicator |
//+------------------------------------------------------------------+
bool FillArraysFromBuffers(double &base_values[], // indicator buffer of the middle line of Bol
double &upper_values[], // indicator buffer of the upper border
double &lower_values[], // indicator buffer of the lower border
int shift, // shift
int ind_handle, // handle of the iBands indicator
int amount // number of copied values
)
{
//--- reset error code
ResetLastError();
//--- fill a part of the MiddleBuffer array with values from the indicator buffer that has 0 index
if(CopyBuffer(ind_handle,0,-shift,amount,base_values)<0)
{
//--- if the copying fails, tell the error code
PrintFormat("Failed to copy data from the iBands indicator, error code %d",GetLastError());
//--- quit with zero result - it means that the indicator is considered as not calculated
return(false);
}
//--- fill a part of the UpperBuffer array with values from the indicator buffer that has index 1
if(CopyBuffer(ind_handle,1,-shift,amount,upper_values)<0)
{
//--- if the copying fails, tell the error code
PrintFormat("Failed to copy data from the iBands indicator, error code %d",GetLastError());
//--- quit with zero result - it means that the indicator is considered as not calculated
return(false);
}
//--- fill a part of the LowerBuffer array with values from the indicator buffer that has index 2
if(CopyBuffer(ind_handle,2,-shift,amount,lower_values)<0)
{
//--- if the copying fails, tell the error code
PrintFormat("Failed to copy data from the iBands indicator, error code %d",GetLastError());
//--- quit with zero result - it means that the indicator is considered as not calculated
return(false);
}
//--- everything is fine
return(true);
}
//+------------------------------------------------------------------+
//| Indicator deinitialization function |
//+------------------------------------------------------------------+
void OnDeinit(const int reason)
{
if(handle!=INVALID_HANDLE)
IndicatorRelease(handle);
//--- clear the chart after deleting the indicator
Comment("");
}
iBullsPower
The function returns the handle of the Bulls Power indicator. It has only one buffer.
int iBullsPower(
string symbol, // symbol name
ENUM_TIMEFRAMES period, // period
int ma_period, // averaging period
);
Parameters
symbol
[in]The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.
period
[in]The value of the period can be one of the ENUM _TIM EFRAM ES values, 0 means the current
timeframe.
ma_period
[in] The averaging period for the indicator calculation.
Return Value
R eturns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.
The computer memory can be freed from an indicator that is no more utilized, using the
IndicatorRelease() function, to which the indicator handle is passed.
Example:
//+------------------------------------------------------------------+
//| Demo_iBullsPower.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property description "The indicator demonstrates how to obtain data"
#property description "of indicator buffers for the iBullsPower technical indicator."
#property description "A symbol and timeframe used for calculation of the indicator,"
#property description "are set by the symbol and period parameters."
#property description "The method of creation of the handle is set through the 'type' parameter (fu
#property indicator_separate_window
#property indicator_buffers 1
#property indicator_plots 1
//--- the iBullsPower plot
#property indicator_label1 "iBullsPower"
#property indicator_type1 DRAW_HISTOGRAM
#property indicator_color1 clrSilver
MqlParam pars[1];
//--- period of ma
pars[0].type=TYPE_INT;
pars[0].integer_value=ma_period;
handle=IndicatorCreate(name,period,IND_BULLS,1,pars);
}
//--- if the handle is not created
if(handle==INVALID_HANDLE)
{
//--- tell about the failure and output the error code
PrintFormat("Failed to create handle of the iBullsPower indicator for the symbol %s/%s, error
name,
EnumToString(period),
GetLastError());
//--- the indicator is stopped early
return(INIT_FAILED);
}
//--- show the symbol/timeframe the Bulls Power indicator is calculated for
short_name=StringFormat("iBullsPower(%s/%s, period=%d)",name,EnumToString(period),ma_period);
IndicatorSetString(INDICATOR_SHORTNAME,short_name);
//--- normal initialization of the indicator
return(INIT_SUCCEEDED);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
//--- number of values copied from the iBullsPower indicator
int values_to_copy;
//--- determine the number of values calculated in the indicator
int calculated=BarsCalculated(handle);
if(calculated<=0)
{
PrintFormat("BarsCalculated() returned %d, error code %d",calculated,GetLastError());
return(0);
}
//--- if it is the first start of calculation of the indicator or if the number of values in the iB
//---or if it is necessary to calculated the indicator for two or more bars (it means something has
if(prev_calculated==0 || calculated!=bars_calculated || rates_total>prev_calculated+1)
{
//--- if the iBullsPowerBuffer array is greater than the number of values in the iBullsPower
//--- otherwise, we copy less than the size of indicator buffers
if(calculated>rates_total) values_to_copy=rates_total;
else values_to_copy=calculated;
}
else
{
//--- it means that it's not the first time of the indicator calculation, and since the last
//--- for calculation not more than one bar is added
values_to_copy=(rates_total-prev_calculated)+1;
}
//--- fill the iBullsPowerBuffer array with values of the Bulls Power indicator
//--- if FillArrayFromBuffer returns false, it means the information is nor ready yet, quit operati
if(!FillArrayFromBuffer(iBullsPowerBuffer,handle,values_to_copy)) return(0);
//--- form the message
string comm=StringFormat("%s ==> Updated value in the indicator %s: %d",
TimeToString(TimeCurrent(),TIME_DATE|TIME_SECONDS),
short_name,
values_to_copy);
//--- display the service message on the chart
Comment(comm);
//--- memorize the number of values in the Bulls Power indicator
bars_calculated=calculated;
//--- return the prev_calculated value for the next call
return(rates_total);
}
//+------------------------------------------------------------------+
//| Filling indicator buffers from the iBullsPower indicator |
//+------------------------------------------------------------------+
bool FillArrayFromBuffer(double &values[], // indicator buffer of Bulls Power values
int ind_handle, // handle of the iBullsPower indicator
int amount // number of copied values
)
{
//--- reset error code
ResetLastError();
//--- fill a part of the iBullsPowerBuffer array with values from the indicator buffer that has 0 i
if(CopyBuffer(ind_handle,0,0,amount,values)<0)
{
//--- if the copying fails, tell the error code
PrintFormat("Failed to copy data from the iBullsPower indicator, error code %d",GetLastError(
//--- quit with zero result - it means that the indicator is considered as not calculated
return(false);
}
//--- everything is fine
return(true);
}
//+------------------------------------------------------------------+
iCCI
The function returns the handle of the Commodity Channel Index indicator. It has only one buffer.
int iCCI(
string symbol, // symbol name
ENUM_TIMEFRAMES period, // period
int ma_period, // averaging period
ENUM_APPLIED_PRICE applied_price // type of price or handle
);
Parameters
symbol
[in]The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.
period
[in]The value of the period can be one of the ENUM _TIM EFRAM ES values, 0 means the current
timeframe.
ma_period
[in] The averaging period for the indicator calculation.
applied_price
[in] The price used. Can be any of the price constants ENUM _APPLIED_PR ICE or a handle of
another indicator.
Return Value
R eturns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.
The computer memory can be freed from an indicator that is no more utilized, using the
IndicatorRelease() function, to which the indicator handle is passed.
Example:
//+------------------------------------------------------------------+
//| Demo_iCCI.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property description "The indicator demonstrates how to obtain data"
#property description "of indicator buffers for the iCCI technical indicator."
#property description "A symbol and timeframe used for calculation of the indicator,"
#property description "are set by the symbol and period parameters."
#property description "The method of creation of the handle is set through the 'type' parameter (fu
#property indicator_separate_window
#property indicator_buffers 1
#property indicator_plots 1
//--- the iCCI plot
#property indicator_label1 "iCCI"
#property indicator_type1 DRAW_LINE
#property indicator_color1 clrLightSeaGreen
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
//--- horizontal levels in the indicator window
#property indicator_level1 -100.0
#property indicator_level2 100.0
//+------------------------------------------------------------------+
//| Enumeration of the methods of handle creation |
//+------------------------------------------------------------------+
enum Creation
{
Call_iCCI, // use iCCI
Call_IndicatorCreate // use IndicatorCreate
};
//--- input parameters
input Creation type=Call_iCCI; // type of the function
input int ma_period=14; // period of moving average
input ENUM_APPLIED_PRICE applied_price=PRICE_TYPICAL; // type of price
input string symbol=" "; // symbol
input ENUM_TIMEFRAMES period=PERIOD_CURRENT; // timeframe
//--- indicator buffer
double iCCIBuffer[];
//--- variable for storing the handle of the iCCI indicator
int handle;
//--- variable for storing
string name=symbol;
//--- name of the indicator on a chart
string short_name;
//--- we will keep the number of values in the Commodity Channel Index indicator
int bars_calculated=0;
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- assignment of array to indicator buffer
SetIndexBuffer(0,iCCIBuffer,INDICATOR_DATA);
//--- determine the symbol the indicator is drawn for
name=symbol;
//--- delete spaces to the right and to the left
StringTrimRight(name);
StringTrimLeft(name);
//--- if it results in zero length of the 'name' string
if(StringLen(name)==0)
{
{
//--- number of values copied from the iCCI indicator
int values_to_copy;
//--- determine the number of values calculated in the indicator
int calculated=BarsCalculated(handle);
if(calculated<=0)
{
PrintFormat("BarsCalculated() returned %d, error code %d",calculated,GetLastError());
return(0);
}
//--- if it is the first start of calculation of the indicator or if the number of values in the iC
//---or if it is necessary to calculated the indicator for two or more bars (it means something has
if(prev_calculated==0 || calculated!=bars_calculated || rates_total>prev_calculated+1)
{
//--- if the iCCIBuffer array is greater than the number of values in the iCCI indicator for
//--- otherwise, we copy less than the size of indicator buffers
if(calculated>rates_total) values_to_copy=rates_total;
else values_to_copy=calculated;
}
else
{
//--- it means that it's not the first time of the indicator calculation, and since the last
//--- for calculation not more than one bar is added
values_to_copy=(rates_total-prev_calculated)+1;
}
//--- fill the iCCIBuffer array with values of the Commodity Channel Index indicator
//--- if FillArrayFromBuffer returns false, it means the information is nor ready yet, quit operati
if(!FillArrayFromBuffer(iCCIBuffer,handle,values_to_copy)) return(0);
//--- form the message
string comm=StringFormat("%s ==> Updated value in the indicator %s: %d",
TimeToString(TimeCurrent(),TIME_DATE|TIME_SECONDS),
short_name,
values_to_copy);
//--- display the service message on the chart
Comment(comm);
//--- memorize the number of values in the Commodity Channel Index indicator
bars_calculated=calculated;
//--- return the prev_calculated value for the next call
return(rates_total);
}
//+------------------------------------------------------------------+
//| Filling indicator buffers from the iCCI indicator |
//+------------------------------------------------------------------+
bool FillArrayFromBuffer(double &values[], // indicator buffer of Commodity Channel Index values
int ind_handle, // handle of the iCCI indicator
int amount // number of copied values
)
{
//--- reset error code
ResetLastError();
//--- fill a part of the iCCIBuffer array with values from the indicator buffer that has 0 index
if(CopyBuffer(ind_handle,0,0,amount,values)<0)
{
//--- if the copying fails, tell the error code
PrintFormat("Failed to copy data from the iCCI indicator, error code %d",GetLastError());
//--- quit with zero result - it means that the indicator is considered as not calculated
return(false);
}
//--- everything is fine
return(true);
}
//+------------------------------------------------------------------+
//| Indicator deinitialization function |
//+------------------------------------------------------------------+
void OnDeinit(const int reason)
{
if(handle!=INVALID_HANDLE)
IndicatorRelease(handle);
//--- clear the chart after deleting the indicator
Comment("");
}
iChaikin
The function returns the handle of the Chaikin Oscillator indicator. It has only one buffer.
int iChaikin(
string symbol, // symbol name
ENUM_TIMEFRAMES period, // period
int fast_ma_period, // fast period
int slow_ma_period, // slow period
ENUM_MA_METHOD ma_method, // smoothing type
ENUM_APPLIED_VOLUME applied_volume // type of volume
);
Parameters
symbol
[in]The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.
period
[in]The value of the period can be one of the ENUM _TIM EFRAM ES values, 0 means the current
timeframe.
fast_ma_period
[in] Fast averaging period for calculations.
slow_ma_period
[in] S low averaging period for calculations.
ma_method
[in] S moothing type. Can be one of the averaging constants of ENUM _M A_M ETHOD.
applied_volume
[in] The volume used. Can be one of the constants of ENUM _APPLIED_VOLUM E.
Return Value
R eturns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.
The computer memory can be freed from an indicator that is no more utilized, using the
IndicatorRelease() function, to which the indicator handle is passed.
Example:
//+------------------------------------------------------------------+
//| Demo_iChaikin.mq5 |
//| Copyright 2011, MetaQuotes Software Corp. |
//| https://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "Copyright 2000-2024, MetaQuotes Ltd."
#property link "https://www.mql5.com"
#property version "1.00"
#property description "The indicator demonstrates how to obtain data"
#property description "of indicator buffers for the iChaikin technical indicator."
#property description "A symbol a