enum.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008 INRIA
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Authors: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
 */
#ifndef ENUM_VALUE_H
#define ENUM_VALUE_H
 
#include "attribute-accessor-helper.h"
#include "attribute.h"
 
#include <list>
 
namespace ns3
{
 
//  Additional docs for class EnumValue:
class EnumValue : public AttributeValue
{
  public:
    EnumValue();
    EnumValue(int value);
    void Set(int value);
    int Get() const;
    template <typename T>
    bool GetAccessor(T& value) const;
 
    Ptr<AttributeValue> Copy() const override;
    std::string SerializeToString(Ptr<const AttributeChecker> checker) const override;
    bool DeserializeFromString(std::string value, Ptr<const AttributeChecker> checker) override;
 
  private:
    int m_value; 
};
 
template <typename T>
bool
EnumValue::GetAccessor(T& value) const
{
    value = T(m_value);
    return true;
}
 
class EnumChecker : public AttributeChecker
{
  public:
    EnumChecker();
 
    void AddDefault(int value, std::string name);
    void Add(int value, std::string name);
 
    std::string GetName(int value) const;
 
    int GetValue(const std::string name) const;
 
    // Inherited
    bool Check(const AttributeValue& value) const override;
    std::string GetValueTypeName() const override;
    bool HasUnderlyingTypeInformation() const override;
    std::string GetUnderlyingTypeInformation() const override;
    Ptr<AttributeValue> Create() const override;
    bool Copy(const AttributeValue& src, AttributeValue& dst) const override;
 
  private:
    typedef std::pair<int, std::string> Value;
    typedef std::list<Value> ValueSet;
    ValueSet m_valueSet;
};
 
template <typename T1>
Ptr<const AttributeAccessor> MakeEnumAccessor(T1 a1);
 
template <typename T1, typename T2>
Ptr<const AttributeAccessor> MakeEnumAccessor(T1 a1, T2 a2);
 
template <typename... Ts>
Ptr<const AttributeChecker>
MakeEnumChecker(int v, std::string n, Ts... args)
{
    Ptr<EnumChecker> checker = Create<EnumChecker>();
    checker->AddDefault(v, n);
    return MakeEnumChecker(checker, args...);
}
 
template <typename... Ts>
Ptr<const AttributeChecker>
MakeEnumChecker(Ptr<EnumChecker> checker, int v, std::string n, Ts... args)
{
    checker->Add(v, n);
    return MakeEnumChecker(checker, args...);
}
 
// inline to allow tail call optimization
inline Ptr<const AttributeChecker>
MakeEnumChecker(Ptr<EnumChecker> checker)
{
    return checker;
}
 
template <typename T1>
Ptr<const AttributeAccessor>
MakeEnumAccessor(T1 a1)
{
    return MakeAccessorHelper<EnumValue>(a1);
}
 
template <typename T1, typename T2>
Ptr<const AttributeAccessor>
MakeEnumAccessor(T1 a1, T2 a2)
{
    return MakeAccessorHelper<EnumValue>(a1, a2);
}
 
} // namespace ns3
 
#endif /* ENUM_VALUE_H */