Dateioperationen

Plattformbenutzer äußern berechtigte Bedenken hinsichtlich des Startens von cBots und Indikatoren mit AccessRights.FullAccess. Dies gilt insbesondere dann, wenn kein Quellcode verfügbar ist, da es schwierig ist, mit Sicherheit zu wissen, welche Änderungen der Algorithmus am Dateisystem vornehmen wird. Im Leitfaden zu Zugriffsrechten haben wir bereits empfohlen, dass cBots und Indikatoren, die Sie mit anderen teilen, AccessRights.None erhalten sollten.

Dieser API-Leitfaden erklärt, wie Algorithmen mit eingeschränkten AccessRights sicher Operationen mit lokalen Dateien durchführen können.

Regeln für Dateioperationen

Jeder Algorithmus mit eingeschränkten Zugriffsrechten darf Dateioperationen nur in einem bestimmten Ordner des Dateisystems des Benutzers durchführen. Jeder Algorithmustyp lokalisiert seinen eigenen Ordner wie unten gezeigt (z. B. cBots und Indikatoren), wobei für jeden Algorithmusnamen ein separater Ordner erstellt wird.

Documents
|-cAlgo
  |-Data
    |-cBots
      |-${cBot Name}
    |-Indicators
      |-${Indicator Name}

Die folgenden Regeln bestimmen, wie die Funktion für Dateioperationen in der API funktioniert:

1. Jeder Algorithmus hat nur Zugriff auf den Ordner, der seinem Namen entspricht (einschließlich Unterordner, falls vorhanden).

2. Wenn kein entsprechender Ordner vorhanden ist, wird ein solcher Ordner im Dateisystem gemäß dem obigen Schema erstellt, wenn eine Instanz zum ersten Mal gestartet wird.

3. Wenn ein neuer Ordner nicht erstellt werden kann, startet der cBot oder Indikator nicht und ein Fehler wird gemeldet.

4. Im Algorithmuscode müssen Sie nicht den vollständigen Pfad zum entsprechenden Ordner angeben. Stattdessen verwenden Algorithmen einen relativen Pfad.

5. Der Namespace System.IO bietet eine Vielzahl von Klassen (File, FileInfo, Directory. DirectoryInfo, Path usw.), für die relevante Methoden aufgerufen werden können, um Operationen mit Dateien und Ordnern auszuführen.

Nachfolgend finden Sie einige Beispiele für die Methoden, die in den Klassen File und Directory enthalten sind.

Erstellen Sie ein cBot-Beispiel

Das folgende cBot-Beispiel hat AccessRights.None, erstellt aber unmittelbar nach seiner Initialisierung eine Textdatei im entsprechenden Ordner mit dem Namen „File Access Test". Wenn eine erfolgreiche Market-Order platziert wird OnStart(), schreibt der cBot eine Positions-ID in die erstellte Datei.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using cAlgo.API;
using cAlgo.API.Collections;
using cAlgo.API.Indicators;
using cAlgo.API.Internals;
using System.IO;

namespace cAlgo.Robots
{
    [Robot(TimeZone = TimeZones.UTC, AccessRights = AccessRights.None)]
    public class MycBot : Robot
    {
        protected override void OnStart()
        {
            TradeResult result = ExecuteMarketOrder(TradeType.Buy, SymbolName, 1000);

            if (result.IsSuccessful)
            {
                string positionId = result.Position.Id.ToString();
                {
                    File.WriteAllText("My positions.txt", $"{positionId}");
                } 
            }
        }
    }
}

Dateiparameter

Der Parametertyp File ermöglicht es Algorithmen, Dateieingaben von Benutzern über die API zu akzeptieren. Er ermöglicht es Algorithmen, sicher aus einer vom Benutzer ausgewählten Datei auf dem lokalen Rechner zu lesen und in diese zu schreiben.

Wenn er in einem Algorithmus definiert ist:

• In der cTrader-Benutzeroberfläche wird der Parameter als Textfeld mit einer Schaltfläche Durchsuchen angezeigt, die einen Dateiauswahldialog öffnet.
• In cTrader CLI können Benutzer einen Dateipfad direkt als Parameterwert übergeben.
• Der Algorithmus erhält ein stark typisiertes File-Objekt mit integrierten Lese- und Schreibmethoden.

Der Parametertyp File kann verwendet werden, um Folgendes in Algorithmen zu tun:

Um einen Dateiparameter zu definieren, deklarieren Sie eine Eigenschaft vom Typ File und versehen Sie sie mit dem Attribut [Parameter].

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

using cAlgo.API;

namespace cAlgo.Robots;

[Robot(AccessRights = AccessRights.None)]
public class FileParameterTypeTest : Robot
{
    [Parameter(DefaultValue = @"C:\Data\input.txt")]
    public File DataFile { get; set; }

    protected override void OnStart()
    {
        Print($"Exists: {DataFile.Exists()}");
    }
}

Sie können die gesamte Datei als Text oder als einzelne Zeilen lesen.

1
2

var text = DataFile.ReadAllText();
var lines = DataFile.ReadLines();

Schreibvorgänge überschreiben den vorhandenen Dateiinhalt.

1

DataFile.WriteAllText("This is a test", EncodingType.Ascii);

Sie können Text oder mehrere Zeilen anhängen, ohne den vorhandenen Inhalt zu überschreiben.

1
2

DataFile.AppendAllText("This is a test", EncodingType.Utf8);
DataFile.AppendAllLines(new[] { "Line 1", "Line 2" }, EncodingType.Utf8);

Vor der Durchführung von Vorgängen können Sie überprüfen, ob die Datei existiert.

1
2
3
4

if (DataFile.Exists())
{
    Print("File is available");
}

Zusammenfassung

Die Dateioperationsfunktion in der API ermöglicht es Algorithmen mit eingeschränkten Zugriffsrechten weiterhin, mit lokalen Dateien und Ordnern zu arbeiten. Sie können Methoden aus dem Namespace System.IO von C# verwenden, um zu programmieren, wie Algorithmen solche Operationen innerhalb der Grenzen des entsprechenden Ordners durchführen. Somit bleiben andere Verzeichnisse im Dateisystem des Benutzers vollständig geschützt, selbst wenn der Quellcode des Algorithmus nicht verfügbar ist.