DataTag.hpp

 
//
//  Copyright Phoenix Contact GmbH & Co. KG
//
#pragma once
#include "Arp/System/Core/Arp.h"
#include "Arp/Plc/Commons/DataTypeEnum.hpp"
#include "Arp/Plc/Commons/Meta/TypeIdentifier.hpp"
#include "Arp/Base/Rsc/Commons/RscSerializable.hpp"
#include "Arp/Base/Commons/Exceptions/InvalidOperationException.hpp"
 
namespace Arp { namespace Plc { namespace Commons { namespace Meta
{
 
using namespace Arp::Base::Rsc::Commons;
 
//forwards
class DataInfo;
class IChangeNavigator;
 
class DataTag : public RscSerializable
{
    friend class DataInfo;
 
public: // construction/destruction
    DataTag(void) = default;
    DataTag(const String& name, byte* valueAddress, DataType dataType, const TypeIdentifier& typeId, bool isBackgroundDomain = false);
    DataTag(const DataTag& arg) = default;
    DataTag(DataTag&& arg) = default;
    DataTag& operator=(const DataTag& arg) = default;
    DataTag& operator=(DataTag&& arg) = default;
    ~DataTag(void) = default;
 
public: // setter/getter operations
    bool IsEmpty(void)const;
 
    const String& GetName(void)const;
 
    void SetDataType(DataType value);
 
    DataTypeEnum& GetDataType(void);
 
    const DataTypeEnum& GetDataType(void)const;
 
    TypeIdentifier& GetTypeIdentifier(void);
 
    const TypeIdentifier& GetTypeIdentifier(void)const;
 
    void SetValueAddress(byte* value);
 
    byte* GetDataAddress(void)const;
 
    byte* GetVariableAddress(void)const;
 
    byte* GetChangeCounterpartAddress(void)const;
 
    bool IsBackgroundDomain(void)const;
 
    bool& IsBackgroundDomain(void);
 
    bool IsNullPointer(void)const;
 
    bool IsChangeCounterpartNullPointer(void)const;
 
    bool IsEmptyOrNullPointer(void)const;
 
public: // operations
    void    ResolveIndirection(void);
 
    void    ShiftValueAddress(size_t offset);
 
    void    SetChangeCounterpart(byte* value, byte* typeTag);
 
    void    SetChangeCounterpart(const DataTag& changeCounterpart);
 
    void    GetChangeInfo(byte*& valueAddressOut, byte*& changeCounterpartAddressOut, bool& isBackgroundDomainOut)const;
 
    void    Change(IChangeNavigator* pChangeNavigator);
 
public: // RscSerializable operations
    void    Serialize(RscWriter& writer)const;
    void    Deserialize(RscReader& reader);
    static size_t GetFieldCount(void);
 
private: // methods
    void    SetName(const String& value);
    void    SwapDomain(void);
 
private: // static methods
    static byte* ResolveIndirectAddress(byte* address);
 
private: // fields
    String          name;
    DataTypeEnum    dataType = DataType::None;
    TypeIdentifier  typeId;
    byte*           variableAddress = nullptr;
    byte*           changeCounterpartAddress = nullptr;
    bool            isBackgroundDomain = false;
};
 
}}}} // end of namespace Arp::Plc::Meta