ArrayDimensions.hpp

 
//
//  Copyright Phoenix Contact GmbH & Co. KG
//
#pragma once
#include "Arp/System/Core/Arp.h"
#include "Arp/Plc/Commons/Meta/ArrayDimension.hpp"
#include <vector>
#include <algorithm>
#include <initializer_list>
 
namespace Arp { namespace Plc { namespace Commons { namespace Meta
{
 
class ArrayDimensions
{
    friend class ArrayNavigator;
 
public: // typedefs
    using Values = std::vector<ArrayDimension>;
 
public: // construction/destruction
    ArrayDimensions(void) = default;
    explicit ArrayDimensions(size_t count);
    ArrayDimensions(const ArrayDimension& entry);
    ArrayDimensions(const Values& values);
    ArrayDimensions(const std::initializer_list<int>& dimensions);
    ArrayDimensions(const std::initializer_list<ArrayDimension>& entries);
    ArrayDimensions(const ArrayDimensions& arg) = default;
    ArrayDimensions(ArrayDimensions&& arg) noexcept = default;
    ArrayDimensions& operator=(const ArrayDimensions& arg) = default;
    ArrayDimensions& operator=(ArrayDimensions&& arg) noexcept = default;
    ~ArrayDimensions(void) noexcept = default;
 
public: // static properties
    static const ArrayDimensions Empty;
 
public: // operators
    ArrayDimension&         operator[](size_t index);
    const ArrayDimension&   operator[](size_t index)const;
 
public: // setter/getter operations
    bool            IsEmpty(void)const;
 
 
    size_t          GetCount(void)const;
    const Values&   GetValues(void)const;
    size_t          GetCacheSize(void)const;
    size_t          GetDimensionsProduct(void)const;
 
public: // operations
    void    Append(const ArrayDimension& dimension);
 
protected: // setter/getter operations
    void EraseFrontDimension(void);
 
private: // fields
    Values values;
};
 
bool operator==(const ArrayDimensions& lhs, const ArrayDimensions& rhs);
bool operator!= (const ArrayDimensions& lhs, const ArrayDimensions& rhs);
std::ostream& operator<<(std::ostream& os, const ArrayDimensions& rhs);
 
 
}}}} // end of namespace Arp::Plc::Commons::Meta
 
// template specialization of ArrayDimensions formatter
template<> struct fmt::formatter<Arp::Plc::Commons::Meta::ArrayDimensions>: public fmt::ostream_formatter {};