PortDefinition.hpp

 
//
//  Copyright Phoenix Contact GmbH & Co. KG
//
#pragma once
#include "Arp/Base/Core/Arp.hpp"
#include "Arp/Base/Core/PimplPtr.hxx"
#include "Arp/Plc/Meta/Commons/BitSize.hpp"
#include "Arp/Plc/Meta/Commons/CustomAttribute.hpp"
#include "Arp/Plc/Meta/Commons/DataType.hpp"
#include "Arp/Plc/Meta/Commons/StandardAttribute.hpp"
#include "Arp/Plc/Meta/Commons/ArrayDimension.hpp"
#include <vector>
 
namespace Arp::Plc::Meta::Commons::Io
{
 
class ARP_EXPORT PortDefinition
{
public: // Impl forward declaration
    class Impl;
 
public: // usings
    using ArrayDimensions = std::vector<ArrayDimension>;
    using CustomAttributes = std::vector<CustomAttribute>;
    using Children = std::vector<PortDefinition>;
 
public: // construction/destruction/assignment
    PortDefinition(
        const String& name, DataType dataType, const ArrayDimensions& arrayDimensions,
        StandardAttribute standardAttribute, const CustomAttributes& customAttributes,
        const String& bufferName, const BitSize& offset);
    PortDefinition(
        const String& name, DataType dataType, const String& typeName, const BitSize& size,
        const ArrayDimensions& arrayDimensions, StandardAttribute standardAttribute,
        const CustomAttributes& customAttributes, const String& bufferName, const BitSize& offset);
    PortDefinition(const String& name, const CustomAttributes& customAttributesArg, const Children& childrenArg);
 
    PortDefinition(const PortDefinition& arg);
    PortDefinition(PortDefinition&& arg)noexcept;
    PortDefinition& operator=(const PortDefinition& arg);
    PortDefinition& operator=(PortDefinition&& arg)noexcept;
    ~PortDefinition(void);
 
public: // setter/getter operations
    String GetName() const;
    DataType GetDataType() const;
    String GetTypeName() const;
    BitSize GetSize() const;
    ArrayDimensions GetArrayDimensions() const;
    StandardAttribute GetStandardAttribute() const;
    CustomAttributes GetCustomAttributes() const;
    String GetBufferName() const;
    BitSize GetOffset() const;
    const Children& GetChildren() const;
 
public: // operations
    void AddAttribute(const CustomAttribute& customAttribute);
    void AddChild(const PortDefinition& child);
 
public: // internal operations
    Impl&       GetImpl(void);
    const Impl& GetImpl(void)const;
 
private: // Impl usings
    using Pimpl = PimplPtr<Impl, true>;
 
private: // Impl fields
    Pimpl   pimpl;
};
 
} // end of namespace Arp::Plc::Meta::Commons::Io