TicFieldDefinition.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/Configuration/TicBase.hpp"
#include "Arp/Plc/Meta/Commons/Io/ChildTypeDefinition.hpp"
#include "Arp/Plc/Meta/Commons/DataType.hpp"
#include "Arp/Plc/Meta/Commons/BitSize.hpp"
 
namespace Arp::Io::Commons::Configuration
{
 
class ARP_EXPORT TicFieldDefinition : public TicBase
{
public: // Impl forward declaration
    class Impl;
 
public: // usings
    using Ptr = std::shared_ptr<TicFieldDefinition>;
    using DataType = Arp::Plc::Meta::Commons::DataType;
    using BitSize = Arp::Plc::Meta::Commons::BitSize;
    using ChildTypeDefinition = Arp::Plc::Meta::Commons::Io::ChildTypeDefinition;
 
public: // construction
    TicFieldDefinition(void);
 
    // canonical construction/destruction/assignment
    TicFieldDefinition(const TicFieldDefinition& arg) = delete;
    TicFieldDefinition(TicFieldDefinition&& arg)noexcept;
    TicFieldDefinition& operator=(const TicFieldDefinition& arg) = delete;
    TicFieldDefinition& operator=(TicFieldDefinition&& arg)noexcept;
    ~TicFieldDefinition(void)override;
 
public: // operators
 
public: // static operations
    static const char* GetTicElementName(void);
 
public: // setter/getter operations
    const String& GetFieldName()const;
    DataType GetDataType()const;
    const String& GetTypeName()const;
    uint32 GetArrayElementCount()const;
    BitSize GetOffset()const;
 
public: // operations
    ChildTypeDefinition CreateChildTypeDefinition()const;
 
    bool TryReadAttribute(TicReader& reader, const String& attributeName)final;
    bool TryCreateElement(const String& elementName, ChildPtr& result)final;
    void OnReadEnd(void)override;
 
public: // internal 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::Configuration