generic-battery-model-helper.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 Tokushima University, Japan.
 *
 * 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: Alberto Gallegos Ramonet <alramonet@is.tokushima-u.ac.jp>
 */
 
#ifndef GENERIC_BATTERY_MODEL_HELPER_H_
#define GENERIC_BATTERY_MODEL_HELPER_H_
 
#include "energy-model-helper.h"
 
#include <ns3/generic-battery-model.h>
#include <ns3/node.h>
 
namespace ns3
{
 
class GenericBatteryModelHelper : public EnergySourceHelper
{
  public:
    GenericBatteryModelHelper();
    ~GenericBatteryModelHelper() override;
 
    void Set(std::string name, const AttributeValue& v) override;
 
    Ptr<EnergySourceContainer> Install(NodeContainer c) const;
 
    Ptr<EnergySource> Install(Ptr<Node> node, BatteryModel bm) const;
 
    EnergySourceContainer Install(NodeContainer c, BatteryModel bm) const;
 
    void SetCellPack(Ptr<EnergySource> energySource, uint8_t series, uint8_t parallel) const;
 
    void SetCellPack(EnergySourceContainer energySourceContainer,
                     uint8_t series,
                     uint8_t parallel) const;
 
  private:
    Ptr<EnergySource> DoInstall(Ptr<Node> node) const override;
 
  private:
    ObjectFactory m_batteryModel; 
};
 
} // namespace ns3
 
#endif /* GENERIC_BATTERY_MODEL_HELPER_H_ */