global-value.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 GLOBAL_VALUE_H
#define GLOBAL_VALUE_H
 
#include "attribute.h"
#include "ptr.h"
 
#include <string>
#include <vector>
 
namespace ns3
{
 
/* Forward declaration */
namespace tests
{
class GlobalValueTestCase;
}
 
class GlobalValue
{
    typedef std::vector<GlobalValue*> Vector;
 
  public:
    typedef Vector::const_iterator Iterator;
 
    GlobalValue(std::string name,
                std::string help,
                const AttributeValue& initialValue,
                Ptr<const AttributeChecker> checker);
 
    std::string GetName() const;
    std::string GetHelp() const;
    void GetValue(AttributeValue& value) const;
    Ptr<const AttributeChecker> GetChecker() const;
    bool SetValue(const AttributeValue& value);
 
    void ResetInitialValue();
 
    static void Bind(std::string name, const AttributeValue& value);
 
    static bool BindFailSafe(std::string name, const AttributeValue& value);
 
    static Iterator Begin();
    static Iterator End();
 
    static bool GetValueByNameFailSafe(std::string name, AttributeValue& value);
 
    static void GetValueByName(std::string name, AttributeValue& value);
 
  private:
    friend class tests::GlobalValueTestCase;
 
    static Vector* GetVector();
    void InitializeFromEnv();
 
    std::string m_name;
    std::string m_help;
    Ptr<AttributeValue> m_initialValue;
    Ptr<AttributeValue> m_currentValue;
    Ptr<const AttributeChecker> m_checker;
};
 
} // namespace ns3
 
#endif /* GLOBAL_VALUE_H */