ConfigurationWriter.h

Go to the documentation of this file.

/******************************************************************************
* Copyright (c) ATTX INC 2025. All Rights Reserved.
*
* This software and associated documentation (the "Software") are the 
* proprietary and confidential information of ATTX INC. The Software is 
* furnished under a license agreement between ATTX and the user organization 
* and may be used or copied only in accordance with the terms of the agreement.
* Refer to 'license/attx_license.adoc' for standard license terms.
*
* EXPORT CONTROL NOTICE: THIS SOFTWARE MAY INCLUDE CONTENT CONTROLLED UNDER THE
* INTERNATIONAL TRAFFIC IN ARMS REGULATIONS (ITAR) OR THE EXPORT ADMINISTRATION 
* REGULATIONS (EAR99). No part of the Software may be used, reproduced, or 
* transmitted in any form or by any means, for any purpose, without the express 
* written permission of ATTX INC.
******************************************************************************/ 
#ifndef CPP_APP_CONFIGURATION_WRITER_H
#define CPP_APP_CONFIGURATION_WRITER_H
 
#include <future>
 
#include "EventLogger.h"
#include "utils/AutoDoc.h"
#include "ImNode.h"
#include "Connection.h"
 
namespace warptwin {
    class ConfigurationWriter {
    public:
        ConfigurationWriter() {}
        virtual ~ConfigurationWriter() {}

        void file(const std::string &filename) {_filename = filename;}
        std::string file() {return _filename;}

        void eventLogger(EventLogger* logger_ptr) {_logger_ptr = logger_ptr;}

        void watchNode(ImNode* target);

        void unwatchNode(ImNode* target);

        virtual void write();

        virtual std::future<int> build() = 0;

        std::future<int> run() {return std::future<int>();}

        int post() {return NO_ERROR;}
    protected:
        virtual void _setNodeConnectionSequence() {}

        virtual void _decomposeNodeInformation() {}

        virtual void _writeOutputStart() {}

        virtual void _writeDataValue(ImNode* node) {}

        virtual void _writeDataConnection(Connection* upstream, Connection* downstream) {}

        virtual void _writeLogData() {}

        virtual void _writeOutputEnd() {}
 
        // Autodoc framework, which we repurpose here for writing to file
        AutoDoc* _autodoc_ptr;
 
        // EventLogger instance for error logging
        EventLogger* _logger_ptr;
 
        // Vector in which to store watched nodes
        std::vector<ImNode*> _watched_nodes;
 
        // Vector in which to store sequenced nodes
        std::vector<ImNode*> _sequenced_nodes;
 
        // Vector of sequenced connections
        std::vector<std::pair<Connection*, Connection*>> _paired_connections;
 
        // String to record our filename
        std::string _filename = "gui_config_file.py";
    };
}
 
#endif