83 lines
2.2 KiB
C++
83 lines
2.2 KiB
C++
/* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
|
|
/*
|
|
* Copyright (c) 2007 INRIA
|
|
* All rights reserved.
|
|
*
|
|
* 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 NODE_LIST_H
|
|
#define NODE_LIST_H
|
|
|
|
#include <vector>
|
|
#include "ns3/array-trace-resolver.h"
|
|
#include "ns3/ptr.h"
|
|
|
|
namespace ns3 {
|
|
|
|
class INode;
|
|
class TraceResolver;
|
|
class TraceContext;
|
|
|
|
/**
|
|
* \brief the list of simulation nodes.
|
|
*
|
|
* Every INode created is automatically added to this list.
|
|
*/
|
|
class NodeList
|
|
{
|
|
public:
|
|
typedef ArrayTraceResolver<INode>::Index NodeIndex;
|
|
typedef std::vector< Ptr<INode> >::iterator Iterator;
|
|
|
|
/**
|
|
* \param node node to add
|
|
* \returns index of node in list.
|
|
*
|
|
* This method is called automatically from INode::INode so
|
|
* the user has little reason to call it himself.
|
|
*/
|
|
static uint32_t Add (Ptr<INode> node);
|
|
/**
|
|
* \returns a C++ iterator located at the beginning of this
|
|
* list.
|
|
*/
|
|
static Iterator Begin (void);
|
|
/**
|
|
* \returns a C++ iterator located at the end of this
|
|
* list.
|
|
*/
|
|
static Iterator End (void);
|
|
/**
|
|
* \param context trace context to use for trace resolver
|
|
* to create.
|
|
* \returns the requested trace resolver. The caller
|
|
* takes ownership of the returned pointer.
|
|
*/
|
|
static TraceResolver *CreateTraceResolver (TraceContext const &context);
|
|
|
|
/**
|
|
* \param n index of requested node.
|
|
* \returns the INode associated to index n.
|
|
*/
|
|
static Ptr<INode> GetINode (uint32_t n);
|
|
};
|
|
|
|
}//namespace ns3
|
|
|
|
|
|
#endif /* NODE_LIST_H */
|