EnumFlagsDictionary.hxx

 
//
//  Copyright Phoenix Contact GmbH & Co. KG
//
#pragma once
#include "Arp/Base/Core/Arp.hpp"
#include "Arp/Base/Core/Detail/EnumDictionaryBase.hxx"
#include <iosfwd>
namespace Arp { namespace Base { namespace Core
{
 
template<class T, char Delimiter = '|'>
class EnumFlagsDictionary : public EnumDictionaryBase<T>
{
private: // usings
    using Base = EnumDictionaryBase<T>;
    using U = typename Base::U;
    using InitializerList = typename Base::InitializerList;
 
public: // construction
    EnumFlagsDictionary(const InitializerList& fields);
    EnumFlagsDictionary(T flagsMask, const InitializerList& fields);
    EnumFlagsDictionary(T flagsMask, const char* invalidValueString, const InitializerList& fields);
    EnumFlagsDictionary(U flagsMask, const InitializerList& fields);
    EnumFlagsDictionary(U flagsMask, const char* invalidValueString, const InitializerList& fields);
 
public: // overlapping operations from base class EnumDictionary<T> (used by stream operators of enums)
    std::ostream& WriteEnumString(std::ostream& os, T value)const;
    std::istream& ReadEnumValue(std::istream& is, T& value)const;
 
public: // string conversion operation
    String  GetEnumString(T value)const;
    bool    TryGetEnumString(T value, String& result)const;
    T       GetEnumValue(const String& fieldName)const;
    bool    TryGetEnumValue(const String& fieldName, T& value)const;
 
private: // methods
    bool IsFlag(T value)const;
    bool TryGetCombinedEnumString(T value, String& result)const;
    bool TryParseCombinedEnumValue(const String& input, T& value)const;
    bool TryFormatFlags(T value, String& result)const;
 
private: // fields
    T flagsMask = static_cast<T>(std::numeric_limits<U>::max());
};
 
}}} // end of namespace Arp::Base::Core
 
namespace Arp {
using Arp::Base::Core::EnumFlagsDictionary;
}
#include "Arp/Base/Core/Detail/EnumFlagsDictionary.ipp"