blob: bd04d9a2908d51147f17c0fa3444b129940f82c0 [file] [log] [blame]
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -08001/* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil -*- */
2/*
3 * Copyright (c) 2011,2012 University of California, Los Angeles
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation;
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 *
18 * Author: Alexander Afanasyev <alexander.afanasyev@ucla.edu>
19 */
20
21#ifndef _BATCHES_H_
22#define _BATCHES_H_
23
24#include "ns3/attribute.h"
25#include "ns3/attribute-helper.h"
26#include "ns3/nstime.h"
27#include <list>
Mickey Sweatt89046c12014-11-16 20:32:27 -080028#include <tuple>
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080029
30namespace ns3 {
31
Alexander Afanasyevb4fee8b2012-06-06 12:54:26 -070032/**
Alexander Afanasyev79206512013-07-27 16:49:12 -070033 * @ingroup ndn-apps
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -080034 * @brief Class representing sets of (time, number) tuples with support of reading writing to
35 * streams
Alexander Afanasyevb4fee8b2012-06-06 12:54:26 -070036 */
Mickey Sweatt89046c12014-11-16 20:32:27 -080037class Batches : public std::list<std::tuple<Time, uint32_t>> {
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080038public:
Alexander Afanasyevb4fee8b2012-06-06 12:54:26 -070039 /**
40 * @brief Default constructor
41 */
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -080042 Batches(){};
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080043
Alexander Afanasyevb4fee8b2012-06-06 12:54:26 -070044 /**
45 * @brief Add tuple
46 * @param when time for the tuple
47 * @param amount number for the tuple
48 */
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080049 void
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -080050 Add(const Time& when, uint32_t amount)
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080051 {
Mickey Sweatt89046c12014-11-16 20:32:27 -080052 push_back(std::make_tuple(when, amount));
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080053 }
54};
55
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -080056ATTRIBUTE_HELPER_HEADER(Batches);
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080057
Alexander Afanasyevb4fee8b2012-06-06 12:54:26 -070058/**
59 * @brief Output contents of the Batches to the std::ostream
60 * @param os reference to std::ostream
61 * @param batch constant reference to Batch object
62 */
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -080063std::ostream&
64operator<<(std::ostream& os, const Batches& batch);
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080065
66/**
67 * \brief Read components from input and add them to components. Will read input stream till eof
68 * Substrings separated by slashes will become separate components
69 */
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -080070std::istream&
71operator>>(std::istream& is, Batches& batch);
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080072
73} // namespace ns3
74
75#endif // _BATCHES_H_