structs.hpp

Go to the documentation of this file.

#ifndef IV_SRC_LOGIC_FILES_STRUCTS_HPP_
#define IV_SRC_LOGIC_FILES_STRUCTS_HPP_
 
#include "core/defines.hpp"
 
#include <cstdint>
#include <memory>
#include <string>
#include <string_view>
#include <vector>
 
namespace iv::logic::files
{
 
// LOM File Structs
//
 
typedef uint8_t propertyStringSize;
 
struct PropertiesLom
{
    uint16_t numProperties;
 
    static constexpr std::string_view propLomNumberTitle {"LOM Number"};
    std::string propLomNumber;
    static constexpr std::string_view propAuthorTitle {"Author"};
    std::string propAuthor;
    static constexpr std::string_view propNameTitle {"Name"};
    std::string propName;
    static constexpr std::string_view propFileTitle {"File"};
    std::string propFile;
    static constexpr std::string_view propVersionTitle {"Version"};
    std::string propVersion;
    static constexpr std::string_view propTimeTitle {"Time"};
    std::string propTime;
    static constexpr std::string_view propDateTitle {"Date"};
    std::string propDate;
    static constexpr std::string_view propDescriptionTitle {"Description"};
    std::string propDescription;
 
    bool operator==(const PropertiesLom &other) const = default;
};
 
struct BlockParamLom
{
    // Basic properties
    uint8_t size;
    uint8_t type;
    std::string description;
    std::string tag;
    uint32_t globalIdOrValue;
 
    // Ending property
    std::string sParamValue;
 
    bool operator==(const BlockParamLom &other) const = default;
};
 
struct BlockLom
{
    uint8_t size;
    uint8_t subtype;
    uint8_t type;
    uint8_t extraSize;
    uint8_t numParams;
    std::string name;
    uint16_t order;
 
    std::vector<BlockParamLom> params;
 
    bool operator==(const BlockLom &other) const = default;
};
 
struct BlocksLom
{
    uint32_t numBlocks;
 
    std::vector<BlockLom> blocks;
 
    bool operator==(const BlocksLom &other) const = default;
};
 
struct GraphicInfoLom
{
    std::string libraryName;
    uint16_t numProperties;
 
    std::vector<std::pair<std::string, std::string>> graphicToChannel;
 
    bool operator==(const GraphicInfoLom &other) const = default;
};
 
struct GraphicsInfoLom
{
    uint32_t numGraphicInfo;
    std::vector<GraphicInfoLom> graphicInfo;
 
    bool operator==(const GraphicsInfoLom &other) const = default;
};
 
struct LomFile
{
    PropertiesLom properties;
 
    BlocksLom blocks;
 
    uint32_t version;
 
    GraphicsInfoLom graphicsInfo;
 
    std::string lomType;
 
    // Blocks Ending Properties
 
    bool operator==(const LomFile &other) const = default;
};
 
// PL File Structs
//
 
struct LibraryParameterPl
{
    uint8_t size;
    uint8_t type;
 
    std::string libraryBlockTagName {};
    std::string externalTag {};
    std::string externalTag2 {};
 
    std::string tag {};
    uint32_t value {};
 
    uint16_t blockOrder {};
    uint16_t orderInBlock {};
    uint32_t orderInLogic {};
 
    bool operator==(const LibraryParameterPl &other) const = default;
};
 
struct LibraryPl
{
    std::string tagName;
 
    uint32_t numParam {0};
    std::vector<LibraryParameterPl> parameters;
 
    bool operator==(const LibraryPl &other) const = default;
};
 
struct PlFile
{
    uint32_t version {3};
    uint32_t numLibraries {0};
    uint32_t numParams {0};
 
    std::vector<LibraryPl> libraries;
 
    bool operator==(const PlFile &other) const = default;
};
 
// LIM File Structs
//
 
struct LogicInfoStationLom
{
    std::string name;
    std::string unit;
    std::string author;
    std::string file;
    std::string date;
    std::string time;
    std::string version;
    std::string description;
};
 
struct LogicParameterStationLom
{
    uint32_t type {};// Tipo del param
    uint16_t channelUnitId {};
    uint16_t channelId {};
    uint32_t globalIdOrValue {};
    std::string channelType {};
    std::string parameterDescription {};// Parameter system description
    std::string sParamValue {};         // Parameter value (user input in block) (for String6 types)
    std::string text {};                // Formatted description (general libraries info) (for .txt)
};
 
struct LogicBlockStationLom
{
    uint16_t orderOfExecution {};
    std::string name {};
    uint8_t type {};
    uint8_t subType {};
 
    std::vector<LogicParameterStationLom> parameters;
};
 
struct StationLomFile
{
    LogicInfoStationLom logicInfoLim;
 
    std::vector<LogicBlockStationLom> logicBlocksLim;
};
 
// TXT File Structs
//
 
struct LogicInfoTxt
{
    std::string unit;
    std::string description;
    std::string version;
    std::string author;
    std::string date;
    std::string time;
    std::string file;
    std::string name;
};
 
struct LogicParameterTxt
{
    std::string text {};// Formatted description (general libraries info) (for .txt)
 
    std::string libraryEditParamText {};// Text "EDIT PARAMETER" (for .txt)
    std::string libraryBlocksText {};   // Text "PARAMETRO ... con tag externo: ()" (for .txt)
};
 
struct LogicChannelInfoTxt
{
    iv::types::channelId channelId;
    iv::types::unitId idUnit;
    iv::types::channelOrder channelOrder;
    iv::types::indexChannel indexChannel;
};
 
struct LogicBlockTxt
{
    uint32_t orderOfWrittenBlock;
 
    uint16_t orderOfExecution {};
    std::string name {};
    uint8_t type {};
    uint8_t subType {};
 
    std::vector<LogicParameterTxt> parameters;
 
    bool isLibrary;
    std::vector<LogicBlockTxt> libraryBlocks;
};
 
struct LogicParameterOnlineTxt
{
    std::string libraryBlockTagName;
    std::string externalTag;
    std::string externalTag2;
 
    std::string value;
 
    uint16_t unpackedBlockOrder;
    uint16_t orderInBlock;
};
 
struct TxtFile
{
    LogicInfoTxt logicInfo;
 
    std::string lomType;
 
    std::vector<LogicChannelInfoTxt> logicChannelsInfo;
 
    std::vector<LogicBlockTxt> logicBlocks;
 
    std::vector<LogicParameterOnlineTxt> logicParametersOnline;
};
 
}// namespace iv::logic::files
 
#endif//IV_SRC_LOGIC_FILES_STRUCTS_HPP_