--- a/src/helper/node-container.h Fri Mar 21 15:52:49 2008 -0700
+++ b/src/helper/node-container.h Fri Mar 21 15:58:20 2008 -0700
@@ -7,23 +7,71 @@
namespace ns3 {
+/**
+ * \brief keep track of a set of node pointers.
+ *
+ */
class NodeContainer
{
public:
typedef std::vector<Ptr<Node> >::const_iterator Iterator;
+ /**
+ * Create an empty NodeContainer.
+ */
NodeContainer ();
+ /**
+ * \param node a node to add to the container
+ *
+ * Create a NodeContainer with exactly one node.
+ */
NodeContainer (Ptr<Node> node);
+ /**
+ * \param a a node container
+ * \param b another node container
+ *
+ * Create a node container which is a concatenation of the two input
+ * NodeContainers.
+ */
NodeContainer (const NodeContainer &a, const NodeContainer &b);
+ /**
+ * \returns an iterator to the start of the vector of node pointers.
+ */
Iterator Begin (void) const;
+ /**
+ * \returns an iterator to the end of the vector of node pointers.
+ */
Iterator End (void) const;
+ /**
+ * \returns the number of node pointers stored in this NodeContainer.
+ */
uint32_t GetN (void) const;
+ /**
+ * \param i the index of the requested node pointer.
+ * \returns the requested node pointer.
+ */
Ptr<Node> Get (uint32_t i) const;
+ /**
+ * \param n the number of nodes to create
+ *
+ * Create n nodes and append pointers to them to the end of this NodeContainer.
+ */
void Create (uint32_t n);
+ /**
+ * \param other another NodeContainer
+ *
+ * Append the node pointers from the input NodeContainer at the end
+ * of this NodeContainer.
+ */
void Add (NodeContainer other);
+ /**
+ * \param node a node pointer
+ *
+ * Append the input node pointer at the end of this NodeContainer.
+ */
void Add (Ptr<Node> node);
private: