DataInfo.hpp

//
//  Copyright PHOENIX CONTACT Electronics GmbH
//
#pragma once
#include "Arp/System/Core/Arp.h"
#include "Arp/System/Rsc/Services/IRscSerializable.hpp"
#include "Arp/System/Rsc/Services/RscReader.hpp"
#include "Arp/System/Rsc/Services/RscString.hxx"
#include "Arp/System/Rsc/Services/RscWriter.hpp"
#include "Arp/Plc/Commons/Meta/DataTag.hpp"
#include "Arp/Plc/Commons/Meta/ArrayDimension.hpp"
#include "Arp/Plc/Commons/Meta/ArrayDimensions.hpp"
#include "Arp/Plc/Commons/Meta/ITypeNavigator.hpp"




namespace Arp { namespace Plc { namespace Meta { namespace Internal
{
class DataBrowser;
}}}}

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

using namespace Arp::System::Rsc::Services;

class DataInfo : public IRscSerializable
{
    friend class Arp::Plc::Meta::Internal::DataBrowser;

public: // typedefs

public: // construction/destruction
    DataInfo(void) = default;
    DataInfo(const DataInfo& arg) = default;
    DataInfo(DataInfo&& arg) = default;
    DataInfo(const DataTag& dataTag);
    DataInfo(const DataTag& dataTag, const ArrayDimension& arrayDimension);
    DataInfo(const DataTag& dataTag, const ArrayDimensions& arrayDimensions);
    DataInfo& operator=(const DataInfo& arg) = default;
    DataInfo& operator=(DataInfo&& arg) = default;
    ~DataInfo(void) = default;

public: // static properties
    static const DataInfo Empty;

public: // setter/getter operations
    bool IsEmpty(void)const;

    DataTypeEnum& GetDataType(void);

    const DataTypeEnum& GetDataType(void)const;

    DataTag& GetDataTag(void);

    const DataTag& GetDataTag(void)const;

    TypeIdentifier& GetTypeIdentifier(void);

    const TypeIdentifier& GetTypeIdentifier(void)const;

    ArrayDimensions& GetArrayDimensions(void);

    const ArrayDimensions& GetArrayDimensions(void)const;

    bool IsBackgroundDomain(void)const;

public: // operations
    ARP_DEPRECATED("Use GetBaseDataTypeSize instead")
    size_t      GetTypeSize(ITypeNavigator& typeNavigator)const;

    size_t      GetBaseDataTypeSize(ITypeNavigator& typeNavigator)const;

    size_t      GetDataSize(ITypeNavigator& typeNavigator)const;

    size_t      GetDataAlignment(ITypeNavigator& typeNavigator)const;

    size_t      GetVariableSize(ITypeNavigator& typeNavigator)const;

    size_t      GetVariableAlignment(ITypeNavigator& typeNavigator)const;

    TypeInfo    GetTypeInfo(ITypeNavigator& typeNavigator)const;

public: // IRscSerializable operations
    void Serialize(RscWriter& writer)const override;
    void Deserialize(RscReader& reader)override;
    static size_t GetFieldCount(void);

private: // methods
    void            SetName(const String& value);

private: // fields
    DataTag         dataTag;
    ArrayDimensions dimensions;

private: // static fields
};

// inline methods of class DataInfo

inline bool DataInfo::IsEmpty()const
{
    return this->dataTag.IsEmpty();
}

inline DataTypeEnum& DataInfo::GetDataType()
{
    return this->dataTag.GetDataType();
}

inline const DataTypeEnum& DataInfo::GetDataType()const
{
    return this->dataTag.GetDataType();
}

inline DataTag& DataInfo::GetDataTag()
{
    return this->dataTag;
}

inline const DataTag& DataInfo::GetDataTag()const
{
    return this->dataTag;
}

inline TypeIdentifier& DataInfo::GetTypeIdentifier()
{
    return this->dataTag.GetTypeIdentifier();
}

inline const TypeIdentifier& DataInfo::GetTypeIdentifier()const
{
    return this->dataTag.GetTypeIdentifier();
}

inline ArrayDimensions& DataInfo::GetArrayDimensions(void)
{
    return this->dimensions;
}

inline const ArrayDimensions& DataInfo::GetArrayDimensions(void)const
{
    return this->dimensions;
}

inline bool DataInfo::IsBackgroundDomain()const
{
    return this->dataTag.IsBackgroundDomain();
}

inline void DataInfo::SetName(const String& value)
{
    this->dataTag.SetName(value);
}

inline size_t DataInfo::GetFieldCount(void)
{
    return 2;
}

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