DataManager.hpp

 
//
//  Copyright Phoenix Contact GmbH & Co. KG
//
#pragma once
#include "Arp/Base/Core/Arp.hpp"
#include "Arp/Base/Core/PimplPtr.hxx"
#include "Arp/Io/Commons/IoBuffer.hpp"
#include "Arp/Plc/Meta/Commons/DataType.hpp"
#include "Arp/Plc/Meta/Commons/Io/PortDefinition.hpp"
#include <vector>
 
// forwards
namespace Arp::Io::Commons::Data
{
class BufferInfo;
} // end of namespace Arp::Io::Commons::Data
 
namespace Arp::Io::Commons
{
 
class ARP_EXPORT DataManager
{
public: // Impl forward declaration
    class Impl;
 
public: // usings
    using BufferInfo = Arp::Io::Commons::Data::BufferInfo;
    using DataType = Arp::Plc::Meta::Commons::DataType;
    using ArrayDimensions = Arp::Plc::Meta::Commons::Io::PortDefinition::ArrayDimensions;
 
public: // canonical construction/destruction/assignment
    DataManager(const DataManager& arg) = delete;
    DataManager(DataManager&& arg)noexcept;
    DataManager& operator=(const DataManager& arg) = delete;
    DataManager& operator=(DataManager&& arg)noexcept;
    ~DataManager(void);
 
public: // construction
    DataManager(const String& componentName, Endianness defaultEndianness);
 
public: // setter/getter operations
    Endianness      GetDefaultEndianness(void)const;
    bool            IsPlcRunning(void)const;
 
public: // operations
    IoBuffer::Ptr   GetSystemIoBuffer(const String& bufferName);
    bool            TryGetSystemIoBuffer(const String& bufferName, IoBuffer::Ptr& result);
    IoBuffer::Ptr   GetPlcIoBuffer(const String& bufferName, bool isChanging = false);
    bool            TryGetPlcIoBuffer(const String& bufferName, IoBuffer::Ptr& result, bool isChanging = false);
    IoBuffer::Ptr   CreateSystemIoBuffer(const BufferInfo& bufferInfo);
    IoBuffer::Ptr   CreatePlcIoBuffer(const BufferInfo& bufferInfo, bool isChanging = false);
 
public: // operations for status variables
    void  RegisterStatusVariable(const String& name, DataType dataType);
    void  RegisterStatusVariable(const String& name, DataType dataType, const ArrayDimensions& dimensions);
    void  RegisterBitStatusVariable(const String& name, uint32 bitOffset);
    byte* GetStatusVariableAddress(const String& name)const;
 
public: // Impl operations
    Impl&       GetImpl(void);
    const Impl& GetImpl(void)const;
 
private: // Impl usings
    using Pimpl = PimplPtr<Impl>;
 
private: // Impl fields
    Pimpl   pimpl;
};
 
} // end of namespace Arp::Io::Commons::Io