peak_port_url.hpp

Go to the documentation of this file.

 
#pragma once
 
#include <peak_common_c/detail/peak_common_defines.h>
 
#include <peak/backend/peak_backend.h>
#include <peak/common/peak_common_structs.hpp>
#include <peak/dll_interface/peak_dll_interface_util.hpp>
 
#include <cstddef>
#include <cstdint>
#include <memory>
#include <string>
#include <vector>
 
 
namespace peak
{
namespace core
{

enum class PortURLScheme
{
    Local,
    HTTP,
    File,
 
    Custom = 1000
};
 
class Port;

class PortURL
{
public:
    PortURL() = delete;
    ~PortURL() = default;
    PortURL(const PortURL& other) = delete;
    PortURL& operator=(const PortURL& other) = delete;
    PortURL(PortURL&& other) = delete;
    PortURL& operator=(PortURL&& other) = delete;

    PEAK_COMMON_NO_DISCARD RawInformation Info(int32_t infoCommand) const;

    PEAK_COMMON_NO_DISCARD std::string URL() const;

    PEAK_COMMON_NO_DISCARD PortURLScheme Scheme() const;

    PEAK_COMMON_NO_DISCARD std::string FileName() const;

    PEAK_COMMON_NO_DISCARD uint64_t FileRegisterAddress() const;

    PEAK_COMMON_NO_DISCARD uint64_t FileSize() const;

    PEAK_COMMON_NO_DISCARD std::vector<uint8_t> FileSHA1Hash() const;

    PEAK_COMMON_NO_DISCARD int32_t FileVersionMajor() const;

    PEAK_COMMON_NO_DISCARD int32_t FileVersionMinor() const;

    PEAK_COMMON_NO_DISCARD int32_t FileVersionSubminor() const;

    PEAK_COMMON_NO_DISCARD int32_t FileSchemaVersionMajor() const;

    PEAK_COMMON_NO_DISCARD int32_t FileSchemaVersionMinor() const;

    PEAK_COMMON_NO_DISCARD std::shared_ptr<class Port> ParentPort() const;
 
private:
    friend ClassCreator<PortURL>;
    explicit PortURL(PEAK_PORT_URL_HANDLE portUrlHandle, const std::weak_ptr<Port>& parentPort);
    PEAK_PORT_URL_HANDLE m_backendHandle;
 
    std::weak_ptr<Port> m_parentPort;
};
 
} /* namespace core */
} /* namespace peak */
 
#include <peak/port/peak_port.hpp>
 
 
/* Implementation */
namespace peak
{
namespace core
{
 
inline PortURL::PortURL(PEAK_PORT_URL_HANDLE portUrlHandle, const std::weak_ptr<Port>& parentPort)
    : m_backendHandle(portUrlHandle)
    , m_parentPort(parentPort)
{}
 
inline RawInformation PortURL::Info(int32_t infoCommand) const
{
    return QueryRawInformationFromCInterfaceFunction([&](int32_t* dataType, uint8_t* buffer, size_t* bufferSize) {
        return PEAK_C_ABI_PREFIX PEAK_PortURL_GetInfo(m_backendHandle, infoCommand, dataType, buffer, bufferSize);
    });
}
 
inline std::string PortURL::URL() const
{
    return QueryStringFromCInterfaceFunction([&](char* url, size_t* urlSize) {
        return PEAK_C_ABI_PREFIX PEAK_PortURL_GetURL(m_backendHandle, url, urlSize);
    });
}
 
inline PortURLScheme PortURL::Scheme() const
{
    return static_cast<PortURLScheme>(
        QueryNumericFromCInterfaceFunction<PEAK_PORT_URL_SCHEME>([&](PEAK_PORT_URL_SCHEME* scheme) {
            return PEAK_C_ABI_PREFIX PEAK_PortURL_GetScheme(m_backendHandle, scheme);
        }));
}
 
inline std::string PortURL::FileName() const
{
    return QueryStringFromCInterfaceFunction([&](char* fileName, size_t* fileNameSize) {
        return PEAK_C_ABI_PREFIX PEAK_PortURL_GetFileName(m_backendHandle, fileName, fileNameSize);
    });
}
 
inline uint64_t PortURL::FileRegisterAddress() const
{
    return QueryNumericFromCInterfaceFunction<uint64_t>([&](uint64_t* fileRegisterAddress) {
        return PEAK_C_ABI_PREFIX PEAK_PortURL_GetFileRegisterAddress(m_backendHandle, fileRegisterAddress);
    });
}
 
inline uint64_t PortURL::FileSize() const
{
    return QueryNumericFromCInterfaceFunction<uint64_t>([&](uint64_t* fileSize) {
        return PEAK_C_ABI_PREFIX PEAK_PortURL_GetFileSize(m_backendHandle, fileSize);
    });
}
 
inline std::vector<uint8_t> PortURL::FileSHA1Hash() const
{
    return QueryNumericArrayFromCInterfaceFunction<uint8_t>([&](uint8_t* fileSha1Hash, size_t* fileSha1HashSize) {
        return PEAK_C_ABI_PREFIX PEAK_PortURL_GetFileSHA1Hash(m_backendHandle, fileSha1Hash, fileSha1HashSize);
    });
}
 
inline int32_t PortURL::FileVersionMajor() const
{
    return QueryNumericFromCInterfaceFunction<int32_t>([&](int32_t* fileVersionMajor) {
        return PEAK_C_ABI_PREFIX PEAK_PortURL_GetFileVersionMajor(m_backendHandle, fileVersionMajor);
    });
}
 
inline int32_t PortURL::FileVersionMinor() const
{
    return QueryNumericFromCInterfaceFunction<int32_t>([&](int32_t* fileVersionMinor) {
        return PEAK_C_ABI_PREFIX PEAK_PortURL_GetFileVersionMinor(m_backendHandle, fileVersionMinor);
    });
}
 
inline int32_t PortURL::FileVersionSubminor() const
{
    return QueryNumericFromCInterfaceFunction<int32_t>([&](int32_t* fileVersionSubminor) {
        return PEAK_C_ABI_PREFIX PEAK_PortURL_GetFileVersionSubminor(m_backendHandle, fileVersionSubminor);
    });
}
 
inline int32_t PortURL::FileSchemaVersionMajor() const
{
    return QueryNumericFromCInterfaceFunction<int32_t>([&](int32_t* fileSchemaVersionMajor) {
        return PEAK_C_ABI_PREFIX PEAK_PortURL_GetFileVersionMajor(m_backendHandle, fileSchemaVersionMajor);
    });
}
 
inline int32_t PortURL::FileSchemaVersionMinor() const
{
    return QueryNumericFromCInterfaceFunction<int32_t>([&](int32_t* fileSchemaVersionMinor) {
        return PEAK_C_ABI_PREFIX PEAK_PortURL_GetFileVersionMinor(m_backendHandle, fileSchemaVersionMinor);
    });
}
 
inline std::shared_ptr<Port> PortURL::ParentPort() const
{
    return m_parentPort.lock();
}
 
inline std::string ToString(PortURLScheme entry)
{
    std::string entryString;
 
    if (entry == PortURLScheme::Local)
    {
        entryString = "Local";
    }
    else if (entry == PortURLScheme::HTTP)
    {
        entryString = "HTTP";
    }
    else if (entry == PortURLScheme::File)
    {
        entryString = "File";
    }
    else if (entry >= PortURLScheme::Custom)
    {
        entryString = "Custom";
    }
 
    return entryString;
}
 
} /* namespace core */
} /* namespace peak */