src/buildings/model/building-list.cc
author Peter D. Barnes, Jr. <barnes26@llnl.gov>
Fri, 26 Sep 2014 15:51:00 -0700
changeset 10968 2d29fee2b7b8
parent 10967 597a9ec89e60
child 11326 ef18161803a7
permissions -rw-r--r--
[Bug 1551] Redux: NS_LOG_COMPONENT_DEFINE inside or outside of ns3 namespace?

/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2011 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
 *
 * 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
 *
 * Author: Jaume Nin <jaume.nin@cttc,cat>
 * Based on BuildingList implemenation by Mathieu Lacage  <mathieu.lacage@sophia.inria.fr>
 *
 */
#include "building-list.h"
#include "ns3/simulator.h"
#include "ns3/object-vector.h"
#include "ns3/config.h"
#include "ns3/log.h"
#include "ns3/assert.h"
#include "building-list.h"
#include "building.h"

namespace ns3 {

NS_LOG_COMPONENT_DEFINE ("BuildingList");

/**
 * \brief private implementation detail of the BuildingList API.
 */
class BuildingListPriv : public Object
{
public:
  static TypeId GetTypeId (void);
  BuildingListPriv ();
  ~BuildingListPriv ();

  uint32_t Add (Ptr<Building> building);
  BuildingList::Iterator Begin (void) const;
  BuildingList::Iterator End (void) const;
  Ptr<Building> GetBuilding (uint32_t n);
  uint32_t GetNBuildings (void);

  static Ptr<BuildingListPriv> Get (void);

private:
  virtual void DoDispose (void);
  static Ptr<BuildingListPriv> *DoGet (void);
  static void Delete (void);
  std::vector<Ptr<Building> > m_buildings;
};

NS_OBJECT_ENSURE_REGISTERED (BuildingListPriv);

TypeId
BuildingListPriv::GetTypeId (void)
{
  static TypeId tid = TypeId ("ns3::BuildingListPriv")
    .SetParent<Object> ()
    .AddAttribute ("BuildingList", "The list of all buildings created during the simulation.",
                   ObjectVectorValue (),
                   MakeObjectVectorAccessor (&BuildingListPriv::m_buildings),
                   MakeObjectVectorChecker<Building> ())
  ;
  return tid;
}

Ptr<BuildingListPriv>
BuildingListPriv::Get (void)
{
  return *DoGet ();
}
Ptr<BuildingListPriv> *
BuildingListPriv::DoGet (void)
{
  static Ptr<BuildingListPriv> ptr = 0;
  if (ptr == 0)
    {
      ptr = CreateObject<BuildingListPriv> ();
      Config::RegisterRootNamespaceObject (ptr);
      Simulator::ScheduleDestroy (&BuildingListPriv::Delete);
    }
  return &ptr;
}
void
BuildingListPriv::Delete (void)
{
  NS_LOG_FUNCTION_NOARGS ();
  Config::UnregisterRootNamespaceObject (Get ());
  (*DoGet ()) = 0;
}


BuildingListPriv::BuildingListPriv ()
{
  NS_LOG_FUNCTION_NOARGS ();
}
BuildingListPriv::~BuildingListPriv ()
{
}
void
BuildingListPriv::DoDispose (void)
{
  NS_LOG_FUNCTION_NOARGS ();
  for (std::vector<Ptr<Building> >::iterator i = m_buildings.begin ();
       i != m_buildings.end (); i++)
    {
      Ptr<Building> building = *i;
      building->Dispose ();
      *i = 0;
    }
  m_buildings.erase (m_buildings.begin (), m_buildings.end ());
  Object::DoDispose ();
}


uint32_t
BuildingListPriv::Add (Ptr<Building> building)
{
  uint32_t index = m_buildings.size ();
  m_buildings.push_back (building);
  Simulator::ScheduleWithContext (index, TimeStep (0), &Building::Initialize, building);
  return index;

}
BuildingList::Iterator
BuildingListPriv::Begin (void) const
{
  return m_buildings.begin ();
}
BuildingList::Iterator
BuildingListPriv::End (void) const
{
  return m_buildings.end ();
}
uint32_t
BuildingListPriv::GetNBuildings (void)
{
  return m_buildings.size ();
}

Ptr<Building>
BuildingListPriv::GetBuilding (uint32_t n)
{
  NS_ASSERT_MSG (n < m_buildings.size (), "Building index " << n <<
                 " is out of range (only have " << m_buildings.size () << " buildings).");
  return m_buildings.at (n);
}

}

/**
 * The implementation of the public static-based API
 * which calls into the private implementation through
 * the simulation singleton.
 */
namespace ns3 {

uint32_t
BuildingList::Add (Ptr<Building> building)
{
  return BuildingListPriv::Get ()->Add (building);
}
BuildingList::Iterator
BuildingList::Begin (void)
{
  return BuildingListPriv::Get ()->Begin ();
}
BuildingList::Iterator
BuildingList::End (void)
{
  return BuildingListPriv::Get ()->End ();
}
Ptr<Building>
BuildingList::GetBuilding (uint32_t n)
{
  return BuildingListPriv::Get ()->GetBuilding (n);
}
uint32_t
BuildingList::GetNBuildings (void)
{
  return BuildingListPriv::Get ()->GetNBuildings ();
}

} // namespace ns3