SWARM Identity Manager

Ultima modificación

1. Introducción

Propósito: Describir las funciones y partes principales de la clase CSwarmIM que gestiona la identidad del bot en MetaTrader 5.

2. Descripción General

Contexto: La clase CSwarmIM se utiliza para asignar y gestionar la identidad única de cada bot de trading.

3. Componentes Principales

a) Atributos del Bot:

b) Métodos y Funciones:

Constructor
- CSwarmIM(string botCls, string sym, ENUM_TIMEFRAMES tf): Inicializa la identidad del bot.
Funciones de Generación y Gestión
- GenerarBotName(string userSuffix): Genera un nombre único para el bot usando un sufijo proporcionado por el usuario.
- PeriodSecondsToString(ENUM_TIMEFRAMES tf): Convierte el marco temporal en una cadena de texto.
Inicialización
- InitializeIdentity(string botCls, string sym, ENUM_TIMEFRAMES tf): Inicializa los atributos de identidad del bot.
Funciones de Acceso
- GetMagicNumber(): Devuelve el número mágico del bot.
- GetBotName(): Devuelve el nombre del bot.
- GetSymbol(): Devuelve el símbolo financiero.
- GetTimeFrame(): Devuelve el marco temporal.
- GetChartID(): Devuelve el identificador del gráfico.
Información de Identidad
- GetIdentityCard(): Devuelve una tarjeta de identificación del bot con sus principales atributos.
Visualización
- MostrarNombreBot(): Muestra el nombre del bot en el gráfico de trading.

Resumen de Ejecución para la Clase CSwarmIM

Inicialización
- CSwarmIM Constructor: Se llama al constructor de la clase con los parámetros de clase del bot, símbolo y marco temporal. Este, a su vez, llama a InitializeIdentity para inicializar los atributos del bot.
Generación del Nombre del Bot
- GenerarBotName(): Se genera un nombre único para el bot usando la clase del bot, el símbolo financiero, el marco temporal y un sufijo proporcionado por el usuario.
Inicialización de la Identidad
- InitializeIdentity(): Se asignan valores a los atributos del bot, incluyendo el ID del gráfico, el número mágico, el nombre del bot, el símbolo financiero y el marco temporal.
Acceso a Atributos
- GetMagicNumber(): Devuelve el número mágico único para la instancia del bot.
- GetBotName(): Devuelve el nombre único del bot.
- GetSymbol(): Devuelve el símbolo financiero asociado al bot.
- GetTimeFrame(): Devuelve el marco temporal en el que opera el bot.
- GetChartID(): Devuelve el identificador del gráfico en el que opera el bot.
Generación de Tarjeta de Identidad
- GetIdentityCard(): Crea y devuelve una tarjeta de identificación con la información principal del bot (ID del gráfico, nombre del bot y número mágico).
Visualización en el Gráfico
- MostrarNombreBot(): Muestra el nombre del bot en el gráfico de trading, creando o actualizando una etiqueta en la esquina superior izquierda del gráfico.

Propósito: Proveer una guía técnica para la implementación y el mantenimiento de la clase CSwarmIM.
Alcance: Este documento cubre la estructura, funciones y la interacción de CSwarmIM con otros componentes del sistema.

Nombre: CSwarmIM
Ubicación: Parte del sistema SWARM, específicamente en SWARM\SWARM_a110\AUX\SWARM_COMMON_INPUTS.mqh.
Autor: XhakaTech
Versión: 1.02

Constructor:
- Inicializa la identidad del bot asignando valores a botClass, symbol y timeFrame.
Generación del Nombre del Bot:
- Crea un nombre único para el bot utilizando la clase del bot, el símbolo financiero y el marco temporal, combinado con un sufijo proporcionado por el usuario.
Inicialización de la Identidad:
- Asigna y configura todos los atributos principales del bot, como chartID, magicNumber, botName, etc.
Funciones de Acceso:
- Proveen métodos para obtener el número mágico, nombre del bot, símbolo financiero, marco temporal y el ID del gráfico.
Generación de Tarjeta de Identidad:
- Crea una "tarjeta de identidad" que resume los atributos principales del bot, útil para identificar y mantener el bot.
Visualización en el Gráfico:
- Muestra el nombre del bot en el gráfico de trading, creando o actualizando una etiqueta visual en el gráfico.

Inicialización:
- Llamada al constructor CSwarmIM(), que invoca a métodos internos para inicializar los atributos del bot.
Generación del Nombre:
- Uso de un método para crear un nombre único para el bot basado en varios atributos.
Acceso a Atributos:
- Métodos que permiten obtener información específica del bot como su nombre, número mágico, símbolo, marco temporal y ID del gráfico.
Visualización:
- Método para mostrar el nombre del bot en el gráfico, asegurando que se vea fácilmente durante las operaciones de trading.

Compatibilidad: Diseñado para funcionar con MetaTrader 5.
Modularidad: Fácil integración y adaptación a diferentes configuraciones y necesidades de trading automatizado.

Mantenimiento: Proceso de actualización y mantenimiento de la clase para asegurar su buen funcionamiento.
Extensión: Guía para agregar nuevas funcionalidades o modificar las existentes de manera eficiente.