StructNavigator.hpp

//
//  Copyright PHOENIX CONTACT Electronics GmbH
//
#pragma once
#include "Arp/System/Core/Arp.h"
#include "Arp/System/Core/IEnumerator.hxx"
#include "Arp/Plc/Commons/Meta/DataInfo.hpp"
#include "Arp/Plc/Commons/Meta/ITypeNavigator.hpp"

//TODO(OR): move to Arp/Plc/Commons/Internal/Meta

namespace Arp { namespace Plc { namespace Commons { namespace Meta
{

class StructNavigator
{
public: // typedefs
    typedef std::shared_ptr<StructNavigator> Ptr;

public: // Nested types

    class Enumerator : public IEnumerator<const DataInfo&>
    {
    public: // construction
        Enumerator(std::vector<DataInfo>& fieldInfos, std::vector<size_t>& offsets, const byte* startAddress);

    public: // overridden operations
        bool            MoveNext(void)override;
        const DataInfo& GetCurrent(void)override;
        size_t          GetCurrentOffset()const;

    private: // fields
        std::vector<size_t>&    offsets;
        std::vector<DataInfo>&  fieldInfos;
        const byte*             startAddress;
        size_t                  index = 0;
    };

public: // construction/destruction
    StructNavigator(const TypeIdentifier& typeId, ITypeNavigator& typeNavigator, bool isChanging);
    StructNavigator(const StructNavigator& arg) = default;
    StructNavigator(StructNavigator&& arg) = default;
    StructNavigator& operator=(const StructNavigator& arg) = default;
    StructNavigator& operator=(StructNavigator&& arg) = default;
    ~StructNavigator(void) = default;

public: // setter/getter operations

public: // operations
    Enumerator  GetEnumerator(const byte* address);
    Enumerator  GetEnumerator(const DataInfo& dataInfo);
    size_t      GetOffset(const String& fieldName);

private: // methods

private: // fields
    const TypeIdentifier&   typeIdentifier;
    ITypeNavigator&         typeNavigator;
    std::vector<DataInfo>   fieldInfos;
    std::vector<size_t>     offsets;
    bool                    isChanging = false;
};

// inline methods of class StructNavigator

inline StructNavigator::Enumerator StructNavigator::GetEnumerator(const byte* address)
{
    return StructNavigator::Enumerator(this->fieldInfos, this->offsets, address);
}

inline StructNavigator::Enumerator StructNavigator::GetEnumerator(const DataInfo& dataInfo)
{
    return this->GetEnumerator(dataInfo.GetDataTag().GetDataAddress());
}

// inline methods of class StructNavigator::Enumerator
inline size_t StructNavigator::Enumerator::GetCurrentOffset(void)const
{
    if (this->index < offsets.size())
    {
        return offsets[this->index];
    }
    return 0;
}

}}}} // end of namespace Arp::Plc::Commons::Meta