Connection.h

/******************************************************************************
 * Copyright (c) ATTX LLC 2024. All Rights Reserved.
 *
 * This software and associated documentation (the "Software") are the
 * proprietary and confidential information of ATTX, LLC. 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, LLC.
 ******************************************************************************/
#ifndef CPP_APP_CONNECTION_H
#define CPP_APP_CONNECTION_H
 
#include <array>
#include <string>
#include <vector>
 
#include "nlohmann/json.hpp"
 
#include "data_management/DataIOBase.h"
 
namespace modelspace {
/// @brief Hold acceptable values for connection type
enum connection_type_e {
    PARAM = -1,     // One-off input value set on startup
    INPUT = -2,     // Input to be set regularly (mapped to upstream source typically)
    ALL_INPUT = -3, // Special value to indicate all inputs to a node
    OUTPUT = 1      // Output
};
 
/// @brief Hold all connection type enum values to loop through
const std::vector<std::pair<connection_type_e, std::string>> CONN_TYPES = {
    {connection_type_e::PARAM, "Param"},
    {connection_type_e::INPUT, "Input"}
// TODO(Alex) do we need a node section for the ALL_INPUT type? 
//              (If not, we probably don't need this whole map)
    // {connection_type_e::ALL_INPUT, "All input"},
// Only sorting inputs/params when drawing nodes, so leave this out
    // {connection_type_e::OUTPUT, "Output"}
};
 
/** @brief Hold all information related to a connection point in the ImGUI UX */
struct Connection {
    /// @brief The name of the connection
    std::string name;
 
    /// @brief The unique ID of the connection given by the ImGUI UX or other
    long unique_id;
 
    /// @brief The type of connection
    connection_type_e connection_type;
 
    /// @brief The data type associated with the connection
    clockwerk::dataio_types_e data_type;
 
    /// @brief The size of the connection as rows, columns
    std::array<unsigned int, 2> size;
 
    /// @brief The values held within the connection. All values are stored as string
    std::vector<std::vector<std::string>> values;
 
    /// @brief Boolean indicating whether the connection is writable (true) or not (false)
    int writable;
 
    /// @brief The connection to which this connection is paired, given by unique ID
    long paired_connection_id;
 
    /// @brief The parent to this connection, given by its unique ID number
    long parent_node_id;
 
    /// @brief Flag to indicate whether user has set this value via the GUI
    int user_set;
 
    /// @brief Create Connection object from json
    /// @param j The json object from which Connection is created
    void fromJson(const nlohmann::json &j);
 
    /// @brief Create json object from Connection
    /// @return The json object from connection data
    nlohmann::json toJson();
 
    /// @brief Output all connection information
    void dump();
};
 
} // namespace modelspace
 
#endif